From c54e09a5a304c1578689f5b98cfee41c24d95848 Mon Sep 17 00:00:00 2001 From: Micky Date: Fri, 1 Mar 2024 00:59:28 +0100 Subject: [PATCH] Overhaul some "uncommon" wording in class reference --- doc/classes/@GlobalScope.xml | 11 ++++---- doc/classes/Basis.xml | 2 +- doc/classes/CanvasItem.xml | 2 +- doc/classes/CodeEdit.xml | 12 ++++---- doc/classes/CodeHighlighter.xml | 5 ++-- doc/classes/Compositor.xml | 4 +-- doc/classes/CubemapArray.xml | 7 ++--- doc/classes/DisplayServer.xml | 4 +-- doc/classes/EditorPlugin.xml | 5 ++-- doc/classes/EditorSelection.xml | 4 +-- doc/classes/Engine.xml | 8 +++--- doc/classes/Image.xml | 8 +++--- doc/classes/Input.xml | 4 +-- .../MeshConvexDecompositionSettings.xml | 6 ++-- doc/classes/MeshDataTool.xml | 3 +- doc/classes/MultiMesh.xml | 2 +- doc/classes/NavigationAgent3D.xml | 2 +- doc/classes/NavigationMeshGenerator.xml | 2 +- doc/classes/NavigationServer2D.xml | 4 +-- doc/classes/NavigationServer3D.xml | 4 +-- doc/classes/Node3D.xml | 2 +- doc/classes/OS.xml | 2 +- doc/classes/PackedByteArray.xml | 12 ++++---- doc/classes/PacketPeerUDP.xml | 2 +- doc/classes/ProjectSettings.xml | 28 +++++++++---------- doc/classes/Projection.xml | 2 +- doc/classes/RandomNumberGenerator.xml | 3 +- doc/classes/RefCounted.xml | 2 +- doc/classes/RenderingServer.xml | 4 +-- doc/classes/Resource.xml | 2 +- doc/classes/ResourceImporterTexture.xml | 2 +- doc/classes/SceneTree.xml | 2 +- doc/classes/ScriptLanguageExtension.xml | 2 +- doc/classes/Skeleton3D.xml | 2 +- doc/classes/SpinBox.xml | 2 +- doc/classes/TCPServer.xml | 2 +- doc/classes/TileMap.xml | 2 +- doc/classes/Timer.xml | 10 +++++-- doc/classes/Vector2.xml | 2 +- doc/classes/Vector3.xml | 2 +- doc/classes/Vector4.xml | 2 +- doc/classes/Viewport.xml | 20 ++++++------- doc/classes/VisualShader.xml | 4 +-- doc/classes/VisualShaderNodeIf.xml | 7 +++-- doc/classes/VisualShaderNodeIs.xml | 2 +- .../VisualShaderNodeTransformCompose.xml | 2 +- .../VisualShaderNodeTransformDecompose.xml | 2 +- doc/classes/VisualShaderNodeTransformOp.xml | 2 +- .../VisualShaderNodeTransformVecMult.xml | 2 +- doc/classes/XRAnchor3D.xml | 2 +- doc/classes/XRInterface.xml | 4 +-- doc/classes/XRInterfaceExtension.xml | 2 +- doc/classes/XRPose.xml | 2 +- doc/classes/float.xml | 2 +- doc/classes/int.xml | 2 +- modules/openxr/doc_classes/OpenXRAction.xml | 2 +- .../doc_classes/EditorExportPlatformWeb.xml | 4 +-- 57 files changed, 128 insertions(+), 121 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index dc7bbe0e4f9e..42d931e12465 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -999,7 +999,7 @@ - Returns a random floating point value between [code]0.0[/code] and [code]1.0[/code] (inclusive). + Returns a random floating-point value between [code]0.0[/code] and [code]1.0[/code] (inclusive). [codeblocks] [gdscript] randf() # Returns e.g. 0.375671 @@ -1015,7 +1015,7 @@ - Returns a random floating point value between [param from] and [param to] (inclusive). + Returns a random floating-point value between [param from] and [param to] (inclusive). [codeblocks] [gdscript] randf_range(0, 20.5) # Returns e.g. 7.45315 @@ -1033,7 +1033,8 @@ - Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified [param mean] and a standard [param deviation]. This is also called Gaussian distribution. + Returns a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url], pseudo-random floating-point value from the specified [param mean] and a standard [param deviation]. This is also known as a Gaussian distribution. + [b]Note:[/b] This method uses the [url=https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform]Box-Muller transform[/url] algorithm. @@ -1261,7 +1262,7 @@ - Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating point number to an arbitrary number of decimals. + Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating-point number to an arbitrary number of decimals. The returned value is the same type of [Variant] as [param step]. Supported types: [int], [float], [Vector2], [Vector2i], [Vector3], [Vector3i], [Vector4], [Vector4i]. [codeblock] snapped(100, 32) # Returns 96 @@ -1278,7 +1279,7 @@ - Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating point number to an arbitrary number of decimals. + Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating-point number to an arbitrary number of decimals. A type-safe version of [method snapped], returning a [float]. [codeblock] snappedf(32.0, 2.5) # Returns 32.5 diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 3865e54e26a2..32077c0b8920 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -4,7 +4,7 @@ A 3×3 matrix for representing 3D rotation and scale. - The [Basis] built-in [Variant] type is a 3x3 [url=https://en.wikipedia.org/wiki/Matrix_(mathematics)]matrix[/url] used to represent 3D rotation, scale, and shear. It is frequently used within a [Transform3D]. + The [Basis] built-in [Variant] type is a 3×3 [url=https://en.wikipedia.org/wiki/Matrix_(mathematics)]matrix[/url] used to represent 3D rotation, scale, and shear. It is frequently used within a [Transform3D]. A [Basis] is composed by 3 axis vectors, each representing a column of the matrix: [member x], [member y], and [member z]. The length of each axis ([method Vector3.length]) influences the basis's scale, while the direction of all axes influence the rotation. Usually, these axes are perpendicular to one another. However, when you rotate any axis individually, the basis becomes sheared. Applying a sheared basis to a 3D model will make the model appear distorted. A [Basis] is [b]orthogonal[/b] if its axes are perpendicular to each other. A basis is [b]normalized[/b] if the length of every axis is [code]1[/code]. A basis is [b]uniform[/b] if all axes share the same length (see [method get_scale]). A basis is [b]orthonormal[/b] if it is both orthogonal and normalized, which allows it to only represent rotations. A basis is [b]conformal[/b] if it is both orthogonal and uniform, which ensures it is not distorted. For a general introduction, see the [url=$DOCS_URL/tutorials/math/matrices_and_transforms.html]Matrices and transforms[/url] tutorial. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 3cb74a9cc986..72783bc5d618 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -700,7 +700,7 @@ Texture will repeat normally. - Texture will repeat in a 2x2 tiled mode, where elements at even positions are mirrored. + Texture will repeat in a 2×2 tiled mode, where elements at even positions are mirrored. Represents the size of the [enum TextureRepeat] enum. diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index bc80b8681112..7c6f1a51c438 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -62,9 +62,8 @@ - Adds a comment delimiter. - Both the start and end keys must be symbols. Only the start key has to be unique. - [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + Adds a comment delimiter from [param start_key] to [param end_key]. Both keys should be symbols, and [param start_key] must not be shared with other delimiters. + If [param line_only] is [code]true[/code] or [param end_key] is an empty [String], the region does not carry over to the next line. @@ -73,9 +72,8 @@ - Adds a string delimiter. - Both the start and end keys must be symbols. Only the start key has to be unique. - [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + Defines a string delimiter from [param start_key] to [param end_key]. Both keys should be symbols, and [param start_key] must not be shared with other delimiters. + If [param line_only] is [code]true[/code] or [param end_key] is an empty [String], the region does not carry over to the next line. @@ -623,7 +621,7 @@ The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes). - The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in the class or a parent class. + The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. [code]0[/code] for the local class, [code]1[/code] for the parent, [code]2[/code] for the grandparent, etc.) to store the depth of an option in the class or a parent class. The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons). diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index 3005ffcdcab7..ca2caf6be50a 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -16,9 +16,8 @@ - Adds a color region such as comments or strings. - Both the start and end keys must be symbols. Only the start key has to be unique. - [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + Adds a color region (such as for comments or strings) from [param start_key] to [param end_key]. Both keys should be symbols, and [param start_key] must not be shared with other delimiters. + If [param line_only] is [code]true[/code] or [param end_key] is an empty [String], the region does not carry over to the next line. diff --git a/doc/classes/Compositor.xml b/doc/classes/Compositor.xml index c287e3b0155f..c030896b6f2c 100644 --- a/doc/classes/Compositor.xml +++ b/doc/classes/Compositor.xml @@ -1,10 +1,10 @@ - The compositor resource holds the configuration with which rendering of a viewport can be customised. + Stores attributes used to customize how a Viewport is rendered. - The compositor resource holds the configuration with which rendering of a viewport can be customised. + The compositor resource stores attributes used to customize how a [Viewport] is rendered. diff --git a/doc/classes/CubemapArray.xml b/doc/classes/CubemapArray.xml index 7ee497385e4c..6e5e466fcf98 100644 --- a/doc/classes/CubemapArray.xml +++ b/doc/classes/CubemapArray.xml @@ -4,10 +4,9 @@ An array of [Cubemap]s, stored together and with a single reference. - [CubemapArray]s are made of an array of [Cubemap]s. Like [Cubemap]s, they are made of multiple textures, the amount of which must be divisible by 6 (one for each face of the cube). The primary benefit of [CubemapArray]s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple [Cubemap]s into a shader using a single [CubemapArray]. - Moreover, [Cubemap]s are allocated in adjacent cache regions on the GPU. This makes [CubemapArray]s the most efficient way to store multiple [Cubemap]s. - Internally, Godot uses [CubemapArray]s for many effects, including the [Sky] if you set [member ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections] to [code]true[/code]. - To create such a texture file yourself, reimport your image files using the import presets of the File System dock. + [CubemapArray]s are made of an array of [Cubemap]s. Like [Cubemap]s, they are made of multiple textures, the amount of which must be divisible by 6 (one for each face of the cube). + The primary benefit of [CubemapArray]s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple [Cubemap]s into a shader using a single [CubemapArray]. [Cubemap]s are allocated in adjacent cache regions on the GPU, which makes [CubemapArray]s the most efficient way to store multiple [Cubemap]s. + [b]Note:[/b] Godot uses [CubemapArray]s internally for many effects, including the [Sky] if you set [member ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections] to [code]true[/code]. To create such a texture file yourself, reimport your image files using the import presets of the File System dock. [b]Note:[/b] [CubemapArray] is not supported in the OpenGL 3 rendering backend. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index d5fc52ab12a3..62fdffc53e11 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -77,8 +77,8 @@ - Sets a custom mouse cursor image for the defined [param shape]. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. The image must be [code]256x256[/code] or smaller for correct appearance. [param hotspot] can optionally be set to define the area where the cursor will click. By default, [param hotspot] is set to [code]Vector2(0, 0)[/code], which is the top-left corner of the image. See also [method cursor_set_shape]. - [param cursor] can be either [Texture2D] or [Image]. + Sets a custom mouse cursor image for the given [param shape]. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. + [param cursor] can be either a [Texture2D] or an [Image], and it should not be larger than 256×256 to display correctly. Optionally, [param hotspot] can be set to offset the image's position relative to the click point. By default, [param hotspot] is set to the top-left corner of the image. See also [method cursor_set_shape]. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 08bdd840bb36..0092c445c1b6 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -239,7 +239,7 @@ Override this method in your plugin to return a [Texture2D] in order to give it an icon. For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. - Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size. + Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size. [codeblocks] [gdscript] func _get_plugin_icon(): @@ -410,7 +410,8 @@ - Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. + Adds a control to the bottom panel (together with [b]Output[/b], [b]Debug[/b], [b]Animation[/b], etc.). Returns the button added to the tab bar. It's up to you to manage the button's visibility as needed. + When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 09aae04d04fd..4ef960ac5cad 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -27,13 +27,13 @@ - Gets the list of selected nodes. + Returns the list of selected nodes. - Gets the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc). This list avoids situations where a node is selected and also child/grandchild. + Returns the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc.). This list can be used to avoid situations where a node is selected and is also a child/grandchild. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 4c8859baf238..d923d229e00f 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -311,13 +311,13 @@ - The maximum number of frames per second (FPS) that can be rendered. A value of [code]0[/code] means the framerate is uncapped. + The maximum number of frames that can be rendered every second (FPS). A value of [code]0[/code] means the framerate is uncapped. Limiting the FPS can be useful to reduce the host machine's power consumption, which reduces heat, noise emissions, and improves battery life. - If [member ProjectSettings.display/window/vsync/vsync_mode] is [code]Enabled[/code] or [code]Adaptive[/code], the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate. - If [member ProjectSettings.display/window/vsync/vsync_mode] is [code]Enabled[/code], on monitors with variable refresh rate enabled (G-Sync/FreeSync), using a FPS limit a few frames lower than the monitor's refresh rate will [url=https://blurbusters.com/howto-low-lag-vsync-on/]reduce input lag while avoiding tearing[/url]. + If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Enabled[/b] or [b]Adaptive[/b], the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate. + If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Enabled[/b], on monitors with variable refresh rate enabled (G-Sync/FreeSync), using a FPS limit a few frames lower than the monitor's refresh rate will [url=https://blurbusters.com/howto-low-lag-vsync-on/]reduce input lag while avoiding tearing[/url]. See also [member physics_ticks_per_second] and [member ProjectSettings.application/run/max_fps]. [b]Note:[/b] The actual number of frames per second may still be below this value if the CPU or GPU cannot keep up with the project's logic and rendering. - [b]Note:[/b] If [member ProjectSettings.display/window/vsync/vsync_mode] is [code]Disabled[/code], limiting the FPS to a high value that can be consistently reached on the system can reduce input lag compared to an uncapped framerate. Since this works by ensuring the GPU load is lower than 100%, this latency reduction is only effective in GPU-bottlenecked scenarios, not CPU-bottlenecked scenarios. + [b]Note:[/b] If [member ProjectSettings.display/window/vsync/vsync_mode] is [b]Disabled[/b], limiting the FPS to a high value that can be consistently reached on the system can reduce input lag compared to an uncapped framerate. Since this works by ensuring the GPU load is lower than 100%, this latency reduction is only effective in GPU-bottlenecked scenarios, not CPU-bottlenecked scenarios. The maximum number of physics steps that can be simulated each rendered frame. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 6c1ecb3aea70..67b373ddfeb0 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -705,13 +705,13 @@ The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also [constant FORMAT_DXT5]. - [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 4x4 (high quality) mode. + [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 4×4 (high quality) mode. Same format as [constant FORMAT_ASTC_4x4], but with the hint to let the GPU know it is used for HDR. - [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 8x8 (low quality) mode. + [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 8×8 (low quality) mode. Same format as [constant FORMAT_ASTC_8x8], but with the hint to let the GPU know it is used for HDR. @@ -793,10 +793,10 @@ Source texture (before compression) is a normal texture (e.g. it can be compressed into two channels). - Hint to indicate that the high quality 4x4 ASTC compression format should be used. + Hint to indicate that the high quality 4×4 ASTC compression format should be used. - Hint to indicate that the low quality 8x8 ASTC compression format should be used. + Hint to indicate that the low quality 8×8 ASTC compression format should be used. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 6c1ae1b0ef16..d624c410feb9 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -469,10 +469,10 @@ Cross cursor. Typically appears over regions in which a drawing operation can be performed or for selections. - Wait cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application isn't usable during the operation (e.g. something is blocking its main thread). + Wait cursor. Indicates that the application is busy performing an operation, and that it cannot be used during the operation (e.g. something is blocking its main thread). - Busy cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application is still usable during the operation. + Busy cursor. Indicates that the application is busy performing an operation, and that it is still usable during the operation. Drag cursor. Usually displayed when dragging something. diff --git a/doc/classes/MeshConvexDecompositionSettings.xml b/doc/classes/MeshConvexDecompositionSettings.xml index 161fd1c1149b..38f1ff3f9bdf 100644 --- a/doc/classes/MeshConvexDecompositionSettings.xml +++ b/doc/classes/MeshConvexDecompositionSettings.xml @@ -10,7 +10,7 @@ - If enabled uses approximation for computing convex hulls. + If [code]true[/code], uses approximation for computing convex hulls. Controls the precision of the convex-hull generation process during the clipping plane selection stage. Ranges from [code]1[/code] to [code]16[/code]. @@ -31,13 +31,13 @@ Mode for the approximate convex decomposition. - If enabled normalizes the mesh before applying the convex decomposition. + If [code]true[/code], normalizes the mesh before applying the convex decomposition. Controls the granularity of the search for the "best" clipping plane. Ranges from [code]1[/code] to [code]16[/code]. - If enabled projects output convex hull vertices onto original source mesh to increase floating point accuracy of the results. + If [code]true[/code], projects output convex hull vertices onto the original source mesh to increase floating-point accuracy of the results. Maximum number of voxels generated during the voxelization stage. diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 1b8ae8cc5916..0b9890b2ecb7 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -158,8 +158,7 @@ - Returns the [Mesh]'s format. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant Mesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant Mesh.ARRAY_FORMAT_NORMAL] is [code]2[/code]. - See [enum Mesh.ArrayFormat] for a list of format flags. + Returns the [Mesh]'s format as a combination of the [enum Mesh.ArrayFormat] flags. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant Mesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant Mesh.ARRAY_FORMAT_NORMAL] is [code]2[/code]. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index c608ee79f1b3..406aacc75caa 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -65,7 +65,7 @@ - Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. + Sets custom data for a specific instance. [param custom_data] is a [Color] type only to contain 4 floating-point numbers. For the custom data to be used, ensure that [member use_custom_data] is [code]true[/code]. This custom instance data has to be manually accessed in your custom shader using [code]INSTANCE_CUSTOM[/code]. diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index 37f92ab42a27..dd75cedf6170 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -168,7 +168,7 @@ The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone. - If [code]true[/code], and the agent uses 2D avoidance, it will remember the set y-axis velocity and reapply it after the avoidance step. While 2D avoidance has no y-axis and simulates on a flat plane this setting can help mitigate the most obvious clipping on uneven 3D geometry. + If [code]true[/code], and the agent uses 2D avoidance, it will remember the set y-axis velocity and reapply it after the avoidance step. While 2D avoidance has no y-axis and simulates on a flat plane this setting can help to soften the most obvious clipping on uneven 3D geometry. The maximum number of neighbors for the agent to consider. diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index c017a16dfab2..2ff791d5eef9 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -5,7 +5,7 @@ This class is responsible for creating and clearing 3D navigation meshes used as [NavigationMesh] resources inside [NavigationRegion3D]. The [NavigationMeshGenerator] has very limited to no use for 2D as the navigation mesh baking process expects 3D node types and 3D source geometry to parse. - The entire navigation mesh baking is best done in a separate thread as the voxelization, collision tests and mesh optimization steps involved are very performance and time hungry operations. + The entire navigation mesh baking is best done in a separate thread as the voxelization, collision tests and mesh optimization steps involved are very slow and performance-intensive operations. Navigation mesh baking happens in multiple steps and the result depends on 3D source geometry and properties of the [NavigationMesh] resource. In the first step, starting from a root node and depending on [NavigationMesh] properties all valid 3D source geometry nodes are collected from the [SceneTree]. Second, all collected nodes are parsed for their relevant 3D geometry data and a combined 3D mesh is build. Due to the many different types of parsable objects, from normal [MeshInstance3D]s to [CSGShape3D]s or various [CollisionObject3D]s, some operations to collect geometry data can trigger [RenderingServer] and [PhysicsServer3D] synchronizations. Server synchronization can have a negative effect on baking time or framerate as it often involves [Mutex] locking for thread security. Many parsable objects and the continuous synchronization with other threaded Servers can increase the baking time significantly. On the other hand only a few but very large and complex objects will take some time to prepare for the Servers which can noticeably stall the next frame render. As a general rule the total number of parsable objects and their individual size and complexity should be balanced to avoid framerate issues or very long baking times. The combined mesh is then passed to the Recast Navigation Object to test the source geometry for walkable terrain suitable to [NavigationMesh] agent properties by creating a voxel world around the meshes bounding area. The finalized navigation mesh is then returned and stored inside the [NavigationMesh] for use as a resource inside [NavigationRegion3D] nodes. [b]Note:[/b] Using meshes to not only define walkable surfaces but also obstruct navigation baking does not always work. The navigation baking has no concept of what is a geometry "inside" when dealing with mesh source geometry and this is intentional. Depending on current baking parameters, as soon as the obstructing mesh is large enough to fit a navigation mesh area inside, the baking will generate navigation mesh areas that are inside the obstructing source geometry mesh. diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index dccdd02d0af4..91d69edf29b5 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -5,7 +5,7 @@ NavigationServer2D is the server that handles navigation maps, regions and agents. It does not handle A* navigation from [AStar2D] or [AStarGrid2D]. - Maps are made up of regions, which are made of navigation polygons. Together, they define the traversable areas in the 2D world. + Maps are divided into regions, which are composed of navigation polygons. Together, they define the traversable areas in the 2D world. [b]Note:[/b] Most [NavigationServer2D] changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation-related nodes in the scene tree or made through scripts. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer2D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This can be used to allow or deny certain areas for some objects. @@ -175,7 +175,7 @@ Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). - The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. + The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code]avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 4fc75461e787..29d9f5424ad0 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -5,7 +5,7 @@ NavigationServer3D is the server that handles navigation maps, regions and agents. It does not handle A* navigation from [AStar3D]. - Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world. + Maps are divided into regions, which are composed of navigation meshes. Together, they define the navigable areas in the 3D world. [b]Note:[/b] Most [NavigationServer3D] changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation-related nodes in the scene tree or made through scripts. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer3D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. This can be used to allow or deny certain areas for some objects. @@ -189,7 +189,7 @@ Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). - The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. + The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code]avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index 0b7b982e52d4..17c872ab756c 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -271,7 +271,7 @@ - Direct access to the 3x3 basis of the [member transform] property. + Basis of the [member transform] property. Represents the rotation, scale, and shear of this node. Global basis of this node. This is equivalent to [code]global_transform.basis[/code]. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 63733bc13325..be7394a30b3f 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -488,7 +488,7 @@ Returns a string that is unique to the device. [b]Note:[/b] This string may change without notice if the user reinstalls their operating system, upgrades it, or modifies their hardware. This means it should generally not be used to encrypt persistent data, as the data saved before an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by this method for security purposes. - [b]Note:[/b] On Web, returns an empty string and generates an error, as this method cannot be implemented for security concerns. + [b]Note:[/b] On Web, returns an empty string and generates an error, as this method cannot be implemented for security reasons. diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index c5f522ba1056..0c1532f61ae8 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -79,21 +79,21 @@ - Decodes a 64-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. + Decodes a 64-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. - Decodes a 32-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. + Decodes a 32-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. - Decodes a 16-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. + Decodes a 16-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded. @@ -199,7 +199,7 @@ - Encodes a 64-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of allocated space, starting at the offset. + Encodes a 64-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of allocated space, starting at the offset. @@ -207,7 +207,7 @@ - Encodes a 32-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset. + Encodes a 32-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -215,7 +215,7 @@ - Encodes a 16-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. + Encodes a 16-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index bd774ac34c80..41457761fd9e 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -19,7 +19,7 @@ Binds this [PacketPeerUDP] to the specified [param port] and [param bind_address] with a buffer size [param recv_buf_size], allowing it to receive incoming packets. If [param bind_address] is set to [code]"*"[/code] (default), the peer will be bound on all available addresses (both IPv4 and IPv6). If [param bind_address] is set to [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the peer will be bound to all available addresses matching that IP type. - If [param bind_address] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the peer will only be bound to the interface with that addresses (or fail if no interface with the given address exists). + If [param bind_address] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc.), the peer will only be bound to the interface with that address (or fail if no interface with the given address exists). diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 75897bd85d0e..7c3dfeda4c98 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -532,7 +532,7 @@ When enabled, using a property, enum, or function that was renamed since Godot 3 will produce a hint if an error occurs. - When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum. + When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when calling a function without using its return value (by assigning it to a variable or using it as a function argument). These return values are sometimes used to indicate possible errors using the [enum Error] enum. When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when defining a local or member variable, signal, or enum that would have the same name as a built-in function or global class name, thus shadowing it. @@ -626,7 +626,7 @@ If [code]true[/code], enables specific shader warnings (see [code]debug/shader_language/warnings/*[/code] settings). If [code]false[/code], disables all shader warnings. - When set to [code]true[/code], produces a warning when two floating point numbers are compared directly with the [code]==[/code] operator or the [code]!=[/code] operator. + When set to [code]true[/code], produces a warning when two floating-point numbers are compared directly with the [code]==[/code] operator or the [code]!=[/code] operator. When set to [code]true[/code], produces a warning upon encountering certain formatting errors. Currently this only checks for empty statements. More formatting errors may be added over time. @@ -1426,7 +1426,7 @@ Specifies the [TextServer] to use. If left empty, the default will be used. - "ICU / HarfBuzz / Graphite" is the most advanced text driver, supporting right-to-left typesetting and complex scripts (for languages like Arabic, Hebrew, etc). The "Fallback" text driver does not support right-to-left typesetting and complex scripts. + "ICU / HarfBuzz / Graphite" is the most advanced text driver, supporting right-to-left typesetting and complex scripts (for languages like Arabic, Hebrew, etc.). The "Fallback" text driver does not support right-to-left typesetting and complex scripts. [b]Note:[/b] The driver in use can be overridden at runtime via the [code]--text-driver[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. [b]Note:[/b] There is an additional [code]Dummy[/code] text driver available, which disables all text rendering and font-related functionality. This driver is not listed in the project settings, but it can be enabled when running the editor or project using the [code]--text-driver Dummy[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. @@ -2797,7 +2797,7 @@ If [code]true[/code], the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP. - If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm for lower quality textures and normal maps and Adaptable Scalable Texture Compression algorithm for high quality textures (in 4x4 block size). + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm for lower quality textures and normal maps and Adaptable Scalable Texture Compression algorithm for high quality textures (in 4×4 block size). [b]Note:[/b] This setting is an override. The texture importer will always import the format the host platform needs, even if this is set to [code]false[/code]. [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). @@ -2825,16 +2825,16 @@ If [member rendering/vrs/mode] is set to [b]Texture[/b], this is the path to default texture loaded as the VRS image. The texture [i]must[/i] use a lossless compression format so that colors can be matched precisely. The following VRS densities are mapped to various colors, with brighter colors representing a lower level of shading precision: [codeblock] - - 1x1 = rgb(0, 0, 0) - #000000 - - 1x2 = rgb(0, 85, 0) - #005500 - - 2x1 = rgb(85, 0, 0) - #550000 - - 2x2 = rgb(85, 85, 0) - #555500 - - 2x4 = rgb(85, 170, 0) - #55aa00 - - 4x2 = rgb(170, 85, 0) - #aa5500 - - 4x4 = rgb(170, 170, 0) - #aaaa00 - - 4x8 = rgb(170, 255, 0) - #aaff00 - Not supported on most hardware - - 8x4 = rgb(255, 170, 0) - #ffaa00 - Not supported on most hardware - - 8x8 = rgb(255, 255, 0) - #ffff00 - Not supported on most hardware + - 1×1 = rgb(0, 0, 0) - #000000 + - 1×2 = rgb(0, 85, 0) - #005500 + - 2×1 = rgb(85, 0, 0) - #550000 + - 2×2 = rgb(85, 85, 0) - #555500 + - 2×4 = rgb(85, 170, 0) - #55aa00 + - 4×2 = rgb(170, 85, 0) - #aa5500 + - 4×4 = rgb(170, 170, 0) - #aaaa00 + - 4×8 = rgb(170, 255, 0) - #aaff00 - Not supported on most hardware + - 8×4 = rgb(255, 170, 0) - #ffaa00 - Not supported on most hardware + - 8×8 = rgb(255, 255, 0) - #ffff00 - Not supported on most hardware [/codeblock] diff --git a/doc/classes/Projection.xml b/doc/classes/Projection.xml index 694556a693b2..1665660da3a9 100644 --- a/doc/classes/Projection.xml +++ b/doc/classes/Projection.xml @@ -4,7 +4,7 @@ A 4×4 matrix for 3D projective transformations. - A 4x4 matrix used for 3D projective transformations. It can represent transformations such as translation, rotation, scaling, shearing, and perspective division. It consists of four [Vector4] columns. + A 4×4 matrix used for 3D projective transformations. It can represent transformations such as translation, rotation, scaling, shearing, and perspective division. It consists of four [Vector4] columns. For purely linear transformations (translation, rotation, and scale), it is recommended to use [Transform3D], as it is more performant and requires less memory. Used internally as [Camera3D]'s projection matrix. diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 2b6e6af596d8..66692e37e7cd 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -36,7 +36,8 @@ - Returns a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [param mean] and a standard [param deviation]. This is also called Gaussian distribution. + Returns a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url], pseudo-random floating-point number from the specified [param mean] and a standard [param deviation]. This is also known as a Gaussian distribution. + [b]Note:[/b] This method uses the [url=https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform]Box-Muller transform[/url] algorithm. diff --git a/doc/classes/RefCounted.xml b/doc/classes/RefCounted.xml index 3ef87e462d9a..6811170ab020 100644 --- a/doc/classes/RefCounted.xml +++ b/doc/classes/RefCounted.xml @@ -8,7 +8,7 @@ Unlike other [Object] types, [RefCounted]s keep an internal reference counter so that they are automatically released when no longer in use, and only then. [RefCounted]s therefore do not need to be freed manually with [method Object.free]. [RefCounted] instances caught in a cyclic reference will [b]not[/b] be freed automatically. For example, if a node holds a reference to instance [code]A[/code], which directly or indirectly holds a reference back to [code]A[/code], [code]A[/code]'s reference count will be 2. Destruction of the node will leave [code]A[/code] dangling with a reference count of 1, and there will be a memory leak. To prevent this, one of the references in the cycle can be made weak with [method @GlobalScope.weakref]. In the vast majority of use cases, instantiating and using [RefCounted]-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. - [b]Note:[/b] In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will linger on for a while before being removed. + [b]Note:[/b] In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will remain in memory for a while before being removed. $DOCS_URL/tutorials/best_practices/node_alternatives.html diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index b368e8374d94..bc4f3a90520e 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -2385,7 +2385,7 @@ - Returns the MultiMesh data (such as instance transforms, colors, etc). See [method multimesh_set_buffer] for a description of the returned data. + Returns the MultiMesh data (such as instance transforms, colors, etc.). See [method multimesh_set_buffer] for details on the returned data. [b]Note:[/b] If the buffer is in the engine's internal cache, it will have to be fetched from GPU memory and possibly decompressed. This means [method multimesh_get_buffer] is potentially a slow operation and should be avoided whenever possible. @@ -3605,7 +3605,7 @@ - Detaches a viewport from a canvas and vice versa. + Detaches a viewport from a canvas. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index a7df88f7c6dc..85372288e77d 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -7,7 +7,7 @@ Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Since they inherit from [RefCounted], resources are reference-counted and freed when no longer in use. They can also be nested within other resources, and saved on disk. [PackedScene], one of the most common [Object]s in a Godot project, is also a resource, uniquely capable of storing and instantiating the [Node]s it contains as many times as desired. In GDScript, resources can loaded from disk by their [member resource_path] using [method @GDScript.load] or [method @GDScript.preload]. The engine keeps a global cache of all loaded resources, referenced by paths (see [method ResourceLoader.has_cached]). A resource will be cached when loaded for the first time and removed from cache once all references are released. When a resource is cached, subsequent loads using its path will return the cached reference. - [b]Note:[/b] In C#, resources will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free resources that are no longer in use. This means that unused resources will linger on for a while before being removed. + [b]Note:[/b] In C#, resources will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free resources that are no longer in use. This means that unused resources will remain in memory for a while before being removed. $DOCS_URL/tutorials/scripting/resources.html diff --git a/doc/classes/ResourceImporterTexture.xml b/doc/classes/ResourceImporterTexture.xml index b6669b8293e1..678aa2101c60 100644 --- a/doc/classes/ResourceImporterTexture.xml +++ b/doc/classes/ResourceImporterTexture.xml @@ -66,7 +66,7 @@ Unimplemented. This currently has no effect when changed. - If [code]true[/code], puts pixels of the same surrounding color in transition from transparent to opaque areas. For textures displayed with bilinear filtering, this helps mitigate the outline effect when exporting images from an image editor. + If [code]true[/code], puts pixels of the same surrounding color in transition from transparent to opaque areas. For textures displayed with bilinear filtering, this helps to reduce the outline effect when exporting images from an image editor. It's recommended to leave this enabled (as it is by default), unless this causes issues for a particular image. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index aad2d853c28b..f1bb5a1cf6ce 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -310,7 +310,7 @@ - Emitted any time the tree's hierarchy changes (nodes being moved, renamed, etc). + Emitted any time the tree's hierarchy changes (nodes being moved, renamed, etc.). diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml index 778e456646f3..87d82d8af79e 100644 --- a/doc/classes/ScriptLanguageExtension.xml +++ b/doc/classes/ScriptLanguageExtension.xml @@ -378,7 +378,7 @@ The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes). - The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in the class or a parent class. + The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. [code]0[/code] for the local class, [code]1[/code] for the parent, [code]2[/code] for the grandparent, etc.) to store the depth of an option in the class or a parent class. The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons). diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 31c608f3a137..c9ad204247b5 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -323,7 +323,7 @@ - This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose. + Emitted when the bone at [param bone_idx] changes its transform/pose. This can be used to update other nodes that rely on bone positions. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 44427c8c5e53..03e247ec8a70 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -4,7 +4,7 @@ An input field for numbers. - [SpinBox] is a numerical input text field. It allows entering integers and floating point numbers. + [SpinBox] is a numerical input text field. It allows entering integers and floating-point numbers. [b]Example:[/b] [codeblocks] [gdscript] diff --git a/doc/classes/TCPServer.xml b/doc/classes/TCPServer.xml index f84983de4996..1daf84b5f1bd 100644 --- a/doc/classes/TCPServer.xml +++ b/doc/classes/TCPServer.xml @@ -36,7 +36,7 @@ Listen on the [param port] binding to [param bind_address]. If [param bind_address] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). If [param bind_address] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type. - If [param bind_address] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). + If [param bind_address] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc.), the server will only listen on the interface with that address (or fail if no interface with the given address exists). diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 5731c10651c7..b8e060c75c93 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -375,7 +375,7 @@ - Enables or disables the layer [param layer]. A disabled layer is not processed at all (no rendering, no physics, etc...). + Enables or disables the layer [param layer]. A disabled layer is not processed at all (no rendering, no physics, etc.). If [param layer] is negative, the layers are accessed from the last one. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 00e5c6e144eb..6eee569443a6 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -4,9 +4,15 @@ A countdown timer. - Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode. - [b]Note:[/b] Timers are affected by [member Engine.time_scale], a higher scale means quicker timeouts, and vice versa. + The [Timer] node is a countdown timer and is the simplest way to handle time-based logic in the engine. When a timer reaches the end of its [member wait_time], it will emit the [signal timeout] signal. + After a timer enters the tree, it can be manually started with [method start]. A timer node is also started automatically if [member autostart] is [code]true[/code]. + Without requiring much code, a timer node can be added and configured in the editor. The [signal timeout] signal it emits can also be connected through the Node dock in the editor: + [codeblock] + func _on_timer_timeout(): + print("Time to attack!") + [/codeblock] [b]Note:[/b] To create a one-shot timer without instantiating a node, use [method SceneTree.create_timer]. + [b]Note:[/b] Timers are affected by [member Engine.time_scale]. The higher the time scale, the sooner timers will end. How often a timer processes may depend on the framerate or [member Engine.physics_ticks_per_second]. https://godotengine.org/asset-library/asset/515 diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index bdc49b5c31fc..f33076a92f62 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -1,7 +1,7 @@ - A 2D vector using floating point coordinates. + A 2D vector using floating-point coordinates. A 2-element structure that can be used to represent 2D coordinates or any other pair of numeric values. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index b9b03462500c..872534fd89dd 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -1,7 +1,7 @@ - A 3D vector using floating point coordinates. + A 3D vector using floating-point coordinates. A 3-element structure that can be used to represent 3D coordinates or any other triplet of numeric values. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 8514670231cd..b31cdb01c98d 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -1,7 +1,7 @@ - A 4D vector using floating point coordinates. + A 4D vector using floating-point coordinates. A 4-element structure that can be used to represent 4D coordinates or any other quadruplet of numeric values. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index d5dc92e16ae5..82bc8d82cb6d 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -390,16 +390,16 @@ Texture to use when [member vrs_mode] is set to [constant Viewport.VRS_TEXTURE]. The texture [i]must[/i] use a lossless compression format so that colors can be matched precisely. The following VRS densities are mapped to various colors, with brighter colors representing a lower level of shading precision: [codeblock] - - 1x1 = rgb(0, 0, 0) - #000000 - - 1x2 = rgb(0, 85, 0) - #005500 - - 2x1 = rgb(85, 0, 0) - #550000 - - 2x2 = rgb(85, 85, 0) - #555500 - - 2x4 = rgb(85, 170, 0) - #55aa00 - - 4x2 = rgb(170, 85, 0) - #aa5500 - - 4x4 = rgb(170, 170, 0) - #aaaa00 - - 4x8 = rgb(170, 255, 0) - #aaff00 - Not supported on most hardware - - 8x4 = rgb(255, 170, 0) - #ffaa00 - Not supported on most hardware - - 8x8 = rgb(255, 255, 0) - #ffff00 - Not supported on most hardware + - 1×1 = rgb(0, 0, 0) - #000000 + - 1×2 = rgb(0, 85, 0) - #005500 + - 2×1 = rgb(85, 0, 0) - #550000 + - 2×2 = rgb(85, 85, 0) - #555500 + - 2×4 = rgb(85, 170, 0) - #55aa00 + - 4×2 = rgb(170, 85, 0) - #aa5500 + - 4×4 = rgb(170, 170, 0) - #aaaa00 + - 4×8 = rgb(170, 255, 0) - #aaff00 - Not supported on most hardware + - 8×4 = rgb(255, 170, 0) - #ffaa00 - Not supported on most hardware + - 8×8 = rgb(255, 255, 0) - #ffff00 - Not supported on most hardware [/codeblock] diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index f424a27a8f72..0b416214b537 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -245,10 +245,10 @@ Represents the size of the [enum VaryingType] enum. - Denotes invalid [VisualShader] node. + Indicates an invalid [VisualShader] node. - Denotes output node of [VisualShader]. + Indicates an output node of [VisualShader]. diff --git a/doc/classes/VisualShaderNodeIf.xml b/doc/classes/VisualShaderNodeIf.xml index 82799bb5fddf..f3d76a4ac338 100644 --- a/doc/classes/VisualShaderNodeIf.xml +++ b/doc/classes/VisualShaderNodeIf.xml @@ -1,10 +1,13 @@ - Outputs a 3D vector based on the result of a floating point comparison within the visual shader graph. + Outputs a 3D vector based on the result of a floating-point comparison within the visual shader graph. - This visual shader node has six input ports. Port 1 and 2 provide the two floating point numbers [code]a[/code] and [code]b[/code] that will be compared. Port 3 is the tolerance, which allows similar floating point number to be considered equal. Ports 4 to 6 are the possible outputs, returned if [code]a == b[/code], [code]a > b[/code], or [code]a < b[/code] respectively. + This visual shader node has six input ports: + - Port [b]1[/b] and [b]2[/b] provide the two floating-point numbers [code]a[/code] and [code]b[/code] that will be compared. + - Port [b]3[/b] is the tolerance, which allows similar floating-point numbers to be considered equal. + - Ports [b]4[/b], [b]5[/b], and [b]6[/b] are the possible outputs, returned if [code]a == b[/code], [code]a > b[/code], or [code]a < b[/code] respectively. diff --git a/doc/classes/VisualShaderNodeIs.xml b/doc/classes/VisualShaderNodeIs.xml index 35832f448fab..fa5c83771e04 100644 --- a/doc/classes/VisualShaderNodeIs.xml +++ b/doc/classes/VisualShaderNodeIs.xml @@ -18,7 +18,7 @@ Comparison with [code]INF[/code] (Infinity). - Comparison with [code]NaN[/code] (Not a Number; denotes invalid numeric results, e.g. division by zero). + Comparison with [code]NaN[/code] (Not a Number; indicates invalid numeric results, such as division by zero). Represents the size of the [enum Function] enum. diff --git a/doc/classes/VisualShaderNodeTransformCompose.xml b/doc/classes/VisualShaderNodeTransformCompose.xml index f2250544a4ee..6418d2a72962 100644 --- a/doc/classes/VisualShaderNodeTransformCompose.xml +++ b/doc/classes/VisualShaderNodeTransformCompose.xml @@ -4,7 +4,7 @@ Composes a [Transform3D] from four [Vector3]s within the visual shader graph. - Creates a 4x4 transform matrix using four vectors of type [code]vec3[/code]. Each vector is one row in the matrix and the last column is a [code]vec4(0, 0, 0, 1)[/code]. + Creates a 4×4 transform matrix using four vectors of type [code]vec3[/code]. Each vector is one row in the matrix and the last column is a [code]vec4(0, 0, 0, 1)[/code]. diff --git a/doc/classes/VisualShaderNodeTransformDecompose.xml b/doc/classes/VisualShaderNodeTransformDecompose.xml index fc4e3151da0e..0d1403ea1d64 100644 --- a/doc/classes/VisualShaderNodeTransformDecompose.xml +++ b/doc/classes/VisualShaderNodeTransformDecompose.xml @@ -4,7 +4,7 @@ Decomposes a [Transform3D] into four [Vector3]s within the visual shader graph. - Takes a 4x4 transform matrix and decomposes it into four [code]vec3[/code] values, one from each row of the matrix. + Takes a 4×4 transform matrix and decomposes it into four [code]vec3[/code] values, one from each row of the matrix. diff --git a/doc/classes/VisualShaderNodeTransformOp.xml b/doc/classes/VisualShaderNodeTransformOp.xml index a6ada4b07eb3..0993fd52e698 100644 --- a/doc/classes/VisualShaderNodeTransformOp.xml +++ b/doc/classes/VisualShaderNodeTransformOp.xml @@ -4,7 +4,7 @@ A [Transform3D] operator to be used within the visual shader graph. - Applies [member operator] to two transform (4x4 matrices) inputs. + Applies [member operator] to two transform (4×4 matrices) inputs. diff --git a/doc/classes/VisualShaderNodeTransformVecMult.xml b/doc/classes/VisualShaderNodeTransformVecMult.xml index 100bc6645e16..27953d4c19e9 100644 --- a/doc/classes/VisualShaderNodeTransformVecMult.xml +++ b/doc/classes/VisualShaderNodeTransformVecMult.xml @@ -4,7 +4,7 @@ Multiplies a [Transform3D] and a [Vector3] within the visual shader graph. - A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators. + A multiplication operation on a transform (4×4 matrix) and a vector, with support for different multiplication operators. diff --git a/doc/classes/XRAnchor3D.xml b/doc/classes/XRAnchor3D.xml index 9390d5c545ac..cdfe1da90e9e 100644 --- a/doc/classes/XRAnchor3D.xml +++ b/doc/classes/XRAnchor3D.xml @@ -4,7 +4,7 @@ An anchor point in AR space. - The [XRAnchor3D] point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them. + The [XRAnchor3D] point is an [XRNode3D] that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc.) and create anchors for them. This node is mapped to one of the anchors through its unique ID. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the ID; the nodes will simply remain on 0,0,0 until a plane is recognized. Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view. diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index ced641611f00..631bceec49d5 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -26,13 +26,13 @@ - Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc). + Returns the name of this interface ([code]"OpenXR"[/code], [code]"OpenVR"[/code], [code]"OpenHMD"[/code], [code]"ARKit"[/code], etc.). - Returns an array of vectors that denotes the physical play area mapped to the virtual space around the [XROrigin3D] point. The points form a convex polygon that can be used to react to or visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available. + Returns an array of vectors that represent the physical play area mapped to the virtual space around the [XROrigin3D] point. The points form a convex polygon that can be used to react to or visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available. diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index b2c27bedf34c..b11c4cbb26aa 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -61,7 +61,7 @@ - Returns an [PackedVector3Array] that denotes the play areas boundaries (if applicable). + Returns a [PackedVector3Array] that represents the play areas boundaries (if applicable). diff --git a/doc/classes/XRPose.xml b/doc/classes/XRPose.xml index f7bfcf4e3863..60a2226a6046 100644 --- a/doc/classes/XRPose.xml +++ b/doc/classes/XRPose.xml @@ -50,7 +50,7 @@ Tracking information may be inaccurate or estimated. For example, with inside out tracking this would indicate a controller may be (partially) obscured. - Tracking information is deemed accurate and up to date. + Tracking information is considered accurate and up to date. diff --git a/doc/classes/float.xml b/doc/classes/float.xml index 3ffaa60c3208..56f78bdc8acc 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -1,7 +1,7 @@ - A built-in type for floating point numbers. + A built-in type for floating-point numbers. The [float] built-in type is a 64-bit double-precision floating-point number, equivalent to [code]double[/code] in C++. This type has 14 reliable decimal digits of precision. The maximum value of [float] is approximately [code]1.79769e308[/code], and the minimum is approximately [code]-1.79769e308[/code]. diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 9d168c60e2e7..c38b0fa38ec7 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -6,7 +6,7 @@ Signed 64-bit integer type. This means that it can take values from [code]-2^63[/code] to [code]2^63 - 1[/code], i.e. from [code]-9223372036854775808[/code] to [code]9223372036854775807[/code]. When it exceeds these bounds, it will wrap around. [int]s can be automatically converted to [float]s when necessary, for example when passing them as arguments in functions. The [float] will be as close to the original integer as possible. - Likewise, [float]s can be automatically converted into [int]s. This will truncate the [float], discarding anything after the floating point. + Likewise, [float]s can be automatically converted into [int]s. This will truncate the [float], discarding anything after the floating-point. [b]Note:[/b] In a boolean context, an [int] will evaluate to [code]false[/code] if it equals [code]0[/code], and to [code]true[/code] otherwise. [codeblocks] [gdscript] diff --git a/modules/openxr/doc_classes/OpenXRAction.xml b/modules/openxr/doc_classes/OpenXRAction.xml index 6a3529e43e9d..2a9f255f2f20 100644 --- a/modules/openxr/doc_classes/OpenXRAction.xml +++ b/modules/openxr/doc_classes/OpenXRAction.xml @@ -4,7 +4,7 @@ An OpenXR action. - This resource defines an OpenXR action. Actions can be used both for inputs (buttons/joystick/trigger/etc) and outputs (haptics). + This resource defines an OpenXR action. Actions can be used both for inputs (buttons, joysticks, triggers, etc.) and outputs (haptics). OpenXR performs automatic conversion between action type and input type whenever possible. An analog trigger bound to a boolean action will thus return [code]false[/code] if the trigger is depressed and [code]true[/code] if pressed fully. Actions are not directly bound to specific devices, instead OpenXR recognizes a limited number of top level paths that identify devices by usage. We can restrict which devices an action can be bound to by these top level paths. For instance an action that should only be used for hand held controllers can have the top level paths "/user/hand/left" and "/user/hand/right" associated with them. See the [url=https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved]reserved path section in the OpenXR specification[/url] for more info on the top level paths. Note that the name of the resource is used to register the action with. diff --git a/platform/web/doc_classes/EditorExportPlatformWeb.xml b/platform/web/doc_classes/EditorExportPlatformWeb.xml index c6e506ab9f7c..c759701d2f51 100644 --- a/platform/web/doc_classes/EditorExportPlatformWeb.xml +++ b/platform/web/doc_classes/EditorExportPlatformWeb.xml @@ -83,8 +83,8 @@ If [code]true[/code] enables [GDExtension] support for this web build. - If enabled, the exported game will support threads. It requires [url=https://web.dev/articles/coop-coep]a "cross-origin isolated" website[/url], which can be difficult to setup and brings some limitations (e.g. not being able to communicate with third-party websites). - If disabled, the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on a HTTPS website. + If [code]true[/code], the exported game will support threads. It requires [url=https://web.dev/articles/coop-coep]a "cross-origin isolated" website[/url], which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites). + If [code]false[/code], the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on a HTTPS website. If [code]true[/code], allows textures to be optimized for desktop through the S3TC algorithm.