limboai/doc/source/classes/class_btsubtree.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.3/modules/limboai/doc_classes/BTSubtree.xml.

.. _class_BTSubtree:

BTSubtree
=========

**Inherits:** :ref:`BTNewScope<class_BTNewScope>` **<** :ref:`BTDecorator<class_BTDecorator>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`

BT decorator that instantiates and runs a subtree within the larger tree.

.. rst-class:: classref-introduction-group

Description
-----------

BTSubtree instantiates a :ref:`BehaviorTree<class_BehaviorTree>` and includes its root task as a child during initialization, while also creating a new :ref:`Blackboard<class_Blackboard>` scope.

Returns the status of the subtree's execution.

Subtree blackboard variables can be mapped to the main tree blackboard plan variables. Check out mapping section in the inspector.

Note: BTSubTree is designed as a simpler loader, and does not support updating :ref:`subtree<class_BTSubtree_property_subtree>` at runtime. A custom subtree decorator is better suited and `somewhat trivial <https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610>`__ to implement.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------------------+--------------------------------------------------+
   | :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`subtree<class_BTSubtree_property_subtree>` |
   +-----------------------------------------+--------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_BTSubtree_property_subtree:

.. rst-class:: classref-property

:ref:`BehaviorTree<class_BehaviorTree>` **subtree** :ref:`🔗<class_BTSubtree_property_subtree>`

.. rst-class:: classref-property-setget

- |void| **set_subtree**\ (\ value\: :ref:`BehaviorTree<class_BehaviorTree>`\ )
- :ref:`BehaviorTree<class_BehaviorTree>` **get_subtree**\ (\ )

A :ref:`BehaviorTree<class_BehaviorTree>` resource that will be instantiated as a subtree.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`