From 5d8ba2b2d11fc6c4debdf21fa91bddefaa6f3d6d Mon Sep 17 00:00:00 2001 From: Josh Jones Date: Wed, 5 Oct 2022 17:24:45 -0600 Subject: Add support for emitting a signal when entering a NavLink --- doc/classes/NavigationAgent2D.xml | 31 +++++++++++++++++++++++++ doc/classes/NavigationAgent3D.xml | 31 +++++++++++++++++++++++++ doc/classes/NavigationPathQueryParameters2D.xml | 18 ++++++++++++++ doc/classes/NavigationPathQueryParameters3D.xml | 18 ++++++++++++++ doc/classes/NavigationPathQueryResult2D.xml | 17 ++++++++++++++ doc/classes/NavigationPathQueryResult3D.xml | 17 ++++++++++++++ 6 files changed, 132 insertions(+) (limited to 'doc/classes') diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 770a5dc5b0..31d347d76c 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -28,6 +28,12 @@ Returns which index the agent is currently on in the navigation path's [PackedVector2Array]. + + + + Returns the path query result for the path the agent is currently following. + + @@ -122,6 +128,9 @@ The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. + + Additional information to return with the navigation path. + The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]). 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. @@ -137,6 +146,17 @@ + + + + Notifies when a navigation link has been reached. + The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: + - [code]location[/code]: The start location of the link that was reached. + - [code]type[/code]: Always [constant NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK]. + - [code]rid[/code]: The [RID] of the link. + - [code]owner[/code]: The object which manages the link (usually [NavigationLink2D]). + + Notifies when the final location is reached. @@ -158,5 +178,16 @@ Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true. + + + + Notifies when a waypoint along the path has been reached. + The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: + - [code]location[/code]: The location of the waypoint that was reached. + - [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint. + - [code]rid[/code]: The [RID] of the containing navigation primitive (region or link). + - [code]owner[/code]: The object which manages the containing navigation primitive (region or link). + + diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index d9a1235bdd..c3f4809b5e 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -28,6 +28,12 @@ Returns which index the agent is currently on in the navigation path's [PackedVector3Array]. + + + + Returns the path query result for the path the agent is currently following. + + @@ -128,6 +134,9 @@ The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. + + Additional information to return with the navigation path. + The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]). 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. @@ -143,6 +152,17 @@ + + + + Notifies when a navigation link has been reached. + The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: + - [code]location[/code]: The start location of the link that was reached. + - [code]type[/code]: Always [constant NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK]. + - [code]rid[/code]: The [RID] of the link. + - [code]owner[/code]: The object which manages the link (usually [NavigationLink3D]). + + Notifies when the final location is reached. @@ -164,5 +184,16 @@ Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true. + + + + Notifies when a waypoint along the path has been reached. + The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: + - [code]location[/code]: The location of the waypoint that was reached. + - [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint. + - [code]rid[/code]: The [RID] of the containing navigation primitive (region or link). + - [code]owner[/code]: The object which manages the containing navigation primitive (region or link). + + diff --git a/doc/classes/NavigationPathQueryParameters2D.xml b/doc/classes/NavigationPathQueryParameters2D.xml index dff58fc1bd..511b2e7a8c 100644 --- a/doc/classes/NavigationPathQueryParameters2D.xml +++ b/doc/classes/NavigationPathQueryParameters2D.xml @@ -12,6 +12,9 @@ The navigation [code]map[/code] [RID] used in the path query. + + Additional information to include with the navigation path. + The navigation layers the query will use (as a bitmask). @@ -38,5 +41,20 @@ 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. + + Don't include any additional metadata about the returned path. + + + Include the type of navigation primitive (region or link) that each point of the path goes through. + + + Include the [RID]s of the regions and links that each point of the path goes through. + + + Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. + + + Include all available metadata about the returned path. + diff --git a/doc/classes/NavigationPathQueryParameters3D.xml b/doc/classes/NavigationPathQueryParameters3D.xml index 46a35b1071..b5031f60f2 100644 --- a/doc/classes/NavigationPathQueryParameters3D.xml +++ b/doc/classes/NavigationPathQueryParameters3D.xml @@ -12,6 +12,9 @@ The navigation [code]map[/code] [RID] used in the path query. + + Additional information to include with the navigation path. + The navigation layers the query will use (as a bitmask). @@ -38,5 +41,20 @@ 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. + + Don't include any additional metadata about the returned path. + + + Include the type of navigation primitive (region or link) that each point of the path goes through. + + + Include the [RID]s of the regions and links that each point of the path goes through. + + + Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. + + + Include all available metadata about the returned path. + diff --git a/doc/classes/NavigationPathQueryResult2D.xml b/doc/classes/NavigationPathQueryResult2D.xml index 77b19b07b6..75f7cc47aa 100644 --- a/doc/classes/NavigationPathQueryResult2D.xml +++ b/doc/classes/NavigationPathQueryResult2D.xml @@ -20,5 +20,22 @@ The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer2D.map_get_path]. + + The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. + + + The [RID]s of the regions and links that each point of the path goes through. + + + The type of navigation primitive (region or link) that each point of the path goes through. + + + + This segment of the path goes through a region. + + + This segment of the path goes through a link. + + diff --git a/doc/classes/NavigationPathQueryResult3D.xml b/doc/classes/NavigationPathQueryResult3D.xml index 6c553bf36b..03d41cb230 100644 --- a/doc/classes/NavigationPathQueryResult3D.xml +++ b/doc/classes/NavigationPathQueryResult3D.xml @@ -20,5 +20,22 @@ The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer3D.map_get_path]. + + The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. + + + The [RID]s of the regions and links that each point of the path goes through. + + + The type of navigation primitive (region or link) that each point of the path goes through. + + + + This segment of the path goes through a region. + + + This segment of the path goes through a link. + + -- cgit v1.2.3