godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/visual_script/doc_classes/VisualScript.xml

511 lines
15 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref with current source
2019-07-05 09:32:53 +00:00
<class name="VisualScript" inherits="Script" category="Core" version="3.1.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
A script implemented in the Visual Script programming environment.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
[method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
You are most likely to use this class via the Visual Script editor or when writing plugins for it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
doc: Make all tutorial links track "3.1" in 3.1 branch See discussion in #29104.
2019-06-01 09:39:12 +00:00
<link>https://docs.godotengine.org/en/3.1/getting_started/scripting/visual_script/index.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="add_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Add a custom signal with the specified name to the VisualScript.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="add_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Add a function with the specified name to the VisualScript.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="3" name="position" type="Vector2" default="Vector2( 0, 0 )">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Add a node to a function of the VisualScript.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Add an argument to a custom signal added with [method add_custom_signal].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="custom_signal_get_argument_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Get the count of a custom signal's arguments.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Get the name of a custom signal's argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Get the type of a custom signal's argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Remove a specific custom signal's argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Rename a custom signal's argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change the type of a custom signal's argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Swap two of the arguments of a custom signal.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Disconnect two data ports previously connected with [method data_connect].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_function_node_id" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns the id of a function's entry point node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_function_scroll" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns the position of the center of the screen for a given function.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns a node given its id and its function.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="get_node_position" qualifiers="const">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="Vector2">
</return>
<argument index="0" name="func" type="String">
</argument>
<argument index="1" name="id" type="int">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns a node's position in pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_variable_default_value" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns the default (initial) value of a variable.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_variable_export" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether a variable is exported.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_variable_info" qualifiers="const">
<return type="Dictionary">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_custom_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether a signal exists with the specified name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether the specified data ports are connected.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_function" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether a function exists with the specified name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether a node exists with the given id.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether the specified sequence ports are connected.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_variable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Returns whether a variable exists with the specified name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Remove a custom signal with the given name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Remove a specific function and its nodes from the script.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Remove a specific node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Remove a variable with the given name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change the name of a custom signal.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change the name of a function.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change the name of a variable.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Disconnect two sequence ports previously connected with [method sequence_connect].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Position the center of the screen for a function.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_instance_base_type">
<return type="void">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Set the base type of the script.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="set_node_position">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="void">
</return>
<argument index="0" name="func" type="String">
</argument>
<argument index="1" name="id" type="int">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="2" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Position a node on the screen.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change the default (initial) value of a variable.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Change whether a variable is exported.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Set a variable's info, using the same format as [method get_variable_info].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<signals>
<signal name="node_ports_changed">
<argument index="0" name="function" type="String">
</argument>
<argument index="1" name="id" type="int">
</argument>
<description>
Document some of the VisualScript classes.
2017-09-28 10:07:20 +00:00
Emitted when the ports of a node are changed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
</constants>
</class>