mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
79 lines
3.1 KiB
ReStructuredText
79 lines
3.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 Functions
|
|
----------------
|
|
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_return_type<class_VisualScriptReturn_get_return_type>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_return_value_enabled<class_VisualScriptReturn_is_return_value_enabled>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_enable_return_value<class_VisualScriptReturn_set_enable_return_value>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_return_type<class_VisualScriptReturn_set_return_type>` **(** :ref:`int<class_int>` type **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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:`int<class_int>` **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
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_VisualScriptReturn_get_return_type:
|
|
|
|
- :ref:`int<class_int>` **get_return_type** **(** **)** const
|
|
|
|
.. _class_VisualScriptReturn_is_return_value_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **is_return_value_enabled** **(** **)** const
|
|
|
|
.. _class_VisualScriptReturn_set_enable_return_value:
|
|
|
|
- void **set_enable_return_value** **(** :ref:`bool<class_bool>` enable **)**
|
|
|
|
.. _class_VisualScriptReturn_set_return_type:
|
|
|
|
- void **set_return_type** **(** :ref:`int<class_int>` type **)**
|
|
|
|
|