limboai/doc_classes/BTSetAgentProperty.xml

25 lines
1.3 KiB
XML
Raw Normal View History

2023-08-11 10:49:00 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSetAgentProperty" inherits="BTAction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2023-08-11 10:49:00 +00:00
<brief_description>
BT action that assigns a value to the specified agent's property.
2023-08-11 10:49:00 +00:00
</brief_description>
<description>
2023-11-20 14:14:55 +00:00
BTSetAgentProperty assigns the specified [member value] to the agent's property identified by the [member property] and returns [code]SUCCESS[/code]. Optionally, it can perform a specific [member operation] before assignment.
2023-08-11 10:49:00 +00:00
Returns [code]FAILURE[/code] if it fails to set the property.
</description>
<tutorials>
</tutorials>
<members>
2023-11-20 14:14:55 +00:00
<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]property = property OPERATION value[/code]
</member>
2023-08-11 20:16:03 +00:00
<member name="property" type="StringName" setter="set_property" getter="get_property" default="&amp;&quot;&quot;">
2023-08-11 10:49:00 +00:00
Parameter that specifies the agent's property name.
</member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value that will be assigned to agent's property.
</member>
</members>
</class>