limboai/doc_classes/BTCheckVar.xml

23 lines
1.1 KiB
XML
Raw Normal View History

2023-08-08 13:26:21 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCheckVar" inherits="BTCondition" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
2023-08-10 11:24:41 +00:00
BT condition that checks a variable on the blackboard.
2023-08-08 13:26:21 +00:00
</brief_description>
<description>
BTCheckVar evaluates the [member variable] against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type].
2023-08-08 13:26:21 +00:00
</description>
<tutorials>
</tutorials>
<members>
2023-08-10 11:24:41 +00:00
<member name="check_type" type="int" setter="set_check_type" getter="get_check_type" enum="LimboUtility.CheckType" default="0">
The type of check to be performed.
2023-08-08 13:26:21 +00:00
</member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
A parameter that specifies the value against which the [member variable] will be compared.
2023-08-08 13:26:21 +00:00
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
The name of the variable to check its value.
2023-08-08 13:26:21 +00:00
</member>
</members>
</class>