limboai/doc_classes/BTSetVar.xml

25 lines
1.3 KiB
XML
Raw Permalink Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSetVar" inherits="BTAction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code].
</brief_description>
<description>
BTSetVar assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code]. Optionally, it can perform a specific [member operation] before assignment.
Returns [code]FAILURE[/code] if it fails to set the [member variable].
</description>
<tutorials>
</tutorials>
<members>
<member name="operation" type="int" setter="set_operation" getter="get_operation" enum="LimboUtility.Operation" default="0">
Specifies the operation to be performed before assignment. Operation is executed as follows:
[code]variable = variable OPERATION value[/code]
</member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value to be assigned to the variable.
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
Name of the variable to which the value will be assigned.
</member>
</members>
</class>