2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
|
<class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
|
|
|
<brief_description>
|
2017-10-15 03:11:00 +00:00
|
|
|
Exits a function and returns an optional value.
|
2017-09-12 20:42:36 +00:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-10-15 03:11:00 +00:00
|
|
|
Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value.
|
|
|
|
[b]Input Ports:[/b]
|
|
|
|
- Sequence
|
|
|
|
- Data (variant): [code]result[/code] (optional)
|
|
|
|
[b]Output Ports:[/b]
|
|
|
|
none
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<demos>
|
|
|
|
</demos>
|
|
|
|
<methods>
|
|
|
|
<method name="get_return_type" qualifiers="const">
|
|
|
|
<return type="int" enum="Variant.Type">
|
|
|
|
</return>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="is_return_value_enabled" qualifiers="const">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="set_enable_return_value">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="enable" type="bool">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="set_return_type">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="type" type="int" enum="Variant.Type">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<members>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled">
|
2017-10-15 03:11:00 +00:00
|
|
|
If [code]true[/code] the [code]return[/code] input port is available.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type">
|
2017-10-15 03:11:00 +00:00
|
|
|
The return value's data type.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|