limboai/doc_classes/BTSubtree.xml

20 lines
1.1 KiB
XML
Raw Normal View History

2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSubtree" inherits="BTNewScope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2022-11-01 20:31:22 +00:00
<brief_description>
BT decorator that instantiates and runs a subtree within the larger tree.
2022-11-01 20:31:22 +00:00
</brief_description>
<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.
2022-11-01 20:31:22 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="subtree" type="BehaviorTree" setter="set_subtree" getter="get_subtree">
2022-11-04 12:27:09 +00:00
A [BehaviorTree] resource that will be instantiated as a subtree.
2022-11-01 20:31:22 +00:00
</member>
</members>
</class>