A script that can be used to calculate paths by any entity that needs to use HyperNav for navigation. More...

Classes
class	PropNames
	This is used to refer to the names of private fields in this class from a custom Editor. More...

Public Member Functions
virtual void	Stop (bool abortPaths)
	Stop following the current path, and optionally cancel all path requests. More...

virtual UpdatePathResult	SetDestinationByNavHit (NavSampleResult fromHit, NavSampleResult toHit)
	Request a new path between two NavSampleResults. More...

virtual UpdatePathResult	UpdatePath (Vector3 destination)
	Request a new path from the current position to the desired destination. This is equivalent to setting Destination, but returns a result. More...

Protected Member Functions
virtual void	Awake ()
	Sets the AvoidanceAgent.Infohazard.HyperNav.AvoidanceAgent.InputVelocityFunc. More...

virtual void	OnEnable ()
	Resets MeasuredVelocity and sets Arrived to true. More...

virtual void	OnDisable ()
	Stops all pathfinding and cancels path requests. More...

virtual void	Update ()
	Updates measured velocity and current index in path. More...

virtual void	OnDrawGizmos ()
	Draws the current path as a sequence of debug lines if DebugPath is true. More...

virtual Vector3	CalculateDesiredNavigationVelocity ()
	Calculate the velocity the agent wants to move in, in the range [0, 1]. More...

virtual void	UpdateMeasuredVelocity ()
	Update the value of MeasuredVelocity, which is used to determine StoppingDistance. More...

virtual void	UpdatePathIndex ()
	Update the current path index, which is used to determine NextWaypointPosition. More...

virtual void	OnPathReady (long id, NavPath path)
	Callback that is received when a pathfinding request completes, which should start moving along that path. More...

Properties
float	Acceptance `[get, set]`
	How close the agent must get to a destination before it is considered to have arrived. More...

float	AccelerationEstimate `[get, set]`
	This should be set to the maximum acceleration of your agent. More...

Rigidbody	Rigidbody `[get, set]`
	Optional rigidbody to use for measuring velocity. More...

float	SampleRadius `[get, set]`
	The radius to search when finding the nearest NavVolume. More...

NavAreaTypes	AreaTypeMask `[get, set]`
	The types of areas to sample. More...

NavSamplePriority	StartSamplingPriority `[get, set]`
	How to prioritize results for the destination position when sampling in both volumes and surfaces. More...

NavSamplePriority	DestSamplingPriority `[get, set]`
	How to prioritize results for the destination position when sampling in both volumes and surfaces. More...

float	CostToChangeToVolume `[get, set]`
	Additional cost to changing from a surface to a volume. More...

float	CostToChangeToSurface `[get, set]`
	Additional cost to changing from a volume to a surface. More...

float	VolumeCostMultiplier `[get, set]`
	Multiplier for the cost of traversing volume areas. More...

float	SurfaceCostMultiplier `[get, set]`
	Multiplier for the cost of traversing surface areas. More...

NavPathfindingParams	PathfindingParams `[get, set]`
	Pathfinding parameters as a combined struct. More...

float	DesiredSpeedRatio `[get, set]`
	The desired fraction of the maximum speed to travel at. More...

bool	DebugPath `[get, set]`
	Whether to draw a debug line in the scene view showing the agent's current path. More...

bool	KeepPathWhileCalculating `[get, set]`
	Whether to keep following the current path while waiting for a new path to finish calculating. More...

AvoidanceAgent	AvoidanceAgent `[get, set]`
	AvoidanceAgent that this agent uses for avoidance (can be null). More...

bool	ControlAvoidanceIsActive `[get, set]`
	If true, the Infohazard.HyperNav.AvoidanceAgent.IsActive state of the AvoidanceAgent is set based on whether there is a current valid path. More...

bool	CheckSkippingWithPhysicsQuery `[get, set]`
	Whether to check during path following if the agent should skip to the next waypoint. More...

LayerMask	SkippingCheckLayerMask `[get, set]`
	Layer mask to use for physics queries to check for obstacles when skipping waypoints. More...

Collider	SkippingCheckCollider `[get, set]`
	Collider to determine the query parameters for sweep testing. More...

float	SkippingCheckColliderPadding `[get, set]`
	Padding to reduce the size of the collider used for skipping waypoint checks. More...

bool	IsPathPending `[get]`
	Whether a path is currently in the process of being calculated for this agent. More...

virtual float	StoppingDistance `[get]`
	The distance that it will take the agent to come to a stop from its current velocity, determined using the AccelerationEstimate. More...

Vector3	NextWaypointPosition `[get]`
	The current path waypoint that the agent is trying to move towards. More...

Vector3	PositionForVolume `[get]`
	The position to use for sampling volumes. More...

Vector3	PositionForSurface `[get]`
	The position to use for sampling surfaces. More...

NavWaypoint?	NextWaypoint `[get]`
	The current path waypoint that the agent is trying to move towards. More...

NavWaypoint?	PreviousWaypoint `[get]`
	The previous waypoint in the path. More...

bool	Arrived `[get, private set]`
	True if the agent has no active or pending path. More...

float	RemainingDistance `[get, protected set]`
	The remaining distance to the destination. More...

float	RemainingDistanceToNextWaypoint `[get, protected set]`
	The remaining distance to the next waypoint. More...

float	DistanceFromStart `[get, protected set]`
	The distance the agent has traveled along the path. More...

Vector3	Destination `[get, set]`
	Get or set the agent's destination (the position it is trying to get to). More...

Vector3	MeasuredVelocity `[get, protected set]`
	Velocity of the agent measured as delta position / delta time over the last frame, which is used to determine stopping distance. More...

NavPath	CurrentPath `[get, set]`
	The current path that the agent is following. More...

float	AvoidanceMaxSpeed `[get, set]`
	Maximum speed possible by this agent when avoiding obstacles. More...

NavAgentAdvancePredicate	AdvancePredicate `[get, set]`
	An optional condition to check if the agent can advance past a given waypoint in the path. More...

Events
Action	PathReady
	Invoked when the agent finds a path to the destination. More...

Action	PathFailed
	Invoked when the agent fails to find a path to the destination. More...

Action< NavPath >	CurrentPathChanged
	Invoked when the agent's path is updated. More...

Action< int >	PathIndexChanged
	Invoked when the agent's path index changes. More...

Detailed Description

A script that can be used to calculate paths by any entity that needs to use HyperNav for navigation.

While a NavAgent is not necessary to use HyperNav, it makes pathfinding easier. The NavAgent does not impose any restrictions on how movement occurs, nor does it actually perform any movement. It simply provides a desired movement velocity, which other scripts on the object are responsible for using however they need.

The agent can have one active path (the path it is currently following), but can have multiple pending paths (paths in the process of being calculated by a NavPathfinder).

If you desire smoother movement then what the NavAgent provides, see SplineNavAgent.

Member Function Documentation

◆ Awake()

virtual void Infohazard.HyperNav.NavAgent.Awake ( )

protectedvirtual

Sets the AvoidanceAgent.Infohazard.HyperNav.AvoidanceAgent.InputVelocityFunc.

◆ CalculateDesiredNavigationVelocity()

virtual Vector3 Infohazard.HyperNav.NavAgent.CalculateDesiredNavigationVelocity ( )

protectedvirtual

Calculate the velocity the agent wants to move in, in the range [0, 1].

Reimplemented in Infohazard.HyperNav.SplineNavAgent.

◆ OnDisable()

virtual void Infohazard.HyperNav.NavAgent.OnDisable ( )

protectedvirtual

Stops all pathfinding and cancels path requests.

Reimplemented in Infohazard.HyperNav.SplineNavAgent.

◆ OnDrawGizmos()

virtual void Infohazard.HyperNav.NavAgent.OnDrawGizmos ( )

protectedvirtual

Draws the current path as a sequence of debug lines if DebugPath is true.

Reimplemented in Infohazard.HyperNav.SplineNavAgent.

◆ OnEnable()

virtual void Infohazard.HyperNav.NavAgent.OnEnable ( )

protectedvirtual

Resets MeasuredVelocity and sets Arrived to true.

◆ OnPathReady()

virtual void Infohazard.HyperNav.NavAgent.OnPathReady	(	long	id,
		NavPath	path
	)

protectedvirtual

Callback that is received when a pathfinding request completes, which should start moving along that path.

Parameters

id	The id of the path request.
path	The completed path, which is null if no path was found.

◆ SetDestinationByNavHit()

virtual UpdatePathResult Infohazard.HyperNav.NavAgent.SetDestinationByNavHit	(	NavSampleResult	fromHit,
		NavSampleResult	toHit
	)

virtual

Request a new path between two NavSampleResults.

This method is similar to setting Destination. However, you can use this if you want to supply your own query results. For example, you can run a single NavSampleJob for many pathfinding calls.

Parameters

fromHit	Hit at the agent's current position.
toHit	Hit at the destination.

Returns: The result of the path update.

◆ Stop()

virtual void Infohazard.HyperNav.NavAgent.Stop ( bool abortPaths )

virtual

Stop following the current path, and optionally cancel all path requests.

Parameters

abortPaths Whether to cancel pending path requests.

Reimplemented in Infohazard.HyperNav.SplineNavAgent.

◆ Update()

virtual void Infohazard.HyperNav.NavAgent.Update ( )

protectedvirtual

Updates measured velocity and current index in path.

Reimplemented in Infohazard.HyperNav.SplineNavAgent.

◆ UpdateMeasuredVelocity()

virtual void Infohazard.HyperNav.NavAgent.UpdateMeasuredVelocity ( )

protectedvirtual

Update the value of MeasuredVelocity, which is used to determine StoppingDistance.

◆ UpdatePath()

virtual UpdatePathResult Infohazard.HyperNav.NavAgent.UpdatePath ( Vector3 destination )

virtual

Request a new path from the current position to the desired destination. This is equivalent to setting Destination, but returns a result.

It is usually not necessary to call this yourself, as it is called when setting Destination. However, if the agent gets stuck or pushed off course, you may wish to use this to get a new path.

Parameters

destination The position to move towards.

Returns: The result of the path update.

◆ UpdatePathIndex()

virtual void Infohazard.HyperNav.NavAgent.UpdatePathIndex ( )

protectedvirtual

Update the current path index, which is used to determine NextWaypointPosition.

Property Documentation

◆ AccelerationEstimate

float Infohazard.HyperNav.NavAgent.AccelerationEstimate

getset

This should be set to the maximum acceleration of your agent.

This is used to determine when the agent needs to start slowing down when approaching its destination.

◆ Acceptance

float Infohazard.HyperNav.NavAgent.Acceptance

getset

How close the agent must get to a destination before it is considered to have arrived.

Note that setting acceptance too low may prevent the agent from ever stopping, but setting it to high can make the agent stop too far from the destination.

◆ AdvancePredicate

NavAgentAdvancePredicate Infohazard.HyperNav.NavAgent.AdvancePredicate

getset

An optional condition to check if the agent can advance past a given waypoint in the path.

A multicast delegate is not supported.

◆ AreaTypeMask

NavAreaTypes Infohazard.HyperNav.NavAgent.AreaTypeMask

getset

The types of areas to sample.

◆ Arrived

bool Infohazard.HyperNav.NavAgent.Arrived

getprivate set

True if the agent has no active or pending path.

◆ AvoidanceAgent

AvoidanceAgent Infohazard.HyperNav.NavAgent.AvoidanceAgent

getset

AvoidanceAgent that this agent uses for avoidance (can be null).

◆ AvoidanceMaxSpeed

float Infohazard.HyperNav.NavAgent.AvoidanceMaxSpeed

getset

Maximum speed possible by this agent when avoiding obstacles.

◆ CheckSkippingWithPhysicsQuery

bool Infohazard.HyperNav.NavAgent.CheckSkippingWithPhysicsQuery

getset

Whether to check during path following if the agent should skip to the next waypoint.

◆ ControlAvoidanceIsActive

bool Infohazard.HyperNav.NavAgent.ControlAvoidanceIsActive

getset

If true, the Infohazard.HyperNav.AvoidanceAgent.IsActive state of the AvoidanceAgent is set based on whether there is a current valid path.

◆ CostToChangeToSurface

float Infohazard.HyperNav.NavAgent.CostToChangeToSurface

getset

Additional cost to changing from a volume to a surface.

◆ CostToChangeToVolume

float Infohazard.HyperNav.NavAgent.CostToChangeToVolume

getset

Additional cost to changing from a surface to a volume.

◆ CurrentPath

NavPath Infohazard.HyperNav.NavAgent.CurrentPath

getset

The current path that the agent is following.

◆ DebugPath

bool Infohazard.HyperNav.NavAgent.DebugPath

getset

Whether to draw a debug line in the scene view showing the agent's current path.

◆ DesiredSpeedRatio

float Infohazard.HyperNav.NavAgent.DesiredSpeedRatio

getset

The desired fraction of the maximum speed to travel at.

◆ Destination

Vector3 Infohazard.HyperNav.NavAgent.Destination

getset

Get or set the agent's destination (the position it is trying to get to).

If set within the _acceptance radius of the current position, will abort all movement.

◆ DestSamplingPriority

NavSamplePriority Infohazard.HyperNav.NavAgent.DestSamplingPriority

getset

How to prioritize results for the destination position when sampling in both volumes and surfaces.

◆ DistanceFromStart

float Infohazard.HyperNav.NavAgent.DistanceFromStart

getprotected set

The distance the agent has traveled along the path.

◆ IsPathPending

bool Infohazard.HyperNav.NavAgent.IsPathPending

get

Whether a path is currently in the process of being calculated for this agent.

◆ KeepPathWhileCalculating

bool Infohazard.HyperNav.NavAgent.KeepPathWhileCalculating

getset

Whether to keep following the current path while waiting for a new path to finish calculating.

If true, there can be two pending paths at the same time - the most and least recently requested ones. This ensures that even when the agent is receiving pathfinding requests faster than they can be calculated, they will still finish and the agent will not be deadlocked and unable to ever complete a path.

◆ MeasuredVelocity

Vector3 Infohazard.HyperNav.NavAgent.MeasuredVelocity

getprotected set

Velocity of the agent measured as delta position / delta time over the last frame, which is used to determine stopping distance.

This value is calculated in UpdateMeasuredVelocity. You can override that method to implement your own logic for calculating velocity.

◆ NextWaypoint

NavWaypoint? Infohazard.HyperNav.NavAgent.NextWaypoint

get

The current path waypoint that the agent is trying to move towards.

◆ NextWaypointPosition

Vector3 Infohazard.HyperNav.NavAgent.NextWaypointPosition

get

The current path waypoint that the agent is trying to move towards.

If there is no active path, will return the agent's current position.

◆ PathfindingParams

NavPathfindingParams Infohazard.HyperNav.NavAgent.PathfindingParams

getset

Pathfinding parameters as a combined struct.

◆ PositionForSurface

Vector3 Infohazard.HyperNav.NavAgent.PositionForSurface

get

The position to use for sampling surfaces.

◆ PositionForVolume

Vector3 Infohazard.HyperNav.NavAgent.PositionForVolume

get

The position to use for sampling volumes.

◆ PreviousWaypoint

NavWaypoint? Infohazard.HyperNav.NavAgent.PreviousWaypoint

get

The previous waypoint in the path.

◆ RemainingDistance

float Infohazard.HyperNav.NavAgent.RemainingDistance

getprotected set

The remaining distance to the destination.

◆ RemainingDistanceToNextWaypoint

float Infohazard.HyperNav.NavAgent.RemainingDistanceToNextWaypoint

getprotected set

The remaining distance to the next waypoint.

◆ Rigidbody

Rigidbody Infohazard.HyperNav.NavAgent.Rigidbody

getset

Optional rigidbody to use for measuring velocity.

◆ SampleRadius

float Infohazard.HyperNav.NavAgent.SampleRadius

getset

The radius to search when finding the nearest NavVolume.

◆ SkippingCheckCollider

Collider Infohazard.HyperNav.NavAgent.SkippingCheckCollider

getset

Collider to determine the query parameters for sweep testing.

The layer does not matter and it does not need to be enabled. However, it must be of type Box, Capsule, or Sphere, as Unity does not support Mesh casts.

◆ SkippingCheckColliderPadding

float Infohazard.HyperNav.NavAgent.SkippingCheckColliderPadding

getsetadd

Padding to reduce the size of the collider used for skipping waypoint checks.

◆ SkippingCheckLayerMask

LayerMask Infohazard.HyperNav.NavAgent.SkippingCheckLayerMask

getset

Layer mask to use for physics queries to check for obstacles when skipping waypoints.

◆ StartSamplingPriority

NavSamplePriority Infohazard.HyperNav.NavAgent.StartSamplingPriority

getset

How to prioritize results for the destination position when sampling in both volumes and surfaces.

◆ StoppingDistance

virtual float Infohazard.HyperNav.NavAgent.StoppingDistance

get

The distance that it will take the agent to come to a stop from its current velocity, determined using the AccelerationEstimate.

◆ SurfaceCostMultiplier

float Infohazard.HyperNav.NavAgent.SurfaceCostMultiplier

getset

Multiplier for the cost of traversing surface areas.

◆ VolumeCostMultiplier

float Infohazard.HyperNav.NavAgent.VolumeCostMultiplier

getset

Multiplier for the cost of traversing volume areas.

Event Documentation

◆ CurrentPathChanged

Action<NavPath> Infohazard.HyperNav.NavAgent.CurrentPathChanged

Invoked when the agent's path is updated.

◆ PathFailed

Action Infohazard.HyperNav.NavAgent.PathFailed

Invoked when the agent fails to find a path to the destination.

◆ PathIndexChanged

Action<int> Infohazard.HyperNav.NavAgent.PathIndexChanged

Invoked when the agent's path index changes.

◆ PathReady

Action Infohazard.HyperNav.NavAgent.PathReady

Invoked when the agent finds a path to the destination.

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

Runtime/NavAgent.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ Awake()

◆ CalculateDesiredNavigationVelocity()

◆ OnDisable()

◆ OnDrawGizmos()

◆ OnEnable()

◆ OnPathReady()

◆ SetDestinationByNavHit()

◆ Stop()

◆ Update()

◆ UpdateMeasuredVelocity()

◆ UpdatePath()

◆ UpdatePathIndex()

Property Documentation

◆ AccelerationEstimate

◆ Acceptance

◆ AdvancePredicate

◆ AreaTypeMask

◆ Arrived

◆ AvoidanceAgent

◆ AvoidanceMaxSpeed

◆ CheckSkippingWithPhysicsQuery

◆ ControlAvoidanceIsActive

◆ CostToChangeToSurface

◆ CostToChangeToVolume

◆ CurrentPath

◆ DebugPath

◆ DesiredSpeedRatio

◆ Destination

◆ DestSamplingPriority

◆ DistanceFromStart

◆ IsPathPending

◆ KeepPathWhileCalculating

◆ MeasuredVelocity

◆ NextWaypoint

◆ NextWaypointPosition

◆ PathfindingParams

◆ PositionForSurface

◆ PositionForVolume

◆ PreviousWaypoint

◆ RemainingDistance

◆ RemainingDistanceToNextWaypoint

◆ Rigidbody

◆ SampleRadius

◆ SkippingCheckCollider

◆ SkippingCheckColliderPadding

◆ SkippingCheckLayerMask

◆ StartSamplingPriority

◆ StoppingDistance

◆ SurfaceCostMultiplier

◆ VolumeCostMultiplier

Event Documentation

◆ CurrentPathChanged

◆ PathFailed

◆ PathIndexChanged

◆ PathReady