| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- :github_url: hide
- .. 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.
- Properties
- ----------
- +-----------------------------------------------------+-------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`return_enabled<class_VisualScriptReturn_property_return_enabled>` |
- +-----------------------------------------------------+-------------------------------------------------------------------------+
- | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`return_type<class_VisualScriptReturn_property_return_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
- Property Descriptions
- ---------------------
- .. _class_VisualScriptReturn_property_return_enabled:
- - :ref:`bool<class_bool>` **return_enabled**
- +----------+--------------------------------+
- | *Setter* | set_enable_return_value(value) |
- +----------+--------------------------------+
- | *Getter* | is_return_value_enabled() |
- +----------+--------------------------------+
- If ``true``, the ``return`` input port is available.
- ----
- .. _class_VisualScriptReturn_property_return_type:
- - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **return_type**
- +----------+------------------------+
- | *Setter* | set_return_type(value) |
- +----------+------------------------+
- | *Getter* | get_return_type() |
- +----------+------------------------+
- The return value's data type.
|
