virtualx-engine/doc/classes/VisualScriptSequence.xml
2017-10-15 08:59:38 -07:00

42 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<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>