class_visualscriptsequence.rst 1.5 KB

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