Improve class docs for CheckTrigger, CheckVar and SetVar

This commit is contained in:
Serhii Snitsaruk 2023-10-17 12:22:46 +02:00
parent 7324f0462b
commit 91d582ab09
4 changed files with 13 additions and 9 deletions

View File

@ -4,14 +4,16 @@
BT condition that checks a trigger (a boolean variable). BT condition that checks a trigger (a boolean variable).
</brief_description> </brief_description>
<description> <description>
BTCheckTrigger verifies whether the [member variable] is set to [code]true[/code]. If it is, the task changes it to [code]false[/code] and returns [code]SUCCESS[/code]. Otherwise, it returns [code]FAILURE[/code]. 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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<members> <members>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;"> <member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
A boolean variable on the blackboard that is used as a trigger. A boolean variable on the [member blackboard] used as a trigger.
When it is set to [code]true[/code], BTCheckTrigger will flip it to [code]false[/code] and return [code]SUCCESS[/code]. Otherwise, it will return [code]FAILURE[/code]. 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> </member>
</members> </members>
</class> </class>

View File

@ -4,19 +4,19 @@
BT condition that checks a variable on the blackboard. BT condition that checks a variable on the blackboard.
</brief_description> </brief_description>
<description> <description>
BTCheckVar checks [member variable] against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type]. BTCheckVar evaluates the [member variable] against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<members> <members>
<member name="check_type" type="int" setter="set_check_type" getter="get_check_type" enum="LimboUtility.CheckType" default="0"> <member name="check_type" type="int" setter="set_check_type" getter="get_check_type" enum="LimboUtility.CheckType" default="0">
Type of check to perform. The type of check to be performed.
</member> </member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value"> <member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value to which the [member variable] will be compared. A parameter that specifies the value against which the [member variable] will be compared.
</member> </member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;"> <member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
Variable name to check its value. The name of the variable to check its value.
</member> </member>
</members> </members>
</class> </class>

View File

@ -4,6 +4,8 @@
BT action that assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code]. BT action that assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code].
</brief_description> </brief_description>
<description> <description>
BTSetVar assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if it fails to set the [member variable].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -12,7 +14,7 @@
Parameter that specifies the value to be assigned to the variable. Parameter that specifies the value to be assigned to the variable.
</member> </member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;"> <member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
Variable name whose value is to be assigned. Name of the variable to which the value will be assigned.
</member> </member>
</members> </members>
</class> </class>

View File

@ -4,7 +4,7 @@
BT decorator that sets a time limit for its child's execution. BT decorator that sets a time limit for its child's execution.
</brief_description> </brief_description>
<description> <description>
BTTimeLimit allocates a limited time for the child's execution and cancels it, returning [code]FAILURE[/code] if the [member time_limit] is exceeded. BTTimeLimit allocates a limited time for the child's execution and aborts it, returning [code]FAILURE[/code] if the [member time_limit] is exceeded.
Returns [code]FAILURE[/code] if the [member time_limit] is exceeded; otherwise, it returns the status of the child task. Returns [code]FAILURE[/code] if the [member time_limit] is exceeded; otherwise, it returns the status of the child task.
</description> </description>
<tutorials> <tutorials>