From 677e95d8d189a62e6473b43989012a8258f193a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 15 Nov 2017 19:23:20 +0100 Subject: doc: Make all module docs self-contained --- doc/classes/AudioStreamOGGVorbis.xml | 70 --- doc/classes/BulletPhysicsDirectBodyState.xml | 15 - doc/classes/BulletPhysicsServer.xml | 15 - doc/classes/GDFunctionState.xml | 46 -- doc/classes/GDNativeClass.xml | 21 - doc/classes/GDScript.xml | 38 -- doc/classes/NetworkedMultiplayerENet.xml | 85 ---- doc/classes/PluginScript.xml | 15 - doc/classes/RegEx.xml | 134 ------ doc/classes/RegExMatch.xml | 75 --- doc/classes/ResourceImporterOGGVorbis.xml | 15 - doc/classes/VisualScript.xml | 515 --------------------- doc/classes/VisualScriptBasicTypeConstant.xml | 53 --- doc/classes/VisualScriptBuiltinFunc.xml | 219 --------- doc/classes/VisualScriptClassConstant.xml | 57 --- doc/classes/VisualScriptComment.xml | 71 --- doc/classes/VisualScriptCondition.xml | 24 - doc/classes/VisualScriptConstant.xml | 57 --- doc/classes/VisualScriptConstructor.xml | 69 --- doc/classes/VisualScriptCustomNode.xml | 165 ------- doc/classes/VisualScriptDeconstruct.xml | 38 -- doc/classes/VisualScriptEmitSignal.xml | 40 -- doc/classes/VisualScriptEngineSingleton.xml | 36 -- doc/classes/VisualScriptExpression.xml | 15 - doc/classes/VisualScriptFunction.xml | 15 - doc/classes/VisualScriptFunctionCall.xml | 199 -------- doc/classes/VisualScriptFunctionState.xml | 41 -- doc/classes/VisualScriptGlobalConstant.xml | 33 -- doc/classes/VisualScriptIndexGet.xml | 15 - doc/classes/VisualScriptIndexSet.xml | 15 - doc/classes/VisualScriptInputAction.xml | 57 --- doc/classes/VisualScriptIterator.xml | 24 - doc/classes/VisualScriptLocalVar.xml | 57 --- doc/classes/VisualScriptLocalVarSet.xml | 59 --- doc/classes/VisualScriptMathConstant.xml | 66 --- doc/classes/VisualScriptNode.xml | 62 --- doc/classes/VisualScriptOperator.xml | 54 --- doc/classes/VisualScriptPreload.xml | 40 -- doc/classes/VisualScriptPropertyGet.xml | 137 ------ doc/classes/VisualScriptPropertySet.xml | 177 ------- doc/classes/VisualScriptResourcePath.xml | 33 -- doc/classes/VisualScriptReturn.xml | 58 --- doc/classes/VisualScriptSceneNode.xml | 40 -- doc/classes/VisualScriptSceneTree.xml | 15 - doc/classes/VisualScriptSelect.xml | 42 -- doc/classes/VisualScriptSelf.xml | 21 - doc/classes/VisualScriptSequence.xml | 42 -- doc/classes/VisualScriptSubCall.xml | 23 - doc/classes/VisualScriptSwitch.xml | 26 -- doc/classes/VisualScriptTypeCast.xml | 49 -- doc/classes/VisualScriptVariableGet.xml | 40 -- doc/classes/VisualScriptVariableSet.xml | 41 -- doc/classes/VisualScriptWhile.xml | 23 - doc/classes/VisualScriptYield.xml | 55 --- doc/classes/VisualScriptYieldSignal.xml | 87 ---- modules/bullet/config.py | 10 +- .../doc_classes/BulletPhysicsDirectBodyState.xml | 15 + modules/bullet/doc_classes/BulletPhysicsServer.xml | 15 + modules/dds/config.py | 2 - modules/enet/config.py | 10 +- .../enet/doc_classes/NetworkedMultiplayerENet.xml | 85 ++++ modules/etc/config.py | 2 - modules/freetype/config.py | 2 - modules/gdnative/config.py | 11 +- modules/gdnative/doc_classes/PluginScript.xml | 15 + modules/gdscript/config.py | 13 +- modules/gdscript/doc_classes/GDFunctionState.xml | 46 ++ modules/gdscript/doc_classes/GDNativeClass.xml | 21 + modules/gdscript/doc_classes/GDScript.xml | 38 ++ modules/gridmap/config.py | 9 +- modules/hdr/config.py | 2 - modules/jpg/config.py | 2 - modules/mobile_vr/config.py | 12 +- modules/mono/config.py | 6 +- modules/ogg/config.py | 2 - modules/openssl/config.py | 2 - modules/opus/config.py | 10 +- modules/pbm/config.py | 2 - modules/pvr/config.py | 2 - modules/recast/config.py | 2 - modules/regex/config.py | 13 +- modules/regex/doc_classes/RegEx.xml | 134 ++++++ modules/regex/doc_classes/RegExMatch.xml | 75 +++ modules/squish/config.py | 2 - modules/stb_vorbis/config.py | 11 +- .../doc_classes/AudioStreamOGGVorbis.xml | 70 +++ .../doc_classes/ResourceImporterOGGVorbis.xml | 15 + modules/svg/config.py | 2 - modules/tga/config.py | 2 - modules/theora/config.py | 11 +- modules/tinyexr/config.py | 2 - modules/visual_script/config.py | 51 +- modules/visual_script/doc_classes/VisualScript.xml | 515 +++++++++++++++++++++ .../doc_classes/VisualScriptBasicTypeConstant.xml | 53 +++ .../doc_classes/VisualScriptBuiltinFunc.xml | 219 +++++++++ .../doc_classes/VisualScriptClassConstant.xml | 57 +++ .../doc_classes/VisualScriptComment.xml | 71 +++ .../doc_classes/VisualScriptCondition.xml | 24 + .../doc_classes/VisualScriptConstant.xml | 57 +++ .../doc_classes/VisualScriptConstructor.xml | 69 +++ .../doc_classes/VisualScriptCustomNode.xml | 165 +++++++ .../doc_classes/VisualScriptDeconstruct.xml | 38 ++ .../doc_classes/VisualScriptEmitSignal.xml | 40 ++ .../doc_classes/VisualScriptEngineSingleton.xml | 36 ++ .../doc_classes/VisualScriptExpression.xml | 15 + .../doc_classes/VisualScriptFunction.xml | 15 + .../doc_classes/VisualScriptFunctionCall.xml | 199 ++++++++ .../doc_classes/VisualScriptFunctionState.xml | 41 ++ .../doc_classes/VisualScriptGlobalConstant.xml | 33 ++ .../doc_classes/VisualScriptIndexGet.xml | 15 + .../doc_classes/VisualScriptIndexSet.xml | 15 + .../doc_classes/VisualScriptInputAction.xml | 57 +++ .../doc_classes/VisualScriptIterator.xml | 24 + .../doc_classes/VisualScriptLocalVar.xml | 57 +++ .../doc_classes/VisualScriptLocalVarSet.xml | 59 +++ .../doc_classes/VisualScriptMathConstant.xml | 66 +++ .../visual_script/doc_classes/VisualScriptNode.xml | 62 +++ .../doc_classes/VisualScriptOperator.xml | 54 +++ .../doc_classes/VisualScriptPreload.xml | 40 ++ .../doc_classes/VisualScriptPropertyGet.xml | 137 ++++++ .../doc_classes/VisualScriptPropertySet.xml | 177 +++++++ .../doc_classes/VisualScriptResourcePath.xml | 33 ++ .../doc_classes/VisualScriptReturn.xml | 58 +++ .../doc_classes/VisualScriptSceneNode.xml | 40 ++ .../doc_classes/VisualScriptSceneTree.xml | 15 + .../doc_classes/VisualScriptSelect.xml | 42 ++ .../visual_script/doc_classes/VisualScriptSelf.xml | 21 + .../doc_classes/VisualScriptSequence.xml | 42 ++ .../doc_classes/VisualScriptSubCall.xml | 23 + .../doc_classes/VisualScriptSwitch.xml | 26 ++ .../doc_classes/VisualScriptTypeCast.xml | 49 ++ .../doc_classes/VisualScriptVariableGet.xml | 40 ++ .../doc_classes/VisualScriptVariableSet.xml | 41 ++ .../doc_classes/VisualScriptWhile.xml | 23 + .../doc_classes/VisualScriptYield.xml | 55 +++ .../doc_classes/VisualScriptYieldSignal.xml | 87 ++++ modules/vorbis/config.py | 2 - modules/webm/config.py | 11 +- modules/webp/config.py | 2 - 139 files changed, 3676 insertions(+), 3602 deletions(-) delete mode 100644 doc/classes/AudioStreamOGGVorbis.xml delete mode 100644 doc/classes/BulletPhysicsDirectBodyState.xml delete mode 100644 doc/classes/BulletPhysicsServer.xml delete mode 100644 doc/classes/GDFunctionState.xml delete mode 100644 doc/classes/GDNativeClass.xml delete mode 100644 doc/classes/GDScript.xml delete mode 100644 doc/classes/NetworkedMultiplayerENet.xml delete mode 100644 doc/classes/PluginScript.xml delete mode 100644 doc/classes/RegEx.xml delete mode 100644 doc/classes/RegExMatch.xml delete mode 100644 doc/classes/ResourceImporterOGGVorbis.xml delete mode 100644 doc/classes/VisualScript.xml delete mode 100644 doc/classes/VisualScriptBasicTypeConstant.xml delete mode 100644 doc/classes/VisualScriptBuiltinFunc.xml delete mode 100644 doc/classes/VisualScriptClassConstant.xml delete mode 100644 doc/classes/VisualScriptComment.xml delete mode 100644 doc/classes/VisualScriptCondition.xml delete mode 100644 doc/classes/VisualScriptConstant.xml delete mode 100644 doc/classes/VisualScriptConstructor.xml delete mode 100644 doc/classes/VisualScriptCustomNode.xml delete mode 100644 doc/classes/VisualScriptDeconstruct.xml delete mode 100644 doc/classes/VisualScriptEmitSignal.xml delete mode 100644 doc/classes/VisualScriptEngineSingleton.xml delete mode 100644 doc/classes/VisualScriptExpression.xml delete mode 100644 doc/classes/VisualScriptFunction.xml delete mode 100644 doc/classes/VisualScriptFunctionCall.xml delete mode 100644 doc/classes/VisualScriptFunctionState.xml delete mode 100644 doc/classes/VisualScriptGlobalConstant.xml delete mode 100644 doc/classes/VisualScriptIndexGet.xml delete mode 100644 doc/classes/VisualScriptIndexSet.xml delete mode 100644 doc/classes/VisualScriptInputAction.xml delete mode 100644 doc/classes/VisualScriptIterator.xml delete mode 100644 doc/classes/VisualScriptLocalVar.xml delete mode 100644 doc/classes/VisualScriptLocalVarSet.xml delete mode 100644 doc/classes/VisualScriptMathConstant.xml delete mode 100644 doc/classes/VisualScriptNode.xml delete mode 100644 doc/classes/VisualScriptOperator.xml delete mode 100644 doc/classes/VisualScriptPreload.xml delete mode 100644 doc/classes/VisualScriptPropertyGet.xml delete mode 100644 doc/classes/VisualScriptPropertySet.xml delete mode 100644 doc/classes/VisualScriptResourcePath.xml delete mode 100644 doc/classes/VisualScriptReturn.xml delete mode 100644 doc/classes/VisualScriptSceneNode.xml delete mode 100644 doc/classes/VisualScriptSceneTree.xml delete mode 100644 doc/classes/VisualScriptSelect.xml delete mode 100644 doc/classes/VisualScriptSelf.xml delete mode 100644 doc/classes/VisualScriptSequence.xml delete mode 100644 doc/classes/VisualScriptSubCall.xml delete mode 100644 doc/classes/VisualScriptSwitch.xml delete mode 100644 doc/classes/VisualScriptTypeCast.xml delete mode 100644 doc/classes/VisualScriptVariableGet.xml delete mode 100644 doc/classes/VisualScriptVariableSet.xml delete mode 100644 doc/classes/VisualScriptWhile.xml delete mode 100644 doc/classes/VisualScriptYield.xml delete mode 100644 doc/classes/VisualScriptYieldSignal.xml create mode 100644 modules/bullet/doc_classes/BulletPhysicsDirectBodyState.xml create mode 100644 modules/bullet/doc_classes/BulletPhysicsServer.xml create mode 100644 modules/enet/doc_classes/NetworkedMultiplayerENet.xml create mode 100644 modules/gdnative/doc_classes/PluginScript.xml create mode 100644 modules/gdscript/doc_classes/GDFunctionState.xml create mode 100644 modules/gdscript/doc_classes/GDNativeClass.xml create mode 100644 modules/gdscript/doc_classes/GDScript.xml create mode 100644 modules/regex/doc_classes/RegEx.xml create mode 100644 modules/regex/doc_classes/RegExMatch.xml create mode 100644 modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml create mode 100644 modules/stb_vorbis/doc_classes/ResourceImporterOGGVorbis.xml create mode 100644 modules/visual_script/doc_classes/VisualScript.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptClassConstant.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptComment.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptCondition.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptConstant.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptConstructor.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptCustomNode.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptDeconstruct.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptEmitSignal.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptExpression.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptFunction.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptFunctionCall.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptFunctionState.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptIndexGet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptIndexSet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptInputAction.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptIterator.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptLocalVar.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptMathConstant.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptNode.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptOperator.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptPreload.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptPropertyGet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptPropertySet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptResourcePath.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptReturn.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSceneNode.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSceneTree.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSelect.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSelf.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSequence.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSubCall.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptSwitch.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptTypeCast.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptVariableGet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptVariableSet.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptWhile.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptYield.xml create mode 100644 modules/visual_script/doc_classes/VisualScriptYieldSignal.xml diff --git a/doc/classes/AudioStreamOGGVorbis.xml b/doc/classes/AudioStreamOGGVorbis.xml deleted file mode 100644 index ee6c28c36a..0000000000 --- a/doc/classes/AudioStreamOGGVorbis.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - OGG Vorbis audio stream driver. - - - OGG Vorbis audio stream driver. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Raw audio data. - - - If [code]true[/code], audio will loop continuously. Default value: [code]false[/code]. - - - If loop is [code]true[/code], loop starts from this position, in seconds. - - - - - diff --git a/doc/classes/BulletPhysicsDirectBodyState.xml b/doc/classes/BulletPhysicsDirectBodyState.xml deleted file mode 100644 index 831b346942..0000000000 --- a/doc/classes/BulletPhysicsDirectBodyState.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/BulletPhysicsServer.xml b/doc/classes/BulletPhysicsServer.xml deleted file mode 100644 index 4b5c2e6d83..0000000000 --- a/doc/classes/BulletPhysicsServer.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/GDFunctionState.xml b/doc/classes/GDFunctionState.xml deleted file mode 100644 index e1aafa8a5b..0000000000 --- a/doc/classes/GDFunctionState.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - State of a function call after yielding. - - - Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object. - - - - - - - - - - - - - Check whether the function call may be resumed. This is not the case if the function state was already resumed. - If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. - - - - - - - - - Resume execution of the yielded function call. - If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. - This function returns what the resumed function call returns, possibly another function state if yielded again. - - - - - - - - - - - - - - diff --git a/doc/classes/GDNativeClass.xml b/doc/classes/GDNativeClass.xml deleted file mode 100644 index 95789e1b63..0000000000 --- a/doc/classes/GDNativeClass.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/GDScript.xml b/doc/classes/GDScript.xml deleted file mode 100644 index 13d45aa520..0000000000 --- a/doc/classes/GDScript.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - A script implemented in the GDScript programming language. - - - A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. - [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. - - - - - - - - - - - Returns byte code for the script source code. - - - - - - - Returns a new instance of the script. - For example: - [codeblock] - var MyClass = load("myclass.gd") - var instance = MyClass.new() - assert(instance.get_script() == MyClass) - [/codeblock] - - - - - - diff --git a/doc/classes/NetworkedMultiplayerENet.xml b/doc/classes/NetworkedMultiplayerENet.xml deleted file mode 100644 index 70ef6aef20..0000000000 --- a/doc/classes/NetworkedMultiplayerENet.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - PacketPeer implementation using the ENet library. - - - A connection (or a listening server) that should be passed to [method SceneTree.set_network_peer]. Socket events can be handled by connecting to [SceneTree] signals. - - - - - - - - - - - - - - - - - - - - - - - - - Create client that connects to a server at address [code]ip[/code] using specified [code]port[/code]. - - - - - - - - - - - - - - - Create server that listens to connections via [code]port[/code]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/PluginScript.xml b/doc/classes/PluginScript.xml deleted file mode 100644 index a5ab422d3c..0000000000 --- a/doc/classes/PluginScript.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/RegEx.xml b/doc/classes/RegEx.xml deleted file mode 100644 index 4cf272fe8c..0000000000 --- a/doc/classes/RegEx.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - Class for searching text for patterns using regular expressions. - - - Regular Expression (or regex) is a compact programming language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of [code]ab[0-9][/code] would find any string that is [code]ab[/code] followed by any number from [code]0[/code] to [code]9[/code]. For a more in-depth look, you can easily find various tutorials and detailed explainations on the Internet. - To begin, the RegEx object needs to be compiled with the search pattern using [method compile] before it can be used. - [codeblock] - var regex = RegEx.new() - regex.compile("\\w-(\\d+)") - [/codeblock] - The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, [code]compile("\\d+")[/code] would be read by RegEx as [code]\d+[/code]. Similarly, [code]compile("\"(?:\\\\.|[^\"])*\"")[/code] would be read as [code]"(?:\\.|[^"])*"[/code] - Using [method search] you can find the pattern within the given text. If a pattern is found, [RegExMatch] is returned and you can retrieve details of the results using fuctions such as [method RegExMatch.get_string] and [method RegExMatch.get_start]. - [codeblock] - var regex = RegEx.new() - regex.compile("\\w-(\\d+)") - var result = regex.search("abc n-0123") - if result: - print(result.get_string()) # Would print n-0123 - [/codeblock] - The results of capturing groups [code]()[/code] can be retrieved by passing the group number to the various functions in [RegExMatch]. Group 0 is the default and would always refer to the entire pattern. In the above example, calling [code]result.get_string(1)[/code] would give you [code]0123[/code]. - This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match. - [codeblock] - var regex = RegEx.new() - regex.compile("d(?<digit>[0-9]+)|x(?<digit>[0-9a-f]+)") - var result = regex.search("the number is x2f") - if result: - print(result.get_string("digit")) # Would print 2f - [/codeblock] - If you need to process multiple results, [method search_all] generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. - [codeblock] - for result in regex.search_all("d01, d03, d0c, x3f and x42"): - print(result.get_string("digit")) - # Would print 01 03 3f 42 - # Note that d0c would not match - [/codeblock] - - - - - - - - - - - This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. - - - - - - - - - Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. - - - - - - - Returns the number of capturing groups in compiled pattern. - - - - - - - Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. - - - - - - - Returns the original search pattern that was compiled. - - - - - - - Returns whether this object has a valid search pattern assigned. - - - - - - - - - - - - - Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. - - - - - - - - - - - - - Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. - - - - - - - - - - - - - - - - - Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. - - - - - - diff --git a/doc/classes/RegExMatch.xml b/doc/classes/RegExMatch.xml deleted file mode 100644 index 354febf89a..0000000000 --- a/doc/classes/RegExMatch.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - Contains the results of a regex search. - - - Contains the results of a single regex match returned by [method RegEx.search] and [method.RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. - - - - - - - - - - - - - Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. - Returns -1 if the group did not match or doesn't exist. - - - - - - - Returns the number of capturing groups. - - - - - - - Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. - - - - - - - - - Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. - Returns -1 if the group did not match or doesn't exist. - - - - - - - - - Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. - Returns an empty string if the group did not match or doesn't exist. - - - - - - - Returns an [Array] of the match and its capturing groups. - - - - - - - Returns the source string used with the search pattern to find this matching result. - - - - - - diff --git a/doc/classes/ResourceImporterOGGVorbis.xml b/doc/classes/ResourceImporterOGGVorbis.xml deleted file mode 100644 index ce16632d6e..0000000000 --- a/doc/classes/ResourceImporterOGGVorbis.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScript.xml b/doc/classes/VisualScript.xml deleted file mode 100644 index 80b1ed86d7..0000000000 --- a/doc/classes/VisualScript.xml +++ /dev/null @@ -1,515 +0,0 @@ - - - - A script implemented in the Visual Script programming environment. - - - A script implemented in the Visual Script programming environment. The script extends 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. - - - - - - - - - - - - - Add a custom signal with the specified name to the VisualScript. - - - - - - - - - Add a function with the specified name to the VisualScript. - - - - - - - - - - - - - - - Add a node to a function of 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 the position of the center of the screen for a given function. - - - - - - - - - - - Returns a node given its id and its function. - - - - - - - - - - - Returns a node's position in pixels. - - - - - - - - - Returns the default (initial) value of a variable. - - - - - - - - - Returns whether a variable is exported. - - - - - - - - - Returns the info 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 a specific node. - - - - - - - - - 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]. - - - - - - - - - - - Position the center of the screen for a function. - - - - - - - - - Set the base type of the script. - - - - - - - - - - - - - Position a node on the screen. - - - - - - - - - - - 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]. - - - - - - - - - - - - - - - Emitted when the ports of a node are changed. - - - - - - diff --git a/doc/classes/VisualScriptBasicTypeConstant.xml b/doc/classes/VisualScriptBasicTypeConstant.xml deleted file mode 100644 index 6c028e5f28..0000000000 --- a/doc/classes/VisualScriptBasicTypeConstant.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - A Visual Script node representing a constant from the base types. - - - A Visual Script node representing a constant from base types, such as [Vector3.AXIS_X]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The type to get the constant from. - - - The name of the constant to return. - - - - - diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml deleted file mode 100644 index 27231574d7..0000000000 --- a/doc/classes/VisualScriptBuiltinFunc.xml +++ /dev/null @@ -1,219 +0,0 @@ - - - - A Visual Script node used to call built-in functions. - - - A built-in function used inside a [VisualScript]. It is usually a math function or an utility function. - See also [@GDScript], for the same functions in the GDScript language. - - - - - - - - - - - - - - - - - - - - - - - - The function to be executed. - - - - - Return the sine of the input. - - - Return the cosine of the input. - - - Return the tangent of the input. - - - Return the hyperbolic sine of the input. - - - Return the hyperbolic cosine of the input. - - - Return the hyperbolic tangent of the input. - - - Return the arc sine of the input. - - - Return the arc cosine of the input. - - - Return the arc tangent of the input. - - - Return the arc tangent of the input, using the signs of both parameters to determine the exact angle. - - - Return the square root of the input. - - - Return the remainder of one input divided by the other, using floating-point numbers. - - - Return the positive remainder of one input divided by the other, using floating-point numbers. - - - Return the input rounded down. - - - Return the input rounded up. - - - Return the input rounded to the nearest integer. - - - Return the absolute value of the input. - - - Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. - - - Return the input raised to a given power. - - - Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. - - - Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 2.71828. - - - Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. - - - Return whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist. - - - Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - - - Return the number of digit places after the decimal that the first non-zero digit occurs. - - - Return the input snapped to a given step. - - - Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. - - - - - - - Return the result of 'value' decreased by 'step' * 'amount'. - - - Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. - - - Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. - - - Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. - - - Return a random floating-point value between the two inputs. - - - Set the seed for the random number generator. - - - Return a random value from the given seed, along with the new seed. - - - Convert the input from degrees to radians. - - - Convert the input from radians to degrees. - - - Convert the input from linear volume to decibel volume. - - - Convert the input from decibel volume to linear volume. - - - - - - - Return the greater of the two numbers, also known as their maximum. - - - Return the lesser of the two numbers, also known as their minimum. - - - Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` - - - Return the nearest power of 2 to the input. - - - Create a [WeakRef] from the input. - - - Create a [FuncRef] from the input. - - - Convert between types. - - - Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. - - - Checks if a type is registered in the [ClassDB]. - - - Return a character with the given ascii value. - - - Convert the input to a string. - - - Print the given string to the output window. - - - Print the given string to the standard error output. - - - Print the given string to the standard output, without adding a newline. - - - Serialize a [Variant] to a string. - - - Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. - - - Serialize a [Variant] to a [PoolByteArray]. - - - Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. - - - Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. - - - The maximum value the [member function] property can have. - - - diff --git a/doc/classes/VisualScriptClassConstant.xml b/doc/classes/VisualScriptClassConstant.xml deleted file mode 100644 index e6498e92ad..0000000000 --- a/doc/classes/VisualScriptClassConstant.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - Gets a constant from a given class. - - - This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]value[/code] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The constant's parent class. - - - The constant to return. See the given class for its available constants. - - - - - diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml deleted file mode 100644 index ea4545f8ef..0000000000 --- a/doc/classes/VisualScriptComment.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - A Visual Script node used to annotate the script. - - - A Visual Script node used to display annotations in the script, so that code may be documented. - Comment nodes can be resized so they encompass a group of nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The text inside the comment node. - - - The comment node's size (in pixels). - - - The comment node's title. - - - - - diff --git a/doc/classes/VisualScriptCondition.xml b/doc/classes/VisualScriptCondition.xml deleted file mode 100644 index 2a30c604a5..0000000000 --- a/doc/classes/VisualScriptCondition.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - A Visual Script node which branches the flow. - - - A Visual Script node that checks a [bool] input port. If [code]true[/code] it will exit via the “true” sequence port. If [code]false[/code] it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected. - [b]Input Ports:[/b] - - Sequence: [code]if (cond) is[/code] - - Data (boolean): [code]cond[/code] - [b]Output Ports:[/b] - - Sequence: [code]true[/code] - - Sequence: [code]false[/code] - - Sequence: [code]done[/code] - - - - - - - - - - diff --git a/doc/classes/VisualScriptConstant.xml b/doc/classes/VisualScriptConstant.xml deleted file mode 100644 index 51c6d19238..0000000000 --- a/doc/classes/VisualScriptConstant.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - Gets a contant's value. - - - This node returns a constant's value. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]get[/code] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The constant's type. - - - The constant's value. - - - - - diff --git a/doc/classes/VisualScriptConstructor.xml b/doc/classes/VisualScriptConstructor.xml deleted file mode 100644 index 91df52e893..0000000000 --- a/doc/classes/VisualScriptConstructor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - A Visual Script node which calls a base type constructor. - - - A Visual Script node which calls a base type constructor. It can be used for type conversion as well. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The constructor function's method info. Has roughly the following structure: - [codeblock] - { - name = "string", - args = [{ - name = "string" - class_name = "string" - type = TYPE_* - hint = PROPERTY_HINT_* - hint_string = "string" - }] - default_args = [] # Array of variants - flags = METHOD_FLAG_* - id = 0 - return = {type = TYPE_*} - } - [/codeblock] - - - The type to be constructed. - - - - - diff --git a/doc/classes/VisualScriptCustomNode.xml b/doc/classes/VisualScriptCustomNode.xml deleted file mode 100644 index 38c325cfb7..0000000000 --- a/doc/classes/VisualScriptCustomNode.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - A scripted Visual Script node. - - - A custom Visual Script node which can be scripted in powerful ways. - - - - - - - - - - - Return the node's title. - - - - - - - Return the node's category. - - - - - - - Return the count of input value ports. - - - - - - - - - Return the specified input port's name. - - - - - - - - - Return the specified input port's type. See the TYPE_* enum in [@GlobalScope]. - - - - - - - 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's name. - - - - - - - - - Return the specified output's type. See the TYPE_* enum in [@GlobalScope]. - - - - - - - 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. - [code]outputs[/code] is an array whose indices should be set to the respective outputs. - The [code]start_mode[/code] is usually [code]START_MODE_BEGIN_SEQUENCE[/code], unless you have used the STEP_* constants. - [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. - - When returning, you can mask the returned value with one of the STEP_* constants. - - - - - - The start mode used the first time when [method _step] is called. - - - The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT. - - - The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT. - - - Hint used by [method _step] to tell that control should return to it when there is no other node left to execute. - This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the true/false branch has finished execution. - - - Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. - - - - - Hint used by [method _step] to tell that control should stop and exit the function. - - - Hint used by [method _step] to tell that the function should be yielded. - Using this requires you to have at least one working memory slot, which is used for the [VisualScriptFunctionState]. - - - diff --git a/doc/classes/VisualScriptDeconstruct.xml b/doc/classes/VisualScriptDeconstruct.xml deleted file mode 100644 index cbed3ba22c..0000000000 --- a/doc/classes/VisualScriptDeconstruct.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - A Visual Script node which deconstructs a base type instance into its parts. - - - A Visual Script node which deconstructs a base type instance into its parts. - - - - - - - - - - - - - - - - - - - - - - - - - - The type to deconstruct. - - - - - diff --git a/doc/classes/VisualScriptEmitSignal.xml b/doc/classes/VisualScriptEmitSignal.xml deleted file mode 100644 index 669276f0d0..0000000000 --- a/doc/classes/VisualScriptEmitSignal.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Emits a specified signal. - - - Emits a specified signal when it is executed. - [b]Input Ports:[/b] - - Sequence: [code]emit[/code] - [b]Output Ports:[/b] - - Sequence - - - - - - - - - - - - - - - - - - - - - - - - The signal to emit. - - - - - diff --git a/doc/classes/VisualScriptEngineSingleton.xml b/doc/classes/VisualScriptEngineSingleton.xml deleted file mode 100644 index 6703ff4eda..0000000000 --- a/doc/classes/VisualScriptEngineSingleton.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - A Visual Script node returning a singleton from [@GlobalScope] - - - A Visual Script node returning a singleton from [@GlobalScope] - - - - - - - - - - - - - - - - - - - - - - - - The singleton's name. - - - - - diff --git a/doc/classes/VisualScriptExpression.xml b/doc/classes/VisualScriptExpression.xml deleted file mode 100644 index fb3b6ef19d..0000000000 --- a/doc/classes/VisualScriptExpression.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptFunction.xml b/doc/classes/VisualScriptFunction.xml deleted file mode 100644 index d77169679b..0000000000 --- a/doc/classes/VisualScriptFunction.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptFunctionCall.xml b/doc/classes/VisualScriptFunctionCall.xml deleted file mode 100644 index 7a0a7c9f55..0000000000 --- a/doc/classes/VisualScriptFunctionCall.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptFunctionState.xml b/doc/classes/VisualScriptFunctionState.xml deleted file mode 100644 index 9b30f62236..0000000000 --- a/doc/classes/VisualScriptFunctionState.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptGlobalConstant.xml b/doc/classes/VisualScriptGlobalConstant.xml deleted file mode 100644 index 961244fe88..0000000000 --- a/doc/classes/VisualScriptGlobalConstant.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptIndexGet.xml b/doc/classes/VisualScriptIndexGet.xml deleted file mode 100644 index c5229f7678..0000000000 --- a/doc/classes/VisualScriptIndexGet.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptIndexSet.xml b/doc/classes/VisualScriptIndexSet.xml deleted file mode 100644 index 27646b4a5f..0000000000 --- a/doc/classes/VisualScriptIndexSet.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptInputAction.xml b/doc/classes/VisualScriptInputAction.xml deleted file mode 100644 index 7f6d13264e..0000000000 --- a/doc/classes/VisualScriptInputAction.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptIterator.xml b/doc/classes/VisualScriptIterator.xml deleted file mode 100644 index fc905d6c39..0000000000 --- a/doc/classes/VisualScriptIterator.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - Steps through items in a given input. - - - This node steps through each item in a given input. Input can be any sequence data type, such as an [Array] or [String]. When each item has been processed, execution passed out the [code]exit[/code] Sequence port. - [b]Input Ports:[/b] - - Sequence: [code]for (elem) in (input)[/code] - - Data (variant): [code]input[/code] - [b]Output Ports:[/b] - - Sequence: [code]each[/code] - - Sequence: [code]exit[/code] - - Data (variant): [code]elem[/code] - - - - - - - - - - diff --git a/doc/classes/VisualScriptLocalVar.xml b/doc/classes/VisualScriptLocalVar.xml deleted file mode 100644 index ff77dfac0d..0000000000 --- a/doc/classes/VisualScriptLocalVar.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - Gets a local variable's value. - - - Returns a local variable's value. "Var Name" must be supplied, with an optional type. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]get[/code] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The local variable's type. - - - The local variable's name. - - - - - diff --git a/doc/classes/VisualScriptLocalVarSet.xml b/doc/classes/VisualScriptLocalVarSet.xml deleted file mode 100644 index 07b01d4576..0000000000 --- a/doc/classes/VisualScriptLocalVarSet.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - Changes a local variable's value. - - - Changes a local variable's value to the given input. The new value is also provided on an output Data port. - [b]Input Ports:[/b] - - Sequence - - Data (variant): [code]set[/code] - [b]Output Ports:[/b] - - Sequence - - Data (variant): [code]get[/code] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The local variable's type. - - - The local variable's name. - - - - - diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml deleted file mode 100644 index 817bcb5ce2..0000000000 --- a/doc/classes/VisualScriptMathConstant.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - Commonly used mathematical constants. - - - Provides common math constants, such as Pi or Euler's constant, on an output Data port. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]get[/code] - - - - - - - - - - - - - - - - - - - - - - - - The math constant. - - - - - Unity: [code]1[/code] - - - Pi: [code]3.141593[/code] - - - Pi divided by two: [code]1.570796[/code] - - - Tau: [code]6.283185[/code] - - - Natural log: [code]2.718282[/code] - - - Square root of two: [code]1.414214[/code] - - - Infinity: [code]inf[/code] - - - Not a number: [code]nan[/code] - - - - - diff --git a/doc/classes/VisualScriptNode.xml b/doc/classes/VisualScriptNode.xml deleted file mode 100644 index f6f2867172..0000000000 --- a/doc/classes/VisualScriptNode.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - A node which is part of a [VisualScript]. - - - A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree]. - - - - - - - - - - - - - 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. - - - - - - - - - - - Emitted when the available input/output ports are changed. - - - - - - diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml deleted file mode 100644 index bf4032c09c..0000000000 --- a/doc/classes/VisualScriptOperator.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - [b]Input Ports:[/b] - - Data (variant): [code]A[/code] - - Data (variant): [code]B[/code] - [b]Output Ports:[/b] - - Data (variant): [code]result[/code] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptPreload.xml b/doc/classes/VisualScriptPreload.xml deleted file mode 100644 index 4a71e23809..0000000000 --- a/doc/classes/VisualScriptPreload.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Creates a new [Resource] or loads one from the filesystem. - - - Creates a new [Resource] or loads one from the filesystem. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (object): [code]res[/code] - - - - - - - - - - - - - - - - - - - - - - - - The [Resource] to load. - - - - - diff --git a/doc/classes/VisualScriptPropertyGet.xml b/doc/classes/VisualScriptPropertyGet.xml deleted file mode 100644 index eb5c52f4be..0000000000 --- a/doc/classes/VisualScriptPropertyGet.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptPropertySet.xml b/doc/classes/VisualScriptPropertySet.xml deleted file mode 100644 index 794caa2518..0000000000 --- a/doc/classes/VisualScriptPropertySet.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptResourcePath.xml b/doc/classes/VisualScriptResourcePath.xml deleted file mode 100644 index 274a852c3e..0000000000 --- a/doc/classes/VisualScriptResourcePath.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptReturn.xml b/doc/classes/VisualScriptReturn.xml deleted file mode 100644 index 4ac586a02c..0000000000 --- a/doc/classes/VisualScriptReturn.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - Exits a function and returns an optional value. - - - Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value. - [b]Input Ports:[/b] - - Sequence - - Data (variant): [code]result[/code] (optional) - [b]Output Ports:[/b] - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - If [code]true[/code] the [code]return[/code] input port is available. - - - The return value's data type. - - - - - diff --git a/doc/classes/VisualScriptSceneNode.xml b/doc/classes/VisualScriptSceneNode.xml deleted file mode 100644 index e8fdb69c6a..0000000000 --- a/doc/classes/VisualScriptSceneNode.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Node reference. - - - A direct reference to a node. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data: [code]node[/code] (obj) - - - - - - - - - - - - - - - - - - - - - - - - The node's path in the scene tree. - - - - - diff --git a/doc/classes/VisualScriptSceneTree.xml b/doc/classes/VisualScriptSceneTree.xml deleted file mode 100644 index e74c330623..0000000000 --- a/doc/classes/VisualScriptSceneTree.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptSelect.xml b/doc/classes/VisualScriptSelect.xml deleted file mode 100644 index 6a62e364f3..0000000000 --- a/doc/classes/VisualScriptSelect.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - Chooses between two input values. - - - Chooses between two input values based on a Boolean condition. - [b]Input Ports:[/b] - - Data (boolean): [code]cond[/code] - - Data (variant): [code]a[/code] - - Data (variant): [code]b[/code] - [b]Output Ports:[/b] - - Data (variant): [code]out[/code] - - - - - - - - - - - - - - - - - - - - - - - - The input variables' type. - - - - - diff --git a/doc/classes/VisualScriptSelf.xml b/doc/classes/VisualScriptSelf.xml deleted file mode 100644 index f39a02bf84..0000000000 --- a/doc/classes/VisualScriptSelf.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - Outputs a reference to the current instance. - - - Provides a reference to the node running the visual script. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (object): [code]instance[/code] - - - - - - - - - - diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml deleted file mode 100644 index 51238070d5..0000000000 --- a/doc/classes/VisualScriptSequence.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - Executes a series of Sequence ports. - - - Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. - [b]Input Ports:[/b] - - Sequence: [code]in order[/code] - [b]Output Ports:[/b] - - Sequence: [code]1[/code] - - Sequence: [code]2 - n[/code] (optional) - - Data (int): [code]current[/code] - - - - - - - - - - - - - - - - - - - - - - - - The number of steps in the sequence. - - - - - diff --git a/doc/classes/VisualScriptSubCall.xml b/doc/classes/VisualScriptSubCall.xml deleted file mode 100644 index 381095f49b..0000000000 --- a/doc/classes/VisualScriptSubCall.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptSwitch.xml b/doc/classes/VisualScriptSwitch.xml deleted file mode 100644 index 3c8a79f686..0000000000 --- a/doc/classes/VisualScriptSwitch.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - - Branches program flow based on a given input's value. - - - Branches the flow based on an input's value. Use "Case Count" in the Inspector to set the number of branches and each comparison's optional type. - [b]Input Ports:[/b] - - Sequence: [code]'input' is[/code] - - Data (variant): [code]=[/code] - - Data (variant): [code]=[/code] (optional) - - Data (variant): [code]input[/code] - [b]Output Ports:[/b] - - Sequence - - Sequence (optional) - - Sequence: [code]done[/code] - - - - - - - - - - diff --git a/doc/classes/VisualScriptTypeCast.xml b/doc/classes/VisualScriptTypeCast.xml deleted file mode 100644 index 417c0a5159..0000000000 --- a/doc/classes/VisualScriptTypeCast.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptVariableGet.xml b/doc/classes/VisualScriptVariableGet.xml deleted file mode 100644 index 1cad4480a6..0000000000 --- a/doc/classes/VisualScriptVariableGet.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Gets a variable's value. - - - Returns a variable's value. "Var Name" must be supplied, with an optional type. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]value[/code] - - - - - - - - - - - - - - - - - - - - - - - - The variable's name. - - - - - diff --git a/doc/classes/VisualScriptVariableSet.xml b/doc/classes/VisualScriptVariableSet.xml deleted file mode 100644 index fa3befa21d..0000000000 --- a/doc/classes/VisualScriptVariableSet.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - Changes a variable's value. - - - Changes a variable's value to the given input. - [b]Input Ports:[/b] - - Sequence - - Data (variant): [code]set[/code] - [b]Output Ports:[/b] - - Sequence - - - - - - - - - - - - - - - - - - - - - - - - The variable's name. - - - - - diff --git a/doc/classes/VisualScriptWhile.xml b/doc/classes/VisualScriptWhile.xml deleted file mode 100644 index f948660997..0000000000 --- a/doc/classes/VisualScriptWhile.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - Conditional loop. - - - Loops while a condition is [code]true[/code]. Execution continues out the [code]exit[/code] Sequence port when the loop terminates. - [b]Input Ports:[/b] - - Sequence: [code]while(cond)[/code] - - Data (bool): [code]cond[/code] - [b]Output Ports:[/b] - - Sequence: [code]repeat[/code] - - Sequence: [code]exit[/code] - - - - - - - - - - diff --git a/doc/classes/VisualScriptYield.xml b/doc/classes/VisualScriptYield.xml deleted file mode 100644 index 5474ee8b78..0000000000 --- a/doc/classes/VisualScriptYield.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisualScriptYieldSignal.xml b/doc/classes/VisualScriptYieldSignal.xml deleted file mode 100644 index a3b6982075..0000000000 --- a/doc/classes/VisualScriptYieldSignal.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/modules/bullet/config.py b/modules/bullet/config.py index b00ea18328..0a31c2e503 100644 --- a/modules/bullet/config.py +++ b/modules/bullet/config.py @@ -3,4 +3,12 @@ def can_build(platform): def configure(env): pass - + +def get_doc_classes(): + return [ + "BulletPhysicsDirectBodyState", + "BulletPhysicsServer", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/bullet/doc_classes/BulletPhysicsDirectBodyState.xml b/modules/bullet/doc_classes/BulletPhysicsDirectBodyState.xml new file mode 100644 index 0000000000..831b346942 --- /dev/null +++ b/modules/bullet/doc_classes/BulletPhysicsDirectBodyState.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/bullet/doc_classes/BulletPhysicsServer.xml b/modules/bullet/doc_classes/BulletPhysicsServer.xml new file mode 100644 index 0000000000..4b5c2e6d83 --- /dev/null +++ b/modules/bullet/doc_classes/BulletPhysicsServer.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/dds/config.py b/modules/dds/config.py index fb920482f5..5f133eba90 100644 --- a/modules/dds/config.py +++ b/modules/dds/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/enet/config.py b/modules/enet/config.py index fb920482f5..8031fbb4b6 100644 --- a/modules/enet/config.py +++ b/modules/enet/config.py @@ -1,7 +1,13 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "NetworkedMultiplayerENet", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml new file mode 100644 index 0000000000..70ef6aef20 --- /dev/null +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -0,0 +1,85 @@ + + + + PacketPeer implementation using the ENet library. + + + A connection (or a listening server) that should be passed to [method SceneTree.set_network_peer]. Socket events can be handled by connecting to [SceneTree] signals. + + + + + + + + + + + + + + + + + + + + + + + + + Create client that connects to a server at address [code]ip[/code] using specified [code]port[/code]. + + + + + + + + + + + + + + + Create server that listens to connections via [code]port[/code]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/etc/config.py b/modules/etc/config.py index 7dc2cb59c1..395fc1bb02 100644 --- a/modules/etc/config.py +++ b/modules/etc/config.py @@ -1,8 +1,6 @@ - def can_build(platform): return True - def configure(env): # Tools only, disabled for non-tools # TODO: Find a cleaner way to achieve that diff --git a/modules/freetype/config.py b/modules/freetype/config.py index fb920482f5..5f133eba90 100644 --- a/modules/freetype/config.py +++ b/modules/freetype/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/gdnative/config.py b/modules/gdnative/config.py index df3556249d..68148c4d87 100644 --- a/modules/gdnative/config.py +++ b/modules/gdnative/config.py @@ -1,4 +1,3 @@ - def can_build(platform): return True @@ -6,7 +5,13 @@ def configure(env): env.use_ptrcall = True def get_doc_classes(): - return ["GDNative", "GDNativeLibrary", "NativeScript", "ARVRInterfaceGDNative"] + return [ + "ARVRInterfaceGDNative", + "GDNative", + "GDNativeLibrary", + "NativeScript", + "PluginScript", + ] def get_doc_path(): - return "doc_classes" + return "doc_classes" diff --git a/modules/gdnative/doc_classes/PluginScript.xml b/modules/gdnative/doc_classes/PluginScript.xml new file mode 100644 index 0000000000..a5ab422d3c --- /dev/null +++ b/modules/gdnative/doc_classes/PluginScript.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/gdscript/config.py b/modules/gdscript/config.py index 5698a37295..6e8994d643 100644 --- a/modules/gdscript/config.py +++ b/modules/gdscript/config.py @@ -1,8 +1,15 @@ - - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "GDFunctionState", + "GDNativeClass", + "GDScript", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/gdscript/doc_classes/GDFunctionState.xml b/modules/gdscript/doc_classes/GDFunctionState.xml new file mode 100644 index 0000000000..e1aafa8a5b --- /dev/null +++ b/modules/gdscript/doc_classes/GDFunctionState.xml @@ -0,0 +1,46 @@ + + + + State of a function call after yielding. + + + Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object. + + + + + + + + + + + + + Check whether the function call may be resumed. This is not the case if the function state was already resumed. + If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. + + + + + + + + + Resume execution of the yielded function call. + If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. + This function returns what the resumed function call returns, possibly another function state if yielded again. + + + + + + + + + + + + + + diff --git a/modules/gdscript/doc_classes/GDNativeClass.xml b/modules/gdscript/doc_classes/GDNativeClass.xml new file mode 100644 index 0000000000..95789e1b63 --- /dev/null +++ b/modules/gdscript/doc_classes/GDNativeClass.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/gdscript/doc_classes/GDScript.xml b/modules/gdscript/doc_classes/GDScript.xml new file mode 100644 index 0000000000..13d45aa520 --- /dev/null +++ b/modules/gdscript/doc_classes/GDScript.xml @@ -0,0 +1,38 @@ + + + + A script implemented in the GDScript programming language. + + + A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. + [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. + + + + + + + + + + + Returns byte code for the script source code. + + + + + + + Returns a new instance of the script. + For example: + [codeblock] + var MyClass = load("myclass.gd") + var instance = MyClass.new() + assert(instance.get_script() == MyClass) + [/codeblock] + + + + + + diff --git a/modules/gridmap/config.py b/modules/gridmap/config.py index b3dbb9f46a..a93f4edb81 100644 --- a/modules/gridmap/config.py +++ b/modules/gridmap/config.py @@ -1,14 +1,13 @@ - - def can_build(platform): return True - def configure(env): pass def get_doc_classes(): - return ["GridMap"] + return [ + "GridMap", + ] def get_doc_path(): - return "doc_classes" + return "doc_classes" diff --git a/modules/hdr/config.py b/modules/hdr/config.py index fb920482f5..5f133eba90 100644 --- a/modules/hdr/config.py +++ b/modules/hdr/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/jpg/config.py b/modules/jpg/config.py index fb920482f5..5f133eba90 100644 --- a/modules/jpg/config.py +++ b/modules/jpg/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/mobile_vr/config.py b/modules/mobile_vr/config.py index cf96c66125..4e1155f0c6 100644 --- a/modules/mobile_vr/config.py +++ b/modules/mobile_vr/config.py @@ -1,12 +1,14 @@ def can_build(platform): - # should probably change this to only be true on iOS and Android - return True + # should probably change this to only be true on iOS and Android + return True def configure(env): - pass + pass def get_doc_classes(): - return ["MobileVRInterface"] + return [ + "MobileVRInterface", + ] def get_doc_path(): - return "doc_classes" + return "doc_classes" diff --git a/modules/mono/config.py b/modules/mono/config.py index 7ad135e0b9..b4e6433256 100644 --- a/modules/mono/config.py +++ b/modules/mono/config.py @@ -177,7 +177,11 @@ def configure(env): def get_doc_classes(): - return ["@C#", "CSharpScript", "GodotSharp"] + return [ + "@C#", + "CSharpScript", + "GodotSharp", + ] def get_doc_path(): diff --git a/modules/ogg/config.py b/modules/ogg/config.py index fb920482f5..5f133eba90 100644 --- a/modules/ogg/config.py +++ b/modules/ogg/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/openssl/config.py b/modules/openssl/config.py index fb920482f5..5f133eba90 100644 --- a/modules/openssl/config.py +++ b/modules/openssl/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/opus/config.py b/modules/opus/config.py index fb920482f5..60f8d838d6 100644 --- a/modules/opus/config.py +++ b/modules/opus/config.py @@ -1,7 +1,13 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "AudioStreamOpus", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/pbm/config.py b/modules/pbm/config.py index fb920482f5..5f133eba90 100644 --- a/modules/pbm/config.py +++ b/modules/pbm/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/pvr/config.py b/modules/pvr/config.py index fb920482f5..5f133eba90 100644 --- a/modules/pvr/config.py +++ b/modules/pvr/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/recast/config.py b/modules/recast/config.py index d42f07b2a9..fc074cf661 100644 --- a/modules/recast/config.py +++ b/modules/recast/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return platform != "android" - def configure(env): pass diff --git a/modules/regex/config.py b/modules/regex/config.py index 5347cfd243..cb2da26738 100644 --- a/modules/regex/config.py +++ b/modules/regex/config.py @@ -1,9 +1,14 @@ -#!/usr/bin/env python - - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "RegEx", + "RegExMatch", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/regex/doc_classes/RegEx.xml b/modules/regex/doc_classes/RegEx.xml new file mode 100644 index 0000000000..4cf272fe8c --- /dev/null +++ b/modules/regex/doc_classes/RegEx.xml @@ -0,0 +1,134 @@ + + + + Class for searching text for patterns using regular expressions. + + + Regular Expression (or regex) is a compact programming language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of [code]ab[0-9][/code] would find any string that is [code]ab[/code] followed by any number from [code]0[/code] to [code]9[/code]. For a more in-depth look, you can easily find various tutorials and detailed explainations on the Internet. + To begin, the RegEx object needs to be compiled with the search pattern using [method compile] before it can be used. + [codeblock] + var regex = RegEx.new() + regex.compile("\\w-(\\d+)") + [/codeblock] + The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, [code]compile("\\d+")[/code] would be read by RegEx as [code]\d+[/code]. Similarly, [code]compile("\"(?:\\\\.|[^\"])*\"")[/code] would be read as [code]"(?:\\.|[^"])*"[/code] + Using [method search] you can find the pattern within the given text. If a pattern is found, [RegExMatch] is returned and you can retrieve details of the results using fuctions such as [method RegExMatch.get_string] and [method RegExMatch.get_start]. + [codeblock] + var regex = RegEx.new() + regex.compile("\\w-(\\d+)") + var result = regex.search("abc n-0123") + if result: + print(result.get_string()) # Would print n-0123 + [/codeblock] + The results of capturing groups [code]()[/code] can be retrieved by passing the group number to the various functions in [RegExMatch]. Group 0 is the default and would always refer to the entire pattern. In the above example, calling [code]result.get_string(1)[/code] would give you [code]0123[/code]. + This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match. + [codeblock] + var regex = RegEx.new() + regex.compile("d(?<digit>[0-9]+)|x(?<digit>[0-9a-f]+)") + var result = regex.search("the number is x2f") + if result: + print(result.get_string("digit")) # Would print 2f + [/codeblock] + If you need to process multiple results, [method search_all] generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. + [codeblock] + for result in regex.search_all("d01, d03, d0c, x3f and x42"): + print(result.get_string("digit")) + # Would print 01 03 3f 42 + # Note that d0c would not match + [/codeblock] + + + + + + + + + + + This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. + + + + + + + + + Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. + + + + + + + Returns the number of capturing groups in compiled pattern. + + + + + + + Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. + + + + + + + Returns the original search pattern that was compiled. + + + + + + + Returns whether this object has a valid search pattern assigned. + + + + + + + + + + + + + Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. + + + + + + + + + + + + + Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. + + + + + + + + + + + + + + + + + Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. + + + + + + diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml new file mode 100644 index 0000000000..354febf89a --- /dev/null +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -0,0 +1,75 @@ + + + + Contains the results of a regex search. + + + Contains the results of a single regex match returned by [method RegEx.search] and [method.RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. + + + + + + + + + + + + + Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + Returns -1 if the group did not match or doesn't exist. + + + + + + + Returns the number of capturing groups. + + + + + + + Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. + + + + + + + + + Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + Returns -1 if the group did not match or doesn't exist. + + + + + + + + + Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + Returns an empty string if the group did not match or doesn't exist. + + + + + + + Returns an [Array] of the match and its capturing groups. + + + + + + + Returns the source string used with the search pattern to find this matching result. + + + + + + diff --git a/modules/squish/config.py b/modules/squish/config.py index 9b7729bda4..97c95999c8 100644 --- a/modules/squish/config.py +++ b/modules/squish/config.py @@ -1,8 +1,6 @@ - def can_build(platform): return True - def configure(env): # Tools only, disabled for non-tools # TODO: Find a cleaner way to achieve that diff --git a/modules/stb_vorbis/config.py b/modules/stb_vorbis/config.py index fb920482f5..defe8d0c94 100644 --- a/modules/stb_vorbis/config.py +++ b/modules/stb_vorbis/config.py @@ -1,7 +1,14 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "AudioStreamOGGVorbis", + "ResourceImporterOGGVorbis", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml new file mode 100644 index 0000000000..ee6c28c36a --- /dev/null +++ b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml @@ -0,0 +1,70 @@ + + + + OGG Vorbis audio stream driver. + + + OGG Vorbis audio stream driver. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raw audio data. + + + If [code]true[/code], audio will loop continuously. Default value: [code]false[/code]. + + + If loop is [code]true[/code], loop starts from this position, in seconds. + + + + + diff --git a/modules/stb_vorbis/doc_classes/ResourceImporterOGGVorbis.xml b/modules/stb_vorbis/doc_classes/ResourceImporterOGGVorbis.xml new file mode 100644 index 0000000000..ce16632d6e --- /dev/null +++ b/modules/stb_vorbis/doc_classes/ResourceImporterOGGVorbis.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/svg/config.py b/modules/svg/config.py index fb920482f5..5f133eba90 100644 --- a/modules/svg/config.py +++ b/modules/svg/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/tga/config.py b/modules/tga/config.py index fb920482f5..5f133eba90 100644 --- a/modules/tga/config.py +++ b/modules/tga/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/theora/config.py b/modules/theora/config.py index fb920482f5..34d34f8be2 100644 --- a/modules/theora/config.py +++ b/modules/theora/config.py @@ -1,7 +1,14 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "ResourceImporterTheora", + "VideoStreamTheora", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/tinyexr/config.py b/modules/tinyexr/config.py index 3e16fd725e..e12bb398ce 100644 --- a/modules/tinyexr/config.py +++ b/modules/tinyexr/config.py @@ -1,8 +1,6 @@ - def can_build(platform): return True - def configure(env): # Tools only, disabled for non-tools # TODO: Find a cleaner way to achieve that diff --git a/modules/visual_script/config.py b/modules/visual_script/config.py index d10adb09d9..6b1ce41014 100644 --- a/modules/visual_script/config.py +++ b/modules/visual_script/config.py @@ -1,14 +1,57 @@ - - def can_build(platform): return True - def configure(env): pass def get_doc_classes(): - return ["VisualScriptEditor"] + return [ + "VisualScriptBasicTypeConstant", + "VisualScriptBuiltinFunc", + "VisualScriptClassConstant", + "VisualScriptComment", + "VisualScriptCondition", + "VisualScriptConstant", + "VisualScriptConstructor", + "VisualScriptCustomNode", + "VisualScriptDeconstruct", + "VisualScriptEditor", + "VisualScriptEmitSignal", + "VisualScriptEngineSingleton", + "VisualScriptExpression", + "VisualScriptFunctionCall", + "VisualScriptFunctionState", + "VisualScriptFunction", + "VisualScriptGlobalConstant", + "VisualScriptIndexGet", + "VisualScriptIndexSet", + "VisualScriptInputAction", + "VisualScriptIterator", + "VisualScriptLocalVarSet", + "VisualScriptLocalVar", + "VisualScriptMathConstant", + "VisualScriptNode", + "VisualScriptOperator", + "VisualScriptPreload", + "VisualScriptPropertyGet", + "VisualScriptPropertySet", + "VisualScriptResourcePath", + "VisualScriptReturn", + "VisualScriptSceneNode", + "VisualScriptSceneTree", + "VisualScriptSelect", + "VisualScriptSelf", + "VisualScriptSequence", + "VisualScriptSubCall", + "VisualScriptSwitch", + "VisualScriptTypeCast", + "VisualScriptVariableGet", + "VisualScriptVariableSet", + "VisualScriptWhile", + "VisualScript", + "VisualScriptYieldSignal", + "VisualScriptYield", + ] def get_doc_path(): return "doc_classes" diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml new file mode 100644 index 0000000000..80b1ed86d7 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -0,0 +1,515 @@ + + + + A script implemented in the Visual Script programming environment. + + + A script implemented in the Visual Script programming environment. The script extends 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. + + + + + + + + + + + + + Add a custom signal with the specified name to the VisualScript. + + + + + + + + + Add a function with the specified name to the VisualScript. + + + + + + + + + + + + + + + Add a node to a function of 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 the position of the center of the screen for a given function. + + + + + + + + + + + Returns a node given its id and its function. + + + + + + + + + + + Returns a node's position in pixels. + + + + + + + + + Returns the default (initial) value of a variable. + + + + + + + + + Returns whether a variable is exported. + + + + + + + + + Returns the info 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 a specific node. + + + + + + + + + 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]. + + + + + + + + + + + Position the center of the screen for a function. + + + + + + + + + Set the base type of the script. + + + + + + + + + + + + + Position a node on the screen. + + + + + + + + + + + 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]. + + + + + + + + + + + + + + + Emitted when the ports of a node are changed. + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml new file mode 100644 index 0000000000..6c028e5f28 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml @@ -0,0 +1,53 @@ + + + + A Visual Script node representing a constant from the base types. + + + A Visual Script node representing a constant from base types, such as [Vector3.AXIS_X]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The type to get the constant from. + + + The name of the constant to return. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml new file mode 100644 index 0000000000..27231574d7 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -0,0 +1,219 @@ + + + + A Visual Script node used to call built-in functions. + + + A built-in function used inside a [VisualScript]. It is usually a math function or an utility function. + See also [@GDScript], for the same functions in the GDScript language. + + + + + + + + + + + + + + + + + + + + + + + + The function to be executed. + + + + + Return the sine of the input. + + + Return the cosine of the input. + + + Return the tangent of the input. + + + Return the hyperbolic sine of the input. + + + Return the hyperbolic cosine of the input. + + + Return the hyperbolic tangent of the input. + + + Return the arc sine of the input. + + + Return the arc cosine of the input. + + + Return the arc tangent of the input. + + + Return the arc tangent of the input, using the signs of both parameters to determine the exact angle. + + + Return the square root of the input. + + + Return the remainder of one input divided by the other, using floating-point numbers. + + + Return the positive remainder of one input divided by the other, using floating-point numbers. + + + Return the input rounded down. + + + Return the input rounded up. + + + Return the input rounded to the nearest integer. + + + Return the absolute value of the input. + + + Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. + + + Return the input raised to a given power. + + + Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. + + + Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 2.71828. + + + Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. + + + Return whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist. + + + Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. + + + Return the number of digit places after the decimal that the first non-zero digit occurs. + + + Return the input snapped to a given step. + + + Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. + + + + + + + Return the result of 'value' decreased by 'step' * 'amount'. + + + Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. + + + Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. + + + Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. + + + Return a random floating-point value between the two inputs. + + + Set the seed for the random number generator. + + + Return a random value from the given seed, along with the new seed. + + + Convert the input from degrees to radians. + + + Convert the input from radians to degrees. + + + Convert the input from linear volume to decibel volume. + + + Convert the input from decibel volume to linear volume. + + + + + + + Return the greater of the two numbers, also known as their maximum. + + + Return the lesser of the two numbers, also known as their minimum. + + + Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` + + + Return the nearest power of 2 to the input. + + + Create a [WeakRef] from the input. + + + Create a [FuncRef] from the input. + + + Convert between types. + + + Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. + + + Checks if a type is registered in the [ClassDB]. + + + Return a character with the given ascii value. + + + Convert the input to a string. + + + Print the given string to the output window. + + + Print the given string to the standard error output. + + + Print the given string to the standard output, without adding a newline. + + + Serialize a [Variant] to a string. + + + Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. + + + Serialize a [Variant] to a [PoolByteArray]. + + + Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. + + + Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. + + + The maximum value the [member function] property can have. + + + diff --git a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml new file mode 100644 index 0000000000..e6498e92ad --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml @@ -0,0 +1,57 @@ + + + + Gets a constant from a given class. + + + This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]value[/code] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The constant's parent class. + + + The constant to return. See the given class for its available constants. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptComment.xml b/modules/visual_script/doc_classes/VisualScriptComment.xml new file mode 100644 index 0000000000..ea4545f8ef --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptComment.xml @@ -0,0 +1,71 @@ + + + + A Visual Script node used to annotate the script. + + + A Visual Script node used to display annotations in the script, so that code may be documented. + Comment nodes can be resized so they encompass a group of nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The text inside the comment node. + + + The comment node's size (in pixels). + + + The comment node's title. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptCondition.xml b/modules/visual_script/doc_classes/VisualScriptCondition.xml new file mode 100644 index 0000000000..2a30c604a5 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptCondition.xml @@ -0,0 +1,24 @@ + + + + A Visual Script node which branches the flow. + + + A Visual Script node that checks a [bool] input port. If [code]true[/code] it will exit via the “true” sequence port. If [code]false[/code] it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected. + [b]Input Ports:[/b] + - Sequence: [code]if (cond) is[/code] + - Data (boolean): [code]cond[/code] + [b]Output Ports:[/b] + - Sequence: [code]true[/code] + - Sequence: [code]false[/code] + - Sequence: [code]done[/code] + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptConstant.xml b/modules/visual_script/doc_classes/VisualScriptConstant.xml new file mode 100644 index 0000000000..51c6d19238 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptConstant.xml @@ -0,0 +1,57 @@ + + + + Gets a contant's value. + + + This node returns a constant's value. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The constant's type. + + + The constant's value. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml new file mode 100644 index 0000000000..91df52e893 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -0,0 +1,69 @@ + + + + A Visual Script node which calls a base type constructor. + + + A Visual Script node which calls a base type constructor. It can be used for type conversion as well. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The constructor function's method info. Has roughly the following structure: + [codeblock] + { + name = "string", + args = [{ + name = "string" + class_name = "string" + type = TYPE_* + hint = PROPERTY_HINT_* + hint_string = "string" + }] + default_args = [] # Array of variants + flags = METHOD_FLAG_* + id = 0 + return = {type = TYPE_*} + } + [/codeblock] + + + The type to be constructed. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml new file mode 100644 index 0000000000..38c325cfb7 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -0,0 +1,165 @@ + + + + A scripted Visual Script node. + + + A custom Visual Script node which can be scripted in powerful ways. + + + + + + + + + + + Return the node's title. + + + + + + + Return the node's category. + + + + + + + Return the count of input value ports. + + + + + + + + + Return the specified input port's name. + + + + + + + + + Return the specified input port's type. See the TYPE_* enum in [@GlobalScope]. + + + + + + + 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's name. + + + + + + + + + Return the specified output's type. See the TYPE_* enum in [@GlobalScope]. + + + + + + + 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. + [code]outputs[/code] is an array whose indices should be set to the respective outputs. + The [code]start_mode[/code] is usually [code]START_MODE_BEGIN_SEQUENCE[/code], unless you have used the STEP_* constants. + [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. + + When returning, you can mask the returned value with one of the STEP_* constants. + + + + + + The start mode used the first time when [method _step] is called. + + + The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT. + + + The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT. + + + Hint used by [method _step] to tell that control should return to it when there is no other node left to execute. + This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the true/false branch has finished execution. + + + Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. + + + + + Hint used by [method _step] to tell that control should stop and exit the function. + + + Hint used by [method _step] to tell that the function should be yielded. + Using this requires you to have at least one working memory slot, which is used for the [VisualScriptFunctionState]. + + + diff --git a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml new file mode 100644 index 0000000000..cbed3ba22c --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml @@ -0,0 +1,38 @@ + + + + A Visual Script node which deconstructs a base type instance into its parts. + + + A Visual Script node which deconstructs a base type instance into its parts. + + + + + + + + + + + + + + + + + + + + + + + + + + The type to deconstruct. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml b/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml new file mode 100644 index 0000000000..669276f0d0 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml @@ -0,0 +1,40 @@ + + + + Emits a specified signal. + + + Emits a specified signal when it is executed. + [b]Input Ports:[/b] + - Sequence: [code]emit[/code] + [b]Output Ports:[/b] + - Sequence + + + + + + + + + + + + + + + + + + + + + + + + The signal to emit. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml b/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml new file mode 100644 index 0000000000..6703ff4eda --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml @@ -0,0 +1,36 @@ + + + + A Visual Script node returning a singleton from [@GlobalScope] + + + A Visual Script node returning a singleton from [@GlobalScope] + + + + + + + + + + + + + + + + + + + + + + + + The singleton's name. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptExpression.xml b/modules/visual_script/doc_classes/VisualScriptExpression.xml new file mode 100644 index 0000000000..fb3b6ef19d --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptExpression.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptFunction.xml b/modules/visual_script/doc_classes/VisualScriptFunction.xml new file mode 100644 index 0000000000..d77169679b --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptFunction.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml new file mode 100644 index 0000000000..7a0a7c9f55 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml new file mode 100644 index 0000000000..9b30f62236 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml b/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml new file mode 100644 index 0000000000..961244fe88 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptIndexGet.xml b/modules/visual_script/doc_classes/VisualScriptIndexGet.xml new file mode 100644 index 0000000000..c5229f7678 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptIndexGet.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptIndexSet.xml b/modules/visual_script/doc_classes/VisualScriptIndexSet.xml new file mode 100644 index 0000000000..27646b4a5f --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptIndexSet.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptInputAction.xml b/modules/visual_script/doc_classes/VisualScriptInputAction.xml new file mode 100644 index 0000000000..7f6d13264e --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptInputAction.xml @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptIterator.xml b/modules/visual_script/doc_classes/VisualScriptIterator.xml new file mode 100644 index 0000000000..fc905d6c39 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptIterator.xml @@ -0,0 +1,24 @@ + + + + Steps through items in a given input. + + + This node steps through each item in a given input. Input can be any sequence data type, such as an [Array] or [String]. When each item has been processed, execution passed out the [code]exit[/code] Sequence port. + [b]Input Ports:[/b] + - Sequence: [code]for (elem) in (input)[/code] + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence: [code]each[/code] + - Sequence: [code]exit[/code] + - Data (variant): [code]elem[/code] + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVar.xml b/modules/visual_script/doc_classes/VisualScriptLocalVar.xml new file mode 100644 index 0000000000..ff77dfac0d --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptLocalVar.xml @@ -0,0 +1,57 @@ + + + + Gets a local variable's value. + + + Returns a local variable's value. "Var Name" must be supplied, with an optional type. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The local variable's type. + + + The local variable's name. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml new file mode 100644 index 0000000000..07b01d4576 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml @@ -0,0 +1,59 @@ + + + + Changes a local variable's value. + + + Changes a local variable's value to the given input. The new value is also provided on an output Data port. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]set[/code] + [b]Output Ports:[/b] + - Sequence + - Data (variant): [code]get[/code] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The local variable's type. + + + The local variable's name. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml new file mode 100644 index 0000000000..817bcb5ce2 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml @@ -0,0 +1,66 @@ + + + + Commonly used mathematical constants. + + + Provides common math constants, such as Pi or Euler's constant, on an output Data port. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] + + + + + + + + + + + + + + + + + + + + + + + + The math constant. + + + + + Unity: [code]1[/code] + + + Pi: [code]3.141593[/code] + + + Pi divided by two: [code]1.570796[/code] + + + Tau: [code]6.283185[/code] + + + Natural log: [code]2.718282[/code] + + + Square root of two: [code]1.414214[/code] + + + Infinity: [code]inf[/code] + + + Not a number: [code]nan[/code] + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml new file mode 100644 index 0000000000..f6f2867172 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -0,0 +1,62 @@ + + + + A node which is part of a [VisualScript]. + + + A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree]. + + + + + + + + + + + + + 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. + + + + + + + + + + + Emitted when the available input/output ports are changed. + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptOperator.xml b/modules/visual_script/doc_classes/VisualScriptOperator.xml new file mode 100644 index 0000000000..bf4032c09c --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptOperator.xml @@ -0,0 +1,54 @@ + + + + + + [b]Input Ports:[/b] + - Data (variant): [code]A[/code] + - Data (variant): [code]B[/code] + [b]Output Ports:[/b] + - Data (variant): [code]result[/code] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptPreload.xml b/modules/visual_script/doc_classes/VisualScriptPreload.xml new file mode 100644 index 0000000000..4a71e23809 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptPreload.xml @@ -0,0 +1,40 @@ + + + + Creates a new [Resource] or loads one from the filesystem. + + + Creates a new [Resource] or loads one from the filesystem. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (object): [code]res[/code] + + + + + + + + + + + + + + + + + + + + + + + + The [Resource] to load. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml new file mode 100644 index 0000000000..eb5c52f4be --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -0,0 +1,137 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml new file mode 100644 index 0000000000..794caa2518 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptResourcePath.xml b/modules/visual_script/doc_classes/VisualScriptResourcePath.xml new file mode 100644 index 0000000000..274a852c3e --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptResourcePath.xml @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptReturn.xml b/modules/visual_script/doc_classes/VisualScriptReturn.xml new file mode 100644 index 0000000000..4ac586a02c --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptReturn.xml @@ -0,0 +1,58 @@ + + + + Exits a function and returns an optional value. + + + Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]result[/code] (optional) + [b]Output Ports:[/b] + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + If [code]true[/code] the [code]return[/code] input port is available. + + + The return value's data type. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSceneNode.xml b/modules/visual_script/doc_classes/VisualScriptSceneNode.xml new file mode 100644 index 0000000000..e8fdb69c6a --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSceneNode.xml @@ -0,0 +1,40 @@ + + + + Node reference. + + + A direct reference to a node. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data: [code]node[/code] (obj) + + + + + + + + + + + + + + + + + + + + + + + + The node's path in the scene tree. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSceneTree.xml b/modules/visual_script/doc_classes/VisualScriptSceneTree.xml new file mode 100644 index 0000000000..e74c330623 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSceneTree.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSelect.xml b/modules/visual_script/doc_classes/VisualScriptSelect.xml new file mode 100644 index 0000000000..6a62e364f3 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSelect.xml @@ -0,0 +1,42 @@ + + + + Chooses between two input values. + + + Chooses between two input values based on a Boolean condition. + [b]Input Ports:[/b] + - Data (boolean): [code]cond[/code] + - Data (variant): [code]a[/code] + - Data (variant): [code]b[/code] + [b]Output Ports:[/b] + - Data (variant): [code]out[/code] + + + + + + + + + + + + + + + + + + + + + + + + The input variables' type. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSelf.xml b/modules/visual_script/doc_classes/VisualScriptSelf.xml new file mode 100644 index 0000000000..f39a02bf84 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSelf.xml @@ -0,0 +1,21 @@ + + + + Outputs a reference to the current instance. + + + Provides a reference to the node running the visual script. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (object): [code]instance[/code] + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSequence.xml b/modules/visual_script/doc_classes/VisualScriptSequence.xml new file mode 100644 index 0000000000..51238070d5 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSequence.xml @@ -0,0 +1,42 @@ + + + + Executes a series of Sequence ports. + + + Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. + [b]Input Ports:[/b] + - Sequence: [code]in order[/code] + [b]Output Ports:[/b] + - Sequence: [code]1[/code] + - Sequence: [code]2 - n[/code] (optional) + - Data (int): [code]current[/code] + + + + + + + + + + + + + + + + + + + + + + + + The number of steps in the sequence. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSubCall.xml b/modules/visual_script/doc_classes/VisualScriptSubCall.xml new file mode 100644 index 0000000000..381095f49b --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSubCall.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptSwitch.xml b/modules/visual_script/doc_classes/VisualScriptSwitch.xml new file mode 100644 index 0000000000..3c8a79f686 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptSwitch.xml @@ -0,0 +1,26 @@ + + + + Branches program flow based on a given input's value. + + + Branches the flow based on an input's value. Use "Case Count" in the Inspector to set the number of branches and each comparison's optional type. + [b]Input Ports:[/b] + - Sequence: [code]'input' is[/code] + - Data (variant): [code]=[/code] + - Data (variant): [code]=[/code] (optional) + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence + - Sequence (optional) + - Sequence: [code]done[/code] + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptTypeCast.xml b/modules/visual_script/doc_classes/VisualScriptTypeCast.xml new file mode 100644 index 0000000000..417c0a5159 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptTypeCast.xml @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptVariableGet.xml b/modules/visual_script/doc_classes/VisualScriptVariableGet.xml new file mode 100644 index 0000000000..1cad4480a6 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptVariableGet.xml @@ -0,0 +1,40 @@ + + + + Gets a variable's value. + + + Returns a variable's value. "Var Name" must be supplied, with an optional type. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]value[/code] + + + + + + + + + + + + + + + + + + + + + + + + The variable's name. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml new file mode 100644 index 0000000000..fa3befa21d --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml @@ -0,0 +1,41 @@ + + + + Changes a variable's value. + + + Changes a variable's value to the given input. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]set[/code] + [b]Output Ports:[/b] + - Sequence + + + + + + + + + + + + + + + + + + + + + + + + The variable's name. + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptWhile.xml b/modules/visual_script/doc_classes/VisualScriptWhile.xml new file mode 100644 index 0000000000..f948660997 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptWhile.xml @@ -0,0 +1,23 @@ + + + + Conditional loop. + + + Loops while a condition is [code]true[/code]. Execution continues out the [code]exit[/code] Sequence port when the loop terminates. + [b]Input Ports:[/b] + - Sequence: [code]while(cond)[/code] + - Data (bool): [code]cond[/code] + [b]Output Ports:[/b] + - Sequence: [code]repeat[/code] + - Sequence: [code]exit[/code] + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml new file mode 100644 index 0000000000..5474ee8b78 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml new file mode 100644 index 0000000000..a3b6982075 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml @@ -0,0 +1,87 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/vorbis/config.py b/modules/vorbis/config.py index fb920482f5..5f133eba90 100644 --- a/modules/vorbis/config.py +++ b/modules/vorbis/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass diff --git a/modules/webm/config.py b/modules/webm/config.py index fb920482f5..0374bb36f7 100644 --- a/modules/webm/config.py +++ b/modules/webm/config.py @@ -1,7 +1,14 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "ResourceImporterWebm", + "VideoStreamWebm", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/webp/config.py b/modules/webp/config.py index fb920482f5..5f133eba90 100644 --- a/modules/webp/config.py +++ b/modules/webp/config.py @@ -1,7 +1,5 @@ - def can_build(platform): return True - def configure(env): pass -- cgit v1.2.3