limboai/doc/source/classes/class_btrandomwait.rst

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

.. _class_BTRandomWait:

BTRandomWait
============

**Inherits:** :ref:`BTAction<class_BTAction>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`

BT action that waits for a randomized duration to elapse and then returns ``SUCCESS``.

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

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

BTRandomWait action waits for a randomized duration to elapse and then returns ``SUCCESS``. The duration is randomized within the specified range, defined by :ref:`min_duration<class_BTRandomWait_property_min_duration>` and :ref:`max_duration<class_BTRandomWait_property_max_duration>`.

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

Properties
----------

.. table::
   :widths: auto

   +-----------+---------------------------------------------------------------+---------+
   | ``float`` | :ref:`max_duration<class_BTRandomWait_property_max_duration>` | ``2.0`` |
   +-----------+---------------------------------------------------------------+---------+
   | ``float`` | :ref:`min_duration<class_BTRandomWait_property_min_duration>` | ``1.0`` |
   +-----------+---------------------------------------------------------------+---------+

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

----

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

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

.. _class_BTRandomWait_property_max_duration:

.. rst-class:: classref-property

``float`` **max_duration** = ``2.0`` :ref:`🔗<class_BTRandomWait_property_max_duration>`

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

- |void| **set_max_duration**\ (\ value\: ``float``\ )
- ``float`` **get_max_duration**\ (\ )

Maximum duration for the wait.

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

----

.. _class_BTRandomWait_property_min_duration:

.. rst-class:: classref-property

``float`` **min_duration** = ``1.0`` :ref:`🔗<class_BTRandomWait_property_min_duration>`

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

- |void| **set_min_duration**\ (\ value\: ``float``\ )
- ``float`` **get_min_duration**\ (\ )

Minimum duration for the wait.

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