class_visualscriptsequence.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Executes a series of Sequence ports.
  10. Description
  11. -----------
  12. Steps through a series of one or more output Sequence ports. The ``current`` data port outputs the currently executing item.
  13. \ **Input Ports:**\
  14. - Sequence: ``in order``\
  15. \ **Output Ports:**\
  16. - Sequence: ``1``\
  17. - Sequence: ``2 - n`` (optional)
  18. - Data (int): ``current``
  19. Properties
  20. ----------
  21. +-----------------------+---------------------------------------------------------+-------+
  22. | :ref:`int<class_int>` | :ref:`steps<class_VisualScriptSequence_property_steps>` | ``1`` |
  23. +-----------------------+---------------------------------------------------------+-------+
  24. Property Descriptions
  25. ---------------------
  26. .. _class_VisualScriptSequence_property_steps:
  27. - :ref:`int<class_int>` **steps**
  28. +-----------+------------------+
  29. | *Default* | ``1`` |
  30. +-----------+------------------+
  31. | *Setter* | set_steps(value) |
  32. +-----------+------------------+
  33. | *Getter* | get_steps() |
  34. +-----------+------------------+
  35. The number of steps in the sequence.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`