limboai/doc/source/classes/class_behaviortreeview.rst

94 lines
3.4 KiB
ReStructuredText
Raw Normal View History

2024-02-14 19:34:18 +00:00
: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/BehaviorTreeView.xml.
.. _class_BehaviorTreeView:
BehaviorTreeView
================
**Inherits:**
Visualizes the current state of a :ref:`BehaviorTree<class_BehaviorTree>` instance.
.. rst-class:: classref-introduction-group
Description
-----------
Visualizes the current state of a :ref:`BehaviorTree<class_BehaviorTree>` instance. See also :ref:`BehaviorTreeData<class_BehaviorTreeData>`.
.. rst-class:: classref-reftable-group
2024-02-18 19:25:53 +00:00
Properties
----------
.. table::
:widths: auto
+-----+-----------------------------------------------------------------------------------+-------+
| int | :ref:`update_interval_msec<class_BehaviorTreeView_property_update_interval_msec>` | ``0`` |
+-----+-----------------------------------------------------------------------------------+-------+
.. rst-class:: classref-reftable-group
2024-02-14 19:34:18 +00:00
Methods
-------
.. table::
:widths: auto
+------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_tree<class_BehaviorTreeView_method_update_tree>` **(** :ref:`BehaviorTreeData<class_BehaviorTreeData>` p_behavior_tree_data **)** |
+------+------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
2024-02-18 19:25:53 +00:00
Property Descriptions
---------------------
.. _class_BehaviorTreeView_property_update_interval_msec:
.. rst-class:: classref-property
int **update_interval_msec** = ``0``
.. rst-class:: classref-property-setget
- void **set_update_interval_msec** **(** int value **)**
- int **get_update_interval_msec** **(** **)**
Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
2024-02-14 19:34:18 +00:00
Method Descriptions
-------------------
.. _class_BehaviorTreeView_method_update_tree:
.. rst-class:: classref-method
void **update_tree** **(** :ref:`BehaviorTreeData<class_BehaviorTreeData>` p_behavior_tree_data **)**
Updates the representation of a :ref:`BehaviorTree<class_BehaviorTree>` instance. See also :ref:`BehaviorTreeData<class_BehaviorTreeData>`.
.. |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.)`