From d846a0aaa3ea4d2514bab791a622cd08044efa30 Mon Sep 17 00:00:00 2001 From: Sean Heffernan Date: Thu, 23 May 2019 19:15:43 -0700 Subject: [PATCH] Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60) --- doc/classes/AcceptDialog.xml | 4 +-- doc/classes/AnimatedSprite.xml | 2 +- doc/classes/AnimatedSprite3D.xml | 2 +- doc/classes/Animation.xml | 28 +++++++++---------- doc/classes/AnimationNode.xml | 6 ++-- doc/classes/AnimationTreePlayer.xml | 4 +-- doc/classes/Area2D.xml | 4 +-- doc/classes/ArrayMesh.xml | 10 +++---- doc/classes/BaseButton.xml | 4 +-- doc/classes/Basis.xml | 12 ++++---- doc/classes/Camera2D.xml | 2 +- doc/classes/CanvasItem.xml | 4 +-- doc/classes/ClassDB.xml | 6 ++-- doc/classes/ColorPicker.xml | 2 +- doc/classes/ConcavePolygonShape.xml | 2 +- doc/classes/ConfirmationDialog.xml | 2 +- doc/classes/Control.xml | 2 +- doc/classes/Dictionary.xml | 14 +++++----- doc/classes/Directory.xml | 16 +++++------ doc/classes/EditorFileSystem.xml | 4 +-- doc/classes/EditorPlugin.xml | 4 +-- .../EditorResourcePreviewGenerator.xml | 2 +- doc/classes/EditorSpatialGizmo.xml | 2 +- doc/classes/FileDialog.xml | 2 +- doc/classes/Font.xml | 8 +++--- doc/classes/GraphEdit.xml | 4 +-- doc/classes/GraphNode.xml | 28 +++++++++---------- doc/classes/ImageTexture.xml | 2 +- doc/classes/Input.xml | 2 +- doc/classes/ItemList.xml | 6 ++-- doc/classes/Marshalls.xml | 12 ++++---- doc/classes/MenuButton.xml | 2 +- doc/classes/Mesh.xml | 4 +-- doc/classes/MeshLibrary.xml | 6 ++-- doc/classes/MultiMesh.xml | 18 ++++++++++-- doc/classes/NodePath.xml | 4 +-- doc/classes/OptionButton.xml | 12 ++++---- doc/classes/PacketPeer.xml | 4 +-- doc/classes/PacketPeerUDP.xml | 6 ++-- doc/classes/PoolByteArray.xml | 2 +- doc/classes/PoolColorArray.xml | 2 +- doc/classes/PoolIntArray.xml | 2 +- doc/classes/PoolRealArray.xml | 2 +- doc/classes/PoolStringArray.xml | 2 +- doc/classes/PoolVector2Array.xml | 2 +- doc/classes/PoolVector3Array.xml | 2 +- doc/classes/PopupMenu.xml | 24 ++++++++-------- doc/classes/Quat.xml | 2 +- doc/classes/RayCast.xml | 4 +-- doc/classes/RayCast2D.xml | 6 ++-- doc/classes/ResourceInteractiveLoader.xml | 6 ++-- doc/classes/ResourceLoader.xml | 2 +- doc/classes/RigidBody.xml | 2 +- doc/classes/Shape2D.xml | 2 +- doc/classes/Skeleton.xml | 20 ++++++------- doc/classes/StreamPeer.xml | 6 ++-- doc/classes/StreamPeerSSL.xml | 2 +- doc/classes/StreamPeerTCP.xml | 6 ++-- doc/classes/StyleBox.xml | 6 ++-- doc/classes/TCP_Server.xml | 2 +- doc/classes/TextEdit.xml | 22 +++++++-------- doc/classes/Texture.xml | 6 ++-- doc/classes/WindowDialog.xml | 2 +- 63 files changed, 202 insertions(+), 190 deletions(-) diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index b1e89e24965..4a5ecc1d07b 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -36,14 +36,14 @@ - Return the label used for built-in text. + Returns the label used for built-in text. - Return the OK Button. + Returns the OK Button. diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index 9f7da5d5e52..db79adf0fe6 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -13,7 +13,7 @@ - Return [code]true[/code] if an animation if currently being played. + Returns [code]true[/code] if an animation if currently being played. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index ec209029dbf..54bcf151e82 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -13,7 +13,7 @@ - Return [code]true[/code] if an animation if currently being played. + Returns [code]true[/code] if an animation if currently being played. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 91acb47f26f..5a049fca028 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -263,14 +263,14 @@ - Return the index of the specified track. If the track is not found, return -1. + Returns the index of the specified track. If the track is not found, return -1. - Return the amount of tracks in the animation. + Returns the amount of tracks in the animation. @@ -283,7 +283,7 @@ - Return all the key indices of a method track, given a position and delta time. + Returns all the key indices of a method track, given a position and delta time. @@ -294,7 +294,7 @@ - Return the method name of a method track. + Returns the method name of a method track. @@ -305,7 +305,7 @@ - Return the arguments values to be called on a method track for a given key in a given track. + Returns the arguments values to be called on a method track for a given key in a given track. @@ -345,7 +345,7 @@ - Return the interpolation type of a given track, from the INTERPOLATION_* enum. + Returns the interpolation type of a given track, from the INTERPOLATION_* enum. @@ -354,7 +354,7 @@ - Return the amount of keys in a given track. + Returns the amount of keys in a given track. @@ -365,7 +365,7 @@ - Return the time at which the key is located. + Returns the time at which the key is located. @@ -376,7 +376,7 @@ - Return the transition curve (easing) for a specific key (see built-in math function "ease"). + Returns the transition curve (easing) for a specific key (see built-in math function "ease"). @@ -387,7 +387,7 @@ - Return the value of a given key in a given track. + Returns the value of a given key in a given track. @@ -438,7 +438,7 @@ - Return [code]true[/code] if the given track is imported. Else, return [code]false[/code]. + Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. @@ -598,7 +598,7 @@ - Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). + Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). @@ -611,7 +611,7 @@ - Return all the key indices of a value track, given a position and delta time. + Returns all the key indices of a value track, given a position and delta time. @@ -620,7 +620,7 @@ - Return the update mode of a value track. + Returns the update mode of a value track. diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 8db11f37768..116cc6004dd 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -144,7 +144,7 @@ - Return [code]true[/code] whether you want the blend tree editor to display filter editing on this node. + Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. @@ -153,7 +153,7 @@ - Return [code]true[/code] wether a given path is filtered. + Returns [code]true[/code] whether a given path is filtered. @@ -204,7 +204,7 @@ - Return whether filtering is enabled. + Returns whether filtering is enabled. diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index a3f3b60da51..f8e53c7966a 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -256,7 +256,7 @@ - Return the input count for a given node. Different types of nodes have different amount of inputs. + Returns the input count for a given node. Different types of nodes have different amount of inputs. @@ -267,7 +267,7 @@ - Return the input source for a given node input. + Returns the input source for a given node input. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 3af5f021df0..8df3932334c 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -15,7 +15,7 @@ - Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. + Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. @@ -24,7 +24,7 @@ - Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. + Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 9f55dac698f..391084194f2 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -98,7 +98,7 @@ - Return the index of the first surface with this name held within this [code]ArrayMesh[/code]. If none are found -1 is returned. + Returns the index of the first surface with this name held within this [code]ArrayMesh[/code]. If none are found -1 is returned. @@ -107,7 +107,7 @@ - Return the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). + Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). @@ -116,7 +116,7 @@ - Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). + Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). @@ -125,7 +125,7 @@ - Return the format mask of the requested surface (see [method add_surface_from_arrays]). + Returns the format mask of the requested surface (see [method add_surface_from_arrays]). @@ -143,7 +143,7 @@ - Return the primitive type of the requested surface (see [method add_surface_from_arrays]). + Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index cecc0104bbc..af499f01a30 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -29,14 +29,14 @@ - Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. - Return [code]true[/code] if the mouse has entered the button and has not left it yet. + Returns [code]true[/code] if the mouse has entered the button and has not left it yet. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index ecc309971b1..ef1f10ed407 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -57,7 +57,7 @@ - Return the determinant of the matrix. + Returns the determinant of the matrix. @@ -91,7 +91,7 @@ - Return the inverse of the matrix. + Returns the inverse of the matrix. @@ -108,7 +108,7 @@ - Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. + Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. @@ -173,7 +173,7 @@ - Return the transposed version of the matrix. + Returns the transposed version of the matrix. @@ -182,7 +182,7 @@ - Return a vector transformed (multiplied) by the matrix. + Returns a vector transformed (multiplied) by the matrix. @@ -191,7 +191,7 @@ - Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. + Returns a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index e8047f039bc..c226cb0ea27 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -35,7 +35,7 @@ - Return the camera position. + Returns the camera position. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index e7a0027bfe0..459b8da6bd6 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -338,14 +338,14 @@ - Return the [RID] of the [World2D] canvas where this item is in. + Returns the [RID] of the [World2D] canvas where this item is in. - Return the canvas item RID used by [VisualServer] for this item. + Returns the canvas item RID used by [VisualServer] for this item. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 21d02fb041f..7f041af540e 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -121,7 +121,7 @@ - Return whether 'class' or its ancestry has an integer constant called 'name' or not. + Returns whether 'class' or its ancestry has an integer constant called 'name' or not. @@ -134,7 +134,7 @@ - Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. + Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. @@ -145,7 +145,7 @@ - Return whether 'class' or its ancestry has a signal called 'signal' or not. + Returns whether 'class' or its ancestry has a signal called 'signal' or not. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 071e2a5803e..935070c0259 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -31,7 +31,7 @@ - Return the list of colors in the presets of the color picker. + Returns the list of colors in the presets of the color picker. diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index 72af17c54a1..694375e065e 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -13,7 +13,7 @@ - Return the faces (an array of triangles). + Returns the faces (an array of triangles). diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 869c775677d..fede8e805a3 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -13,7 +13,7 @@ - Return the cancel button. + Returns the cancel button. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 2c96ddf807d..1d44cde3ccb 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -221,7 +221,7 @@ - Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. [codeblock] extends Control diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 9b3de13ce22..2693ea09600 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -38,7 +38,7 @@ - Return [code]true[/code] if the dictionary is empty. + Returns [code]true[/code] if the dictionary is empty. @@ -67,7 +67,7 @@ - Return [code]true[/code] if the dictionary has a given key. + Returns [code]true[/code] if the dictionary has a given key. @@ -76,35 +76,35 @@ - Return [code]true[/code] if the dictionary has all of the keys in the given array. + Returns [code]true[/code] if the dictionary has all of the keys in the given array. - Return a hashed integer value representing the dictionary contents. + Returns a hashed integer value representing the dictionary contents. - Return the list of keys in the [code]Dictionary[/code]. + Returns the list of keys in the [code]Dictionary[/code]. - Return the size of the dictionary (in pairs). + Returns the size of the dictionary (in pairs). - Return the list of values in the [code]Dictionary[/code]. + Returns the list of values in the [code]Dictionary[/code]. diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 4f665b4c2af..4bed652cb69 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -52,7 +52,7 @@ - Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). + Returns whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). @@ -61,7 +61,7 @@ - Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. + Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. @@ -70,14 +70,14 @@ - Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. + Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. - Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). + Returns the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). @@ -107,7 +107,7 @@ - Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). + Returns the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). @@ -155,7 +155,7 @@ Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. - Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). + Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). @@ -175,7 +175,7 @@ Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. - Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). @@ -187,7 +187,7 @@ Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index a78165a2c12..c5b0b0321ff 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -38,14 +38,14 @@ - Return the scan progress for 0 to 1 if the FS is being scanned. + Returns the scan progress for 0 to 1 if the FS is being scanned. - Return [code]true[/code] of the filesystem is being scanned. + Returns [code]true[/code] of the filesystem is being scanned. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index e2e88a431e8..bc528cec550 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -241,7 +241,7 @@ - Return the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. + Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. @@ -299,7 +299,7 @@ - Return [code]true[/code] if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). + Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 1717dc7144e..a3d594a4dac 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -41,7 +41,7 @@ - Return if your generator supports this resource type. + Returns if your generator supports this resource type. diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index b43bbf8d4e9..427953b8ecb 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -123,7 +123,7 @@ - Return the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material]. + Returns the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material]. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 2232d71532c..c213bc009f7 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -43,7 +43,7 @@ - Return the vertical box container of the dialog, custom controls can be added to it. + Returns the vertical box container of the dialog, custom controls can be added to it. diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index fdd24bebfdd..1c050026c78 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -51,21 +51,21 @@ - Return the font ascent (number of pixels above the baseline). + Returns the font ascent (number of pixels above the baseline). - Return the font descent (number of pixels below the baseline). + Returns the font descent (number of pixels below the baseline). - Return the total font height (ascent plus descent) in pixels. + Returns the total font height (ascent plus descent) in pixels. @@ -74,7 +74,7 @@ - Return the size of a string, taking kerning and advance into account. + Returns the size of a string, taking kerning and advance into account. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 76c396ef5f6..985348ddd92 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -80,7 +80,7 @@ - Return an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } + Returns an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } @@ -101,7 +101,7 @@ - Return [code]true[/code] if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Returns [code]true[/code] if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index ffac81090dc..3fecf317ce4 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -31,14 +31,14 @@ - Return the color of the input connection 'idx'. + Returns the color of the input connection 'idx'. - Return the number of enabled input slots (connections) to the GraphNode. + Returns the number of enabled input slots (connections) to the GraphNode. @@ -47,7 +47,7 @@ - Return the position of the input connection 'idx'. + Returns the position of the input connection 'idx'. @@ -56,7 +56,7 @@ - Return the type of the input connection 'idx'. + Returns the type of the input connection 'idx'. @@ -65,14 +65,14 @@ - Return the color of the output connection 'idx'. + Returns the color of the output connection 'idx'. - Return the number of enabled output slots (connections) of the GraphNode. + Returns the number of enabled output slots (connections) of the GraphNode. @@ -81,7 +81,7 @@ - Return the position of the output connection 'idx'. + Returns the position of the output connection 'idx'. @@ -90,7 +90,7 @@ - Return the type of the output connection 'idx'. + Returns the type of the output connection 'idx'. @@ -99,7 +99,7 @@ - Return the color set to 'idx' left (input) slot. + Returns the color set to 'idx' left (input) slot. @@ -108,7 +108,7 @@ - Return the color set to 'idx' right (output) slot. + Returns the color set to 'idx' right (output) slot. @@ -117,7 +117,7 @@ - Return the (integer) type of left (input) 'idx' slot. + Returns the (integer) type of left (input) 'idx' slot. @@ -126,7 +126,7 @@ - Return the (integer) type of right (output) 'idx' slot. + Returns the (integer) type of right (output) 'idx' slot. @@ -135,7 +135,7 @@ - Return [code]true[/code] if left (input) slot 'idx' is enabled, [code]false[/code] otherwise. + Returns [code]true[/code] if left (input) slot 'idx' is enabled, [code]false[/code] otherwise. @@ -144,7 +144,7 @@ - Return [code]true[/code] if right (output) slot 'idx' is enabled, [code]false[/code] otherwise. + Returns [code]true[/code] if right (output) slot 'idx' is enabled, [code]false[/code] otherwise. diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 5527f26c883..416adda883b 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -40,7 +40,7 @@ - Return the format of the [code]ImageTexture[/code], one of [enum Image.Format]. + Returns the format of the [code]ImageTexture[/code], one of [enum Image.Format]. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index c8c60660562..2cd79e0698d 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -188,7 +188,7 @@ - Return the mouse mode. See the constants for more information. + Returns the mouse mode. See the constants for more information. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index a5995c5c6c8..ba658d06d55 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -64,7 +64,7 @@ - Return count of items currently in the item list. + Returns count of items currently in the item list. @@ -122,7 +122,7 @@ - Return the text for specified item index. + Returns the text for specified item index. @@ -131,7 +131,7 @@ - Return tooltip hint for specified item index. + Returns tooltip hint for specified item index. diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 10eb6268575..0f90f484d9a 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -15,7 +15,7 @@ - Return [PoolByteArray] of a given base64 encoded String. + Returns [PoolByteArray] of a given base64 encoded String. @@ -24,7 +24,7 @@ - Return utf8 String of a given base64 encoded String. + Returns utf8 String of a given base64 encoded String. @@ -35,7 +35,7 @@ - Return [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. + Returns [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). @@ -45,7 +45,7 @@ - Return base64 encoded String of a given [PoolByteArray]. + Returns base64 encoded String of a given [PoolByteArray]. @@ -54,7 +54,7 @@ - Return base64 encoded String of a given utf8 String. + Returns base64 encoded String of a given utf8 String. @@ -65,7 +65,7 @@ - Return base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Returns base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 2cdb97bec46..c7b5f8cfbfd 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -13,7 +13,7 @@ - Return the [PopupMenu] contained in this button. + Returns the [PopupMenu] contained in this button. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 3663e35a04a..a26d7f10443 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -50,7 +50,7 @@ - Return the amount of surfaces that the [code]Mesh[/code] holds. + Returns the amount of surfaces that the [code]Mesh[/code] holds. @@ -77,7 +77,7 @@ - Return a [Material] in a given surface. Surface is rendered using this material. + Returns a [Material] in a given surface. Surface is rendered using this material. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 5abe00000b4..be6ba14ce25 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -37,7 +37,7 @@ - Return the list of items. + Returns the list of items. @@ -46,7 +46,7 @@ - Return the mesh of the item. + Returns the mesh of the item. @@ -55,7 +55,7 @@ - Return the name of the item. + Returns the name of the item. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 61786912496..e081e834020 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -17,7 +17,7 @@ - Return the visibility AABB. + Returns the visibility AABB. @@ -35,7 +35,7 @@ - Return the custom data that has been set for a specific instance. + Returns the custom data that has been set for a specific instance. @@ -44,7 +44,7 @@ - Return the transform of a specific instance. + Returns the [Transform] of a specific instance. @@ -53,6 +53,18 @@ + Returns the [Transform2D] of a specific instance. + + + + + + + + + Set all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. + All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc... + [Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats. diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 70d52afca68..d2c9247e934 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -68,14 +68,14 @@ - Return [code]true[/code] if the node path is absolute (not relative). + Returns [code]true[/code] if the node path is absolute (not relative). - Return [code]true[/code] if the node path is empty. + Returns [code]true[/code] if the node path is empty. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 990377d208f..8fca50cbd2e 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -51,7 +51,7 @@ - Return the amount of items in the OptionButton. + Returns the amount of items in the OptionButton. @@ -60,7 +60,7 @@ - Return the icon of the item at index "idx". + Returns the icon of the item at index "idx". @@ -69,7 +69,7 @@ - Return the ID of the item at index [code]idx[/code]. + Returns the ID of the item at index [code]idx[/code]. @@ -78,7 +78,7 @@ - Return the index of the item with the given [code]id[/code]. + Returns the index of the item with the given [code]id[/code]. @@ -95,14 +95,14 @@ - Return the text of the item at index "idx". + Returns the text of the item at index "idx". - Return the [PopupMenu] contained in this button. + Returns the [PopupMenu] contained in this button. diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index c55afab4fa6..d2af93b7b10 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -13,7 +13,7 @@ - Return the number of packets currently available in the ring-buffer. + Returns the number of packets currently available in the ring-buffer. @@ -27,7 +27,7 @@ - Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Returns the error state of the last packet received (via [method get_packet] and [method get_var]). diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index eb642c1a404..8c4bb95ce82 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -20,21 +20,21 @@ - Return the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). + Returns the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). - Return the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). + Returns the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). - Return whether this [code]PacketPeerUDP[/code] is listening. + Returns whether this [code]PacketPeerUDP[/code] is listening. diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 56a4bf4bf64..27f1a030105 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -116,7 +116,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index f5ffed27b4a..599f7a76120 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -82,7 +82,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 2c2672f011f..a209fad1e65 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -82,7 +82,7 @@ - Return the array size. + Returns the array size. diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index 3f8726e90bc..91dfd7c5bc5 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -82,7 +82,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index f389aeeb4c4..dc71606ee64 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -91,7 +91,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 597bc463f89..7143892d741 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -82,7 +82,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index f8f16e5a8e2..ff406c983c2 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -82,7 +82,7 @@ - Return the size of the array. + Returns the size of the array. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index e28d780e2c5..4d14766f124 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -178,14 +178,14 @@ - Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Returns the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. - Return the amount of items. + Returns the amount of items. @@ -194,7 +194,7 @@ - Return the icon of the item at index "idx". + Returns the icon of the item at index "idx". @@ -203,7 +203,7 @@ - Return the id of the item at index "idx". + Returns the id of the item at index "idx". @@ -221,7 +221,7 @@ - Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. + Returns the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. @@ -238,7 +238,7 @@ - Return the submenu name of the item at index "idx". + Returns the submenu name of the item at index "idx". @@ -247,7 +247,7 @@ - Return the text of the item at index "idx". + Returns the text of the item at index "idx". @@ -270,7 +270,7 @@ - Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. + Returns whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -279,7 +279,7 @@ - Return whether the item at index "idx" is checked. + Returns whether the item at index "idx" is checked. @@ -288,7 +288,7 @@ - Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + Returns whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. @@ -297,7 +297,7 @@ - Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + Returns whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. @@ -306,7 +306,7 @@ - Return whether the item is a separator. If it is, it would be displayed as a line. + Returns whether the item is a separator. If it is, it would be displayed as a line. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index f120128aa53..f5739c2e461 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -84,7 +84,7 @@ - Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index fe73b924e42..4747c4119b0 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -50,7 +50,7 @@ - Return the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). @@ -87,7 +87,7 @@ - Return whether any object is intersecting with the ray's vector (considering the vector length). + Returns whether any object is intersecting with the ray's vector (considering the vector length). diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index b8770a4e640..b94f2d341d4 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -49,7 +49,7 @@ - Return the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). @@ -65,7 +65,7 @@ - Return an individual bit on the collision mask. + Returns an individual bit on the collision mask. @@ -86,7 +86,7 @@ - Return whether any object is intersecting with the ray's vector (considering the vector length). + Returns whether any object is intersecting with the ray's vector (considering the vector length). diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 0ec1461f562..a19700ad78a 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -13,21 +13,21 @@ - Return the loaded resource (only if loaded). Otherwise, returns null. + Returns the loaded resource (only if loaded). Otherwise, returns null. - Return the load stage. The total amount of stages can be queried with [method get_stage_count] + Returns the load stage. The total amount of stages can be queried with [method get_stage_count] - Return the total amount of stages (calls to [method poll]) needed to completely load this resource. + Returns the total amount of stages (calls to [method poll]) needed to completely load this resource. diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 52e43ad358e..13d333429e5 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -33,7 +33,7 @@ - Return the list of recognized extensions for a resource type. + Returns the list of recognized extensions for a resource type. diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index ae0552eb722..2c0da9d75d2 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -86,7 +86,7 @@ - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index ceaf0ca2dd6..e182c48a851 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -52,7 +52,7 @@ - Return whether this shape would collide with another, if a given movement was applied. + Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index a7b1907e020..e1006769cd4 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -44,14 +44,14 @@ - Return the bone index that matches "name" as its name. + Returns the bone index that matches "name" as its name. - Return the amount of bones in the skeleton. + Returns the amount of bones in the skeleton. @@ -60,7 +60,7 @@ - Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. + Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. @@ -69,7 +69,7 @@ - Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. + Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. @@ -78,7 +78,7 @@ - Return the name of the bone at index "index". + Returns the name of the bone at index "index". @@ -87,7 +87,7 @@ - Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". @@ -96,7 +96,7 @@ - Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. + Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. @@ -105,7 +105,7 @@ - Return the rest transform for a bone "bone_idx". + Returns the rest transform for a bone "bone_idx". @@ -114,7 +114,7 @@ - Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. + Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. @@ -223,7 +223,7 @@ - Return the pose transform for bone "bone_idx". + Returns the pose transform for bone "bone_idx". diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 94d4e130585..10d8ddfea1c 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -41,7 +41,7 @@ - Return the amount of bytes this [code]StreamPeer[/code] has available. + Returns the amount of bytes this [code]StreamPeer[/code] has available. @@ -50,7 +50,7 @@ - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. @@ -73,7 +73,7 @@ - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 7a29ef5bf3f..37d1536229a 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -42,7 +42,7 @@ - Return the status of the connection, one of STATUS_* enum. + Returns the status of the connection, one of STATUS_* enum. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 853062e9226..32098714590 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -31,21 +31,21 @@ - Return the IP of this peer. + Returns the IP of this peer. - Return the port of this peer. + Returns the port of this peer. - Return the status of the connection, see [enum StreamPeerTCP.Status]. + Returns the status of the connection, see [enum StreamPeerTCP.Status]. diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 94a3c527f90..ec0814b558d 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -37,7 +37,7 @@ - Return the content margin offset for the specified margin + Returns the content margin offset for the specified margin Positive values reduce size inwards, unlike [Control]'s margin values. @@ -45,14 +45,14 @@ - Return the minimum size that this stylebox can be shrunk to. + Returns the minimum size that this stylebox can be shrunk to. - Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + Returns the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 6825c456e24..3c9fd5c6de6 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -13,7 +13,7 @@ - Return [code]true[/code] if a connection is available for taking. + Returns [code]true[/code] if a connection is available for taking. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index e094db6826f..da7b50093f6 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -68,14 +68,14 @@ - Return the column the editing cursor is at. + Returns the column the editing cursor is at. - Return the line the editing cursor is at. + Returns the line the editing cursor is at. @@ -134,7 +134,7 @@ - Return an array containing the line number of each breakpoint. + Returns an array containing the line number of each breakpoint. @@ -151,14 +151,14 @@ - Return the text of a specific line. + Returns the text of a specific line. - Return the amount of total lines in the text. + Returns the amount of total lines in the text. @@ -171,35 +171,35 @@ - Return the selection begin column. + Returns the selection begin column. - Return the selection begin line. + Returns the selection begin line. - Return the text inside the selection. + Returns the text inside the selection. - Return the selection end column. + Returns the selection end column. - Return the selection end line. + Returns the selection end line. @@ -245,7 +245,7 @@ - Return [code]true[/code] if the selection is active. + Returns [code]true[/code] if the selection is active. diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index ee8a34e7c34..a10fa22b25e 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -74,21 +74,21 @@ - Return the texture height. + Returns the texture height. - Return the texture size. + Returns the texture size. - Return the texture width. + Returns the texture width. diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index a223359d9e1..a5cce34ab78 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -13,7 +13,7 @@ - Return the close [TextureButton]. + Returns the close [TextureButton].