23 lines
1.3 KiB
XML
23 lines
1.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="BTForEach" 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 its child task for each element of an [Array].
|
|
</brief_description>
|
|
<description>
|
|
BTForEach executes its child task for each element of an [Array]. During each iteration, the next element is stored in the specified [Blackboard] variable.
|
|
Returns [code]RUNNING[/code] if the child task results in [code]RUNNING[/code] or if the child task results in [code]SUCCESS[/code] on a non-last iteration.
|
|
Returns [code]FAILURE[/code] if the child task results in [code]FAILURE[/code].
|
|
Returns [code]SUCCESS[/code] if the child task results in [code]SUCCESS[/code] on the last iteration.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<members>
|
|
<member name="array_var" type="String" setter="set_array_var" getter="get_array_var" default="""">
|
|
A variable within the [Blackboard] that holds an [Array], which is used for the iteration process.
|
|
</member>
|
|
<member name="save_var" type="String" setter="set_save_var" getter="get_save_var" default="""">
|
|
A [Blackboard] variable used to store an element of the array referenced by [member array_var].
|
|
</member>
|
|
</members>
|
|
</class>
|