diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-05-06 08:40:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-06 08:40:12 +0200 |
| commit | f70dd61a49450c986f335bf8aad728da5bdb090c (patch) | |
| tree | 2835aa0ed883e60f452bff750af4ff6a28c17804 /doc/classes | |
| parent | f70085a9425e9f4ebfec389604cc8008b01316ab (diff) | |
| parent | 868fe4942c70267387a116f2ce57d7bf1a7bbd5e (diff) | |
Merge pull request #60811 from smix8/astar_zero_point_weight_4.x
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AStar2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/AStar3D.xml | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 4b65a64389..7a27568d30 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -33,7 +33,7 @@ <argument index="1" name="position" type="Vector2" /> <argument index="2" name="weight_scale" type="float" default="1.0" /> <description> - Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. [codeblocks] [gdscript] diff --git a/doc/classes/AStar3D.xml b/doc/classes/AStar3D.xml index 3087b9e363..33407c3e74 100644 --- a/doc/classes/AStar3D.xml +++ b/doc/classes/AStar3D.xml @@ -62,7 +62,7 @@ <argument index="1" name="position" type="Vector3" /> <argument index="2" name="weight_scale" type="float" default="1.0" /> <description> - Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. [codeblocks] [gdscript] |