: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/BTRandomSequence.xml.

.. _class_BTRandomSequence:

BTRandomSequence
================

**Inherits:** :ref:`BTComposite<class_BTComposite>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`

BT composite that executes tasks in random order as long as they return ``SUCCESS``.

.. rst-class:: classref-introduction-group

Description
-----------

BTRandomSequence executes its child tasks in a random order as long as they return ``SUCCESS``. If a child task results in ``SUCCESS``, BTRandomSequence will immediately execute the next child task until one of them returns ``FAILURE`` or all of them result in ``SUCCESS``.

Returns ``RUNNING`` if a child task results in ``RUNNING``. BTRandomSequence will remember the execution order and the last child task that returned ``RUNNING``, ensuring it resumes from that point in the next tick.

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.)`