limboai/doc/source/classes/class_btchecktrigger.rst

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

.. _class_BTCheckTrigger:

BTCheckTrigger
==============

**Inherits:** :ref:`BTCondition<class_BTCondition>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`

BT condition that checks a trigger (a boolean variable).

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

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

**BTCheckTrigger** verifies whether the :ref:`variable<class_BTCheckTrigger_property_variable>` is set to ``true``. If it is, the task switches it to ``false`` and returns ``SUCCESS``. Otherwise, it returns ``FAILURE``.

\ **BTCheckTrigger** can function as a "gate" within a :ref:`BTSequence<class_BTSequence>`: when the trigger variable is set to ``true``, it permits the execution of subsequent tasks and then changes the variable to ``false``.

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

Properties
----------

.. table::
   :widths: auto

   +----------------+---------------------------------------------------------+---------+
   | ``StringName`` | :ref:`variable<class_BTCheckTrigger_property_variable>` | ``&""`` |
   +----------------+---------------------------------------------------------+---------+

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

----

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

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

.. _class_BTCheckTrigger_property_variable:

.. rst-class:: classref-property

``StringName`` **variable** = ``&""`` :ref:`🔗<class_BTCheckTrigger_property_variable>`

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

- |void| **set_variable**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_variable**\ (\ )

A boolean variable on the blackboard used as a trigger. See also :ref:`BTTask.blackboard<class_BTTask_property_blackboard>`.

If variable's value is ``true``, **BTCheckTrigger** will switch it to ``false`` and return ``SUCCESS``.

If variable's value is ``false``, **BTCheckTrigger** will return ``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.)`