mirror of
https://github.com/godotengine/godot.git
synced 2026-01-06 10:11:57 +03:00
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
@@ -13,482 +13,347 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Add a custom signal with the specified name to the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Add a function with the specified name to the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="node" type="VisualScriptNode">
|
||||
</argument>
|
||||
<argument index="3" name="position" type="Vector2" default="Vector2( 0, 0 )">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<argument index="2" name="node" type="VisualScriptNode" />
|
||||
<argument index="3" name="position" type="Vector2" default="Vector2( 0, 0 )" />
|
||||
<description>
|
||||
Add a node to a function of the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="default_value" type="Variant" default="null">
|
||||
</argument>
|
||||
<argument index="2" name="export" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="default_value" type="Variant" default="null" />
|
||||
<argument index="2" name="export" type="bool" default="false" />
|
||||
<description>
|
||||
Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_add_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="2" name="argname" type="String">
|
||||
</argument>
|
||||
<argument index="3" name="index" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="2" name="argname" type="String" />
|
||||
<argument index="3" name="index" type="int" default="-1" />
|
||||
<description>
|
||||
Add an argument to a custom signal added with [method add_custom_signal].
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Get the count of a custom signal's arguments.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_name" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Get the name of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_type" qualifiers="const">
|
||||
<return type="int" enum="Variant.Type">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="int" enum="Variant.Type" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Get the type of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_remove_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Remove a specific custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_set_argument_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="argname" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="argname" type="String" />
|
||||
<description>
|
||||
Rename a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_set_argument_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
Change the type of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_swap_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="withidx" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="withidx" type="int" />
|
||||
<description>
|
||||
Swap two of the arguments of a custom signal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="data_connect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Connect two data ports. The value of [code]from_node[/code]'s [code]from_port[/code] would be fed into [code]to_node[/code]'s [code]to_port[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="data_disconnect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Disconnect two data ports previously connected with [method data_connect].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_function_node_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the id of a function's entry point node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_function_scroll" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the position of the center of the screen for a given function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node" qualifiers="const">
|
||||
<return type="VisualScriptNode">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="VisualScriptNode" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns a node given its id and its function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_position" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns a node's position in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_default_value" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the default (initial) value of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_export" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a variable is exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_info" qualifiers="const">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_custom_signal" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a signal exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_data_connection" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Returns whether the specified data ports are connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_function" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a function exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_node" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns whether a node exists with the given id.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_sequence_connection" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Returns whether the specified sequence ports are connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_variable" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a variable exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a custom signal with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a specific function and its nodes from the script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Remove a specific node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a variable with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a custom signal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sequence_connect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Connect two sequence ports. The execution will flow from of [code]from_node[/code]'s [code]from_output[/code] into [code]to_node[/code].
|
||||
Unlike [method data_connect], there isn't a [code]to_port[/code], since the target node can have only one sequence port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sequence_disconnect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Disconnect two sequence ports previously connected with [method sequence_connect].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_function_scroll">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="ofs" type="Vector2">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="ofs" type="Vector2" />
|
||||
<description>
|
||||
Position the center of the screen for a function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_instance_base_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="String" />
|
||||
<description>
|
||||
Set the base type of the script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_node_position">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="position" type="Vector2">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<argument index="2" name="position" type="Vector2" />
|
||||
<description>
|
||||
Position a node on the screen.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_default_value">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Change the default (initial) value of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_export">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="enable" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="enable" type="bool" />
|
||||
<description>
|
||||
Change whether a variable is exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_info">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Dictionary">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="value" type="Dictionary" />
|
||||
<description>
|
||||
Set a variable's info, using the same format as [method get_variable_info].
|
||||
</description>
|
||||
@@ -496,10 +361,8 @@
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="node_ports_changed">
|
||||
<argument index="0" name="function" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="function" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Emitted when the ports of a node are changed.
|
||||
</description>
|
||||
|
||||
@@ -10,30 +10,24 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_constructor" qualifiers="const">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<return type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_constructor_type" qualifiers="const">
|
||||
<return type="int" enum="Variant.Type">
|
||||
</return>
|
||||
<return type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constructor">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="constructor" type="Dictionary">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="constructor" type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constructor_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -10,153 +10,122 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_get_caption" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the node's title.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_category" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the node's category.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the count of input value ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_hint" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_hint_string" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's hint string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_name" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_type" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's type. See the [enum Variant.Type] values.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_sequence_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the amount of output [b]sequence[/b] ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_sequence_port_text" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified [b]sequence[/b] output's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the amount of output value ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_hint" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_hint_string" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output port's hint string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_name" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output port's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_type" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output port's type. See the [enum Variant.Type] values.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_text" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it).
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_working_memory_size" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the size of the custom node's working memory. See [method _step] for more details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_input_sequence_port" qualifiers="virtual">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Return whether the custom node has an input [b]sequence[/b] port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_step" qualifiers="virtual">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="inputs" type="Array">
|
||||
</argument>
|
||||
<argument index="1" name="outputs" type="Array">
|
||||
</argument>
|
||||
<argument index="2" name="start_mode" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="working_mem" type="Array">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="inputs" type="Array" />
|
||||
<argument index="1" name="outputs" type="Array" />
|
||||
<argument index="2" name="start_mode" type="int" />
|
||||
<argument index="3" name="working_mem" type="Array" />
|
||||
<description>
|
||||
Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error.
|
||||
The [code]inputs[/code] array contains the values of the input ports.
|
||||
|
||||
@@ -8,25 +8,18 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_custom_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="category" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="script" type="Script">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="category" type="String" />
|
||||
<argument index="2" name="script" type="Script" />
|
||||
<description>
|
||||
Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_custom_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="category" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="category" type="String" />
|
||||
<description>
|
||||
Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
|
||||
</description>
|
||||
|
||||
@@ -10,30 +10,23 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="connect_to_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="obj" type="Object">
|
||||
</argument>
|
||||
<argument index="1" name="signals" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="args" type="Array">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="obj" type="Object" />
|
||||
<argument index="1" name="signals" type="String" />
|
||||
<argument index="2" name="args" type="Array" />
|
||||
<description>
|
||||
Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_valid" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns whether the function state is valid.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resume">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="args" type="Array" default="null">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="args" type="Array" default="null" />
|
||||
<description>
|
||||
Resumes the function to run from the point it was yielded.
|
||||
</description>
|
||||
|
||||
@@ -10,89 +10,65 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_input_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="index" type="int" />
|
||||
<description>
|
||||
Adds an input port to the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_output_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="index" type="int" />
|
||||
<description>
|
||||
Adds an output port to the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_input_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
Removes an input port from the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_output_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
Removes an output port from the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<description>
|
||||
Sets the name of an input port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
Sets the type of an input port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<description>
|
||||
Sets the name of an output port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
Sets the type of an output port.
|
||||
</description>
|
||||
|
||||
@@ -10,35 +10,28 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_default_input_value" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="port_idx" type="int">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="port_idx" type="int" />
|
||||
<description>
|
||||
Returns the default value of a given port. The default value is used when nothing is connected to the port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_visual_script" qualifiers="const">
|
||||
<return type="VisualScript">
|
||||
</return>
|
||||
<return type="VisualScript" />
|
||||
<description>
|
||||
Returns the [VisualScript] instance the node is bound to.
|
||||
</description>
|
||||
</method>
|
||||
<method name="ports_changed_notify">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_default_input_value">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="port_idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="port_idx" type="int" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Change the default value of a given port.
|
||||
</description>
|
||||
|
||||
@@ -10,10 +10,8 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_subcall" qualifiers="virtual">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="arguments" type="Variant">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="arguments" type="Variant" />
|
||||
<description>
|
||||
Called by this node.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user