| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Exits a function and returns an optional value.
- 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
- Properties
- ----------
- +-----------------------------------------------------+-------------------------------------------------------------------------+-----------+
- | :ref:`bool<class_bool>` | :ref:`return_enabled<class_VisualScriptReturn_property_return_enabled>` | ``false`` |
- +-----------------------------------------------------+-------------------------------------------------------------------------+-----------+
- | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`return_type<class_VisualScriptReturn_property_return_type>` | ``0`` |
- +-----------------------------------------------------+-------------------------------------------------------------------------+-----------+
- Property Descriptions
- ---------------------
- .. _class_VisualScriptReturn_property_return_enabled:
- - :ref:`bool<class_bool>` **return_enabled**
- +-----------+--------------------------------+
- | *Default* | ``false`` |
- +-----------+--------------------------------+
- | *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**
- +-----------+------------------------+
- | *Default* | ``0`` |
- +-----------+------------------------+
- | *Setter* | set_return_type(value) |
- +-----------+------------------------+
- | *Getter* | get_return_type() |
- +-----------+------------------------+
- The return value's data type.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
