limboai/doc/source/classes/class_btforeach.rst

90 lines
3.3 KiB
ReStructuredText
Raw Normal View History

: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/BTForEach.xml.
.. _class_BTForEach:
BTForEach
=========
**Inherits:** :ref:`BTDecorator<class_BTDecorator>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
BT decorator that executes its child task for each element of an ``Array``.
.. rst-class:: classref-introduction-group
Description
-----------
BTForEach executes its child task for each element of an ``Array``. During each iteration, the next element is stored in the specified :ref:`Blackboard<class_Blackboard>` variable.
Returns ``RUNNING`` if the child task results in ``RUNNING`` or if the child task results in ``SUCCESS`` on a non-last iteration.
Returns ``FAILURE`` if the child task results in ``FAILURE``.
Returns ``SUCCESS`` if the child task results in ``SUCCESS`` on the last iteration.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
2024-03-04 15:14:47 +00:00
+------------+------------------------------------------------------+---------+
| StringName | :ref:`array_var<class_BTForEach_property_array_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
| StringName | :ref:`save_var<class_BTForEach_property_save_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_BTForEach_property_array_var:
.. rst-class:: classref-property
2024-03-04 15:14:47 +00:00
StringName **array_var** = ``&""``
.. rst-class:: classref-property-setget
2024-03-04 15:14:47 +00:00
- void **set_array_var** **(** StringName value **)**
- StringName **get_array_var** **(** **)**
A variable within the :ref:`Blackboard<class_Blackboard>` that holds an ``Array``, which is used for the iteration process.
.. rst-class:: classref-item-separator
----
.. _class_BTForEach_property_save_var:
.. rst-class:: classref-property
2024-03-04 15:14:47 +00:00
StringName **save_var** = ``&""``
.. rst-class:: classref-property-setget
2024-03-04 15:14:47 +00:00
- void **set_save_var** **(** StringName value **)**
- StringName **get_save_var** **(** **)**
A :ref:`Blackboard<class_Blackboard>` variable used to store an element of the array referenced by :ref:`array_var<class_BTForEach_property_array_var>`.
.. |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.)`