From eb97cd2d5cc88a715128d6a80d1eff388d8a0809 Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Thu, 10 Aug 2023 13:24:41 +0200 Subject: [PATCH] Update class docs --- doc_classes/BTCheckAgentProperty.xml | 22 ++++++++++++++++++++++ doc_classes/BTCheckTrigger.xml | 2 +- doc_classes/BTCheckVar.xml | 19 +++---------------- doc_classes/LimboUtility.xml | 14 ++++++++++++++ 4 files changed, 40 insertions(+), 17 deletions(-) create mode 100644 doc_classes/BTCheckAgentProperty.xml diff --git a/doc_classes/BTCheckAgentProperty.xml b/doc_classes/BTCheckAgentProperty.xml new file mode 100644 index 0000000..f2abc2c --- /dev/null +++ b/doc_classes/BTCheckAgentProperty.xml @@ -0,0 +1,22 @@ + + + + BT condition that checks agent's property value. + + + BTCheckAgentProperty checks agent's property value against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type]. + + + + + + Type of check to perform. + + + Parameter that specifies the agent's property name which will be compared. + + + Parameter that specifies the value to which an agent's property will be compared. + + + diff --git a/doc_classes/BTCheckTrigger.xml b/doc_classes/BTCheckTrigger.xml index 446ebf1..24ce704 100644 --- a/doc_classes/BTCheckTrigger.xml +++ b/doc_classes/BTCheckTrigger.xml @@ -1,7 +1,7 @@ - BT condition that checks a trigger (a boolean variable). + BT condition that checks a trigger (a boolean variable). 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]. diff --git a/doc_classes/BTCheckVar.xml b/doc_classes/BTCheckVar.xml index cc81bc3..11494c6 100644 --- a/doc_classes/BTCheckVar.xml +++ b/doc_classes/BTCheckVar.xml @@ -1,14 +1,15 @@ - BT condition that checks [member variable] against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type]. + BT condition that checks a variable on the blackboard. + BTCheckVar checks [member variable] against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type]. - + Type of check to perform. @@ -18,18 +19,4 @@ Variable name to check its value. - - - - - - - - - - - - - - diff --git a/doc_classes/LimboUtility.xml b/doc_classes/LimboUtility.xml index a5ff636..3edb3b8 100644 --- a/doc_classes/LimboUtility.xml +++ b/doc_classes/LimboUtility.xml @@ -30,4 +30,18 @@ + + + + + + + + + + + + + +