class_visualscriptcondition.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  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 VisualScriptCondition.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptCondition:
  6. VisualScriptCondition
  7. =====================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. A Visual Script node which branches the flow.
  10. Description
  11. -----------
  12. A Visual Script node that checks a :ref:`bool<class_bool>` input port. If ``true``, it will exit via the "true" sequence port. If ``false``, it will exit via the "false" sequence port. After exiting either, it exits via the "done" port. Sequence ports may be left disconnected.
  13. \ **Input Ports:**\
  14. - Sequence: ``if (cond) is``\
  15. - Data (boolean): ``cond``\
  16. \ **Output Ports:**\
  17. - Sequence: ``true``\
  18. - Sequence: ``false``\
  19. - Sequence: ``done``
  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.)`