class_visualscriptsequence.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptSequence.xml.
  6. .. _class_VisualScriptSequence:
  7. VisualScriptSequence
  8. ====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Executes a series of Sequence ports.
  11. Description
  12. -----------
  13. Steps through a series of one or more output Sequence ports. The ``current`` data port outputs the currently executing item.
  14. \ **Input Ports:**\
  15. - Sequence: ``in order``\
  16. \ **Output Ports:**\
  17. - Sequence: ``1``\
  18. - Sequence: ``2 - n`` (optional)
  19. - Data (int): ``current``
  20. Properties
  21. ----------
  22. +-----------------------+---------------------------------------------------------+-------+
  23. | :ref:`int<class_int>` | :ref:`steps<class_VisualScriptSequence_property_steps>` | ``1`` |
  24. +-----------------------+---------------------------------------------------------+-------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptSequence_property_steps:
  28. - :ref:`int<class_int>` **steps**
  29. +-----------+------------------+
  30. | *Default* | ``1`` |
  31. +-----------+------------------+
  32. | *Setter* | set_steps(value) |
  33. +-----------+------------------+
  34. | *Getter* | get_steps() |
  35. +-----------+------------------+
  36. The number of steps in the sequence.
  37. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  38. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  39. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  40. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  41. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  42. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`