103 lines
3.8 KiB
ReStructuredText
103 lines
3.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/limboai/doc_classes/BTCheckVar.xml.
|
|
|
|
.. _class_BTCheckVar:
|
|
|
|
BTCheckVar
|
|
==========
|
|
|
|
**Inherits:** :ref:`BTCondition<class_BTCondition>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
|
|
|
|
BT condition that checks a variable on the blackboard.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
BTCheckVar evaluates the :ref:`variable<class_BTCheckVar_property_variable>` against :ref:`value<class_BTCheckVar_property_value>` and returns ``SUCCESS`` or ``FAILURE`` based on the :ref:`check_type<class_BTCheckVar_property_check_type>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------+---------------------------------------------------------+---------+
|
|
| :ref:`CheckType<enum_LimboUtility_CheckType>` | :ref:`check_type<class_BTCheckVar_property_check_type>` | ``0`` |
|
|
+-----------------------------------------------+---------------------------------------------------------+---------+
|
|
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTCheckVar_property_value>` | |
|
|
+-----------------------------------------------+---------------------------------------------------------+---------+
|
|
| StringName | :ref:`variable<class_BTCheckVar_property_variable>` | ``&""`` |
|
|
+-----------------------------------------------+---------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_BTCheckVar_property_check_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_check_type** **(** :ref:`CheckType<enum_LimboUtility_CheckType>` value **)**
|
|
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type** **(** **)**
|
|
|
|
The type of check to be performed.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_BTCheckVar_property_value:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`BBVariant<class_BBVariant>` **value**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_value** **(** :ref:`BBVariant<class_BBVariant>` value **)**
|
|
- :ref:`BBVariant<class_BBVariant>` **get_value** **(** **)**
|
|
|
|
A parameter that specifies the value against which the :ref:`variable<class_BTCheckVar_property_variable>` will be compared.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_BTCheckVar_property_variable:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
StringName **variable** = ``&""``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_variable** **(** StringName value **)**
|
|
- StringName **get_variable** **(** **)**
|
|
|
|
The name of the variable to check its value.
|
|
|
|
.. |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.)`
|