Fix class doc errors

This commit is contained in:
Serhii Snitsaruk 2023-09-16 18:04:37 +02:00
parent dd01cc82bb
commit 9ed075120e
4 changed files with 7 additions and 7 deletions

View File

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCooldown" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT decorator that executes child only if [member cooldown] time passed since previous execution.
BT decorator that executes child only if [member duration] time passed since previous execution.
</brief_description>
<description>
BT decorator that executes child only if [member cooldown] time passed since previous child task execution.
BT decorator that executes child only if [member duration] time passed since previous child task execution.
Returns [code]RUNNING[/code], when the child returns [code]RUNNING[/code].
Returns [code]SUCCESS[/code], when the child returns [code]SUCCESS[/code], and triggers the cooldown.
Returns [code]FAILURE[/code], if the child returns [code]FAILURE[/code] or [member cooldown] time didn't pass since previous execution.
Returns [code]FAILURE[/code], if the child returns [code]FAILURE[/code] or [member duration] time didn't pass since previous execution.
</description>
<tutorials>
</tutorials>

View File

@ -4,7 +4,7 @@
BT action that assigns a value to agent's property.
</brief_description>
<description>
BTSetAgentProperty assigns the specified [member value] to the agent's property identified by the [member property_name] and returns [code]SUCCESS[/code].
BTSetAgentProperty assigns the specified [member value] to the agent's property identified by the [member property] and returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if it fails to set the property.
</description>
<tutorials>

View File

@ -48,7 +48,7 @@
<param index="0" name="p_delta" type="float" />
<description>
Called when task is "ticked", i.e. executed by [BTPlayer] or [BTState] during update.
Returns [member TaskStatus].
Returns [enum TaskStatus].
*Note:* Tasks perform their main function by implementing this method.
</description>
</method>
@ -157,7 +157,7 @@
<method name="next_sibling" qualifiers="const">
<return type="BTTask" />
<description>
Returns the next task after this task in the children list of the [member parent].
Returns the next task after this task in the children list of the parent.
Returns [code]null[/code] if this task has no parent or it is the last child in the parent's children list.
</description>
</method>

View File

@ -50,7 +50,7 @@
<return type="void" />
<param index="0" name="p_delta" type="float" />
<description>
Calls [member LimboState._update] on itself and on the active substate. Call propagates down to the leaf state.
Calls [method LimboState._update] on itself and on the active substate. Call propagates down to the leaf state.
It is called automatically, if [member update_mode] is not set to [constant MANUAL].
</description>
</method>