Merge 9b7832af31 into 7aebed5897

(cherry picked from commit fe87a87759)

README.md

@@ -16,7 +16,7 @@
 **LimboAI** is an open-source C++ plugin for **Godot Engine 4** providing a combination of
 **Behavior Trees** and **State Machines**, which can be used together to create complex AI behaviors.
 It comes with a behavior tree editor, built-in documentation, visual debugger, extensive demo project with a tutorial, and more!
-While it is implemented in C++, it fully supports GDScript for [creating your own tasks](https://limboai.readthedocs.io/en/stable/getting-started/custom-tasks.html) and [states](https://limboai.readthedocs.io/en/stable/getting-started/hsm.html).
+While it is implemented in C++, it fully supports GDScript for [creating your own tasks](https://limboai.readthedocs.io/en/stable/behavior-trees/custom-tasks.html) and [states](https://limboai.readthedocs.io/en/stable/hierarchical-state-machines/create-hsm.html).
 
 If you enjoy using LimboAI, please **consider supporting** my efforts with a donation on Ko-fi 😊 Your contribution will help me continue developing and improving it.
 
@@ -24,7 +24,7 @@ If you enjoy using LimboAI, please **consider supporting** my efforts with a don
 
 ![Textured screenshot](doc/images/behavior-tree-editor-debugger.png)
 
-Behavior Trees are powerful hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies). They are designed to make it easier to create rich and highly modular behaviors for your games. To learn more about behavior trees, check out [Introduction to Behavior Trees](https://limboai.readthedocs.io/en/stable/getting-started/introduction.html) and our demo project, which includes a tutorial.
+Behavior Trees are powerful hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies). They are designed to make it easier to create rich and highly modular behaviors for your games. To learn more about behavior trees, check out [Introduction to Behavior Trees](https://limboai.readthedocs.io/en/stable/behavior-trees/introduction.html) and our demo project, which includes a tutorial.
 
 ## Demonstration
 
@@ -50,13 +50,13 @@ Behavior Trees are powerful hierarchical structures used to model and control th
     - Execute `BehaviorTree` resources using the `BTPlayer` node.
     - Create complex behaviors by combining and nesting tasks in a hierarchy.
     - Control execution flow using composite, decorator, and condition tasks.
-    - [Create custom tasks](https://limboai.readthedocs.io/en/stable/getting-started/custom-tasks.html) by extending core classes: `BTAction`, `BTCondition`, `BTDecorator`, and `BTComposite`.
+    - [Create custom tasks](https://limboai.readthedocs.io/en/stable/behavior-trees/custom-tasks.html) by extending core classes: `BTAction`, `BTCondition`, `BTDecorator`, and `BTComposite`.
     - Built-in class documentation.
     - Blackboard system: Share data seamlessly between tasks using the `Blackboard`.
       - Blackboard plans: Define variables in the BehaviorTree resource and override their values in the BTPlayer node.
       - Plan editor: Manage variables, their data types and property hints.
-      - Blackboard scopes: Prevent name conflicts and enable advanced techniques like [sharing data between several agents](https://limboai.readthedocs.io/en/stable/getting-started/using-blackboard.html#sharing-data-between-several-agents).
+      - Blackboard scopes: Prevent name conflicts and enable advanced techniques like [sharing data between several agents](https://limboai.readthedocs.io/en/stable/behavior-trees/using-blackboard.html#sharing-data-between-several-agents).
-      - Blackboard parameters: [Export a BB parameter](https://limboai.readthedocs.io/en/stable/getting-started/using-blackboard.html#task-parameters), for which user can provide a value or bind it to a blackboard variable (can be used in custom tasks).
+      - Blackboard parameters: [Export a BB parameter](https://limboai.readthedocs.io/en/stable/behavior-trees/using-blackboard.html#task-parameters), for which user can provide a value or bind it to a blackboard variable (can be used in custom tasks).
       - Inspector support for specifying blackboard variables (custom editor for exported `StringName` properties ending with "_var").
     - Use the `BTSubtree` task to execute a tree from a different resource file, promoting organization and reusability.
     - Visual Debugger: Inspect the execution of any BT in a running scene to identify and troubleshoot issues.
@@ -67,24 +67,24 @@ Behavior Trees are powerful hierarchical structures used to model and control th
     - Extend the `LimboState` class to implement state logic.
     - `LimboHSM` node serves as a state machine that manages `LimboState` instances and transitions.
     - `LimboHSM` is a state itself and can be nested within other `LimboHSM` instances.
-    - [Event-based](https://limboai.readthedocs.io/en/stable/getting-started/hsm.html#events-and-transitions): Transitions are associated with events and are triggered by the state machine when the relevant event is dispatched, allowing for better decoupling of transitions from state logic.
+    - [Event-based](https://limboai.readthedocs.io/en/stable/hierarchical-state-machines/create-hsm.html#events-and-transitions): Transitions are associated with events and are triggered by the state machine when the relevant event is dispatched, allowing for better decoupling of transitions from state logic.
     - Combine state machines with behavior trees using `BTState` for advanced reactive AI.
-    - Delegation Option: Using the vanilla `LimboState`, [delegate the implementation](https://limboai.readthedocs.io/en/stable/getting-started/hsm.html#single-file-state-machine-setup) to your callback functions, making it perfect for rapid prototyping and game jams.
+    - Delegation Option: Using the vanilla `LimboState`, [delegate the implementation](https://limboai.readthedocs.io/en/stable/hierarchical-state-machines/create-hsm.html#single-file-state-machine-setup) to your callback functions, making it perfect for rapid prototyping and game jams.
     - 🛈 Note: State machine setup and initialization require code; there is no GUI editor.
 
 - **Tested:** Behavior tree tasks and HSM are covered by unit tests.
 
-- **GDExtension:** LimboAI can be [used as extension](https://limboai.readthedocs.io/en/stable/getting-started/gdextension.html). Custom engine builds are not necessary.
+- **GDExtension:** LimboAI can be [used as extension](https://limboai.readthedocs.io/en/stable/getting-started/getting-limboai.html#get-gdextension-version). Custom engine builds are not necessary.
 
 - **Demo + Tutorial:** Check out our extensive demo project, which includes an introduction to behavior trees using examples.
 
 ## First steps
 
-Follow the [First steps](https://limboai.readthedocs.io/en/stable/index.html#first-steps) guide to learn how to get started with LimboAI and the demo project.
+Follow the [Getting started](https://limboai.readthedocs.io/en/stable/getting-started/getting-limboai.html) guide to learn how to get started with LimboAI and the demo project.
 
 ## Getting LimboAI
 
-LimboAI can be used as either a C++ module or as a GDExtension shared library. GDExtension version is more convenient to use but somewhat limited in features. Whichever you choose to use, your project will stay compatible with both and you can switch from one to the other any time. See [Using GDExtension](https://limboai.readthedocs.io/en/stable/getting-started/gdextension.html).
+LimboAI can be used as either a C++ module or as a GDExtension shared library. GDExtension version is more convenient to use but somewhat limited in features. Whichever you choose to use, your project will stay compatible with both and you can switch from one to the other any time. See [Using GDExtension](https://limboai.readthedocs.io/en/stable/getting-started/getting-limboai.html#get-gdextension-version).
 
 ### Precompiled builds
 
@@ -109,15 +109,15 @@ LimboAI can be used as either a C++ module or as a GDExtension shared library. G
 ## Using the plugin
 
 - Online Documentation: [stable](https://limboai.readthedocs.io/en/stable/index.html), [latest](https://limboai.readthedocs.io/en/latest/index.html)
-- [First steps](https://limboai.readthedocs.io/en/stable/index.html#first-steps)
+- [Getting started](https://limboai.readthedocs.io/en/stable/getting-started/getting-limboai.html)
-- [Introduction to Behavior Trees](https://limboai.readthedocs.io/en/stable/getting-started/introduction.html)
+- [Introduction to Behavior Trees](https://limboai.readthedocs.io/en/stable/behavior-trees/introduction.html)
-- [Creating custom tasks in GDScript](https://limboai.readthedocs.io/en/stable/getting-started/custom-tasks.html)
+- [Creating custom tasks in GDScript](https://limboai.readthedocs.io/en/stable/behavior-trees/custom-tasks.html)
-- [Sharing data using Blackboard](https://limboai.readthedocs.io/en/stable/getting-started/using-blackboard.html)
+- [Sharing data using Blackboard](https://limboai.readthedocs.io/en/stable/behavior-trees/using-blackboard.html)
-- [Accessing nodes in the scene tree](https://limboai.readthedocs.io/en/stable/getting-started/accessing-nodes.html)
+- [Accessing nodes in the scene tree](https://limboai.readthedocs.io/en/stable/behavior-trees/accessing-nodes.html)
-- [State machines](https://limboai.readthedocs.io/en/stable/getting-started/hsm.html)
+- [State machines](https://limboai.readthedocs.io/en/stable/hierarchical-state-machines/create-hsm.html)
-- [Using GDExtension](https://limboai.readthedocs.io/en/stable/getting-started/gdextension.html)
+- [Using GDExtension](https://limboai.readthedocs.io/en/stable/getting-started/getting-limboai.html#get-gdextension-version)
 - [Using LimboAI with C#](https://limboai.readthedocs.io/en/stable/getting-started/c-sharp.html)
-- [Class reference](https://limboai.readthedocs.io/en/stable/getting-started/featured-classes.html)
+- [Class reference](https://limboai.readthedocs.io/en/stable/classes/featured-classes.html)
 
 ## Contributing
 

bt/bt_instance.cpp

@@ -83,7 +83,7 @@ void BTInstance::register_with_debugger() {
 
 void BTInstance::unregister_with_debugger() {
 #ifdef DEBUG_ENABLED
-	if (LimboDebugger::get_singleton()->is_active()) {
+	if (LimboDebugger::get_singleton() && LimboDebugger::get_singleton()->is_active()) {
 		LimboDebugger::get_singleton()->unregister_bt_instance(get_instance_id());
 	}
 #endif
@@ -151,5 +151,6 @@ BTInstance::~BTInstance() {
 	emit_signal(LW_NAME(freed));
 #ifdef DEBUG_ENABLED
 	_remove_custom_monitor();
+	unregister_with_debugger();
 #endif
 }

bt/bt_player.cpp

@@ -42,7 +42,7 @@
 
 VARIANT_ENUM_CAST(BTPlayer::UpdateMode);
 
-void BTPlayer::_load_tree() {
+void BTPlayer::_instantiate_bt() {
 	bt_instance.unref();
 	ERR_FAIL_COND_MSG(!behavior_tree.is_valid(), "BTPlayer: Initialization failed - needs a valid behavior tree.");
 	ERR_FAIL_COND_MSG(!behavior_tree->get_root_task().is_valid(), "BTPlayer: Initialization failed - behavior tree has no valid root task.");
@@ -70,6 +70,19 @@ void BTPlayer::_update_blackboard_plan() {
 	blackboard_plan->set_base_plan(behavior_tree.is_valid() ? behavior_tree->get_blackboard_plan() : nullptr);
 }
 
+void BTPlayer::_initialize() {
+	if (blackboard.is_null()) {
+		blackboard = Ref<Blackboard>(memnew(Blackboard));
+	}
+	if (blackboard_plan.is_valid()) {
+		// Don't overwrite existing blackboard values as they may be initialized from code.
+		blackboard_plan->populate_blackboard(blackboard, false, this, _get_scene_root());
+	}
+	if (behavior_tree.is_valid()) {
+		_instantiate_bt();
+	}
+}
+
 void BTPlayer::set_bt_instance(const Ref<BTInstance> &p_bt_instance) {
 	ERR_FAIL_COND_MSG(p_bt_instance.is_null(), "BTPlayer: Failed to set behavior tree instance - instance is null.");
 	ERR_FAIL_COND_MSG(!p_bt_instance->is_instance_valid(), "BTPlayer: Failed to set behavior tree instance - instance is not valid.");
@@ -78,6 +91,11 @@ void BTPlayer::set_bt_instance(const Ref<BTInstance> &p_bt_instance) {
 	blackboard = p_bt_instance->get_blackboard();
 	agent_node = p_bt_instance->get_agent()->get_path();
 
+#ifdef DEBUG_ENABLED
+	bt_instance->set_monitor_performance(monitor_performance);
+	bt_instance->register_with_debugger();
+#endif // DEBUG_ENABLED
+
 	blackboard_plan.unref();
 	behavior_tree.unref();
 }
@@ -104,7 +122,8 @@ void BTPlayer::set_behavior_tree(const Ref<BehaviorTree> &p_tree) {
 	} else {
 		behavior_tree = p_tree;
 		if (get_owner() && is_inside_tree()) {
-			_load_tree();
+			_update_blackboard_plan();
+			_initialize();
 		}
 	}
 }
@@ -179,16 +198,7 @@ void BTPlayer::_notification(int p_notification) {
 		} break;
 		case NOTIFICATION_READY: {
 			if (!Engine::get_singleton()->is_editor_hint()) {
-				if (blackboard.is_null()) {
+				_initialize();
-					blackboard = Ref<Blackboard>(memnew(Blackboard));
-				}
-				if (blackboard_plan.is_valid()) {
-					// Don't overwrite existing blackboard values as they may be initialized from code.
-					blackboard_plan->populate_blackboard(blackboard, false, this, _get_scene_root());
-				}
-				if (behavior_tree.is_valid()) {
-					_load_tree();
-				}
 			} else {
 				_update_blackboard_plan();
 			}

bt/bt_player.h

@@ -48,8 +48,9 @@ private:
 
 	Ref<BTInstance> bt_instance;
 
-	void _load_tree();
+	void _instantiate_bt();
 	void _update_blackboard_plan();
+	void _initialize();
 	_FORCE_INLINE_ Node *_get_scene_root() const { return scene_root_hint ? scene_root_hint : get_owner(); }
 
 protected:

editor/limbo_ai_editor_plugin.cpp

@@ -893,6 +893,14 @@ void LimboAIEditor::_on_tree_task_activated() {
 	Ref<Script> scr = selected->get_script();
 	if (scr.is_valid()) {
 		EDIT_SCRIPT(scr->get_path());
+	} else if (IS_CLASS(selected, BTSubtree)) {
+		Ref<BehaviorTree> subtree = static_cast<Ref<BTSubtree>>(selected)->get_subtree();
+		if (subtree.is_valid()) {
+			EDIT_RESOURCE(subtree);
+		} else {
+			LimboUtility::get_singleton()->open_doc_class(selected->get_class());
+		}
+		EDIT_RESOURCE(subtree);
 	} else {
 		LimboUtility::get_singleton()->open_doc_class(selected->get_class());
 	}