20 lines
1.2 KiB
XML
20 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="BTCheckTrigger" inherits="BTCondition" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<brief_description>
|
|
BT condition that checks a trigger (a boolean variable).
|
|
</brief_description>
|
|
<description>
|
|
BTCheckTrigger verifies whether the [member variable] is set to [code]true[/code]. If it is, the task switches it to [code]false[/code] and returns [code]SUCCESS[/code]. Otherwise, it returns [code]FAILURE[/code].
|
|
BTCheckTrigger can function as a "gate" within a [BTSequence]: when the trigger variable is set to [code]true[/code], it permits the execution of subsequent tasks and then changes the variable to [code]false[/code].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<members>
|
|
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="""">
|
|
A boolean variable on the [member blackboard] used as a trigger.
|
|
If variable's value is [code]true[/code], BTCheckTrigger will switch it to [code]false[/code] and return [code]SUCCESS[/code].
|
|
If variable's value is [code]false[/code], BTCheckTrigger will return [code]FAILURE[/code].
|
|
</member>
|
|
</members>
|
|
</class>
|