Files
godot-docs/classes/class_visualscriptreturn.rst
2018-01-12 08:52:43 +01:00

46 lines
1.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptReturn.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptReturn:
VisualScriptReturn
==================
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Exits a function and returns an optional value.
Member Variables
----------------
.. _class_VisualScriptReturn_return_enabled:
- :ref:`bool<class_bool>` **return_enabled** - If ``true`` the ``return`` input port is available.
.. _class_VisualScriptReturn_return_type:
- :ref:`Type<enum_variant_type>` **return_type** - The return value's data type.
Description
-----------
Ends the execution of a function and returns control to the calling function. Optionally, it can return a :ref:`Variant<class_variant>` value.
**Input Ports:**
- Sequence
- Data (variant): ``result`` (optional)
**Output Ports:**
none