class_visualscriptcondition.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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/VisualScriptCondition.xml.
  6. .. _class_VisualScriptCondition:
  7. VisualScriptCondition
  8. =====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A Visual Script node which branches the flow.
  11. Description
  12. -----------
  13. 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.
  14. \ **Input Ports:**\
  15. - Sequence: ``if (cond) is``\
  16. - Data (boolean): ``cond``\
  17. \ **Output Ports:**\
  18. - Sequence: ``true``\
  19. - Sequence: ``false``\
  20. - Sequence: ``done``
  21. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  22. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  23. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  24. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  25. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  26. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`