64 lines
3.0 KiB
ReStructuredText
64 lines
3.0 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/limboai/doc_classes/BehaviorTreeData.xml.
|
||
|
|
|
||
|
|
.. _class_BehaviorTreeData:
|
||
|
|
|
||
|
|
BehaviorTreeData
|
||
|
|
================
|
||
|
|
|
||
|
|
**Inherits:**
|
||
|
|
|
||
|
|
Represents current state of a :ref:`BehaviorTree<class_BehaviorTree>` instance.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
This class is used by the LimboAI debugger for the serialization and deserialization of :ref:`BehaviorTree<class_BehaviorTree>` instance data.
|
||
|
|
|
||
|
|
Additionally, it can be used with :ref:`BehaviorTreeView<class_BehaviorTreeView>` to visualize the current state of a :ref:`BehaviorTree<class_BehaviorTree>` instance. It is meant to be utilized in custom in-game tools.
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Methods
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`BehaviorTreeData<class_BehaviorTreeData>` | :ref:`create_from_tree_instance<class_BehaviorTreeData_method_create_from_tree_instance>` **(** :ref:`BTTask<class_BTTask>` p_tree_instance **)** |static| |
|
||
|
|
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_BehaviorTreeData_method_create_from_tree_instance:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`BehaviorTreeData<class_BehaviorTreeData>` **create_from_tree_instance** **(** :ref:`BTTask<class_BTTask>` p_tree_instance **)** |static|
|
||
|
|
|
||
|
|
Returns current state of the ``p_tree_instance`` encoded as a **BehaviorTreeData**, suitable for use with :ref:`BehaviorTreeView<class_BehaviorTreeView>`.
|
||
|
|
|
||
|
|
Behavior tree instance can be acquired with :ref:`BTPlayer.get_tree_instance<class_BTPlayer_method_get_tree_instance>`.
|
||
|
|
|
||
|
|
.. |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.)`
|