From f9a758772ad7461d57c81b37ccf43e7b0f4ef0de Mon Sep 17 00:00:00 2001 From: Micky Date: Sat, 17 Feb 2024 01:06:33 +0100 Subject: [PATCH] Update many Deprecated/Experimental descriptions for consistency --- doc/classes/@GlobalScope.xml | 8 ++++---- doc/classes/AnimatedTexture.xml | 2 +- doc/classes/AnimationMixer.xml | 4 ++-- doc/classes/AnimationPlayer.xml | 6 ++++++ doc/classes/AnimationTree.xml | 2 ++ doc/classes/Control.xml | 4 ++-- doc/classes/HTTPClient.xml | 4 ++-- doc/classes/LightmapGIData.xml | 2 +- doc/classes/MultiMesh.xml | 13 ++++++++----- doc/classes/NavigationMeshGenerator.xml | 4 ++-- doc/classes/NavigationServer3D.xml | 3 +-- doc/classes/Node.xml | 3 +-- doc/classes/RenderingDevice.xml | 5 +++++ doc/classes/RenderingServer.xml | 9 ++++----- doc/classes/Resource.xml | 2 +- doc/classes/Skeleton3D.xml | 2 +- doc/classes/SurfaceTool.xml | 2 +- doc/classes/TextureRect.xml | 3 +-- doc/classes/TileMap.xml | 13 +++++++------ doc/classes/TreeItem.xml | 4 ++-- doc/classes/Viewport.xml | 3 +-- doc/classes/Window.xml | 2 +- doc/classes/XRInterface.xml | 6 +++--- .../doc_classes/SceneReplicationConfig.xml | 8 ++++---- 24 files changed, 63 insertions(+), 51 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 4cf5a88dd780..ce7bf4ef5ccc 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -2889,7 +2889,7 @@ [/codeblocks] [b]Note:[/b] The trailing colon is required for properly detecting built-in types. - + Hints that an object is too big to be sent via the debugger. @@ -2903,7 +2903,7 @@ Hints that a [String] property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the entire filesystem. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code]. See also [member FileDialog.filters]. - + Hints that an [int] property is a pointer. Used by GDExtension. @@ -2974,7 +2974,7 @@ If this property is modified, all inspector fields will be refreshed. - + The property is an enum, i.e. it only takes named integer constants from its associated enumeration. @@ -3003,7 +3003,7 @@ Inserting an animation key frame of this property will automatically increment the value, allowing to easily keyframe multiple values in a row. - + When this property is a [Resource] and base object is a [Node], a resource instance will be automatically created whenever the node is created in the editor. diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index aad16f6f3acd..d443541e268d 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -1,5 +1,5 @@ - + Proxy texture for simple frame-based animations. diff --git a/doc/classes/AnimationMixer.xml b/doc/classes/AnimationMixer.xml index e521baffda26..e7ec7af8e716 100644 --- a/doc/classes/AnimationMixer.xml +++ b/doc/classes/AnimationMixer.xml @@ -279,7 +279,7 @@ To make the blended results look good, it is recommended to set this to [constant ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS] to update every frame during blending. Other values exist for compatibility and they are fine if there is no blending, but not so, may produce artifacts. - The call mode to use for Call Method tracks. + The call mode used for "Call Method" tracks. The process notification in which to update animations. @@ -301,7 +301,7 @@ If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be canceled visually, and the animation will appear to stay in place. See also [method get_root_motion_position], [method get_root_motion_rotation], [method get_root_motion_scale] and [RootMotionView]. - The node from which node path references will travel. + The node which node path references will travel from. diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 6236f96e63a9..e023f2d41a5b 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -47,6 +47,7 @@ + Returns the call mode used for "Call Method" tracks. @@ -59,6 +60,7 @@ + Returns the process notification in which to update animations. @@ -70,6 +72,7 @@ + Returns the node which node path references will travel from. @@ -159,18 +162,21 @@ + Sets the call mode used for "Call Method" tracks. + Sets the process notification in which to update animations. + Sets the node which node path references will travel from. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 778b5cf51349..d240a4967e1f 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -15,12 +15,14 @@ + Returns the process notification in which to update animations. + Sets the process notification in which to update animations. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 07f41192f7cd..a13bf0870d20 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1158,12 +1158,12 @@ [b]Note:[/b] [member CanvasItem.z_index] doesn't affect which Control receives the notification. See also [constant NOTIFICATION_MOUSE_EXIT_SELF]. - + Sent when the mouse cursor enters the control's visible area, that is not occluded behind other Controls or Windows, provided its [member mouse_filter] lets the event reach it and regardless if it's currently focused or not. [b]Note:[/b] [member CanvasItem.z_index] doesn't affect which Control receives the notification. See also [constant NOTIFICATION_MOUSE_ENTER]. - + Sent when the mouse cursor leaves the control's visible area, that is not occluded behind other Controls or Windows, provided its [member mouse_filter] lets the event reach it and regardless if it's currently focused or not. [b]Note:[/b] [member CanvasItem.z_index] doesn't affect which Control receives the notification. See also [constant NOTIFICATION_MOUSE_EXIT]. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 4befe2f8ec7d..25b6a48283ff 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -322,10 +322,10 @@ HTTP status code [code]304 Not Modified[/code]. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to [code]false[/code]. - + HTTP status code [code]305 Use Proxy[/code]. - + HTTP status code [code]306 Switch Proxy[/code]. diff --git a/doc/classes/LightmapGIData.xml b/doc/classes/LightmapGIData.xml index b1ba6c5d848a..76824f84a081 100644 --- a/doc/classes/LightmapGIData.xml +++ b/doc/classes/LightmapGIData.xml @@ -54,7 +54,7 @@ - + The lightmap atlas texture generated by the lightmapper. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index cd6397137b69..1ac79cd3da2f 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -90,13 +90,14 @@ - + + Array containing each [Color] used by all instances of this mesh. Custom AABB for this MultiMesh resource. Setting this manually prevents costly runtime AABB recalculations. - - See [method set_instance_custom_data]. + + Array containing each custom data value used by all instances of this mesh, as a [PackedColorArray]. Number of instances that will get drawn. This clears and (re)sizes the buffers. Setting data format or flags afterwards will have no effect. @@ -106,9 +107,11 @@ [Mesh] resource to be instanced. The looks of the individual instances can be modified using [method set_instance_color] and [method set_instance_custom_data]. - + + Array containing each [Transform2D] value used by all instances of this mesh, as a [PackedVector2Array]. Each transform is divided into 3 [Vector2] values corresponding to the transforms' [code]x[/code], [code]y[/code], and [code]origin[/code]. - + + Array containing each [Transform3D] value used by all instances of this mesh, as a [PackedVector3Array]. Each transform is divided into 4 [Vector3] values corresponding to the transforms' [code]x[/code], [code]y[/code], [code]z[/code], and [code]origin[/code]. Format of transform used to transform mesh, either 2D or 3D. diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 35c9e13e58b6..c017a16dfab2 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -14,12 +14,12 @@ $DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html - + - The bake function is deprecated due to core threading changes. To upgrade existing code, first create a [NavigationMeshSourceGeometryData3D] resource. Use this resource with [method parse_source_geometry_data] to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with [method bake_from_source_geometry_data] to bake a navigation mesh. + Bakes the [param navigation_mesh] with source geometry collected starting from the [param root_node]. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 95a803b6e561..e88792cadee1 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -886,13 +886,12 @@ Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query. - + Bakes the [param navigation_mesh] with bake source geometry collected starting from the [param root_node]. - [i]Deprecated.[/i] To upgrade existing code, first create a [NavigationMeshSourceGeometryData3D] resource. Use this resource with [method parse_source_geometry_data] to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with [method bake_from_source_geometry_data] to bake a navigation mesh. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index a46bb593d478..92bbacd62a06 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -1068,8 +1068,7 @@ Notification received when the node is about to exit a [SceneTree]. See [method _exit_tree]. This notification is received [i]after[/i] the related [signal tree_exiting] signal. - - This notification is no longer emitted. + Notification received when the node is ready. See [method _ready]. diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 8969d66b35d8..33cd831175ed 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -19,6 +19,7 @@ + This method does nothing. @@ -194,6 +195,7 @@ + This method does nothing. @@ -254,6 +256,7 @@ + This method does nothing and always returns an empty [PackedInt64Array]. @@ -348,6 +351,7 @@ + This method does nothing and always returns an empty [PackedInt64Array]. @@ -438,6 +442,7 @@ + This method does nothing. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 54a11af629e3..1658ad86b734 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1560,7 +1560,7 @@ - Always returns false. + This method does nothing and always returns [code]false[/code]. @@ -3390,7 +3390,7 @@ - This method does nothing when called and always returns a null [RID]. + This method does nothing and always returns an invalid [RID]. @@ -3398,7 +3398,7 @@ - This method should not be used. + This method does nothing. @@ -4059,8 +4059,7 @@ The maximum number of glow levels that can be used with the glow post-processing effect. - - This constant is unused internally. + The maximum number of directional lights that can be rendered at a given time in 2D. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index ee6546dd1480..a7df88f7c6dc 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -71,7 +71,7 @@ Returns the [RID] of this resource (or an empty RID). Many resources (such as [Texture2D], [Mesh], and so on) are high-level abstractions of resources stored in a specialized server ([DisplayServer], [RenderingServer], etc.), so this function will return the original [RID]. - + Calls [method _setup_local_to_scene]. If [member resource_local_to_scene] is set to [code]true[/code], this method is automatically called from [method PackedScene.instantiate] by the newly duplicated resource within the scene instance. diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 360fc9b2a9c2..2c55f0dcd11c 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -44,7 +44,7 @@ Returns the bone index that matches [param name] as its name. - + Force updates the bone transforms/poses for all bones in the skeleton. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 6df5a4d18e47..b4a88513ec40 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -119,7 +119,7 @@ Removes the index array by expanding the vertex array. - + diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index 73fbbb783e58..d18c4a1eee47 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -10,9 +10,8 @@ https://godotengine.org/asset-library/asset/676 - + Defines how minimum size is determined based on the texture's size. See [enum ExpandMode] for options. - [b]Note:[/b] Using [constant EXPAND_FIT_WIDTH], [constant EXPAND_FIT_WIDTH_PROPORTIONAL], [constant EXPAND_FIT_HEIGHT] or [constant EXPAND_FIT_HEIGHT_PROPORTIONAL] may result in unstable behavior in some containers. This functionality is being re-evaluated and will change in the future. If [code]true[/code], texture is flipped horizontally. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index e1e16e86a764..1bb23211c956 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -80,6 +80,7 @@ + Forces the TileMap and the layer [param layer] to update. @@ -167,7 +168,7 @@ - Returns the [NavigationServer2D] navigation map [RID] currently assigned to the specified TileMap [param layer]. + Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified TileMap layer [param layer]. By default the TileMap uses the default [World2D] navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. In order to make [NavigationAgent2D] switch between TileMap layer navigation maps use [method NavigationAgent2D.set_navigation_map] with the navigation map received from [method get_layer_navigation_map]. If [param layer] is negative, the layers are accessed from the last one. @@ -195,11 +196,11 @@ Returns the number of layers in the TileMap. - + - See [method get_layer_navigation_map]. + Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified TileMap layer [param layer]. @@ -409,7 +410,7 @@ - Assigns a [NavigationServer2D] navigation map [RID] to the specified TileMap [param layer]. + Assigns [param map] as a [NavigationServer2D] navigation map for the specified TileMap layer [param layer]. By default the TileMap uses the default [World2D] navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. In order to make [NavigationAgent2D] switch between TileMap layer navigation maps use [method NavigationAgent2D.set_navigation_map] with the navigation map received from [method get_layer_navigation_map]. If [param layer] is negative, the layers are accessed from the last one. @@ -444,12 +445,12 @@ If [param layer] is negative, the layers are accessed from the last one. - + - See [method set_layer_navigation_map]. + Assigns [param map] as a [NavigationServer2D] navigation map for the specified TileMap layer [param layer]. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index b79a8cbdb49e..a1173d4628aa 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -574,8 +574,8 @@ - Sets the given column's custom draw callback to [param callback] method on [param object]. - The [param callback] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. + Sets the given column's custom draw callback to the [param callback] method on [param object]. + The method named [param callback] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 711f6eadf838..930e437aa5b9 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -192,9 +192,8 @@ - Triggers the given [InputEvent] in this [Viewport]. This can be used to pass input events between viewports, or to locally apply inputs that were sent over the network or saved to a file. + Triggers the given [param event] in this [Viewport]. This can be used to pass an [InputEvent] between viewports, or to locally apply inputs that were sent over the network or saved to a file. If [param in_local_coords] is [code]false[/code], the event's position is in the embedder's coordinates and will be converted to viewport coordinates. If [param in_local_coords] is [code]true[/code], the event's position is in viewport coordinates. - While this method serves a similar purpose as [method Input.parse_input_event], it does not remap the specified [param event] based on project settings like [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse]. Calling this method will propagate calls to child nodes for following methods in the given order: - [method Node._shortcut_input] - [method Node._unhandled_key_input] diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 63caaefe0703..97c7ffdd3c42 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -360,7 +360,7 @@ - Moves the [Window] on top of other windows and focuses it. + Causes the window to grab focus, allowing it to receive user input. diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 5276e0537907..ced641611f00 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -99,19 +99,19 @@ - Is [code]true[/code] if this interface has been initialized. + Returns [code]true[/code] if this interface has been initialized. - Is [code]true[/code] if passthrough is enabled. + Returns [code]true[/code] if passthrough is enabled. - Is [code]true[/code] if this interface supports passthrough. + Returns [code]true[/code] if this interface supports passthrough. diff --git a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml index 8b9203d31604..a4f7fad2f0a3 100644 --- a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml +++ b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml @@ -27,7 +27,7 @@ - Returns whether the given [param path] is configured for synchronization. + Returns [code]true[/code] if the given [param path] is configured for synchronization. @@ -48,21 +48,21 @@ - Returns whether the property identified by the given [param path] is configured to be synchronized on spawn. + Returns [code]true[/code] if the property identified by the given [param path] is configured to be synchronized on spawn. - Returns whether the property identified by the given [param path] is configured to be synchronized on process. + Returns [code]true[/code] if the property identified by the given [param path] is configured to be synchronized on process. - Returns whether the property identified by the given [param path] is configured to be reliably synchronized when changes are detected on process. + Returns [code]true[/code] if the property identified by the given [param path] is configured to be reliably synchronized when changes are detected on process.