From 5576f5ab8176582178f4946cde12dcf35aa722a1 Mon Sep 17 00:00:00 2001 From: Septian Date: Sun, 9 Jul 2023 04:41:18 +0700 Subject: [PATCH] Fix various typos in documentation (cherry picked from commit 486609eccf25878f20b71cf5dd92d29b6b0c6167) --- doc/classes/AnimationNodeAdd3.xml | 2 +- doc/classes/AnimationNodeBlend3.xml | 2 +- doc/classes/BoneAttachment3D.xml | 2 +- doc/classes/NavigationMesh.xml | 2 +- doc/classes/OccluderInstance3D.xml | 2 +- doc/classes/PhysicalBone2D.xml | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/classes/AnimationNodeAdd3.xml b/doc/classes/AnimationNodeAdd3.xml index 7048c2329c4..42625782e1c 100644 --- a/doc/classes/AnimationNodeAdd3.xml +++ b/doc/classes/AnimationNodeAdd3.xml @@ -4,7 +4,7 @@ Blends two of three animations additively inside of an [AnimationNodeBlendTree]. - A resource to add to an [AnimationNodeBlendTree]. Blends two animations out of three additively out of three based on the amounmt value. + A resource to add to an [AnimationNodeBlendTree]. Blends two animations out of three additively out of three based on the amount value. This animation node has three inputs: - The base animation to add to - A "-add" animation to blend with when the blend amount is negative diff --git a/doc/classes/AnimationNodeBlend3.xml b/doc/classes/AnimationNodeBlend3.xml index b7a54032389..0af8244d691 100644 --- a/doc/classes/AnimationNodeBlend3.xml +++ b/doc/classes/AnimationNodeBlend3.xml @@ -4,7 +4,7 @@ Blends two of three animations linearly inside of an [AnimationNodeBlendTree]. - A resource to add to an [AnimationNodeBlendTree]. Blends two animations out of three linearly out of three based on the amounmt value. + A resource to add to an [AnimationNodeBlendTree]. Blends two animations out of three linearly out of three based on the amount value. This animation node has three inputs: - The base animation to blend with - A "-blend" animation to blend with when the blend amount is negative value diff --git a/doc/classes/BoneAttachment3D.xml b/doc/classes/BoneAttachment3D.xml index 83f70fc331c..34e13521409 100644 --- a/doc/classes/BoneAttachment3D.xml +++ b/doc/classes/BoneAttachment3D.xml @@ -39,7 +39,7 @@ - Sets whether the BoneAttachment3D node will use an extenral [Skeleton3D] node rather than attenpting to use its parent node as the [Skeleton3D]. When set to [code]true[/code], the BoneAttachment3D node will use the external [Skeleton3D] node set in [method set_external_skeleton]. + Sets whether the BoneAttachment3D node will use an external [Skeleton3D] node rather than attempting to use its parent node as the [Skeleton3D]. When set to [code]true[/code], the BoneAttachment3D node will use the external [Skeleton3D] node set in [method set_external_skeleton]. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index f481fd70990..98b4f6e0891 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -103,7 +103,7 @@ The maximum distance the detail mesh surface should deviate from heightfield, in cell unit. - The maximum distance a simplfied contour's border edges should deviate the original raw contour. + The maximum distance a simplified contour's border edges should deviate the original raw contour. The maximum allowed length for contour edges along the border of the mesh. diff --git a/doc/classes/OccluderInstance3D.xml b/doc/classes/OccluderInstance3D.xml index 172781f5dc2..e297cf8f6eb 100644 --- a/doc/classes/OccluderInstance3D.xml +++ b/doc/classes/OccluderInstance3D.xml @@ -36,7 +36,7 @@ The simplification distance to use for simplifying the generated occluder polygon (in 3D units). Higher values result in a less detailed occluder mesh, which improves performance but reduces culling accuracy. - The occluder geometry is rendered on the CPU, so it is important to keep its geometry as simple as possible. Since the buffer is rendered at a low resolution, less detailed occluder meshes generally still work well. The default value is fairly aggressive, so you may have to decrase it if you run into false negatives (objects being occluded even though they are visible by the camera). A value of [code]0.01[/code] will act conservatively, and will keep geometry [i]perceptually[/i] unaffected in the occlusion culling buffer. Depending on the scene, a value of [code]0.01[/code] may still simplify the mesh noticeably compared to disabling simplification entirely. + The occluder geometry is rendered on the CPU, so it is important to keep its geometry as simple as possible. Since the buffer is rendered at a low resolution, less detailed occluder meshes generally still work well. The default value is fairly aggressive, so you may have to decrease it if you run into false negatives (objects being occluded even though they are visible by the camera). A value of [code]0.01[/code] will act conservatively, and will keep geometry [i]perceptually[/i] unaffected in the occlusion culling buffer. Depending on the scene, a value of [code]0.01[/code] may still simplify the mesh noticeably compared to disabling simplification entirely. Setting this to [code]0.0[/code] disables simplification entirely, but vertices in the exact same position will still be merged. The mesh will also be re-indexed to reduce both the number of vertices and indices. [b]Note:[/b] This uses the [url=https://meshoptimizer.org/]meshoptimizer[/url] library under the hood, similar to LOD generation. diff --git a/doc/classes/PhysicalBone2D.xml b/doc/classes/PhysicalBone2D.xml index f201016f9c7..07655f3e153 100644 --- a/doc/classes/PhysicalBone2D.xml +++ b/doc/classes/PhysicalBone2D.xml @@ -32,7 +32,7 @@ The index of the [Bone2D] that this [PhysicalBone2D] should simulate. - The [NodePath] to the [Bone2D] that this [PhysicalBone2D] isshould simulate. + The [NodePath] to the [Bone2D] that this [PhysicalBone2D] should simulate. If [code]true[/code], the [PhysicalBone2D] will keep the transform of the bone it is bound to when simulating physics.