class_visualscriptwhile.rst 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  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 VisualScriptWhile.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptWhile:
  6. VisualScriptWhile
  7. =================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Conditional loop.
  10. Description
  11. -----------
  12. Loops while a condition is ``true``. Execution continues out the ``exit`` Sequence port when the loop terminates.
  13. **Input Ports:**
  14. - Sequence: ``while(cond)``
  15. - Data (bool): ``cond``
  16. **Output Ports:**
  17. - Sequence: ``repeat``
  18. - Sequence: ``exit``
  19. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  20. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  21. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`