NavigationPathQueryParameters2D

public Reckfell.Collections.Array<Rid> ExcludedRegions { get; set; }

Region RIDs omitted from the query. A region that is both included and excluded is not used. The filter remains in the parameters object until changed or cleared.

public Reckfell.Collections.Array<Rid> IncludedRegions { get; set; }

A nonempty list admits only listed regions; ExcludedRegions takes precedence. Installed 1.0.0 limitation: such a list blocks the tested NavigationLink route even with both connected regions included. For that case, leave it empty and verify layer-based access restrictions.

public Rid Map { get; set; }

RID of the live navigation map to query. A new map must be published by the server before querying; a nonzero iteration ID does not guarantee that the latest changes have synchronized. Do not use a freed RID.

public NavigationPathQueryParameters2D.PathMetadataFlags MetadataFlags { get; set; }

Selects point metadata: types, RIDs and owner IDs. Defaults to All; None disables collection. Read the corresponding array only when its flag is enabled; a checked repeated query with None clears previous metadata arrays.

public uint NavigationLayers { get; set; }

Unsigned 32-bit mask of allowed navigation layers. Layer N is bit 1u << (N - 1), for N from 1 to 32. A region is eligible when masks overlap; zero admits no region. Does not define physics collisions or agent clearance.

public NavigationPathQueryParameters2D.PathPostProcessing PathPostprocessing { get; set; }

Processes the found corridor: Corridorfunnel shortens the path within it, Edgecentered uses crossed-edge centers, and None leaves the raw variant. Does not select another globally shortest corridor.

public float PathReturnMaxLength { get; set; }

Clips the returned path to this length after searching; zero disables the limit. A clipped path may not reach the target. Limits output rather than the search budget.

public float PathReturnMaxRadius { get; set; }

Clips output by a radius around the start; zero disables the limit. The endpoint can intentionally remain short of the target. Does not replace a path-length limit along turns.

public float PathSearchMaxDistance { get; set; }

The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of 0 or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.

public int PathSearchMaxPolygons { get; set; }

The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of 0 or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.

public NavigationPathQueryParameters2D.PathfindingAlgorithmEnum PathfindingAlgorithm { get; set; }

The pathfinding algorithm used in the path query.

public float SimplifyEpsilon { get; set; }

Simplification tolerance when SimplifyPath is enabled, in map coordinate units. It is not the acceptable distance to a gameplay target.

public bool SimplifyPath { get; set; }

Enables additional path simplification using SimplifyEpsilon. Check removed points on your geometry; preserving endpoints in a simple fixture does not establish quality on a complex level.

public Vector2 StartPosition { get; set; }

Start in navigation-map global coordinates. The query may project it onto an allowed polygon: check the first returned point when the requested start must be preserved.

public Vector2 TargetPosition { get; set; }

Target in map-global coordinates. A nonempty result may end at an accessible boundary instead of the target; compare its last point against the target using your game tolerance.