botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update class docs

This commit is contained in:
Serhii Snitsaruk 2023-08-10 13:24:41 +02:00
parent fb9cb06ccb
commit eb97cd2d5c
4 changed files with 40 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc_classes/BTCheckAgentProperty.xml Normal file
View File

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCheckAgentProperty" 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 agent's property value.
</brief_description>
<description>
BTCheckAgentProperty checks agent's property value against [member value] and returns [code]SUCCESS[/code] or [code]FAILURE[/code] based on the [member check_type].
</description>
<tutorials>
</tutorials>
<members>
<member name="check_type" type="int" setter="set_check_type" getter="get_check_type" enum="LimboUtility.CheckType" default="0">
Type of check to perform.
</member>
<member name="property_name" type="StringName" setter="set_property_name" getter="get_property_name" default="&amp;&quot;&quot;">
Parameter that specifies the agent's property name which will be compared.
</member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value to which an agent's property will be compared.
</member>
</members>
</class>

2
doc_classes/BTCheckTrigger.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?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"> <class name="BTCheckTrigger" inherits="BTCondition" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
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 changes it to [code]false[/code] and returns [code]SUCCESS[/code]. Otherwise, it returns [code]FAILURE[/code].

19
doc_classes/BTCheckVar.xml
View File

@ -1,14 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?> <?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"> <class name="BTCheckVar" inherits="BTCondition" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
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.
</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].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<members> <members>
<member name="check_type" type="int" setter="set_check_type" getter="get_check_type" enum="BTCheckVar.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. Type of check to perform.
</member> </member>
<member name="value" type="BBVariant" setter="set_value" getter="get_value"> <member name="value" type="BBVariant" setter="set_value" getter="get_value">
@ -18,18 +19,4 @@
Variable name to check its value. Variable name to check its value.
</member> </member>
</members> </members>
<constants>
<constant name="CHECK_EQUAL" value="0" enum="CheckType">
</constant>
<constant name="CHECK_LESS_THAN" value="1" enum="CheckType">
</constant>
<constant name="CHECK_LESS_THAN_OR_EQUAL" value="2" enum="CheckType">
</constant>
<constant name="CHECK_GREATER_THAN" value="3" enum="CheckType">
</constant>
<constant name="CHECK_GREATER_THAN_OR_EQUAL" value="4" enum="CheckType">
</constant>
<constant name="CHECK_NOT_EQUAL" value="5" enum="CheckType">
</constant>
</constants>
</class> </class>

14
doc_classes/LimboUtility.xml
View File

@ -30,4 +30,18 @@
</description> </description>
</method> </method>
</methods> </methods>
<constants>
<constant name="CHECK_EQUAL" value="0" enum="CheckType">
</constant>
<constant name="CHECK_LESS_THAN" value="1" enum="CheckType">
</constant>
<constant name="CHECK_LESS_THAN_OR_EQUAL" value="2" enum="CheckType">
</constant>
<constant name="CHECK_GREATER_THAN" value="3" enum="CheckType">
</constant>
<constant name="CHECK_GREATER_THAN_OR_EQUAL" value="4" enum="CheckType">
</constant>
<constant name="CHECK_NOT_EQUAL" value="5" enum="CheckType">
</constant>
</constants>
</class> </class>