class_visualscriptsequence.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptSequence.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptSequence:
  5. VisualScriptSequence
  6. ====================
  7. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Executes a series of Sequence ports.
  12. Properties
  13. ----------
  14. +-----------------------+------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`steps<class_VisualScriptSequence_steps>` |
  16. +-----------------------+------------------------------------------------+
  17. Description
  18. -----------
  19. Steps through a series of one or more output Sequence ports. The ``current`` data port outputs the currently executing item.
  20. **Input Ports:**
  21. - Sequence: ``in order``
  22. **Output Ports:**
  23. - Sequence: ``1``
  24. - Sequence: ``2 - n`` (optional)
  25. - Data (int): ``current``
  26. Property Descriptions
  27. ---------------------
  28. .. _class_VisualScriptSequence_steps:
  29. - :ref:`int<class_int>` **steps**
  30. +----------+------------------+
  31. | *Setter* | set_steps(value) |
  32. +----------+------------------+
  33. | *Getter* | get_steps() |
  34. +----------+------------------+
  35. The number of steps in the sequence.