Infohazard.HyperNav 1.1.5
3D Navigation for Flying Characters
Loading...
Searching...
No Matches
Infohazard.HyperNav.NavPath Class Reference

A completed, valid path. More...

Public Member Functions

void Dispose ()
 Dispose the path, returning it to an object pool. More...
 

Properties

long ID = -1 [get, set]
 ID of the path. More...
 
bool HasBeenDisposed = true [get, set]
 Whether the path has been disposed. More...
 
Vector3 StartPos [get, set]
 The position where the path originates from. More...
 
Vector3 EndPos [get, set]
 The destination of the path. More...
 
NavHit StartHit [get, set]
 The navigation query result at the start of the path. More...
 
NavHit EndHit [get, set]
 The navigation query result at the end of the path. More...
 
NavPathfinder Pathfinder [get, set]
 The NavPathfinder that was used to calculate the path. More...
 
List< NavWaypointInternalWaypoints = new List<NavWaypoint>() [get]
 Mutable list of waypoints of the path. More...
 
IReadOnlyList< NavWaypointWaypoints [get]
 List of waypoints of the path. More...
 

Detailed Description

A completed, valid path.

Member Function Documentation

◆ Dispose()

void Infohazard.HyperNav.NavPath.Dispose ( )

Dispose the path, returning it to an object pool.

Property Documentation

◆ EndHit

NavHit Infohazard.HyperNav.NavPath.EndHit
getset

The navigation query result at the end of the path.

◆ EndPos

Vector3 Infohazard.HyperNav.NavPath.EndPos
getset

The destination of the path.

◆ HasBeenDisposed

bool Infohazard.HyperNav.NavPath.HasBeenDisposed = true
getset

Whether the path has been disposed.

◆ ID

long Infohazard.HyperNav.NavPath.ID = -1
getset

ID of the path.

◆ InternalWaypoints

List<NavWaypoint> Infohazard.HyperNav.NavPath.InternalWaypoints = new List<NavWaypoint>()
getpackage

Mutable list of waypoints of the path.

◆ Pathfinder

NavPathfinder Infohazard.HyperNav.NavPath.Pathfinder
getsetpackage

The NavPathfinder that was used to calculate the path.

◆ StartHit

NavHit Infohazard.HyperNav.NavPath.StartHit
getset

The navigation query result at the start of the path.

◆ StartPos

Vector3 Infohazard.HyperNav.NavPath.StartPos
getset

The position where the path originates from.

◆ Waypoints

IReadOnlyList<NavWaypoint> Infohazard.HyperNav.NavPath.Waypoints
get

List of waypoints of the path.


The documentation for this class was generated from the following file: