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

Improve docs for CheckAgentProperty & SetAgentProperty

This commit is contained in:
Serhii Snitsaruk 2023-10-19 13:39:11 +02:00
parent 3d5cbbf50f
commit 81b415a6bf
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc_classes/BTCheckAgentProperty.xml
View File

@ -4,19 +4,20 @@
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].
BTCheckAgentProperty examines the agent's property value and compares it to [member value].
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.
The type of check to be performed.
</member>
<member name="property" type="StringName" setter="set_property" getter="get_property" default="&amp;&quot;&quot;">
Parameter that specifies the agent's property which will be compared.
Parameter that specifies the agent's property to 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.
Parameter that specifies the value against which an agent's property will be compared.
</member>
</members>
</class>

2
doc_classes/BTSetAgentProperty.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSetAgentProperty" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that assigns a value to agent's property.
BT action that assigns a value to the specified agent's property.
</brief_description>
<description>
BTSetAgentProperty assigns the specified [member value] to the agent's property identified by the [member property] and returns [code]SUCCESS[/code].