From 7adf4cc9b5de6701a41e27690a69b9892d5eed85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 30 Jul 2021 15:28:05 +0200 Subject: 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. --- modules/visual_script/doc_classes/VisualScript.xml | 369 +++++++-------------- 1 file changed, 123 insertions(+), 246 deletions(-) (limited to 'modules/visual_script/doc_classes/VisualScript.xml') diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index 9d51bd86a2..2327fc0009 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/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. -- cgit v1.2.3