From b43fdea0d558cb45f478e11c6e48203af2a53899 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Fri, 17 Jun 2022 15:19:31 +0800 Subject: [PATCH] Classref typo fixes and improvements --- doc/classes/@GlobalScope.xml | 2 +- doc/classes/NavigationMeshInstance.xml | 4 ++-- doc/classes/NavigationPolygonInstance.xml | 4 ++-- doc/classes/VisibilityEnabler2D.xml | 4 ++-- doc/classes/World.xml | 2 +- modules/gdscript/doc_classes/@GDScript.xml | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 01286332d77..bc664f13113 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1453,7 +1453,7 @@ Hints that an integer property is a bitmask using the optionally named 3D physics layers. - Hints that an integer property is a bitmask using the optionally named 2D navigation layers. + Hints that an integer property is a bitmask using the optionally named 3D navigation layers. Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code]. diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index 25ee04fc7a6..875041650ee 100644 --- a/doc/classes/NavigationMeshInstance.xml +++ b/doc/classes/NavigationMeshInstance.xml @@ -34,7 +34,7 @@ Determines if the [NavigationMeshInstance] is enabled or disabled. - When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. + When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. A bitfield determining all navigation map layers the [NavigationMesh] belongs to. On path requests with [method NavigationServer.map_get_path] navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers. @@ -43,7 +43,7 @@ The [NavigationMesh] resource to use. - When pathfinding moves inside this regions navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. + When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index efe281d5dc5..be95c246636 100644 --- a/doc/classes/NavigationPolygonInstance.xml +++ b/doc/classes/NavigationPolygonInstance.xml @@ -27,7 +27,7 @@ Determines if the [NavigationPolygonInstance] is enabled or disabled. - When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. + When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. A bitfield determining all navigation map layers the [NavigationPolygon] belongs to. On path requests with [method Navigation2DServer.map_get_path] navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers. @@ -36,7 +36,7 @@ The [NavigationPolygon] resource to use. - When pathfinding moves inside this regions navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. + When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index adac4835e59..115f7a2429c 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -59,10 +59,10 @@ This enabler will stop [Particles2D] nodes. - This enabler will stop the parent's _process function. + This enabler will stop the parent's [method Node._process] function. - This enabler will stop the parent's _physics_process function. + This enabler will stop the parent's [method Node._physics_process] function. This enabler will stop [AnimatedSprite] nodes animations. diff --git a/doc/classes/World.xml b/doc/classes/World.xml index e3130276e6a..607ef091e4f 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -19,7 +19,7 @@ The World's [Environment]. - The World's fallback_environment will be used if the World's [Environment] fails or is missing. + The World's fallback environment will be used if [member environment] fails or is missing. The [RID] of this world's navigation map. Used by the [NavigationServer]. diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 07a39a18e6b..913ae570db7 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -236,7 +236,7 @@ - Compares two values by checking their actual contents, recursing into any `Array` or `Dictionary` up to its deepest level. + Compares two values by checking their actual contents, recursing into any [Array] or [Dictionary] up to its deepest level. This compares to [code]==[/code] in a number of ways: - For [code]null[/code], [code]int[/code], [code]float[/code], [code]String[/code], [code]Object[/code] and [code]RID[/code] both [code]deep_equal[/code] and [code]==[/code] work the same. - For [code]Dictionary[/code], [code]==[/code] considers equality if, and only if, both variables point to the very same [code]Dictionary[/code], with no recursion or awareness of the contents at all.