From c5d7115038de5f83cb83e08748615a84fc26bee2 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Sat, 6 Aug 2022 21:11:48 +0300 Subject: Rename the argument tag to param in XML documentation --- modules/visual_script/doc_classes/VisualScript.xml | 162 ++++++++++----------- .../doc_classes/VisualScriptConstructor.xml | 4 +- .../doc_classes/VisualScriptCustomNode.xml | 26 ++-- .../doc_classes/VisualScriptCustomNodes.xml | 10 +- .../doc_classes/VisualScriptFunctionState.xml | 8 +- .../doc_classes/VisualScriptLists.xml | 32 ++-- .../visual_script/doc_classes/VisualScriptNode.xml | 6 +- 7 files changed, 124 insertions(+), 124 deletions(-) (limited to 'modules/visual_script/doc_classes') diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index 5807c98d32..ff6b7a8b5f 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -14,142 +14,142 @@ - + 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. @@ -162,129 +162,129 @@ - + 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. @@ -292,55 +292,55 @@ - - - + + + 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]. @@ -348,7 +348,7 @@ - + Emitted when the ports of a node are changed. diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml index 5ec17350bd..a003f21ab9 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -21,13 +21,13 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index 97b89fb987..6e522b2f84 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -29,28 +29,28 @@ - + Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. - + Returns the specified input port's hint string. - + Returns the specified input port's name. - + Returns the specified input port's type. See the [enum Variant.Type] values. @@ -63,7 +63,7 @@ - + Returns the specified [b]sequence[/b] output's name. @@ -76,28 +76,28 @@ - + Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. - + Returns the specified output port's hint string. - + Returns the specified output port's name. - + Returns the specified output port's type. See the [enum Variant.Type] values. @@ -122,10 +122,10 @@ - - - - + + + + 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/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml b/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml index f04c862174..48d7975051 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml @@ -11,17 +11,17 @@ - - - + + + 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/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml index ef09c9d4a0..03fef9c13b 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml @@ -11,9 +11,9 @@ - - - + + + Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted. @@ -26,7 +26,7 @@ - + Resumes the function to run from the point it was yielded. diff --git a/modules/visual_script/doc_classes/VisualScriptLists.xml b/modules/visual_script/doc_classes/VisualScriptLists.xml index 27a81fce2f..607965bf71 100644 --- a/modules/visual_script/doc_classes/VisualScriptLists.xml +++ b/modules/visual_script/doc_classes/VisualScriptLists.xml @@ -11,64 +11,64 @@ - - - + + + 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/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml index 2eb99dc25f..97c4f8ce76 100644 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -11,7 +11,7 @@ - + Returns the default value of a given port. The default value is used when nothing is connected to the port. @@ -30,8 +30,8 @@ - - + + Change the default value of a given port. -- cgit v1.2.3