Merge pull request #62131 from timothyqiu/doc-fixes-3.x

This commit is contained in:
Rémi Verschelde 2022-06-17 09:48:18 +02:00 committed by GitHub
commit f1fdada6dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 9 additions and 9 deletions

View File

@ -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 3D physics layers.
</constant> </constant>
<constant name="PROPERTY_HINT_LAYERS_3D_NAVIGATION" value="14" enum="PropertyHint"> <constant name="PROPERTY_HINT_LAYERS_3D_NAVIGATION" value="14" enum="PropertyHint">
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.
</constant> </constant>
<constant name="PROPERTY_HINT_FILE" value="15" enum="PropertyHint"> <constant name="PROPERTY_HINT_FILE" value="15" enum="PropertyHint">
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]. 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].

View File

@ -34,7 +34,7 @@
Determines if the [NavigationMeshInstance] is enabled or disabled. Determines if the [NavigationMeshInstance] is enabled or disabled.
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
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.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
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. 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. The [NavigationMesh] resource to use.
</member> </member>
<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
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.
</member> </member>
</members> </members>
<signals> <signals>

View File

@ -27,7 +27,7 @@
Determines if the [NavigationPolygonInstance] is enabled or disabled. Determines if the [NavigationPolygonInstance] is enabled or disabled.
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
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.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
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. 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. The [NavigationPolygon] resource to use.
</member> </member>
<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
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.
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -59,10 +59,10 @@
This enabler will stop [Particles2D] nodes. This enabler will stop [Particles2D] nodes.
</constant> </constant>
<constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler"> <constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler">
This enabler will stop the parent's _process function. This enabler will stop the parent's [method Node._process] function.
</constant> </constant>
<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler"> <constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler">
This enabler will stop the parent's _physics_process function. This enabler will stop the parent's [method Node._physics_process] function.
</constant> </constant>
<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler"> <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">
This enabler will stop [AnimatedSprite] nodes animations. This enabler will stop [AnimatedSprite] nodes animations.

View File

@ -19,7 +19,7 @@
The World's [Environment]. The World's [Environment].
</member> </member>
<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment"> <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_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.
</member> </member>
<member name="navigation_map" type="RID" setter="" getter="get_navigation_map"> <member name="navigation_map" type="RID" setter="" getter="get_navigation_map">
The [RID] of this world's navigation map. Used by the [NavigationServer]. The [RID] of this world's navigation map. Used by the [NavigationServer].

View File

@ -236,7 +236,7 @@
<argument index="0" name="a" type="Variant" /> <argument index="0" name="a" type="Variant" />
<argument index="1" name="b" type="Variant" /> <argument index="1" name="b" type="Variant" />
<description> <description>
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: 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]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. - 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.