diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2023-05-29 17:14:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-29 17:14:38 +0200 |
| commit | b986d30ec0a7e4453e847e1acefa165af889a340 (patch) | |
| tree | d6b6fd2b8fdb622604b1de83aec506ce664ea5c2 /doc/classes/NavigationRegion2D.xml | |
| parent | 7505fbd93998275e08baa2e71efc882110c99248 (diff) | |
| parent | e3d0da404fd46bef48a816e27897c81140d46aa9 (diff) | |
| download | redot-engine-b986d30ec0a7e4453e847e1acefa165af889a340.tar.gz | |
Merge pull request #76600 from MewPurPur/improve-docs-top-sections-PHYS
Overhaul the top sections of the class reference (Physics classes)
Diffstat (limited to 'doc/classes/NavigationRegion2D.xml')
| -rw-r--r-- | doc/classes/NavigationRegion2D.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml index 1f1c0993d5..05cd49f323 100644 --- a/doc/classes/NavigationRegion2D.xml +++ b/doc/classes/NavigationRegion2D.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="NavigationRegion2D" inherits="Node2D" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - A region of the 2D navigation map. + A traversable 2D region that [NavigationAgent2D]s can use for pathfinding. </brief_description> <description> - A region of the navigation map. It tells the [NavigationServer2D] what can be navigated and what cannot, based on its [NavigationPolygon] resource. + A traversable 2D region based on a [NavigationPolygon] that [NavigationAgent2D]s can use for pathfinding. Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer2D.map_set_edge_connection_margin]. [b]Note:[/b] Overlapping two regions' navigation polygons is not enough for connecting two regions. They must share a similar edge. - The pathfinding cost of entering this region from another region can be controlled with the [member enter_cost] value. + The pathfinding cost of entering a region from another region can be controlled with the [member enter_cost] value. [b]Note:[/b] This value is not added to the path cost when the start position is already inside this region. The pathfinding cost of traveling distances inside this region can be controlled with the [member travel_cost] multiplier. [b]Note:[/b] This node caches changes to its properties, so if you make changes to the underlying region [RID] in [NavigationServer2D], they will not be reflected in this node's properties. |