38 lines
2.4 KiB
ReStructuredText
38 lines
2.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSequence.xml.
|
|
|
|
.. _class_BTSequence:
|
|
|
|
BTSequence
|
|
==========
|
|
|
|
**Inherits:** :ref:`BTComposite<class_BTComposite>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
|
|
|
|
BT composite that sequentially executes tasks as long as they return ``SUCCESS``.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
BTSequence executes its child tasks sequentially, from first to last, as long as they return ``SUCCESS``. If a child task results in ``SUCCESS``, BTSequence will immediately execute the next child task until one of them returns ``FAILURE`` or all of them result in ``SUCCESS``. BTSequence and :ref:`BTSelector<class_BTSelector>` are two of the most common building blocks of behavior trees. Essentially, while :ref:`BTSelector<class_BTSelector>` is similar to a boolean OR operation, BTSequence is similar to a boolean AND operation. Sequences enable the behavior tree to compose complex behaviors from a chain of simpler tasks.
|
|
|
|
Returns ``RUNNING`` if any child task results in ``RUNNING``. BTSequence will remember the last child task that returned ``RUNNING``, ensuring it resumes from that point in the next execution tick.
|
|
|
|
Returns ``SUCCESS`` if all child tasks result in ``SUCCESS``.
|
|
|
|
Returns ``FAILURE`` if a child task results in ``FAILURE``.
|
|
|
|
.. |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.)`
|