pandemonium_engine_docs/classes/class_visualscriptsequence.rst

61 lines
1.9 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSequence.xml.
.. _class_VisualScriptSequence:
VisualScriptSequence
====================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Executes a series of Sequence ports.
Description
-----------
Steps through a series of one or more output Sequence ports. The ``current`` data port outputs the currently executing item.
\ **Input Ports:**\
- Sequence: ``in order``\
\ **Output Ports:**\
- Sequence: ``1``\
- Sequence: ``2 - n`` (optional)
- Data (int): ``current``
Properties
----------
+-----------------------+---------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`steps<class_VisualScriptSequence_property_steps>` | ``1`` |
+-----------------------+---------------------------------------------------------+-------+
Property Descriptions
---------------------
.. _class_VisualScriptSequence_property_steps:
- :ref:`int<class_int>` **steps**
+-----------+------------------+
| *Default* | ``1`` |
+-----------+------------------+
| *Setter* | set_steps(value) |
+-----------+------------------+
| *Getter* | get_steps() |
+-----------+------------------+
The number of steps in the sequence.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`