Update BTRepeat class doc
This commit is contained in:
parent
458ad5280e
commit
258437c340
|
@ -5,7 +5,7 @@
|
|||
</brief_description>
|
||||
<description>
|
||||
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]FAILURE[/code] when [member abort_on_failure] is set and the child returns [code]FAILURE[/code].
|
||||
</description>
|
||||
|
@ -15,6 +15,9 @@
|
|||
<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.
|
||||
</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">
|
||||
A number of times to repeat an execution of the child task.
|
||||
</member>
|
||||
|
|
|
@ -188,7 +188,7 @@
|
|||
<member name="custom_name" type="String" setter="set_custom_name" getter="get_custom_name" default="""">
|
||||
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 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.
|
||||
Returns 0 when task is not [code]RUNNING[/code].
|
||||
</member>
|
||||
|
|
Loading…
Reference in New Issue