diff --git a/doc_classes/VisualScript.xml b/doc_classes/VisualScript.xml index 9d51bd8..2327fc0 100644 --- a/doc_classes/VisualScript.xml +++ b/doc_classes/VisualScript.xml @@ -13,456 +13,334 @@ - - - - + + Add a custom signal with the specified name to the VisualScript. - - - - - - + + + Add a function with the specified name to the VisualScript, and assign the root [VisualScriptFunction] node's id as [code]func_node_id[/code]. - - - - - - - - + + + + Add a node to the VisualScript. - - - - - - - - + + + + Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. - - - - - - - - - - + + + + + Add an argument to a custom signal added with [method add_custom_signal]. - - - - + + Get the count of a custom signal's arguments. - - - - - - + + + Get the name of a custom signal's argument. - - - - - - + + + Get the type of a custom signal's argument. - - - - - - + + + Remove a specific custom signal's argument. - - - - - - - - + + + + Rename a custom signal's argument. - - - - - - - - + + + + Change the type of a custom signal's argument. - - - - - - - - + + + + Swap two of the arguments of a custom signal. - - - - - - - - - - + + + + + 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]. - - - - - - - - - - + + + + + Disconnect two data ports previously connected with [method data_connect]. - - - - + + Returns the id of a function's entry point node. - - - - + + Returns a node given its id. - - - - + + Returns a node's position in pixels. - - + Returns the current position of the center of the screen. - - - - + + Returns the default (initial) value of a variable. - - - - + + Returns whether a variable is exported. - - - - + + Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. - - - - + + Returns whether a signal exists with the specified name. - - - - - - - - - - + + + + + Returns whether the specified data ports are connected. - - - - + + Returns whether a function exists with the specified name. - - - - + + Returns whether a node exists with the given id. - - - - - - - - + + + + Returns whether the specified sequence ports are connected. - - - - + + Returns whether a variable exists with the specified name. - - - - + + Remove a custom signal with the given name. - - - - + + Remove a specific function and its nodes from the script. - - - - + + Remove the node with the specified id. - - - - + + Remove a variable with the given name. - - - - - - + + + Change the name of a custom signal. - - - - - - + + + Change the name of a function. - - - - - - + + + Change the name of a variable. - - - - - - - - + + + + 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. - - - - - - - - + + + + Disconnect two sequence ports previously connected with [method sequence_connect]. - - - - + + Set the base type of the script. - - - - - - + + + Set the node position in the VisualScript graph. - - - - + + Set the screen center to the given position. - - - - - - + + + Change the default (initial) value of a variable. - - - - - - + + + Change whether a variable is exported. - - - - - - + + + Set a variable's info, using the same format as [method get_variable_info]. @@ -470,8 +348,7 @@ - - + Emitted when the ports of a node are changed. diff --git a/doc_classes/VisualScriptConstructor.xml b/doc_classes/VisualScriptConstructor.xml index 2f162e7..4743594 100644 --- a/doc_classes/VisualScriptConstructor.xml +++ b/doc_classes/VisualScriptConstructor.xml @@ -10,30 +10,24 @@ - - + - - + - - - - + + - - - - + + diff --git a/doc_classes/VisualScriptCustomNode.xml b/doc_classes/VisualScriptCustomNode.xml index ba4eba2..8aa34f8 100644 --- a/doc_classes/VisualScriptCustomNode.xml +++ b/doc_classes/VisualScriptCustomNode.xml @@ -10,153 +10,122 @@ - - + Return the node's title. - - + Return the node's category. - - + Return the count of input value ports. - - - - + + Return the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. - - - - + + Return the specified input port's hint string. - - - - + + Return the specified input port's name. - - - - + + Return the specified input port's type. See the [enum Variant.Type] values. - - + Return the amount of output [b]sequence[/b] ports. - - - - + + Return the specified [b]sequence[/b] output's name. - - + Return the amount of output value ports. - - - - + + Return the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. - - - - + + Return the specified output port's hint string. - - - - + + Return the specified output port's name. - - - - + + Return the specified output port's type. See the [enum Variant.Type] values. - - + 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). - - + Return the size of the custom node's working memory. See [method _step] for more details. - - + Return whether the custom node has an input [b]sequence[/b] port. - - - - - - - - - - + + + + + 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. diff --git a/doc_classes/VisualScriptEditor.xml b/doc_classes/VisualScriptEditor.xml index 186cd21..9ea889c 100644 --- a/doc_classes/VisualScriptEditor.xml +++ b/doc_classes/VisualScriptEditor.xml @@ -8,25 +8,18 @@ - - - - - - - - + + + + Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. - - - - - - + + + Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. diff --git a/doc_classes/VisualScriptFunctionState.xml b/doc_classes/VisualScriptFunctionState.xml index 54a02bf..18c3826 100644 --- a/doc_classes/VisualScriptFunctionState.xml +++ b/doc_classes/VisualScriptFunctionState.xml @@ -10,30 +10,23 @@ - - - - - - - - + + + + Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted. - - + Returns whether the function state is valid. - - - - + + Resumes the function to run from the point it was yielded. diff --git a/doc_classes/VisualScriptLists.xml b/doc_classes/VisualScriptLists.xml index 671c427..d5bff13 100644 --- a/doc_classes/VisualScriptLists.xml +++ b/doc_classes/VisualScriptLists.xml @@ -10,89 +10,65 @@ - - - - - - - - + + + + Adds an input port to the Visual Script node. - - - - - - - - + + + + Adds an output port to the Visual Script node. - - - - + + Removes an input port from the Visual Script node. - - - - + + Removes an output port from the Visual Script node. - - - - - - + + + Sets the name of an input port. - - - - - - + + + Sets the type of an input port. - - - - - - + + + Sets the name of an output port. - - - - - - + + + Sets the type of an output port. diff --git a/doc_classes/VisualScriptNode.xml b/doc_classes/VisualScriptNode.xml index 82a023f..23574a5 100644 --- a/doc_classes/VisualScriptNode.xml +++ b/doc_classes/VisualScriptNode.xml @@ -10,35 +10,28 @@ - - - - + + Returns the default value of a given port. The default value is used when nothing is connected to the port. - - + Returns the [VisualScript] instance the node is bound to. - - + Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] . - - - - - - + + + Change the default value of a given port. diff --git a/doc_classes/VisualScriptSubCall.xml b/doc_classes/VisualScriptSubCall.xml index 89a10ed..374e7d0 100644 --- a/doc_classes/VisualScriptSubCall.xml +++ b/doc_classes/VisualScriptSubCall.xml @@ -10,10 +10,8 @@ - - - - + + Called by this node.