Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

NavigationPathQueryResult2D

Inherits: RefCounted < Object

Represents the result of a 2D pathfinding query.

Description

This class stores the result of a 2D navigation path query from the NavigationServer2D.

Tutorials

Properties

PackedVector2Array

path

PackedVector2Array()

PackedInt64Array

path_owner_ids

PackedInt64Array()

RID[]

path_rids

[]

PackedInt32Array

path_types

PackedInt32Array()

Methods

void

reset ( )


Enumerations

enum PathSegmentType:

PathSegmentType PATH_SEGMENT_TYPE_REGION = 0

This segment of the path goes through a region.

PathSegmentType PATH_SEGMENT_TYPE_LINK = 1

This segment of the path goes through a link.


Property Descriptions

PackedVector2Array path = PackedVector2Array()

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 NavigationServer2D.map_get_path.


PackedInt64Array path_owner_ids = PackedInt64Array()

The ObjectIDs of the Objects which manage the regions and links each point of the path goes through.


RID[] path_rids = []

  • void set_path_rids ( RID[] value )

  • RID[] get_path_rids ( )

The RIDs of the regions and links that each point of the path goes through.


PackedInt32Array path_types = PackedInt32Array()

The type of navigation primitive (region or link) that each point of the path goes through.


Method Descriptions

void reset ( )

Reset the result object to its initial state. This is useful to reuse the object across multiple queries.