NavigationPathQueryParameters3D

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

The list of region Rids that will be excluded from the path query. Use NavigationRegion3D.GetRid to get the Rid associated with a NavigationRegion3D node. Note: The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.

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

The list of region Rids that will be included by the path query. Use NavigationRegion3D.GetRid to get the Rid associated with a NavigationRegion3D node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded. Note: The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.

public Rid Map { get; set; }

The navigation map Rid used in the path query.

public NavigationPathQueryParameters3D.PathMetadataFlags MetadataFlags { get; set; }

Additional information to include with the navigation path.

public uint NavigationLayers { get; set; }

The navigation layers the query will use (as a bitmask).

public NavigationPathQueryParameters3D.PathPostProcessing PathPostprocessing { get; set; }

The path postprocessing applied to the raw path corridor found by the NavigationPathQueryParameters3D.PathfindingAlgorithm.

public float PathReturnMaxLength { get; set; }

The maximum allowed length of the returned path in world units. A path will be clipped when going over this length. A value of 0 or below counts as disabled.

public float PathReturnMaxRadius { get; set; }

The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. A value of 0 or below counts as disabled. Note: This will perform a sphere shaped clip operation on the path with the first path position being the sphere's center position.

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 NavigationPathQueryParameters3D.PathfindingAlgorithmEnum PathfindingAlgorithm { get; set; }

The pathfinding algorithm used in the path query.

public float SimplifyEpsilon { get; set; }

The path simplification amount in world units.

public bool SimplifyPath { get; set; }

If true a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by NavigationPathQueryParameters3D.SimplifyEpsilon. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation. Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".

public Vector3 StartPosition { get; set; }

The pathfinding start position in global coordinates.

public Vector3 TargetPosition { get; set; }

The pathfinding target position in global coordinates.