limboai/doc_classes/BTRepeat.xml

27 lines
1.4 KiB
XML
Raw Permalink Normal View History

2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeat" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
2022-11-04 12:27:09 +00:00
BT decorator that repeats its child specified number of [member times].
2022-11-01 20:31:22 +00:00
</brief_description>
<description>
2022-11-04 12:27:09 +00:00
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]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].
2022-11-01 20:31:22 +00:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false">
2022-11-04 12:27:09 +00:00
If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
2022-11-01 20:31:22 +00:00
</member>
<member name="times" type="int" setter="set_times" getter="get_times" default="1">
2022-11-04 12:27:09 +00:00
A number of times to repeat an execution of the child task.
2022-11-01 20:31:22 +00:00
</member>
</members>
<constants>
</constants>
</class>