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

Public Member Functions

override void Stop (bool abortPaths)

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

Parameters

abortPaths Whether to cancel pending path requests.

More...

Public Member Functions inherited from Infohazard.HyperNav.NavAgent

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
override void	Update ()
	Updates measured velocity and finds the nearest point on the spline. More...

override void	OnDrawGizmos ()
	Draws the current spline if NavAgent.DebugPath is true. More...

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

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

Protected Member Functions inherited from Infohazard.HyperNav.NavAgent
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	TangentScale `[get, set]`
	Scale to apply to spline tangents (lower values make the spline less curvy). More...

bool	RaycastTangents `[get, set]`
	Whether to shorten tangents by raycasting to ensure they don't penetrate blocked areas. More...

int	DistanceSamplesPerSegment `[get, set]`
	How many samples to take per segment of the spline when mapping the distance. More...

int	DebugPointCount `[get, set]`
	If NavAgent.DebugPath is enabled, how many points to use to draw the curve. More...

float	MaxAlignmentVelocityDistance `[get, set]`
	At what distance from the spline the agent will have all its desired velocity devoted to returning. More...

float	CurvatureSampleDistance `[get, set]`
	Delta-T to use when sampling curvature (should be quite small). More...

float	CurvatureOfMaxSlowdown `[get, set]`
	At what curvature value is the agent at its max curvature slowdown. More...

float	MaxCurvatureSlowdown `[get, set]`
	The multiplier on desired tangent velocity when at the max curvature value. More...

bool	DebugProjectOnSpline `[get, set]`
	Whether to draw debug lines when projecting on the spline. More...

float	BlockedDetectionDistance `[get, set]`
	Distance in front of the agent to check to see if it needs to avoid level geometry. More...

float	BlockedDetectionBackDistance `[get, set]`
	Distance behind the agent to check to see if it needs to avoid level geometry. More...

float	BlockedDetectionMinSplineDistance `[get, set]`
	How far the agent must be from the spline to check for blocking level geometry. More...

bool	BlockedDetectionPhysicsQuery `[get, set]`
	Whether to use physics queries to detect blocking level geometry. More...

Rigidbody	BlockedDetectionPhysicsQueryRigidbody `[get, set]`
	Rigidbody to use for physics queries to detect blocking level geometry. More...

bool	IsOnSpline `[get, private set]`
	Whether the agent is currently traveling along a spline. More...

SplinePath	SplinePath `[get]`
	The spline that the agent is currently following. More...

float	CurrentSplineParameter `[get]`
	The spline parameter value the agent is nearest to on the spline. More...

float	CurrentSplineDistance `[get]`
	The distance along the spline the agent is nearest to. More...

float	MaxSplineDistance `[get]`
	The length of the agent's current spline path. More...

float	RemainingDistanceAfterSpline `[get, private set]`
	The remaining distance along the path after the end of the current spline. More...

int	PathIndexOfSplineEnd `[get, private set]`
	The index of the end of the current spline in the current path. More...

Properties inherited from Infohazard.HyperNav.NavAgent
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...

Additional Inherited Members
Events inherited from Infohazard.HyperNav.NavAgent
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 smooth paths by any entity that needs to use HyperNav for navigation.

A SplineNavAgent works just like (and is a subclass of) NavAgent. However, a SplineNavAgent feeds the path waypoints into a spline function to get a smoother path. The spline-based movement is only active during volume-based navigation; surface navigation will use the default point-based path. In order to follow the spline, the SplineNavAgent creates its NavAgent.DesiredVelocity based on two factors:

Tangent: The direction the spline is pointing nearest the agent.
Alignment: The direction from the agent to the nearest point on the spline.f

The agent will increase the influence of the alignment velocity the further it gets from the spline, in order to prevent drifting too far off. Additionally, the agent can slow down its desired tangent velocity on high-curvature regions, in order to take the curves more slowly.

Member Function Documentation

◆ CalculateDesiredNavigationVelocity()

override Vector3 Infohazard.HyperNav.SplineNavAgent.CalculateDesiredNavigationVelocity ( )

protectedvirtual

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

Reimplemented from Infohazard.HyperNav.NavAgent.

◆ OnDisable()

override void Infohazard.HyperNav.SplineNavAgent.OnDisable ( )

protectedvirtual

Stops all pathfinding and cancels path requests.

Reimplemented from Infohazard.HyperNav.NavAgent.

◆ OnDrawGizmos()

override void Infohazard.HyperNav.SplineNavAgent.OnDrawGizmos ( )

protectedvirtual

Draws the current spline if NavAgent.DebugPath is true.

The spline will be drawn with DebugPointCount points.

Reimplemented from Infohazard.HyperNav.NavAgent.

◆ Stop()

override void Infohazard.HyperNav.SplineNavAgent.Stop ( bool abortPaths )

virtual

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

Parameters

abortPaths Whether to cancel pending path requests.

Reimplemented from Infohazard.HyperNav.NavAgent.

◆ Update()

override void Infohazard.HyperNav.SplineNavAgent.Update ( )

protectedvirtual

Updates measured velocity and finds the nearest point on the spline.

Reimplemented from Infohazard.HyperNav.NavAgent.

Property Documentation

◆ BlockedDetectionBackDistance

float Infohazard.HyperNav.SplineNavAgent.BlockedDetectionBackDistance

getset

Distance behind the agent to check to see if it needs to avoid level geometry.

◆ BlockedDetectionDistance

float Infohazard.HyperNav.SplineNavAgent.BlockedDetectionDistance

getset

Distance in front of the agent to check to see if it needs to avoid level geometry.

◆ BlockedDetectionMinSplineDistance

float Infohazard.HyperNav.SplineNavAgent.BlockedDetectionMinSplineDistance

getset

How far the agent must be from the spline to check for blocking level geometry.

◆ BlockedDetectionPhysicsQuery

bool Infohazard.HyperNav.SplineNavAgent.BlockedDetectionPhysicsQuery

getset

Whether to use physics queries to detect blocking level geometry.

◆ BlockedDetectionPhysicsQueryRigidbody

Rigidbody Infohazard.HyperNav.SplineNavAgent.BlockedDetectionPhysicsQueryRigidbody

getset

Rigidbody to use for physics queries to detect blocking level geometry.

◆ CurrentSplineDistance

float Infohazard.HyperNav.SplineNavAgent.CurrentSplineDistance

get

The distance along the spline the agent is nearest to.

◆ CurrentSplineParameter

float Infohazard.HyperNav.SplineNavAgent.CurrentSplineParameter

get

The spline parameter value the agent is nearest to on the spline.

◆ CurvatureOfMaxSlowdown

float Infohazard.HyperNav.SplineNavAgent.CurvatureOfMaxSlowdown

getset

At what curvature value is the agent at its max curvature slowdown.

◆ CurvatureSampleDistance

float Infohazard.HyperNav.SplineNavAgent.CurvatureSampleDistance

getset

Delta-T to use when sampling curvature (should be quite small).

◆ DebugPointCount

int Infohazard.HyperNav.SplineNavAgent.DebugPointCount

getset

If NavAgent.DebugPath is enabled, how many points to use to draw the curve.

◆ DebugProjectOnSpline

bool Infohazard.HyperNav.SplineNavAgent.DebugProjectOnSpline

getset

Whether to draw debug lines when projecting on the spline.

◆ DistanceSamplesPerSegment

int Infohazard.HyperNav.SplineNavAgent.DistanceSamplesPerSegment

getset

How many samples to take per segment of the spline when mapping the distance.

◆ IsOnSpline

bool Infohazard.HyperNav.SplineNavAgent.IsOnSpline

getprivate set

Whether the agent is currently traveling along a spline.

◆ MaxAlignmentVelocityDistance

float Infohazard.HyperNav.SplineNavAgent.MaxAlignmentVelocityDistance

getset

At what distance from the spline the agent will have all its desired velocity devoted to returning.

◆ MaxCurvatureSlowdown

float Infohazard.HyperNav.SplineNavAgent.MaxCurvatureSlowdown

getset

The multiplier on desired tangent velocity when at the max curvature value.

◆ MaxSplineDistance

float Infohazard.HyperNav.SplineNavAgent.MaxSplineDistance

get

The length of the agent's current spline path.

◆ PathIndexOfSplineEnd

int Infohazard.HyperNav.SplineNavAgent.PathIndexOfSplineEnd

getprivate set

The index of the end of the current spline in the current path.

◆ RaycastTangents

bool Infohazard.HyperNav.SplineNavAgent.RaycastTangents

getset

Whether to shorten tangents by raycasting to ensure they don't penetrate blocked areas.

◆ RemainingDistanceAfterSpline

float Infohazard.HyperNav.SplineNavAgent.RemainingDistanceAfterSpline

getprivate set

The remaining distance along the path after the end of the current spline.

◆ SplinePath

SplinePath Infohazard.HyperNav.SplineNavAgent.SplinePath

get

The spline that the agent is currently following.

◆ TangentScale

float Infohazard.HyperNav.SplineNavAgent.TangentScale

getset

Scale to apply to spline tangents (lower values make the spline less curvy).

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

Runtime/Spline/SplineNavAgent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CalculateDesiredNavigationVelocity()

◆ OnDisable()

◆ OnDrawGizmos()

◆ Stop()

◆ Update()

Property Documentation

◆ BlockedDetectionBackDistance

◆ BlockedDetectionDistance

◆ BlockedDetectionMinSplineDistance

◆ BlockedDetectionPhysicsQuery

◆ BlockedDetectionPhysicsQueryRigidbody

◆ CurrentSplineDistance

◆ CurrentSplineParameter

◆ CurvatureOfMaxSlowdown

◆ CurvatureSampleDistance

◆ DebugPointCount

◆ DebugProjectOnSpline

◆ DistanceSamplesPerSegment

◆ IsOnSpline

◆ MaxAlignmentVelocityDistance

◆ MaxCurvatureSlowdown

◆ MaxSplineDistance

◆ PathIndexOfSplineEnd

◆ RaycastTangents

◆ RemainingDistanceAfterSpline

◆ SplinePath

◆ TangentScale