From 15ada56d73817c5c0be97882a88cb27696fcd3a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 24 Nov 2017 09:16:27 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/@GlobalScope.xml | 3 + doc/classes/Array.xml | 52 ++++++------ doc/classes/Basis.xml | 2 +- doc/classes/CanvasItem.xml | 47 ----------- doc/classes/Color.xml | 26 +++--- doc/classes/Control.xml | 4 + doc/classes/EditorExportPlugin.xml | 48 +++++++++++ doc/classes/EditorScenePostImport.xml | 23 ++++++ doc/classes/ItemList.xml | 6 ++ doc/classes/Light.xml | 32 ++++---- doc/classes/LineEdit.xml | 2 +- doc/classes/Node2D.xml | 9 --- doc/classes/NodePath.xml | 19 +++-- doc/classes/OS.xml | 14 ++-- doc/classes/Object.xml | 18 +++++ doc/classes/Physics2DDirectSpaceState.xml | 28 +------ doc/classes/Physics2DShapeQueryParameters.xml | 16 ---- doc/classes/PhysicsDirectSpaceState.xml | 14 ---- doc/classes/PhysicsShapeQueryParameters.xml | 20 +---- doc/classes/RayCast.xml | 23 ------ doc/classes/RayCast2D.xml | 23 ------ doc/classes/RichTextLabel.xml | 16 ++-- doc/classes/Tabs.xml | 28 +++++++ doc/classes/TextEdit.xml | 80 +++++++++++++++++++ doc/classes/TileMap.xml | 7 +- doc/classes/TileSet.xml | 64 +++++++++++++++ doc/classes/Tween.xml | 10 +-- doc/classes/VisualServer.xml | 28 +++---- .../gdnative/doc_classes/GDNativeLibrary.xml | 6 -- .../doc_classes/VisualScriptBuiltinFunc.xml | 34 ++++---- .../doc_classes/VisualScriptEditor.xml | 2 +- 31 files changed, 406 insertions(+), 298 deletions(-) create mode 100644 doc/classes/EditorScenePostImport.xml diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index d9bdf0e3cff..62e2222d213 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -73,6 +73,9 @@ [TranslationServer] singleton + + [VisualScriptEditor] singleton + [VisualServer] singleton diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 3bb40755a63..aa477b2e047 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -88,6 +88,32 @@ Returns the last element of the array if the array is not empty (size>0). + + + + + + + + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. + + + + + + + + + + + + + + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. + + Clear the array (resize to 0). @@ -260,32 +286,6 @@ Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. - - - - - - - - - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. - - - - - - - - - - - - - - - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. - - diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index c8a28621ea2..0e9e16ae8a5 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -24,7 +24,7 @@ - + Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index bb3a9b38458..3b34e1b2701 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -271,39 +271,6 @@ Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. - - - - - Used for editing, returns an opaque value representing the transform state. - - - - - - - - - Used for editing, handle rotation. - - - - - - - - - - - - - - - - - Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation (radians) and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. - - @@ -346,20 +313,6 @@ Get the global transform matrix of this item in relation to the canvas. - - - - - Get a [Rect2] with the boundaries of this item and its children. - - - - - - - Return a rect containing the editable boundaries of the item. - - diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index ce49ec66548..1e5d9805fb9 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -103,6 +103,19 @@ [/codeblock] + + + + + + + Returns a new color resulting from making this color darker by the specified percentage (0-1). + [codeblock] + var green = Color(0.0, 1.0, 0.0) + var darkgreen = green.darkened(0.2) # 20% darker than regular green + [/codeblock] + + @@ -139,19 +152,6 @@ [/codeblock] - - - - - - - Returns a new color resulting from making this color darker by the specified percentage (0-1). - [codeblock] - var green = Color(0.0, 1.0, 0.0) - var darkgreen = green.darkened(0.2) # 20% darker than regular green - [/codeblock] - - diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 57966fb74e3..56cd75b8dda 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -909,6 +909,10 @@ Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one. + + + + diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index a3bab32476d..40ddb1a7eca 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -14,6 +14,12 @@ + + + + + + @@ -41,11 +47,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml new file mode 100644 index 00000000000..80bf30f7a41 --- /dev/null +++ b/doc/classes/EditorScenePostImport.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 950b43417b7..468463faf7a 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -514,6 +514,12 @@ Fired when a multiple selection is altered on a list allowing multiple selection. + + + + + + diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 1c625d59e1d..f7b7264e942 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -137,6 +137,8 @@ + + @@ -155,33 +157,35 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 432f583566c..3eae13cb50c 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -274,7 +274,7 @@ If [code]false[/code] existing text cannot be modified and new text cannot be added. - + If [code]true[/code] the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 195dd9265fa..0d5a288330a 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -20,15 +20,6 @@ Multiplies the current scale by the 'ratio' vector. - - - - - - - Sets the node's pivot position. - - diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index c7068643791..58635b3b82d 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -22,6 +22,18 @@ Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. + + + + + + + + + + + + @@ -38,13 +50,6 @@ Get the number of node names which make up the path. - - - - - Get the path's property name, or an empty string if the path doesn't have a property. - - diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 8f82040eca6..f86c33f59ca 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -127,13 +127,6 @@ Returns the current screen index (0 padded). - - - - - Returns the absolute directory path where user data is written ([code]user://[/code]). - - @@ -397,6 +390,13 @@ You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. + + + + + Returns the absolute directory path where user data is written ([code]user://[/code]). + + diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index bea4c14a3c4..28d6ed11689 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -178,6 +178,14 @@ - "method_name" is a name of method to which signal is connected. + + + + + + + + @@ -338,6 +346,16 @@ If set to true, signal emission is blocked. + + + + + + + + + + diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index ca7dbab8b8c..09b156ba711 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -18,7 +18,7 @@ Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. - If the shape can not move, the array will be empty. + If the shape can not move, the array will be empty. @@ -61,8 +61,6 @@ - - Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the point is in. @@ -70,7 +68,7 @@ collider_id: Id of the object the point is in. collider: Object the point is inside of. rid: [RID] of the object the point is in. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. @@ -84,8 +82,6 @@ - - Intersect a ray in a given space. The returned object is a dictionary with the following fields: position: Place where ray is stopped. @@ -96,7 +92,7 @@ collider: Object against which the ray was stopped. rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. @@ -118,23 +114,5 @@ - - Check for collisions with static bodies. - - - Check for collisions with kinematic bodies. - - - Check for collisions with rigid bodies. - - - Check for collisions with rigid bodies in character mode. - - - Check for collisions with any kind of bodies (but not areas). - - - Check for collisions with areas. - diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 829aec7a257..b0d4363c6b7 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -39,13 +39,6 @@ Return the current movement speed of the shape. - - - - - Return the type of object the shape belongs to. - - @@ -96,15 +89,6 @@ Set the current movement speed of the shape. - - - - - - - Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). - - diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index b5765b64213..c93adefcc41 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -48,8 +48,6 @@ - - @@ -65,17 +63,5 @@ - - - - - - - - - - - - diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index b9023194d7c..4e3539beb6c 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -9,7 +9,7 @@ - + @@ -27,12 +27,6 @@ - - - - - - @@ -45,10 +39,10 @@ - + - + @@ -69,14 +63,6 @@ - - - - - - - - diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index d5f57c43c80..68fd2382283 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -107,13 +107,6 @@ Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. - - - - - Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState]. - - @@ -183,15 +176,6 @@ Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - - - - - - - Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. - - @@ -203,13 +187,6 @@ If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. - - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. - Example: - [codeblock] - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - [/codeblock] - diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index f5828da7962..b722d801ee0 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -113,13 +113,6 @@ Returns whether this ray should hit your parent node, if it's a body. - - - - - Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [Physics2DDirectSpaceState]. - - @@ -198,15 +191,6 @@ Toggle whether this ray should hit your parent node, if it's a body. - - - - - - - Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [Physics2DDirectSpaceState], eg. [code]Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. - - @@ -221,13 +205,6 @@ If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code]. - - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. - Example: - [codeblock] - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - [/codeblock] - diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 18e77ff5e32..41b9975d3ac 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -403,18 +403,18 @@ Triggered when the user clicks on content between [url] tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack. - - - - - Triggers when the mouse enters a meta tag. - - - Triggers when the mouse exits a meta tag. + Triggers when the mouse exits a meta tag. + + + + + + + Triggers when the mouse enters a meta tag. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index e007decf47f..9ba51114782 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -35,6 +35,18 @@ + + + + + + + + + + + + @@ -69,6 +81,12 @@ + + + + + + @@ -113,6 +131,14 @@ + + + + + + + + @@ -163,6 +189,8 @@ + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 0e862a79039..f507431ad2b 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -37,6 +37,14 @@ Add a keyword and its color. + + + + + + + + @@ -137,6 +145,8 @@ + + @@ -147,6 +157,20 @@ Cut the current selection. + + + + + + + + + + + + + + @@ -239,6 +263,20 @@ Returns true if the context menu is enabled. + + + + + + + + + + + + + + @@ -252,6 +290,14 @@ + + + + + + + + @@ -360,6 +406,14 @@ Set the status of the context menu. When enabled, the context menu will appear when the [code]TextEdit[/code] is right clicked. + + + + + + + + @@ -377,6 +431,16 @@ + + + + + + + + + + @@ -462,6 +526,20 @@ Perform undo operation. + + + + + + + + + + + + + + @@ -472,6 +550,8 @@ + + diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c48f58f123e..c4615037d6f 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -252,10 +252,12 @@ + + Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y coordinates or transposed. + Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. @@ -505,9 +507,6 @@ The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). - - A [PoolIntArray] containing - The assigned [TileSet]. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index a1063567f8f..f6afa3340d2 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -12,6 +12,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -71,6 +113,8 @@ + + @@ -368,5 +412,25 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 822eee5838e..291be07c366 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -50,13 +50,13 @@ - + - + @@ -167,7 +167,7 @@ - + @@ -355,11 +355,11 @@ - + - + diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index d716d99e5dc..9a0d6ecf96c 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1942,33 +1942,33 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index e271665fd4a..55166bc407d 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -33,12 +33,6 @@ - - - - - - diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml index c45c8d2b64b..a62fc317c2d 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -170,55 +170,55 @@ 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/VisualScriptEditor.xml b/modules/visual_script/doc_classes/VisualScriptEditor.xml index 70d52b2bd73..a22e2533a73 100644 --- a/modules/visual_script/doc_classes/VisualScriptEditor.xml +++ b/modules/visual_script/doc_classes/VisualScriptEditor.xml @@ -1,5 +1,5 @@ - +