Doc: Mention mapping in BTSubtree class doc

This commit is contained in:
Serhii Snitsaruk 2024-06-18 13:25:33 +02:00
parent 5a60ad9308
commit c6851259e8
No known key found for this signature in database
GPG Key ID: A965EF8799FFEC2D
2 changed files with 3 additions and 0 deletions

View File

@ -23,6 +23,8 @@ BTSubtree instantiates a :ref:`BehaviorTree<class_BehaviorTree>` and includes it
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

View File

@ -6,6 +6,7 @@
<description>
BTSubtree instantiates a [BehaviorTree] and includes its root task as a child during initialization, while also creating a new [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 [member subtree] at runtime. A custom subtree decorator is better suited and [url=https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610]somewhat trivial[/url] to implement.
</description>
<tutorials>