limboai/doc_classes/BTForEach.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTForEach" inherits="BTDecorator" 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="StringName" setter="set_array_var" getter="get_array_var" default="&amp;&quot;&quot;">
			A variable within the [Blackboard] that holds an [Array], which is used for the iteration process.
		</member>
		<member name="save_var" type="StringName" setter="set_save_var" getter="get_save_var" default="&amp;&quot;&quot;">
			A [Blackboard] variable used to store an element of the array referenced by [member array_var].
		</member>
	</members>
</class>
Add documentation stubs 2022-11-01 20:31:22 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update class docs and refactor SetVar enums 2023-11-15 14:40:07 +00:00			`<class name="BTForEach" inherits="BTDecorator" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
Add documentation stubs 2022-11-01 20:31:22 +00:00			`<brief_description>`
Improve class docs for ForEach, Invert, NewScope, Probability 2023-10-09 08:29:34 +00:00			`BT decorator that executes its child task for each element of an [Array].`
Add documentation stubs 2022-11-01 20:31:22 +00:00			`</brief_description>`
			`<description>`
Improve class docs for ForEach, Invert, NewScope, Probability 2023-10-09 08:29:34 +00:00			`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.`
Add documentation stubs 2022-11-01 20:31:22 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Doc: Update class docs 2024-03-04 15:14:47 +00:00			`<member name="array_var" type="StringName" setter="set_array_var" getter="get_array_var" default="&""">`
Improve class docs for ForEach, Invert, NewScope, Probability 2023-10-09 08:29:34 +00:00			`A variable within the [Blackboard] that holds an [Array], which is used for the iteration process.`
Add documentation stubs 2022-11-01 20:31:22 +00:00			`</member>`
Doc: Update class docs 2024-03-04 15:14:47 +00:00			`<member name="save_var" type="StringName" setter="set_save_var" getter="get_save_var" default="&""">`
Improve class docs for ForEach, Invert, NewScope, Probability 2023-10-09 08:29:34 +00:00			`A [Blackboard] variable used to store an element of the array referenced by [member array_var].`
Add documentation stubs 2022-11-01 20:31:22 +00:00			`</member>`
			`</members>`
			`</class>`