Merge pull request #57 from ThePat02/2.0.0

Upgrade main branch to 2.0.0

Author: ThePat02

addons/behaviour_toolkit/behaviour_toolkit.gd

@@ -1,3 +1,5 @@
 @icon("res://addons/behaviour_toolkit/icons/Gear.svg")
 class_name BehaviourToolkit extends Node
-## The main node of the BehaviourToolkit plugin.
+## Base class for Behaviour Toolkit plugin nodes.
+##
+## Currently only used to group this plugins nodes.

addons/behaviour_toolkit/behaviour_tree/bt_behaviour.gd

@@ -1,9 +1,14 @@
 @icon("res://addons/behaviour_toolkit/icons/BTBehaviour.svg")
 class_name BTBehaviour extends BehaviourToolkit
+## Base class for building behaviour nodes in BehaviourToolkit.
+##
+## Behaviours can return [enum BTBehaviour.BTStatus.SUCCESS],
+## [enum BTBehaviour.BTStatus.FAILURE] or [enum BTBehaviour.BTStatus.RUNNING]
+## which control the flow of the behaviours in Behaviour Tree system.
 
 
-enum Status {
+enum BTStatus {
 	SUCCESS,
 	FAILURE,
-	RUNNING
+	RUNNING,
 }

addons/behaviour_toolkit/behaviour_tree/bt_composite.gd

@@ -1,6 +1,29 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTComposite.svg")
 class_name BTComposite extends BTBehaviour
+## Base class to build composite behaviour nodes.
+##
+## Composites can hold multiple behaviour nodes and evalute/execute them
+## based on custom logic based on their return values.
 
 
 ## The leaves under the composite node.
 @onready var leaves: Array = get_children()
+
+
+func _get_configuration_warnings() -> PackedStringArray:
+	var warnings: Array = []
+	
+	var parent = get_parent()
+	var children = get_children()
+
+	if not parent is BTComposite and not parent is BTRoot and not parent is BTDecorator:
+		warnings.append("BTComposite node must be a child of BTComposite or BTRoot node.")
+	
+	if children.size() == 0:
+		warnings.append("BTComposite node must have at least one child.")
+	
+	if children.size() == 1:
+		warnings.append("BTComposite node should have more than one child.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/bt_decorator.gd

@@ -1,13 +1,37 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTDecorator.svg")
 class_name BTDecorator extends BTBehaviour
+## Base class for decorators.
+##
+## Decorators are used to augment the behaviour of a leaf.[br]
+## Think of it as another layer of logic that is executed before the leaf.
 
 
 ## The leaf the decorator is decorating.
 @onready var leaf: BTBehaviour =  _get_leaf()
 
 
 func _get_leaf() -> BTBehaviour:
-    if get_child_count() == 0:
-        return null
-    
-    return get_child(0)
+	if get_child_count() == 0:
+		return null
+	
+	return get_child(0)
+
+
+func _get_configuration_warnings() -> PackedStringArray:
+	var warnings: Array = []
+	
+	var parent = get_parent()
+	var children = get_children()
+
+	if not parent is BTComposite and not parent is BTRoot:
+		warnings.append("Decorator node should be a child of a composite node or the root node.")
+	
+	if children.size() == 0:
+		warnings.append("Decorator node should have a child.")
+	elif children.size() > 1:
+		warnings.append("Decorator node should have only one child.")
+	elif not children[0] is BTBehaviour:
+		warnings.append("Decorator node should have a BTBehaviour node as a child.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/bt_leaf.gd

@@ -1,6 +1,29 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTLeaf.svg")
 class_name BTLeaf extends BTBehaviour
+## A leaf is where the actual logic that controlls the actor or other nodes
+## is implemented. 
+##
+## It is the base class for all leaves and can be extended to implement
+## custom behaviours.[br]
+## The [code]tick(actor: Node, blackboard: Blackboard)[/code] method is called
+## every frame and should return the status.
 
 
-func tick(_actor: Node, _blackboard: Blackboard) -> Status:
-	return Status.SUCCESS
+func tick(_delta: float, _actor: Node, _blackboard: Blackboard) -> BTStatus:
+	return BTStatus.SUCCESS
+
+
+func _get_configuration_warnings() -> PackedStringArray:
+	var warnings: Array = []
+	
+	var parent = get_parent()
+	var children = get_children()
+
+	if not parent is BTBehaviour and not parent is BTRoot:
+		warnings.append("BTLeaf node must be a child of BTBehaviour or BTRoot node.")
+	
+	if children.size() > 0:
+		warnings.append("BTLeaf node must not have any children.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/bt_leaf_integration.gd

@@ -1,5 +1,21 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTLeafIntegration.svg")
 class_name BTLeafIntegration extends BTLeaf
+## Base class to build [BTLeaf]s that act on [FiniteStateMachine].
 
 
-@export var state_machine: FiniteStateMachine
+@export var state_machine: FiniteStateMachine:
+	set(value):
+		state_machine = value
+		update_configuration_warnings()
+
+
+func _get_configuration_warnings():
+	var warnings: Array = []
+
+	warnings.append_array(super._get_configuration_warnings())
+
+	if state_machine == null:
+		warnings.append("No state machine set.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/bt_root.gd

@@ -1,11 +1,17 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTRoot.svg")
 class_name BTRoot extends BehaviourToolkit
 ## Node used as a base parent (root) of a Behaviour Tree
+##
+## This is the root of your behaviour tree.[br]
+## It is designed to expect first child node to be a BTComposite node to start
+## the execution of the behaviour tree.[br]
+## The root node is responsible for updating the tree.
 
 
 enum ProcessType {
 	IDLE, ## Updates on every rendered frame (at current FPS).
-	PHYSICS ## Updates on a fixed rate (60 FPS by default) synchornized with physics thread. 
+	PHYSICS, ## Updates on a fixed rate (60 FPS by default) synchornized with physics thread. 
 }
 
 
@@ -25,13 +31,19 @@ enum ProcessType {
 
 
 var active: bool = false
-var current_status: BTBehaviour.Status
+var current_status: BTBehaviour.BTStatus
 
 
 @onready var entry_point = get_child(0)
 
 
 func _ready() -> void:
+	# Don't run in editor
+	if Engine.is_editor_hint():
+		set_physics_process(false)
+		set_process(false)
+		return
+	
 	if blackboard == null:
 		blackboard = _create_local_blackboard()
 
@@ -56,8 +68,7 @@ func _process_code(delta: float) -> void:
 	if not active:
 		return
 
-	blackboard.set_value("delta", delta)
-	current_status = entry_point.tick(actor, blackboard)
+	current_status = entry_point.tick(delta, actor, blackboard)
 
 
 func _create_local_blackboard() -> Blackboard:
@@ -69,3 +80,19 @@ func _create_local_blackboard() -> Blackboard:
 func _setup_processing() -> void:
 	set_physics_process(process_type == ProcessType.PHYSICS)
 	set_process(process_type == ProcessType.IDLE)
+
+
+func _get_configuration_warnings() -> PackedStringArray:
+	var warnings: Array = []
+	
+	var children = get_children()
+
+	if children.size() == 0:
+		warnings.append("Behaviour Tree needs to have one Behaviour child.")
+	elif children.size() == 1:
+		if not children[0] is BTBehaviour:
+			warnings.append("The child of Behaviour Tree needs to be a Behaviour.")
+	elif children.size() > 1:
+		warnings.append("Behaviour Tree can have only one Behaviour child.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/composites/bt_integrated_fsm.gd

@@ -1,15 +1,33 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTCompositeIntegration.svg")
 class_name BTIntegratedFSM extends BTComposite
+## A composite behaviour node that allows to integrate [FiniteStateMachine]
+## in a behaviour tree by handling FSM node.
+##
+## To nest a FSM you need to add a [FiniteStateMachine] as a first child of
+## [BTIntegratedFSM]. When this behaviour is evaluated the child FSM
+## is set to active.
+## [br][br]
+## After the FSM is started it returns status
+## [enum BTBehaviour.BTStatus.RUNNING]. If FSM return
+## [enum BTBehaviour.BTStatus.SUCCESS] or [enum BTBehaviour.BTStatus.FAILURE]
+## the child FSM is stopped.
 
 
-@onready var state_machine: FiniteStateMachine = _get_machine()
+var state_machine: FiniteStateMachine = null
 
 
-func tick(_actor: Node, _blackboard: Blackboard) -> Status:
+func _ready():
+	if not Engine.is_editor_hint():
+		state_machine = _get_machine()
+		
+
+
+func tick(_delta: float, _actor: Node, _blackboard: Blackboard) -> BTStatus:
 	if state_machine.active == false:
 		state_machine.start()
 
-	if not state_machine.current_bt_status == Status.RUNNING:
+	if not state_machine.current_bt_status == BTStatus.RUNNING:
 		state_machine.active = false
 
 	return state_machine.current_bt_status
@@ -20,3 +38,20 @@ func _get_machine() -> FiniteStateMachine:
 		return null
 	else:
 		return get_child(0)
+
+
+func _get_configuration_warnings():
+	var warnings: Array = []
+	var children = get_children()
+
+	if children.size() == 0:
+		warnings.append("BTIntegratedFSM must have a child node. The first child will be used as the state machine.")
+
+	if children.size() > 1:
+		warnings.append("BTIntegratedFSM can only have one child node. The first child will be used as the state machine.")
+	
+	if children.size() == 1:
+		if not children[0] is FiniteStateMachine:
+			warnings.append("BTIntegratedFSM's child node must be a FiniteStateMachine. The first child will be used as the state machine.")
+
+	return warnings

addons/behaviour_toolkit/behaviour_tree/composites/bt_random.gd

@@ -12,18 +12,18 @@ var active_leave: BTBehaviour
 
 
 func _ready():
-    if use_seed:
-        rng.seed = hash(seed)
-
-
-func tick(actor: Node, blackboard: Blackboard):
-    if active_leave == null:
-        active_leave = leaves[rng.randi() % leaves.size()]
-    
-    var response = active_leave.tick(actor, blackboard)
-    
-    if response == Status.RUNNING:
-        return response
-    
-    active_leave = null
-    return response
+	if use_seed:
+		rng.seed = hash(seed)
+
+
+func tick(delta: float, actor: Node, blackboard: Blackboard):
+	if active_leave == null:
+		active_leave = leaves[rng.randi() % leaves.size()]
+	
+	var response = active_leave.tick(delta, actor, blackboard)
+	
+	if response == BTStatus.RUNNING:
+		return response
+	
+	active_leave = null
+	return response

addons/behaviour_toolkit/behaviour_tree/composites/bt_random_selector.gd

@@ -1,3 +1,4 @@
+@tool
 @icon("res://addons/behaviour_toolkit/icons/BTCompositeRandomSelector.svg")
 class_name BTRandomSelector extends BTComposite
 ## The selector composite but with a random order of the leaves.
@@ -7,24 +8,24 @@ var is_shuffled: bool = false
 var current_leaf: int = 0
 
 
-func tick(actor: Node, blackboard: Blackboard):
+func tick(delta: float, actor: Node, blackboard: Blackboard):
 	if not is_shuffled:
 		leaves.shuffle()
 
 	if current_leaf > leaves.size() -1:
 		current_leaf = 0
 		is_shuffled = false
-		return Status.FAILURE
+		return BTStatus.FAILURE
 
-	var response = leaves[current_leaf].tick(actor, blackboard)
+	var response = leaves[current_leaf].tick(delta, actor, blackboard)
 
-	if response == Status.SUCCESS:
+	if response == BTStatus.SUCCESS:
 		current_leaf = 0
 		is_shuffled = false
 		return response
 
-	if response == Status.RUNNING:
+	if response == BTStatus.RUNNING:
 		return response
 
 	current_leaf += 1
-	return Status.RUNNING
+	return BTStatus.RUNNING