Class NavigationQuery`Abstract`

The NavigationQuery allows querying a precalculated navigation mesh to perform path finding.

Index

Constructors

Methods

destroy findNearestPoint findPath findRandomPointInSphere findRandomPointsInSphere intersect

Constructors

`Protected`constructor

new NavigationQuery(isInternalConstructor?: boolean): NavigationQuery
Parameters
- OptionalisInternalConstructor: boolean
Returns NavigationQuery

Overrides FrameworkObject.constructor

Methods

destroy

destroy(): void

Called to destroy the internal data.

Returns void

findNearestPoint

findNearestPoint(position: Immutable<Vector3>): Vector3
Finds the closest position on the navigation to the specified position.
Parameters
- position: Immutable<Vector3>
Returns Vector3

findPath

findPath(
    start: Immutable<Vector3>,
    end: Immutable<Vector3>,
    filter: NavigationQueryFilter,
): Vector3[]
Finds a navigatable path from start to end using the optional filter. If start and end are not located on the navigation mesh, the positions will be mapped to the closest point on the navigation mesh used for the query.
Parameters
- start: Immutable<Vector3>
  The start position.
- end: Immutable<Vector3>
  The end position.
- filter: NavigationQueryFilter
  The query filter.
Returns Vector3[]
true upon success.

findRandomPointInSphere

findRandomPointInSphere(
sphere: Immutable<Sphere>,
filter: NavigationQueryFilter,
): Vector3
Finds a random point on the navigation mesh in the shere using the optional filter.
Parameters
- sphere: Immutable<Sphere>
  The sphere position.
- filter: NavigationQueryFilter
  The query filter.
Returns Vector3

findRandomPointsInSphere

findRandomPointsInSphere(
    sphere: Immutable<Sphere>,
    filter: NavigationQueryFilter,
    pointCount: number,
): Vector3[]
Finds a random point on the navigation mesh in the shere using the optional filter.
Parameters
- sphere: Immutable<Sphere>
  The sphere position.
- filter: NavigationQueryFilter
  The query filter.
- pointCount: number
  The number of points to find.
Returns Vector3[]

intersect

intersect(
    start: Immutable<Vector3>,
    end: Immutable<Vector3>,
    filter: NavigationQueryFilter,
): Intersection
Casts a ray on the navigation mesh rom start to end using the optional filter. If start and end are not located on the navigation mesh, the positions will be mapped to the closest point on the navigation mesh used for the query.
Parameters
- start: Immutable<Vector3>
  The start position.
- end: Immutable<Vector3>
  The end position.
- filter: NavigationQueryFilter
  The query filter.
Returns Intersection
Intersection if intersected, or empty if intersection free..