106 lines
4.2 KiB
ReStructuredText
106 lines
4.2 KiB
ReStructuredText
: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/BTCheckAgentProperty.xml.
|
|
|
|
.. _class_BTCheckAgentProperty:
|
|
|
|
BTCheckAgentProperty
|
|
====================
|
|
|
|
**Inherits:** :ref:`BTCondition<class_BTCondition>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`
|
|
|
|
BT condition that checks agent's property value.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
BTCheckAgentProperty examines the agent's property value and compares it to :ref:`value<class_BTCheckAgentProperty_property_value>`.
|
|
|
|
Returns ``SUCCESS`` or ``FAILURE`` based on the :ref:`check_type<class_BTCheckAgentProperty_property_check_type>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------+-------------------------------------------------------------------+---------+
|
|
| :ref:`CheckType<enum_LimboUtility_CheckType>` | :ref:`check_type<class_BTCheckAgentProperty_property_check_type>` | ``0`` |
|
|
+-----------------------------------------------+-------------------------------------------------------------------+---------+
|
|
| ``StringName`` | :ref:`property<class_BTCheckAgentProperty_property_property>` | ``&""`` |
|
|
+-----------------------------------------------+-------------------------------------------------------------------+---------+
|
|
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTCheckAgentProperty_property_value>` | |
|
|
+-----------------------------------------------+-------------------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_BTCheckAgentProperty_property_check_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0`` :ref:`🔗<class_BTCheckAgentProperty_property_check_type>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_check_type**\ (\ value\: :ref:`CheckType<enum_LimboUtility_CheckType>`\ )
|
|
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type**\ (\ )
|
|
|
|
The type of check to be performed.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_BTCheckAgentProperty_property_property:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
``StringName`` **property** = ``&""`` :ref:`🔗<class_BTCheckAgentProperty_property_property>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_property**\ (\ value\: ``StringName``\ )
|
|
- ``StringName`` **get_property**\ (\ )
|
|
|
|
Parameter that specifies the agent's property to be compared.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_BTCheckAgentProperty_property_value:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`BBVariant<class_BBVariant>` **value** :ref:`🔗<class_BTCheckAgentProperty_property_value>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_value**\ (\ value\: :ref:`BBVariant<class_BBVariant>`\ )
|
|
- :ref:`BBVariant<class_BBVariant>` **get_value**\ (\ )
|
|
|
|
Parameter that specifies the value against which an agent's property will be compared.
|
|
|
|
.. |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.)`
|