class_visualscriptwhile.rst 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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/VisualScriptWhile.xml.
  6. .. _class_VisualScriptWhile:
  7. VisualScriptWhile
  8. =================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Conditional loop.
  11. Description
  12. -----------
  13. Loops while a condition is ``true``. Execution continues out the ``exit`` Sequence port when the loop terminates.
  14. \ **Input Ports:**\
  15. - Sequence: ``while(cond)``\
  16. - Data (bool): ``cond``\
  17. \ **Output Ports:**\
  18. - Sequence: ``repeat``\
  19. - Sequence: ``exit``
  20. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  21. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  22. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  23. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  24. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  25. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`