Table of Contents

Class NavigationPathQueryParameters3D

Provides parameters for 3D navigation path queries.

Inheritance
NavigationPathQueryParameters3D

By changing various properties of this object, such as the start and target position, you can configure path queries to the NavigationServer3D.

See Also

Using NavigationPathQueryObjects

Properties

The navigation map RID used in the path query.

var map : RID = RID()

Property Value

RID
  • void set_map(RID value)
  • RID get_map

Additional information to include with the navigation path.

var metadata_flags : int = 7

Property Value

int
  • void set_metadata_flags(int value)
  • int get_metadata_flags

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

var navigation_layers : int = 1

Property Value

int
  • void set_navigation_layers(int value)
  • int get_navigation_layers

The path postprocessing applied to the raw path corridor found by the pathfinding_algorithm.

var path_postprocessing : int = 0

Property Value

int
  • void set_path_postprocessing(int value)
  • int get_path_postprocessing

The pathfinding algorithm used in the path query.

var pathfinding_algorithm : int = 0

Property Value

int
  • void set_pathfinding_algorithm(int value)
  • int get_pathfinding_algorithm

The path simplification amount in worlds units.

var simplify_epsilon : float = 0.0

Property Value

float
  • void set_simplify_epsilon(float value)
  • float get_simplify_epsilon

If true a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by simplify_epsilon. 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".

var simplify_path : bool = false

Property Value

bool
  • void set_simplify_path(bool value)
  • bool get_simplify_path

The pathfinding start position in global coordinates.

var start_position : Vector3 = Vector3(0, 0, 0)

Property Value

Vector3

The pathfinding target position in global coordinates.

var target_position : Vector3 = Vector3(0, 0, 0)

Property Value

Vector3