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/BTDynamicSequence.xml.
|
|
|
|
.. _class_BTDynamicSequence:
|
|
|
|
BTDynamicSequence
|
|
=================
|
|
|
|
**Inherits:** :ref:`BTComposite<class_BTComposite>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
|
|
|
|
BT composite that executes tasks from scratch every tick as long as they return ``SUCCESS``.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
BTDynamicSequence executes its child tasks sequentially, from first to last, for as long as they return ``SUCCESS``. Unlike :ref:`BTSequence<class_BTSequence>`, it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to recheck conditions preceding a long-running action during each tick and abort the ``RUNNING`` action when any condition results in ``FAILURE``.
|
|
|
|
Returns ``RUNNING`` if a child task results in ``RUNNING``. BTDynamicSequence will remember the last ``RUNNING`` child, but, unlike :ref:`BTSequence<class_BTSequence>`, on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn't result in ``SUCCESS``, it will abort the remembered ``RUNNING`` task.
|
|
|
|
Returns ``FAILURE`` if a child task results in ``FAILURE``.
|
|
|
|
Returns ``SUCCESS`` if all child tasks result in ``SUCCESS``.
|
|
|
|
.. |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.)`
|