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

Update BTRepeat class doc

This commit is contained in:
Serhii Snitsaruk 2023-08-06 12:55:52 +02:00
parent 458ad5280e
commit 258437c340
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc_classes/BTRepeat.xml
View File

@ -5,7 +5,7 @@
</brief_description> </brief_description>
<description> <description>
BT decorator that repeats execution of the child task specified number of [member times]. BT decorator that repeats execution of the child task specified number of [member times].
Returns [code]RUNNING[/code] if the child returns [code]RUNNING[/code]. Returns [code]RUNNING[/code] if the child returns [code]RUNNING[/code]. If [member forever] is [code]true[/code], BTRepeat will always return [code]RUNNING[/code].
Returns [code]SUCCESS[/code] when specified number of successfully finished executions is reached. When [member abort_on_failure] is [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution. Returns [code]SUCCESS[/code] when specified number of successfully finished executions is reached. When [member abort_on_failure] is [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
Returns [code]FAILURE[/code] when [member abort_on_failure] is set and the child returns [code]FAILURE[/code]. Returns [code]FAILURE[/code] when [member abort_on_failure] is set and the child returns [code]FAILURE[/code].
</description> </description>
@ -15,6 +15,9 @@
<member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false"> <member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false">
If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution. If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
</member> </member>
<member name="forever" type="bool" setter="set_forever" getter="get_forever" default="false">
If [code]true[/code], the child's execution will be repeated indefinitely, always returning [code]RUNNING[/code].
</member>
<member name="times" type="int" setter="set_times" getter="get_times" default="1"> <member name="times" type="int" setter="set_times" getter="get_times" default="1">
A number of times to repeat an execution of the child task. A number of times to repeat an execution of the child task.
</member> </member>

2
doc_classes/BTTask.xml
View File

@ -188,7 +188,7 @@
<member name="custom_name" type="String" setter="set_custom_name" getter="get_custom_name" default="&quot;&quot;"> <member name="custom_name" type="String" setter="set_custom_name" getter="get_custom_name" default="&quot;&quot;">
User provided name for the task. If not empty, [code]custom_name[/code] is used by the editor to display the task. See [method get_task_name]. User provided name for the task. If not empty, [code]custom_name[/code] is used by the editor to display the task. See [method get_task_name].
</member> </member>
<member name="elapsed_time" type="float" setter="" getter="get_elapsed_time" default="0.0"> <member name="elapsed_time" type="float" setter="" getter="get_elapsed_time">
Elapsed time since the task was entered. Elapsed time since the task was entered.
Returns 0 when task is not [code]RUNNING[/code]. Returns 0 when task is not [code]RUNNING[/code].
</member> </member>