summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptSequence.xml
blob: 51238070d53cdd5b3c1b21d5bf50560126ded5c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
	<brief_description>
		Executes a series of Sequence ports.
	</brief_description>
	<description>
		Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item.
		[b]Input Ports:[/b]
		- Sequence: [code]in order[/code]
		[b]Output Ports:[/b]
		- Sequence: [code]1[/code]
		- Sequence: [code]2 - n[/code] (optional)
		- Data (int): [code]current[/code]
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_steps" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="set_steps">
			<return type="void">
			</return>
			<argument index="0" name="steps" type="int">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="steps" type="int" setter="set_steps" getter="get_steps">
			The number of steps in the sequence.
		</member>
	</members>
	<constants>
	</constants>
</class>