limboai/doc/source/classes/class_btsetvar.rst

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

.. _class_BTSetVar:

BTSetVar
========

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

BT action that assigns :ref:`value<class_BTSetVar_property_value>` to the :ref:`variable<class_BTSetVar_property_variable>` and then returns ``SUCCESS``.

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

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

BTSetVar assigns :ref:`value<class_BTSetVar_property_value>` to the :ref:`variable<class_BTSetVar_property_variable>` and then returns ``SUCCESS``. Optionally, it can perform a specific :ref:`operation<class_BTSetVar_property_operation>` before assignment.

Returns ``FAILURE`` if it fails to set the :ref:`variable<class_BTSetVar_property_variable>`.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------------------------+-----------------------------------------------------+---------+
   | :ref:`Operation<enum_LimboUtility_Operation>` | :ref:`operation<class_BTSetVar_property_operation>` | ``0``   |
   +-----------------------------------------------+-----------------------------------------------------+---------+
   | :ref:`BBVariant<class_BBVariant>`             | :ref:`value<class_BTSetVar_property_value>`         |         |
   +-----------------------------------------------+-----------------------------------------------------+---------+
   | StringName                                    | :ref:`variable<class_BTSetVar_property_variable>`   | ``&""`` |
   +-----------------------------------------------+-----------------------------------------------------+---------+

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

----

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

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

.. _class_BTSetVar_property_operation:

.. rst-class:: classref-property

:ref:`Operation<enum_LimboUtility_Operation>` **operation** = ``0``

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

- void **set_operation** **(** :ref:`Operation<enum_LimboUtility_Operation>` value **)**
- :ref:`Operation<enum_LimboUtility_Operation>` **get_operation** **(** **)**

Specifies the operation to be performed before assignment. Operation is executed as follows:

\ ``variable = variable OPERATION value``

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

----

.. _class_BTSetVar_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** **(** **)**

Parameter that specifies the value to be assigned to the variable.

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

----

.. _class_BTSetVar_property_variable:

.. rst-class:: classref-property

StringName **variable** = ``&""``

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

- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**

Name of the variable to which the value will be assigned.

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