limboai/doc_classes/BehaviorTree.xml

47 lines
1.7 KiB
XML
Raw Normal View History

2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-04-10 14:57:36 +00:00
<class name="BehaviorTree" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2022-11-01 20:31:22 +00:00
<brief_description>
2023-04-10 14:57:36 +00:00
Contains Behavior Tree data.
2022-11-01 20:31:22 +00:00
</brief_description>
<description>
2023-04-10 14:57:36 +00:00
[BehaviorTree] is a hierarchical structure used to model and control the behavior of agents in a game. It is composed of tasks that represent specific actions or decision-making rules. The [BehaviorTree] is executed from the root task down to the leaf tasks, which represent the actual actions or behaviors that the agent should perform.
See also [BTTask] class.
2022-11-01 20:31:22 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="clone" qualifiers="const">
<return type="BehaviorTree" />
<description>
2022-11-04 12:27:09 +00:00
Makes a copy of behavior tree.
2022-11-01 20:31:22 +00:00
</description>
</method>
2023-04-10 14:57:36 +00:00
<method name="get_root_task" qualifiers="const">
<return type="BTTask" />
2022-11-01 20:31:22 +00:00
<description>
2023-04-10 14:57:36 +00:00
Returns root task of the [BehaviorTree] resource.
2022-11-01 20:31:22 +00:00
</description>
</method>
2023-04-10 14:57:36 +00:00
<method name="instantiate" qualifiers="const">
2022-11-01 20:31:22 +00:00
<return type="BTTask" />
2023-04-10 14:57:36 +00:00
<param index="0" name="p_agent" type="Node" />
<param index="1" name="p_blackboard" type="Blackboard" />
2022-11-01 20:31:22 +00:00
<description>
2022-11-04 12:27:09 +00:00
Instantiates behavior tree and returns the root [BTTask].
2022-11-01 20:31:22 +00:00
</description>
</method>
2023-04-10 14:57:36 +00:00
<method name="set_root_task">
<return type="void" />
<param index="0" name="p_value" type="BTTask" />
<description>
Assign new root task to [BehaviorTree] resource.
</description>
</method>
2022-11-01 20:31:22 +00:00
</methods>
<members>
<member name="description" type="String" setter="set_description" getter="get_description" default="&quot;&quot;">
2022-11-04 12:27:09 +00:00
User-provided description of BehaviorTree.
2022-11-01 20:31:22 +00:00
</member>
</members>
</class>