northern-lighthouse/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document some of the VisualScript classes.

Browse Source
This commit is contained in:
Bojidar Marinov
2017-09-28 13:07:20 +03:00
parent 62cb43bb8d
commit 10469c1962
16 changed files with 210 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/classes/VisualScript.xml
View File

@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScript" inherits="Script" category="Core" version="3.0.alpha.custom_build">
<brief_description>
A script implemented in the Visual Script programming environment.
</brief_description>
<description>
A script implemented in the Visual Script programming environment. The script exends the functionality of all objects that instance it.
[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.
</description>
<tutorials>
</tutorials>
@ -15,6 +19,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Add a custom signal with the specified name to the VisualScript.
</description>
</method>
<method name="add_function">
@ -23,6 +28,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Add a function with the specified name to the VisualScript.
</description>
</method>
<method name="add_node">
@ -37,6 +43,7 @@
<argument index="3" name="pos" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
Add a node to a function of the VisualScript.
</description>
</method>
<method name="add_variable">
@ -49,6 +56,7 @@
<argument index="2" name="export" type="bool" default="false">
</argument>
<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">
@ -63,6 +71,7 @@
<argument index="3" name="index" type="int" default="-1">
</argument>
<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">
@ -71,6 +80,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Get the count of a custom signal's arguments.
</description>
</method>
<method name="custom_signal_get_argument_name" qualifiers="const">
@ -81,6 +91,7 @@
<argument index="1" name="argidx" type="int">
</argument>
<description>
Get the name of a custom signal's argument.
</description>
</method>
<method name="custom_signal_get_argument_type" qualifiers="const">
@ -91,6 +102,7 @@
<argument index="1" name="argidx" type="int">
</argument>
<description>
Get the type of a custom signal's argument.
</description>
</method>
<method name="custom_signal_remove_argument">
@ -101,6 +113,7 @@
<argument index="1" name="argidx" type="int">
</argument>
<description>
Remove a specific custom signal's argument.
</description>
</method>
<method name="custom_signal_set_argument_name">
@ -113,6 +126,7 @@
<argument index="2" name="argname" type="String">
</argument>
<description>
Rename a custom signal's argument.
</description>
</method>
<method name="custom_signal_set_argument_type">
@ -125,6 +139,7 @@
<argument index="2" name="type" type="int" enum="Variant.Type">
</argument>
<description>
Change the type of a custom signal's argument.
</description>
</method>
<method name="custom_signal_swap_argument">
@ -137,6 +152,7 @@
<argument index="2" name="withidx" type="int">
</argument>
<description>
Swap two of the arguments of a custom signal.
</description>
</method>
<method name="data_connect">
@ -153,6 +169,7 @@
<argument index="4" name="to_port" type="int">
</argument>
<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">
@ -169,6 +186,7 @@
<argument index="4" name="to_port" type="int">
</argument>
<description>
Disconnect two data ports previously connected with [method data_connect].
</description>
</method>
<method name="get_function_node_id" qualifiers="const">
@ -177,6 +195,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the id of a function's entry point node.
</description>
</method>
<method name="get_function_scroll" qualifiers="const">
@ -185,6 +204,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the position of the center of the screen for a given function.
</description>
</method>
<method name="get_node" qualifiers="const">
@ -195,6 +215,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Returns a node given its id and its function.
</description>
</method>
<method name="get_node_pos" qualifiers="const">
@ -205,6 +226,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Returns a node's position in pixels.
</description>
</method>
<method name="get_variable_default_value" qualifiers="const">
@ -213,6 +235,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the default (initial) value of a variable.
</description>
</method>
<method name="get_variable_export" qualifiers="const">
@ -221,6 +244,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns whether a variable is exported.
</description>
</method>
<method name="get_variable_info" qualifiers="const">
@ -229,6 +253,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the info 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">
@ -237,6 +262,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns whether a signal exists with the specified name.
</description>
</method>
<method name="has_data_connection" qualifiers="const">
@ -253,6 +279,7 @@
<argument index="4" name="to_port" type="int">
</argument>
<description>
Returns whether the specified data ports are connected.
</description>
</method>
<method name="has_function" qualifiers="const">
@ -261,6 +288,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns whether a function exists with the specified name.
</description>
</method>
<method name="has_node" qualifiers="const">
@ -271,6 +299,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Returns whether a node exists with the given id.
</description>
</method>
<method name="has_sequence_connection" qualifiers="const">
@ -285,6 +314,7 @@
<argument index="3" name="to_node" type="int">
</argument>
<description>
Returns whether the specified sequence ports are connected.
</description>
</method>
<method name="has_variable" qualifiers="const">
@ -293,6 +323,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns whether a variable exists with the specified name.
</description>
</method>
<method name="remove_custom_signal">
@ -301,6 +332,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Remove a custom signal with the given name.
</description>
</method>
<method name="remove_function">
@ -309,6 +341,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Remove a specific function and its nodes from the script.
</description>
</method>
<method name="remove_node">
@ -319,6 +352,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Remove a specific node.
</description>
</method>
<method name="remove_variable">
@ -327,6 +361,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Remove a variable with the given name.
</description>
</method>
<method name="rename_custom_signal">
@ -337,6 +372,7 @@
<argument index="1" name="new_name" type="String">
</argument>
<description>
Change the name of a custom signal.
</description>
</method>
<method name="rename_function">
@ -347,6 +383,7 @@
<argument index="1" name="new_name" type="String">
</argument>
<description>
Change the name of a function.
</description>
</method>
<method name="rename_variable">
@ -357,6 +394,7 @@
<argument index="1" name="new_name" type="String">
</argument>
<description>
Change the name of a variable.
</description>
</method>
<method name="sequence_connect">
@ -371,6 +409,8 @@
<argument index="3" name="to_node" type="int">
</argument>
<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">
@ -385,6 +425,7 @@
<argument index="3" name="to_node" type="int">
</argument>
<description>
Disconnect two sequence ports previously connected with [method sequence_connect].
</description>
</method>
<method name="set_function_scroll">
@ -395,6 +436,7 @@
<argument index="1" name="ofs" type="Vector2">
</argument>
<description>
Position the center of the screen for a function.
</description>
</method>
<method name="set_instance_base_type">
@ -403,6 +445,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Set the base type of the script.
</description>
</method>
<method name="set_node_pos">
@ -415,6 +458,7 @@
<argument index="2" name="pos" type="Vector2">
</argument>
<description>
Position a node on the screen.
</description>
</method>
<method name="set_variable_default_value">
@ -425,6 +469,7 @@
<argument index="1" name="value" type="Variant">
</argument>
<description>
Change the default (initial) value of a variable.
</description>
</method>
<method name="set_variable_export">
@ -435,6 +480,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
Change whether a variable is exported.
</description>
</method>
<method name="set_variable_info">
@ -445,6 +491,7 @@
<argument index="1" name="value" type="Dictionary">
</argument>
<description>
Set a variable's info, using the same format as [method get_variable_info].
</description>
</method>
</methods>
@ -459,6 +506,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Emitted when the ports of a node are changed.
</description>
</signal>
</signals>