Files
godot-visual-script/doc_classes/VisualScriptReturn.xml
Hugo Locurcio ab7886cfd4 Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00

29 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptReturn" inherits="VisualScriptNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Exits a function and returns an optional value.
</brief_description>
<description>
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
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled" default="false">
If [code]true[/code], the [code]return[/code] input port is available.
</member>
<member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type" default="0">
The return value's data type.
</member>
</members>
<constants>
</constants>
</class>