limboai/doc/source/classes/class_behaviortreeview.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.3/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

Properties
----------

.. table::
   :widths: auto

   +---------+-----------------------------------------------------------------------------------+-------+
   | ``int`` | :ref:`update_interval_msec<class_BehaviorTreeView_property_update_interval_msec>` | ``0`` |
   +---------+-----------------------------------------------------------------------------------+-------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +--------+-------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`clear<class_BehaviorTreeView_method_clear>`\ (\ )                                                                                   |
   +--------+-------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`update_tree<class_BehaviorTreeView_method_update_tree>`\ (\ behavior_tree_data\: :ref:`BehaviorTreeData<class_BehaviorTreeData>`\ ) |
   +--------+-------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_BehaviorTreeView_signal_task_selected:

.. rst-class:: classref-signal

**task_selected**\ (\ type_name\: ``String``, script_path\: ``String``\ ) :ref:`🔗<class_BehaviorTreeView_signal_task_selected>`

Emitted when a task item is selected in **BehaviorTreeView**.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_BehaviorTreeView_property_update_interval_msec:

.. rst-class:: classref-property

``int`` **update_interval_msec** = ``0`` :ref:`🔗<class_BehaviorTreeView_property_update_interval_msec>`

.. rst-class:: classref-property-setget

- |void| **set_update_interval_msec**\ (\ value\: ``int``\ )
- ``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

Method Descriptions
-------------------

.. _class_BehaviorTreeView_method_clear:

.. rst-class:: classref-method

|void| **clear**\ (\ ) :ref:`🔗<class_BehaviorTreeView_method_clear>`

Clears the tree view.

.. rst-class:: classref-item-separator

----

.. _class_BehaviorTreeView_method_update_tree:

.. rst-class:: classref-method

|void| **update_tree**\ (\ behavior_tree_data\: :ref:`BehaviorTreeData<class_BehaviorTreeData>`\ ) :ref:`🔗<class_BehaviorTreeView_method_update_tree>`

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.)`
.. |void| replace:: :abbr:`void (No return value.)`