Skip to content

Commit 512ad87

Browse files
Docs: Proofreading for grammar and spelling
Minor cases with confusion over `it's`, `its`, and the possessive.
1 parent eb3d6d8 commit 512ad87

26 files changed

+52
-50
lines changed

doc/classes/Camera3D.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@
184184
The distance to the far culling boundary for this camera relative to its local Z axis. Higher values allow the camera to see further away, while decreasing [member far] can improve performance if it results in objects being partially or fully culled.
185185
</member>
186186
<member name="fov" type="float" setter="set_fov" getter="get_fov" default="75.0">
187-
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [member fov] sets the other axis' field of view angle.
188-
For reference, the default vertical field of view value ([code]75.0[/code]) is equivalent to a horizontal FOV of:
187+
The camera's field of view (also known as FOV), as an angle in degrees. Only applicable in perspective mode. Since [member keep_aspect] locks one axis, this property sets the field of view on the other axis.
188+
For reference, the default angle for the vertical FOV ([code]75.0[/code]) is equivalent to a horizontal FOV of:
189189
- ~91.31 degrees in a 4:3 viewport
190190
- ~101.67 degrees in a 16:10 viewport
191191
- ~107.51 degrees in a 16:9 viewport

doc/classes/EditorImportPlugin.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,10 +238,10 @@
238238
<param index="3" name="platform_variants" type="String[]" />
239239
<param index="4" name="gen_files" type="String[]" />
240240
<description>
241-
Imports [param source_file] with the import [param options] specified. Should return [constant @GlobalScope.OK] if the import is successful, other values indicate failure.
241+
Imports [param source_file] with the specified import [param options]. Should return [constant @GlobalScope.OK] if the import is successful.
242242
The imported resource is expected to be saved to [code]save_path + "." + _get_save_extension()[/code]. If a different variant is preferred for a [url=$DOCS_URL/tutorials/export/feature_tags.html]feature tag[/url], save the variant to [code]save_path + "." + tag + "." + _get_save_extension()[/code] and add the feature tag to [param platform_variants].
243243
If additional resource files are generated in the resource filesystem ([code]res://[/code]), add their full path to [param gen_files] so that the editor knows they depend on [param source_file].
244-
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
244+
This method must be overridden to do the actual importing work. See this class's description for an example of overriding this method.
245245
</description>
246246
</method>
247247
<method name="append_import_external_resource">

doc/classes/Marker2D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Generic 2D position hint for editing.
55
</brief_description>
66
<description>
7-
Generic 2D position hint for editing. It's just like a plain [Node2D], but it displays as a cross in the 2D editor at all times. You can set the cross' visual size by using the gizmo in the 2D editor while the node is selected.
7+
Generic 2D position hint for editing. This is like a plain [Node2D], but it displays as a cross in the 2D editor. While the node is selected, you can adjust the cross's visual size by using the gizmo in the 2D editor.
88
</description>
99
<tutorials>
1010
</tutorials>

doc/classes/Marker3D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Generic 3D position hint for editing.
55
</brief_description>
66
<description>
7-
Generic 3D position hint for editing. It's just like a plain [Node3D], but it displays as a cross in the 3D editor at all times.
7+
Generic 3D position hint for editing. This is like a plain [Node3D], but it displays as a cross in the 3D editor. While the node is selected, you can adjust the cross's visual size by using the gizmo in the 3D editor.
88
</description>
99
<tutorials>
1010
</tutorials>

doc/classes/NavigationAgent2D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationPolygon] resources with a different [member NavigationPolygon.agent_radius] property and use different navigation maps for each actor size.
220220
</member>
221221
<member name="simplify_epsilon" type="float" setter="set_simplify_epsilon" getter="get_simplify_epsilon" default="0.0">
222-
The path simplification amount in worlds units.
222+
The path simplification amount in world units.
223223
</member>
224224
<member name="simplify_path" type="bool" setter="set_simplify_path" getter="get_simplify_path" default="false">
225225
If [code]true[/code] a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.

doc/classes/NavigationAgent3D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@
225225
Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationMesh] resources with a different [member NavigationMesh.agent_radius] property and use different navigation maps for each actor size.
226226
</member>
227227
<member name="simplify_epsilon" type="float" setter="set_simplify_epsilon" getter="get_simplify_epsilon" default="0.0">
228-
The path simplification amount in worlds units.
228+
The path simplification amount in world units.
229229
</member>
230230
<member name="simplify_path" type="bool" setter="set_simplify_path" getter="get_simplify_path" default="false">
231231
If [code]true[/code] a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.

doc/classes/NavigationObstacle2D.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@
6666
Sets the avoidance radius for the obstacle.
6767
</member>
6868
<member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2(0, 0)">
69-
Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices.
69+
The wanted velocity for the obstacle, used by other agents to better predict the obstacle if it is moved with a velocity regularly (every frame), instead of warped to a new position.
70+
[b]Note:[/b] This property only affects avoidance for the obstacle's [member radius]. Does nothing for the obstacle's static vertices.
7071
</member>
7172
<member name="vertices" type="PackedVector2Array" setter="set_vertices" getter="get_vertices" default="PackedVector2Array()">
72-
The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle.
73+
The outline vertices of the obstacle. If the vertices are winded in clockwise order, agents will be pushed in by the obstacle, otherwise they will be pushed out. Outlines cannot be crossed or overlap. If the obstacle is warped to a new position, agents cannot predict this movement and may get trapped inside the obstacle.
7374
</member>
7475
</members>
7576
</class>

doc/classes/NavigationObstacle3D.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,21 @@
6363
Requires [member affect_navigation_mesh] to be enabled.
6464
</member>
6565
<member name="height" type="float" setter="set_height" getter="get_height" default="1.0">
66-
Sets the obstacle height used in 2D avoidance. 2D avoidance using agent's ignore obstacles that are below or above them.
66+
Sets the obstacle height used in 2D avoidance. 2D avoidance using agents ignore obstacles that are below or above them.
6767
</member>
6868
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.0">
6969
Sets the avoidance radius for the obstacle.
7070
</member>
7171
<member name="use_3d_avoidance" type="bool" setter="set_use_3d_avoidance" getter="get_use_3d_avoidance" default="false">
72-
If [code]true[/code] the obstacle affects 3D avoidance using agent's with obstacle [member radius].
73-
If [code]false[/code] the obstacle affects 2D avoidance using agent's with both obstacle [member vertices] as well as obstacle [member radius].
72+
If [code]true[/code] the obstacle affects 3D avoidance using agents with obstacle [member radius].
73+
If [code]false[/code] the obstacle affects 2D avoidance using agents with both obstacle [member vertices] as well as obstacle [member radius].
7474
</member>
7575
<member name="velocity" type="Vector3" setter="set_velocity" getter="get_velocity" default="Vector3(0, 0, 0)">
76-
Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices.
76+
The wanted velocity for the obstacle, used by other agents to better predict the obstacle if it is moved with a velocity regularly (every frame), instead of warped to a new position.
77+
[b]Note:[/b] This property only affects avoidance for the obstacle's [member radius]. Does nothing for the obstacle's static vertices.
7778
</member>
7879
<member name="vertices" type="PackedVector3Array" setter="set_vertices" getter="get_vertices" default="PackedVector3Array()">
79-
The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle.
80+
The outline vertices of the obstacle. If the vertices are winded in clockwise order, agents will be pushed in by the obstacle, otherwise they will be pushed out. Outlines cannot be crossed or overlap. If the obstacle is warped to a new position, agents cannot predict this movement and may get trapped inside the obstacle.
8081
</member>
8182
</members>
8283
</class>

doc/classes/NavigationPathQueryParameters2D.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
The pathfinding algorithm used in the path query.
4848
</member>
4949
<member name="simplify_epsilon" type="float" setter="set_simplify_epsilon" getter="get_simplify_epsilon" default="0.0">
50-
The path simplification amount in worlds units.
50+
The path simplification amount in world units.
5151
</member>
5252
<member name="simplify_path" type="bool" setter="set_simplify_path" getter="get_simplify_path" default="false">
5353
If [code]true[/code] a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
@@ -68,7 +68,7 @@
6868
Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes.
6969
</constant>
7070
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
71-
Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
71+
Centers every position in the middle of the traveled navigation mesh's polygon edge. This creates better paths for tile- or grid-based layouts that restrict the movement to the cells' centers.
7272
</constant>
7373
<constant name="PATH_POSTPROCESSING_NONE" value="2" enum="PathPostProcessing">
7474
Applies no postprocessing and returns the raw path corridor as found by the pathfinding algorithm.

doc/classes/NavigationPathQueryParameters3D.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
The pathfinding algorithm used in the path query.
4848
</member>
4949
<member name="simplify_epsilon" type="float" setter="set_simplify_epsilon" getter="get_simplify_epsilon" default="0.0">
50-
The path simplification amount in worlds units.
50+
The path simplification amount in world units.
5151
</member>
5252
<member name="simplify_path" type="bool" setter="set_simplify_path" getter="get_simplify_path" default="false">
5353
If [code]true[/code] a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
@@ -68,7 +68,7 @@
6868
Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes.
6969
</constant>
7070
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
71-
Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
71+
Centers every position in the middle of the traveled navigation mesh's polygon edge. This creates better paths for tile- or grid-based layouts that restrict the movement to the cells' centers.
7272
</constant>
7373
<constant name="PATH_POSTPROCESSING_NONE" value="2" enum="PathPostProcessing">
7474
Applies no postprocessing and returns the raw path corridor as found by the pathfinding algorithm.

0 commit comments

Comments
 (0)