Merge pull request #33 from Shargon-Pendragon/clean

Cleaned up scripts and fixed the "Resumed function '_tick()' after yield, but script is gone." error for bt_wait.gd

Author: kagenash1

.DS_Store

@@ -1,8 +1,8 @@
-class_name BehaviorTree, "res://addons/behavior_tree/icons/bt.svg" 
+class_name BehaviorTree, "res://addons/behavior_tree/icons/bt.svg"
 extends Node
 
 # This is your main node. Put one of these at the root of the scene and start adding BTNodes.
-# A Behavior Tree only accepts ONE entry point (so one child), for example a BTSequence or a BTSelector.
+# A Behavior Tree only accepts ONE entry point (so one child).
 
 export(bool) var is_active: bool = false
 export(NodePath) var _blackboard
@@ -16,51 +16,46 @@ onready var agent = get_node(_agent) as Node
 onready var blackboard = get_node(_blackboard) as Blackboard
 onready var bt_root = get_child(0) as BTNode
 
-
-
 func _ready() -> void:
 	assert(get_child_count() == 1, "A Behavior Tree can only have one entry point.")
 	bt_root.propagate_call("connect", ["abort_tree", self, "abort"])
 	start()
 
-
-func _process(delta: float) -> void:
+func _process(_delta: float) -> void:
 	if not is_active:
 		set_process(false)
 		return
-	
+
 	if debug:
 		print()
-	
+
 	tick_result = bt_root.tick(agent, blackboard)
-	
+
 	if tick_result is GDScriptFunctionState:
 		set_process(false)
 		yield(tick_result, "completed")
 		set_process(true)
-	
-
 
-func _physics_process(delta: float) -> void:
+func _physics_process(_delta: float) -> void:
 	if not is_active:
 		set_physics_process(false)
 		return
-	
+
 	if debug:
 		print()
-	
+
 	tick_result = bt_root.tick(agent, blackboard)
-	
+
 	if tick_result is GDScriptFunctionState:
 		set_physics_process(false)
 		yield(tick_result, "completed")
 		set_physics_process(true)
 
-
+# Internal: Set up if we are using process or physics_process for the behavior tree
 func start() -> void:
 	if not is_active:
 		return
-	
+
 	match sync_mode:
 		0:
 			set_physics_process(false)
@@ -69,6 +64,6 @@ func start() -> void:
 			set_process(false)
 			set_physics_process(true)
 
-
+# Public: Set the tree to inactive when a abort_tree signal is sent from bt_root
 func abort() -> void:
 	is_active = false

addons/.DS_Store

@@ -1,33 +1,43 @@
-class_name Blackboard, "res://addons/behavior_tree/icons/blackboard.svg" 
+class_name Blackboard, "res://addons/behavior_tree/icons/blackboard.svg"
 extends Node
 
-# This is the database where all your variables go. Here you keep track of 
+# This is the database where all your variables go. Here you keep track of
 # whether the player is nearby, your health is low, there is a cover available,
 # or whatever.
 #
-# You just store the data here and use it for condition checks in BTCondition scripts, 
+# You just store the data here and use it for condition checks in BTCondition scripts,
 # or as arguments for your function calls in BTAction.
 #
-# This is a good way to separate data from behavior, which is essential 
+# This is a good way to separate data from behavior, which is essential
 # to avoid nasty bugs.
 
 export(Dictionary) var data: Dictionary
 
-
-
 func _enter_tree() -> void:
 	data = data.duplicate()
 
-
 func _ready() -> void :
 	for key in data.keys():
 		assert(key is String, "Blackboard keys must be stored as strings.")
 
-
+# Public: Updates or adds the blackboard with the provided key and value
+#
+# key = Contains the name the data will be stored upder in the blackboard
+# value = Contains the data that will be associated with the key. (Variant)
+# Example
+#	set_data("health", 15)
 func set_data(key: String, value) -> void:
 	data[key] = value
 
-
+# Public: Returns the blackboard data for the provided key
+#
+# key = Contains the name the data will be stored upder in the blackboard
+#
+# Example
+#	get("health")
+#		=> 15
+#
+# Returns Variant
 func get_data(key: String):
 	if data.has(key):
 		var value = data[key]
@@ -42,6 +52,12 @@ func get_data(key: String):
 	else:
 		return null
 
-
+# Public: Returns true if the key is present in the blackboard
+#
+# key = Contains the name the data will be stored upder in the blackboard
+#
+# Example
+#	had_data("health")
+#		=> true
 func has_data(key: String) -> bool:
 	return data.has(key)

addons/behavior_tree/.DS_Store

@@ -1,35 +1,34 @@
-class_name BTNode, "res://addons/behavior_tree/icons/btnode.svg" 
+class_name BTNode, "res://addons/behavior_tree/icons/btnode.svg"
 extends Node
 
-# Base class from which every node in the behavior tree inherits. 
+# Base class from which every node in the behavior tree inherits.
 # You don't usually need to instance this node directly.
 # To define your behaviors, use and extend BTLeaf instead.
 
+# (Optional) Emitted after a tick() call. True is success, false is failure.
+signal tick(result)
+
+# Emitted if abort_tree is set to true
+signal abort_tree()
+
+
 enum BTNodeState {
 	FAILURE,
 	SUCCESS,
 	RUNNING,
 }
 
-# (Optional) Emitted after a tick() call. True is success, false is failure. 
-signal tick(result)
-
-# Emitted if abort_tree is set to true
-signal abort_tree()
-
 # Turn this off to make the node fail at each tick.
-export(bool) var is_active: bool = true 
+export(bool) var is_active: bool = true
 
 # Turn this on to print the name of the node at each tick.
-export(bool) var debug: bool = false 
+export(bool) var debug: bool = false
 
 # Turn this on to abort the tree after completion.
 export(bool) var abort_tree: bool
 
 var state: int setget set_state
 
-
-
 func _ready():
 	if is_active:
 		succeed()
@@ -41,17 +40,18 @@ func _ready():
 ### OVERRIDE THE FOLLOWING FUNCTIONS ###
 # You just need to implement them. DON'T CALL THEM MANUALLY.
 
-func _pre_tick(agent: Node, blackboard: Blackboard) -> void:
+# Public: Called before the tick happens used for preperation for action or conditional
+func _pre_tick(_agent: Node, _blackboard: Blackboard) -> void:
 	pass
 
 
 # This is where the core behavior goes and where the node state is changed.
 # You must return either succeed() or fail() (check below), not just set the state.
-func _tick(agent: Node, blackboard: Blackboard) -> bool:
+func _tick(_agent: Node, _blackboard: Blackboard) -> bool:
 	return succeed()
 
-
-func _post_tick(agent: Node, blackboard: Blackboard, result: bool) -> void:
+# Public: Called after the tick for anything that needs to happen after the action
+func _post_tick(_agent: Node, _blackboard: Blackboard, _result: bool) -> void:
 	pass
 
 ### DO NOT OVERRIDE ANYTHING FROM HERE ON ###
@@ -81,7 +81,7 @@ func set_state(rhs: int) -> bool:
 			return succeed()
 		BTNodeState.FAILURE:
 			return fail()
-	
+
 	assert(false, "Invalid BTNodeState assignment. Can only set to success or failure.")
 	return false
 
@@ -117,38 +117,45 @@ func get_state() -> String:
 		return "running"
 
 
-# Again, DO NOT override this. 
+# Again, DO NOT override this.
 func tick(agent: Node, blackboard: Blackboard) -> bool:
 	if not is_active:
 		return fail()
-	
+
 	if running():
 		return false
-	
+
 	if debug:
 		print(name)
-	
+
 	# Do stuff before core behavior
 	_pre_tick(agent, blackboard)
-	
-	run() 
-	
+
+	run()
+
 	var result = _tick(agent, blackboard)
-	
+
 	if result is GDScriptFunctionState:
-		assert(running(), "BTNode execution was suspended but it's not running. Did you succeed() or fail() before yield?")
+		assert(
+			running(),
+			"BTNode execution was suspended. Did you succeed() or fail() before yield?"
+		)
+
 		result = yield(result, "completed")
-	
-	assert(not running(), "BTNode execution was completed but it's still running. Did you forget to return succeed() or fail()?") 
-	
+
+	assert(
+		not running(),
+		"BTNode executed but it's still running. Did you forget to return succeed() or fail()?"
+	)
+
 	# Do stuff after core behavior depending on the result
 	_post_tick(agent, blackboard, result)
-	
+
 	# Notify completion and new state (i.e. the result of the execution)
 	emit_signal("tick", result)
-	
+
 	# Queue tree abortion at the end of current tick
 	if abort_tree:
 		emit_signal("abort_tree")
-	
+
 	return result

addons/behavior_tree/src/behavior_tree.gd

@@ -8,25 +8,29 @@ extends BTNode
 # to you, but you may have some specific flow in your game. In that case,
 # you can extend this script and define it yourself.
 
-onready var children: Array = get_children() as Array
-
 var bt_child: BTNode # Used to iterate over children
 
-
+onready var children: Array = get_children() as Array
 
 func _ready():
 	assert(get_child_count() > 1, "A BTComposite must have more than one child.")
 
-
-
+# Public: Returns true once all the childrens _tick functions are completed
+#
+# agent = Is the agent instance
+# blackboard = Contains data that the agent has stored
+#
+# Example
+#	_tick(Node.new(), Blackboard.new())
+#		=> true
 func _tick(agent: Node, blackboard: Blackboard) -> bool:
 	var result
-	
+
 	for c in children:
 		bt_child = c
 		result = bt_child.tick(agent, blackboard)
-		
+
 		if result is GDScriptFunctionState:
 			result = yield(result, "completed")
-	
+
 	return succeed()

addons/behavior_tree/src/blackboard.gd

@@ -6,17 +6,21 @@ extends BTNode
 
 onready var bt_child: BTNode = get_child(0) as BTNode
 
-
-
 func _ready():
 	assert(get_child_count() == 1, "A BTDecorator can only have one child.")
 
-
+# Public: Returns true once it's only child's _tick function has completed
+#
+# agent = Is the agent instance
+# blackboard = Contains data that the agent has stored
+#
+# Example
+#	_tick(Node.new(), Blackboard.new())
+#		=> true
 func _tick(agent: Node, blackboard: Blackboard) -> bool:
 	var result = bt_child.tick(agent, blackboard)
-	
+
 	if result is GDScriptFunctionState:
 		result = yield(result, "completed")
-	
-	return set_state(bt_child.state)
 
+	return set_state(bt_child.state)

addons/behavior_tree/src/bt_node.gd

@@ -1,8 +1,8 @@
-class_name BTLeaf, "res://addons/behavior_tree/icons/btleaf.svg" 
+class_name BTLeaf, "res://addons/behavior_tree/icons/btleaf.svg"
 extends BTNode
 
 # Leaf nodes are used to implement your own behavior logic.
-# That can be for example calling functions on the agent, or checking conditions in the blackboard. 
+# That can be for example calling functions on the agent, or checking conditions in the blackboard.
 # Good practice is to not make leaf nodes do too much stuff, and to not have flow logic in them.
 # Instead, just use them to do a single action or condition check, and use a composite node
 # (BTSequence, BTSelector or BTParallel) to define the flow between multiple leaf nodes.

addons/behavior_tree/src/btnodes/bt_composite.gd

@@ -3,10 +3,18 @@ extends BTComposite
 
 # Executes each child. doesn't wait for completion, always succeeds.
 
+# Public: Returns true once all the childrens _tick functions are ran doesn't check for completion
+#
+# agent = Is the agent instance
+# blackboard = Contains data that the agent has stored
+#
+# Example
+#	_tick(Node.new(), Blackboard.new())
+#		=> true
 func _tick(agent: Node, blackboard: Blackboard) -> bool:
 	for c in children:
 		bt_child = c
 		bt_child.tick(agent, blackboard)
-	
+
 	return succeed()