limboai/doc/source/classes/class_btwaitticks.rst

59 lines
2.2 KiB
ReStructuredText

: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/BTWaitTicks.xml.
.. _class_BTWaitTicks:
BTWaitTicks
===========
**Inherits:** :ref:`BTAction<class_BTAction>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
BT action that waits for a specified number of ticks to elapse and then returns ``SUCCESS``.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------+--------------------------------------------------------+-------+
| ``int`` | :ref:`num_ticks<class_BTWaitTicks_property_num_ticks>` | ``1`` |
+---------+--------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_BTWaitTicks_property_num_ticks:
.. rst-class:: classref-property
``int`` **num_ticks** = ``1`` :ref:`🔗<class_BTWaitTicks_property_num_ticks>`
.. rst-class:: classref-property-setget
- |void| **set_num_ticks**\ (\ value\: ``int``\ )
- ``int`` **get_num_ticks**\ (\ )
The number of ticks to wait before returning ``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.)`