From 2db7ecd410b24ba6a12118aa04c488f2f2770ff1 Mon Sep 17 00:00:00 2001 From: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Date: Mon, 23 Jun 2025 16:34:51 +0200 Subject: [PATCH] [Docs] Various grammar and spelling fixes --- doc/classes/AABB.xml | 4 ++-- doc/classes/BitMap.xml | 2 +- doc/classes/CodeEdit.xml | 2 +- doc/classes/CubemapArray.xml | 2 +- doc/classes/DisplayServer.xml | 4 ++-- doc/classes/EditorDebuggerSession.xml | 2 +- doc/classes/EditorNode3DGizmo.xml | 2 +- doc/classes/EditorPlugin.xml | 2 +- doc/classes/HTTPClient.xml | 2 +- doc/classes/HTTPRequest.xml | 2 +- doc/classes/NavigationMeshSourceGeometryData3D.xml | 2 +- doc/classes/Node.xml | 4 ++-- doc/classes/OS.xml | 2 +- doc/classes/Performance.xml | 2 +- doc/classes/ProjectSettings.xml | 2 +- doc/classes/RDShaderSPIRV.xml | 4 ++-- doc/classes/RID.xml | 2 +- doc/classes/RenderSceneBuffers.xml | 2 +- doc/classes/RenderingDevice.xml | 12 ++++++------ doc/classes/RenderingServer.xml | 6 +++--- doc/classes/Resource.xml | 2 +- doc/classes/ResourceImporterImage.xml | 2 +- doc/classes/ResourceImporterSVG.xml | 2 +- doc/classes/ResourceImporterShaderFile.xml | 2 +- doc/classes/ScriptEditorBase.xml | 2 +- doc/classes/SpringBoneCollisionPlane3D.xml | 4 ++-- doc/classes/TextMesh.xml | 4 ++-- doc/classes/Viewport.xml | 2 +- doc/classes/XRFaceModifier3D.xml | 2 +- doc/classes/XRInterfaceExtension.xml | 2 +- doc/classes/XRNode3D.xml | 2 +- doc/classes/XRPositionalTracker.xml | 4 ++-- doc/classes/XRServer.xml | 2 +- doc/classes/XRTracker.xml | 14 +++++++------- modules/openxr/doc_classes/OpenXRAPIExtension.xml | 2 +- .../openxr/doc_classes/OpenXRBindingModifier.xml | 2 +- .../OpenXRInteractionProfileMetadata.xml | 2 +- .../doc_classes/OpenXRRenderModelExtension.xml | 2 +- modules/theora/doc_classes/VideoStreamTheora.xml | 2 +- modules/upnp/doc_classes/UPNP.xml | 2 +- modules/webxr/doc_classes/WebXRInterface.xml | 2 +- 41 files changed, 61 insertions(+), 61 deletions(-) diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index cb43c196cda..1b170f395ad 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -7,7 +7,7 @@ The [AABB] built-in [Variant] type represents an axis-aligned bounding box in a 3D space. It is defined by its [member position] and [member size], which are [Vector3]. It is frequently used for fast overlap tests (see [method intersects]). Although [AABB] itself is axis-aligned, it can be combined with [Transform3D] to represent a rotated or skewed bounding box. It uses floating-point coordinates. The 2D counterpart to [AABB] is [Rect2]. There is no version of [AABB] that uses integer coordinates. [b]Note:[/b] Negative values for [member size] are not supported. With negative size, most [AABB] methods do not work correctly. Use [method abs] to get an equivalent [AABB] with a non-negative size. - [b]Note:[/b] In a boolean context, a [AABB] evaluates to [code]false[/code] if both [member position] and [member size] are zero (equal to [constant Vector3.ZERO]). Otherwise, it always evaluates to [code]true[/code]. + [b]Note:[/b] In a boolean context, an [AABB] evaluates to [code]false[/code] if both [member position] and [member size] are zero (equal to [constant Vector3.ZERO]). Otherwise, it always evaluates to [code]true[/code]. $DOCS_URL/tutorials/math/index.html @@ -127,7 +127,7 @@ - Returns the position of one of the 8 vertices that compose this bounding box. With a [param idx] of [code]0[/code] this is the same as [member position], and a [param idx] of [code]7[/code] is the same as [member end]. + Returns the position of one of the 8 vertices that compose this bounding box. With an [param idx] of [code]0[/code] this is the same as [member position], and an [param idx] of [code]7[/code] is the same as [member end]. diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index fa454a1b0de..39e59154734 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -12,7 +12,7 @@ - Returns an image of the same size as the bitmap and with a [enum Image.Format] of type [constant Image.FORMAT_L8]. [code]true[/code] bits of the bitmap are being converted into white pixels, and [code]false[/code] bits into black. + Returns an image of the same size as the bitmap and with an [enum Image.Format] of type [constant Image.FORMAT_L8]. [code]true[/code] bits of the bitmap are being converted into white pixels, and [code]false[/code] bits into black. diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index edc0ee87824..44139739940 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -22,7 +22,7 @@ Override this method to define what items in [param candidates] should be displayed. - Both [param candidates] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. + Both [param candidates] and the return is an [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. diff --git a/doc/classes/CubemapArray.xml b/doc/classes/CubemapArray.xml index 0a099a46e2d..47786611f8e 100644 --- a/doc/classes/CubemapArray.xml +++ b/doc/classes/CubemapArray.xml @@ -13,7 +13,7 @@ - [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/tutorials/assets_pipeline/img/cubemap_template_3x2.webp]3×2 cubemap template[/url] - [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/tutorials/assets_pipeline/img/cubemap_template_1x6.webp]1×6 cubemap template[/url] - [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/tutorials/assets_pipeline/img/cubemap_template_6x1.webp]6×1 cubemap template[/url] - Multiple layers are stacked on top of each other when using the default vertical import option (with the first layer at the top). Alternatively, you can choose an horizontal layout in the import options (with the first layer at the left). + Multiple layers are stacked on top of each other when using the default vertical import option (with the first layer at the top). Alternatively, you can choose a horizontal layout in the import options (with the first layer at the left). [b]Note:[/b] [CubemapArray] is not supported in the Compatibility renderer due to graphics API limitations. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index b29b4edf63a..d5e1d980580 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -651,7 +651,7 @@ Returns the user's clipboard as an image if possible. - [b]Note:[/b] This method uses the copied pixel data, e.g. from a image editing software or a web browser, not an image file copied from file explorer. + [b]Note:[/b] This method uses the copied pixel data, e.g. from an image editing software or a web browser, not an image file copied from file explorer. @@ -1976,7 +1976,7 @@ - Returns an [PackedStringArray] of voice identifiers for the [param language]. + Returns a [PackedStringArray] of voice identifiers for the [param language]. [b]Note:[/b] This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. diff --git a/doc/classes/EditorDebuggerSession.xml b/doc/classes/EditorDebuggerSession.xml index f5fa3e34d5e..4bd52f9d04a 100644 --- a/doc/classes/EditorDebuggerSession.xml +++ b/doc/classes/EditorDebuggerSession.xml @@ -4,7 +4,7 @@ A class to interact with the editor debugger. - This class cannot be directly instantiated and must be retrieved via a [EditorDebuggerPlugin]. + This class cannot be directly instantiated and must be retrieved via an [EditorDebuggerPlugin]. You can add tabs to the session UI via [method add_session_tab], send messages via [method send_message], and toggle [EngineProfiler]s via [method toggle_profiler]. diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index 7597489601e..febff1bdea7 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -4,7 +4,7 @@ Gizmo for editing [Node3D] objects. - Gizmo that is used for providing custom visualization and editing (handles and subgizmos) for [Node3D] objects. Can be overridden to create custom gizmos, but for simple gizmos creating a [EditorNode3DGizmoPlugin] is usually recommended. + Gizmo that is used for providing custom visualization and editing (handles and subgizmos) for [Node3D] objects. Can be overridden to create custom gizmos, but for simple gizmos creating an [EditorNode3DGizmoPlugin] is usually recommended. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index e8df4c8eb63..9892d208329 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -540,7 +540,7 @@ - Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. + Add an [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. If [param first_priority] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index b7cddae28b1..08dc5fef5b7 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -7,7 +7,7 @@ Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. See the [HTTPRequest] node for a higher-level alternative. [b]Note:[/b] This client only needs to connect to a host once (see [method connect_to_host]) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See [method request] for a full example and to get started. - A [HTTPClient] should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports Transport Layer Security (TLS), including server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. + An [HTTPClient] should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports Transport Layer Security (TLS), including server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. For more information on HTTP, see [url=https://developer.mozilla.org/en-US/docs/Web/HTTP]MDN's documentation on HTTP[/url] (or read [url=https://tools.ietf.org/html/rfc2616]RFC 2616[/url] to get it straight from the source). [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. [b]Note:[/b] It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 5d262eb1c70..4275251d8c9 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -150,7 +150,7 @@ } [/csharp] [/codeblocks] - [b]Note:[/b] [HTTPRequest] nodes will automatically handle decompression of response bodies. A [code]Accept-Encoding[/code] header will be automatically added to each of your requests, unless one is already specified. Any response with a [code]Content-Encoding: gzip[/code] header will automatically be decompressed and delivered to you as uncompressed bytes. + [b]Note:[/b] [HTTPRequest] nodes will automatically handle decompression of response bodies. An [code]Accept-Encoding[/code] header will be automatically added to each of your requests, unless one is already specified. Any response with a [code]Content-Encoding: gzip[/code] header will automatically be decompressed and delivered to you as uncompressed bytes. $DOCS_URL/tutorials/networking/http_request_class.html diff --git a/doc/classes/NavigationMeshSourceGeometryData3D.xml b/doc/classes/NavigationMeshSourceGeometryData3D.xml index aa43dff52d5..8245ec88e8d 100644 --- a/doc/classes/NavigationMeshSourceGeometryData3D.xml +++ b/doc/classes/NavigationMeshSourceGeometryData3D.xml @@ -40,7 +40,7 @@ - Adds a projected obstruction shape to the source geometry. The [param vertices] are considered projected on a xz-axes plane, placed at the global y-axis [param elevation] and extruded by [param height]. If [param carve] is [code]true[/code] the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. + Adds a projected obstruction shape to the source geometry. The [param vertices] are considered projected on an xz-axes plane, placed at the global y-axis [param elevation] and extruded by [param height]. If [param carve] is [code]true[/code] the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 9267d0d0c1d..6fddc0f44ec 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -450,7 +450,7 @@ - Element [code]0[/code] is the [Node], or [code]null[/code] if not found; - Element [code]1[/code] is the subname's last nested [Resource], or [code]null[/code] if not found; - Element [code]2[/code] is the remaining [NodePath], referring to an existing, non-[Resource] property (see [method Object.get_indexed]). - [b]Example:[/b] Assume that the child's [member Sprite2D.texture] has been assigned a [AtlasTexture]: + [b]Example:[/b] Assume that the child's [member Sprite2D.texture] has been assigned an [AtlasTexture]: [codeblocks] [gdscript] var a = get_node_and_resource("Area2D/Sprite2D") @@ -1008,7 +1008,7 @@ - If set to [code]true[/code], the node becomes a [InstancePlaceholder] when packed and instantiated from a [PackedScene]. See also [method get_scene_instance_load_placeholder]. + If set to [code]true[/code], the node becomes an [InstancePlaceholder] when packed and instantiated from a [PackedScene]. See also [method get_scene_instance_load_placeholder]. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 57c1b6c7505..018e42a6572 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -737,7 +737,7 @@ Opens one or more files/directories with the specified application. The [param program_path] specifies the path to the application to use for opening the files, and [param paths] contains an array of file/directory paths to open. [b]Note:[/b] This method is mostly only relevant for macOS, where opening files using [method create_process] might fail. On other platforms, this falls back to using [method create_process]. - [b]Note:[/b] On macOS, [param program_path] should ideally be the path to an [code].app[/code] bundle. + [b]Note:[/b] On macOS, [param program_path] should ideally be the path to a [code].app[/code] bundle. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 1590ee7abdf..20f858e1e65 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -231,7 +231,7 @@ Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required. - Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading an scene the first time a user runs the game and the pipeline is required. + Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading a scene the first time a user runs the game and the pipeline is required. Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index ab34c5077f8..6c3e78ace0f 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -3383,7 +3383,7 @@ The default compression factor for lossless WebP. Decompression speed is mostly unaffected by the compression factor. Supported values are 0 to 100. - If [code]true[/code], enables [member Viewport.use_hdr_2d] on the root viewport. 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an [code]RGBA16[/code] framebuffer, while when using the Mobile renderer it will be an [code]RGB10_A2[/code] framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen. Practically speaking, this means that the end result of the Viewport will not be clamped into the [code]0-1[/code] range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. + If [code]true[/code], enables [member Viewport.use_hdr_2d] on the root viewport. 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an [code]RGBA16[/code] framebuffer, while when using the Mobile renderer it will be an [code]RGB10_A2[/code] framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen. Practically speaking, this means that the end result of the Viewport will not be clamped into the [code]0-1[/code] range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. [b]Note:[/b] This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons. [b]Note:[/b] This property is only read when the project starts. To toggle HDR 2D at runtime, set [member Viewport.use_hdr_2d] on the root [Viewport]. diff --git a/doc/classes/RDShaderSPIRV.xml b/doc/classes/RDShaderSPIRV.xml index dd8a292c610..f3de94072f9 100644 --- a/doc/classes/RDShaderSPIRV.xml +++ b/doc/classes/RDShaderSPIRV.xml @@ -1,10 +1,10 @@ - SPIR-V intermediate representation as part of a [RDShaderFile] (used by [RenderingDevice]). + SPIR-V intermediate representation as part of an [RDShaderFile] (used by [RenderingDevice]). - [RDShaderSPIRV] represents a [RDShaderFile]'s [url=https://www.khronos.org/spir/]SPIR-V[/url] code for various shader stages, as well as possible compilation error messages. SPIR-V is a low-level intermediate shader representation. This intermediate representation is not used directly by GPUs for rendering, but it can be compiled into binary shaders that GPUs can understand. Unlike compiled shaders, SPIR-V is portable across GPU models and driver versions. + [RDShaderSPIRV] represents an [RDShaderFile]'s [url=https://www.khronos.org/spir/]SPIR-V[/url] code for various shader stages, as well as possible compilation error messages. SPIR-V is a low-level intermediate shader representation. This intermediate representation is not used directly by GPUs for rendering, but it can be compiled into binary shaders that GPUs can understand. Unlike compiled shaders, SPIR-V is portable across GPU models and driver versions. This object is used by [RenderingDevice]. diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 323ac3b0ec2..a5c3ddb48e1 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -21,7 +21,7 @@ - Constructs a [RID] as a copy of the given [RID]. + Constructs an [RID] as a copy of the given [RID]. diff --git a/doc/classes/RenderSceneBuffers.xml b/doc/classes/RenderSceneBuffers.xml index 1a1c3f413bb..1b2f5cad4db 100644 --- a/doc/classes/RenderSceneBuffers.xml +++ b/doc/classes/RenderSceneBuffers.xml @@ -14,7 +14,7 @@ - This method is called by the rendering server when the associated viewports configuration is changed. It will discard the old buffers and recreate the internal buffers used. + This method is called by the rendering server when the associated viewport's configuration is changed. It will discard the old buffers and recreate the internal buffers used. diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 73847793810..3ab4aa107da 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -806,7 +806,7 @@ - Compiles a SPIR-V from the shader source code in [param shader_source] and returns the SPIR-V as a [RDShaderSPIRV]. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using [method shader_compile_binary_from_spirv]. + Compiles a SPIR-V from the shader source code in [param shader_source] and returns the SPIR-V as an [RDShaderSPIRV]. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using [method shader_compile_binary_from_spirv]. If [param allow_cache] is [code]true[/code], make use of the shader cache generated by Godot. This avoids a potentially lengthy shader compilation step if the shader is already in cache. If [param allow_cache] is [code]false[/code], Godot's shader cache is ignored and the shader will always be recompiled. @@ -966,8 +966,8 @@ Returns the [param texture] data for the specified [param layer] as raw binary data. For 2D textures (which only have one layer), [param layer] must be [code]0[/code]. - [b]Note:[/b] [param texture] can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to [constant FINAL_ACTION_CONTINUE]) to retrieve this texture. Otherwise, an error is printed and a empty [PackedByteArray] is returned. - [b]Note:[/b] [param texture] requires the [constant TEXTURE_USAGE_CAN_COPY_FROM_BIT] to be retrieved. Otherwise, an error is printed and a empty [PackedByteArray] is returned. + [b]Note:[/b] [param texture] can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to [constant FINAL_ACTION_CONTINUE]) to retrieve this texture. Otherwise, an error is printed and an empty [PackedByteArray] is returned. + [b]Note:[/b] [param texture] requires the [constant TEXTURE_USAGE_CAN_COPY_FROM_BIT] to be retrieved. Otherwise, an error is printed and an empty [PackedByteArray] is returned. [b]Note:[/b] This method will block the GPU from working until the data is retrieved. Refer to [method texture_get_data_async] for an alternative that returns the data in more performant way. @@ -2064,19 +2064,19 @@ Return a floating-point transparent black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. - Return a integer transparent black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. + Return an integer transparent black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. Return a floating-point opaque black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. - Return a integer opaque black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. + Return an integer opaque black color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. Return a floating-point opaque white color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. - Return a integer opaque white color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. + Return an integer opaque white color when sampling outside the [code][0.0, 1.0][/code] range. Only effective if the sampler repeat mode is [constant SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER]. Represents the size of the [enum SamplerBorderColor] enum. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 31aa49244fc..47c48f1487c 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -31,7 +31,7 @@ - As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as [RenderingDevice] and similar RD classes), push a callable via this function so it will be executed on the render thread. + As the RenderingServer actual logic may run on a separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as [RenderingDevice] and similar RD classes), push a callable via this function so it will be executed on the render thread. @@ -5893,7 +5893,7 @@ Cubemap sampler global shader parameter ([code]global uniform samplerCube ...[/code]). Exposed as a [Cubemap] in the editor UI. - External sampler global shader parameter ([code]global uniform samplerExternalOES ...[/code]). Exposed as a [ExternalTexture] in the editor UI. + External sampler global shader parameter ([code]global uniform samplerExternalOES ...[/code]). Exposed as an [ExternalTexture] in the editor UI. Represents the size of the [enum GlobalShaderParameterType] enum. @@ -5923,7 +5923,7 @@ Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required. - Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading an scene the first time a user runs the game and the pipeline is required. + Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading a scene the first time a user runs the game and the pipeline is required. Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 0d4e73d4d7d..9873db6d859 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -166,7 +166,7 @@ [b]Note:[/b] Setting this property manually may fail if a resource with the same path has already been previously loaded. If necessary, use [method take_over_path]. - An unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a [PackedScene]. If the resource is not inside a scene, this property is empty by default. + A unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a [PackedScene]. If the resource is not inside a scene, this property is empty by default. [b]Note:[/b] When the [PackedScene] is saved, if multiple resources in the same scene use the same ID, only the earliest resource in the scene hierarchy keeps the original ID. The other resources are assigned new IDs from [method generate_scene_unique_id]. [b]Note:[/b] Setting this property does not emit the [signal changed] signal. [b]Warning:[/b] When setting, the ID must only consist of letters, numbers, and underscores. Otherwise, it will fail and default to a randomly generated ID. diff --git a/doc/classes/ResourceImporterImage.xml b/doc/classes/ResourceImporterImage.xml index 8fbec8af01a..eb7219cc2e2 100644 --- a/doc/classes/ResourceImporterImage.xml +++ b/doc/classes/ResourceImporterImage.xml @@ -1,7 +1,7 @@ - Imports a image for use in scripting, with no rendering capabilities. + Imports an image for use in scripting, with no rendering capabilities. This importer imports [Image] resources, as opposed to [CompressedTexture2D]. If you need to render the image in 2D or 3D, use [ResourceImporterTexture] instead. diff --git a/doc/classes/ResourceImporterSVG.xml b/doc/classes/ResourceImporterSVG.xml index 4c14c85410a..625fb2b9177 100644 --- a/doc/classes/ResourceImporterSVG.xml +++ b/doc/classes/ResourceImporterSVG.xml @@ -1,7 +1,7 @@ - Imports a SVG file as a scalable texture for use in 2D or 3D rendering. + Imports an SVG file as a scalable texture for use in 2D or 3D rendering. This importer imports [SVGTexture] resources. See also [ResourceImporterTexture] and [ResourceImporterImage]. diff --git a/doc/classes/ResourceImporterShaderFile.xml b/doc/classes/ResourceImporterShaderFile.xml index 85863758d80..35f2ebc3e2b 100644 --- a/doc/classes/ResourceImporterShaderFile.xml +++ b/doc/classes/ResourceImporterShaderFile.xml @@ -1,7 +1,7 @@ - Imports native GLSL shaders (not Godot shaders) as a [RDShaderFile]. + Imports native GLSL shaders (not Godot shaders) as an [RDShaderFile]. This imports native GLSL shaders as [RDShaderFile] resources, for use with low-level [RenderingDevice] operations. This importer does [i]not[/i] handle [code].gdshader[/code] files. diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index 638bc921d63..1b0084d68b2 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -13,7 +13,7 @@ - Adds a [EditorSyntaxHighlighter] to the open script. + Adds an [EditorSyntaxHighlighter] to the open script. diff --git a/doc/classes/SpringBoneCollisionPlane3D.xml b/doc/classes/SpringBoneCollisionPlane3D.xml index d9f7199f5d1..6a6507ff3f1 100644 --- a/doc/classes/SpringBoneCollisionPlane3D.xml +++ b/doc/classes/SpringBoneCollisionPlane3D.xml @@ -1,10 +1,10 @@ - A infinite plane collision that interacts with [SpringBoneSimulator3D]. + An infinite plane collision that interacts with [SpringBoneSimulator3D]. - A infinite plane collision that interacts with [SpringBoneSimulator3D]. It is an infinite size XZ plane, and the +Y direction is treated as normal. + An infinite plane collision that interacts with [SpringBoneSimulator3D]. It is an infinite size XZ plane, and the +Y direction is treated as normal. diff --git a/doc/classes/TextMesh.xml b/doc/classes/TextMesh.xml index 481930c3039..cc11bb6d83b 100644 --- a/doc/classes/TextMesh.xml +++ b/doc/classes/TextMesh.xml @@ -1,10 +1,10 @@ - Generate an [PrimitiveMesh] from the text. + Generate a [PrimitiveMesh] from the text. - Generate an [PrimitiveMesh] from the text. + Generate a [PrimitiveMesh] from the text. TextMesh can be generated only when using dynamic fonts with vector glyph contours. Bitmap fonts (including bitmap data in the TrueType/OpenType containers, like color emoji fonts) are not supported. The UV layout is arranged in 4 horizontal strips, top to bottom: 40% of the height for the front face, 40% for the back face, 10% for the outer edges and 10% for the inner edges. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index e7eba28d654..f6f9895cb4b 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -449,7 +449,7 @@ See also [member ProjectSettings.rendering/anti_aliasing/quality/use_debanding] and [method RenderingServer.viewport_set_use_debanding]. - If [code]true[/code], 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an [code]RGBA16[/code] framebuffer, while when using the Mobile renderer it will be an [code]RGB10_A2[/code] framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the [code]0-1[/code] range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. + If [code]true[/code], 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an [code]RGBA16[/code] framebuffer, while when using the Mobile renderer it will be an [code]RGB10_A2[/code] framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the [code]0-1[/code] range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. [b]Note:[/b] This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons. diff --git a/doc/classes/XRFaceModifier3D.xml b/doc/classes/XRFaceModifier3D.xml index 9599051b1b8..9fb51575606 100644 --- a/doc/classes/XRFaceModifier3D.xml +++ b/doc/classes/XRFaceModifier3D.xml @@ -4,7 +4,7 @@ A node for driving standard face meshes from [XRFaceTracker] weights. - This node applies weights from a [XRFaceTracker] to a mesh with supporting face blend shapes. + This node applies weights from an [XRFaceTracker] to a mesh with supporting face blend shapes. The [url=https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/unified-blendshapes]Unified Expressions[/url] blend shapes are supported, as well as ARKit and SRanipal blend shapes. The node attempts to identify blend shapes based on name matching. Blend shapes should match the names listed in the [url=https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/compatibility/overview]Unified Expressions Compatibility[/url] chart. diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 7ea98ad3981..8ac85503510 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -108,7 +108,7 @@ - Returns a [enum XRInterface.TrackingStatus] specifying the current status of our tracking. + Returns an [enum XRInterface.TrackingStatus] specifying the current status of our tracking. diff --git a/doc/classes/XRNode3D.xml b/doc/classes/XRNode3D.xml index cc2f4b874e7..1ab4adaf46c 100644 --- a/doc/classes/XRNode3D.xml +++ b/doc/classes/XRNode3D.xml @@ -4,7 +4,7 @@ A 3D node that has its position automatically updated by the [XRServer]. - This node can be bound to a specific pose of a [XRPositionalTracker] and will automatically have its [member Node3D.transform] updated by the [XRServer]. Nodes of this type must be added as children of the [XROrigin3D] node. + This node can be bound to a specific pose of an [XRPositionalTracker] and will automatically have its [member Node3D.transform] updated by the [XRServer]. Nodes of this type must be added as children of the [XROrigin3D] node. $DOCS_URL/tutorials/xr/index.html diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index 2b2eae0c5e0..75b28f3940d 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -45,7 +45,7 @@ - Changes the value for the given input. This method is called by a [XRInterface] implementation and should not be used directly. + Changes the value for the given input. This method is called by an [XRInterface] implementation and should not be used directly. @@ -56,7 +56,7 @@ - Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by a [XRInterface] implementation and should not be used directly. + Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by an [XRInterface] implementation and should not be used directly. diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 0cebc04cae7..27c4ed9a1ed 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -168,7 +168,7 @@ - The tracker tracks the location of the players head. This is usually a location centered between the players eyes. Note that for handheld AR devices this can be the current location of the device. + The tracker tracks the location of the player's head. This is usually a location centered between the player's eyes. Note that for handheld AR devices this can be the current location of the device. The tracker tracks the location of a controller. diff --git a/doc/classes/XRTracker.xml b/doc/classes/XRTracker.xml index 00a44bd03eb..78ff68258cd 100644 --- a/doc/classes/XRTracker.xml +++ b/doc/classes/XRTracker.xml @@ -15,13 +15,13 @@ The unique name of this tracker. The trackers that are available differ between various XR runtimes and can often be configured by the user. Godot maintains a number of reserved names that it expects the [XRInterface] to implement if applicable: - - [code]head[/code] identifies the [XRPositionalTracker] of the players head - - [code]left_hand[/code] identifies the [XRControllerTracker] in the players left hand - - [code]right_hand[/code] identifies the [XRControllerTracker] in the players right hand - - [code]/user/hand_tracker/left[/code] identifies the [XRHandTracker] for the players left hand - - [code]/user/hand_tracker/right[/code] identifies the [XRHandTracker] for the players right hand - - [code]/user/body_tracker[/code] identifies the [XRBodyTracker] for the players body - - [code]/user/face_tracker[/code] identifies the [XRFaceTracker] for the players face + - [code]"head"[/code] identifies the [XRPositionalTracker] of the player's head + - [code]"left_hand"[/code] identifies the [XRControllerTracker] in the player's left hand + - [code]"right_hand"[/code] identifies the [XRControllerTracker] in the player's right hand + - [code]"/user/hand_tracker/left"[/code] identifies the [XRHandTracker] for the player's left hand + - [code]"/user/hand_tracker/right"[/code] identifies the [XRHandTracker] for the player's right hand + - [code]"/user/body_tracker"[/code] identifies the [XRBodyTracker] for the player's body + - [code]"/user/face_tracker"[/code] identifies the [XRFaceTracker] for the player's face The type of tracker. diff --git a/modules/openxr/doc_classes/OpenXRAPIExtension.xml b/modules/openxr/doc_classes/OpenXRAPIExtension.xml index 0980a3ca846..fa24bc28e2e 100644 --- a/modules/openxr/doc_classes/OpenXRAPIExtension.xml +++ b/modules/openxr/doc_classes/OpenXRAPIExtension.xml @@ -140,7 +140,7 @@ - Returns the id of the system, which is a [url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrSystemId.html]XrSystemId[/url] cast to an integer. + Returns the id of the system, which is an [url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrSystemId.html]XrSystemId[/url] cast to an integer. diff --git a/modules/openxr/doc_classes/OpenXRBindingModifier.xml b/modules/openxr/doc_classes/OpenXRBindingModifier.xml index 697756ba1d4..1e999abbd69 100644 --- a/modules/openxr/doc_classes/OpenXRBindingModifier.xml +++ b/modules/openxr/doc_classes/OpenXRBindingModifier.xml @@ -19,7 +19,7 @@ Returns the data that is sent to OpenXR when submitting the suggested interacting bindings this modifier is a part of. - [b]Note:[/b] This must be data compatible with a [code]XrBindingModificationBaseHeaderKHR[/code] structure. + [b]Note:[/b] This must be data compatible with an [code]XrBindingModificationBaseHeaderKHR[/code] structure. diff --git a/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml b/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml index c91d3569eb9..ebb739a8449 100644 --- a/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml +++ b/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml @@ -47,7 +47,7 @@ Registers a top level path to which profiles can be bound. For instance [code]/user/hand/left[/code] refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register [code]/user/body/vest[/code]. [param display_name] is the name shown to the user. [param openxr_path] is the top level path being registered. [param openxr_extension_name] is optional and ensures the top level path is only used if the specified extension is available/enabled. - When a top level path ends up being bound by OpenXR, a [XRPositionalTracker] is instantiated to manage the state of the device. + When a top level path ends up being bound by OpenXR, an [XRPositionalTracker] is instantiated to manage the state of the device. diff --git a/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml b/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml index 1f048dcc145..9726401748f 100644 --- a/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml +++ b/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml @@ -87,7 +87,7 @@ - Returns the top level path associated with this [param render_model]. If provided this identifies whether the render model is associated with the players hands or other body part. + Returns the top level path associated with this [param render_model]. If provided this identifies whether the render model is associated with the player's hands or other body part. diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml index 4dfc529cef1..97939eeaffc 100644 --- a/modules/theora/doc_classes/VideoStreamTheora.xml +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -5,7 +5,7 @@ [VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension. The Theora codec is decoded on the CPU. - [b]Note:[/b] While Ogg Theora videos can also have an [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot. + [b]Note:[/b] While Ogg Theora videos can also have a [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot. diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index ac295ff4bf1..15436f4eb8a 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -173,7 +173,7 @@ Inconsistent parameters. - No such entry in array. May be returned if a given port, protocol combination is not found on an [UPNPDevice]. + No such entry in array. May be returned if a given port, protocol combination is not found on a [UPNPDevice]. The action failed. diff --git a/modules/webxr/doc_classes/WebXRInterface.xml b/modules/webxr/doc_classes/WebXRInterface.xml index 5c1dc16792c..6c4e28bc039 100644 --- a/modules/webxr/doc_classes/WebXRInterface.xml +++ b/modules/webxr/doc_classes/WebXRInterface.xml @@ -174,7 +174,7 @@ A comma-seperated list of reference space types used by [method XRInterface.initialize] when setting up the WebXR session. - The reference space types are requested in order, and the first one supported by the users device or browser will be used. The [member reference_space_type] property contains the reference space type that was ultimately selected. + The reference space types are requested in order, and the first one supported by the user's device or browser will be used. The [member reference_space_type] property contains the reference space type that was ultimately selected. This doesn't have any effect on the interface when already initialized. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url]. If you want to use a particular reference space type, it must be listed in either [member required_features] or [member optional_features].