Quantum.INavigationCallbacks Interface Reference

Basic callbacks from the navigation system to Quantum systems. More...

Inheritance diagram for Quantum.INavigationCallbacks:

Public Member Functions
void	OnMoveAgent (EntityRef entity, FPVector2 desiredDirection)
	This callback is only called when NavMeshAgentConfig.MovementType is set to Navigation.MovementType.Callback."/> It can be used to implement a custom steering behavior for the agent using the desiredDirection which is an outcome of the pathfinding and avoidance systems. More...
void	OnSearchFailed (EntityRef entity, ref bool resetAgent)
	The path finding request issued by NavMeshPathfinder.SetTarget(Core.FrameBase, FPVector3, NavMesh) failed. Set resetAgent parameter to true when a new target for the agent was issued inside this callback. More...
void	OnWaypointReached (EntityRef entity, FPVector3 waypoint, Navigation.WaypointFlag waypointFlags, ref bool resetAgent)
	Callback is executed when a waypoint has been reached. Set resetAgent parameter to true when a new target for the agent was issued inside this callback. More...

Detailed Description

Basic callbacks from the navigation system to Quantum systems.

Member Function Documentation

OnWaypointReached()

void Quantum.INavigationCallbacks.OnWaypointReached	(	EntityRef	entity,
		FPVector3	waypoint,
		Navigation.WaypointFlag	waypointFlags,
		ref bool	resetAgent
	)

Callback is executed when a waypoint has been reached. Set resetAgent parameter to true when a new target for the agent was issued inside this callback.

Parameters

entity	Agent entity
waypoint	World position waypoint
waypointFlags	Waypoint flags
resetAgent	A flag to prevent resetting the agent after this callback.

Implemented in Quantum.Core.NavigationSystem.

OnSearchFailed()

void Quantum.INavigationCallbacks.OnSearchFailed	(	EntityRef	entity,
		ref bool	resetAgent
	)

The path finding request issued by NavMeshPathfinder.SetTarget(Core.FrameBase, FPVector3, NavMesh) failed. Set resetAgent parameter to true when a new target for the agent was issued inside this callback.

Parameters

entity	Agent entity
resetAgent	A flag to prevent resetting the agent after this callback.

Implemented in Quantum.Core.NavigationSystem.

OnMoveAgent()

void Quantum.INavigationCallbacks.OnMoveAgent	(	EntityRef	entity,
		FPVector2	desiredDirection
	)

This callback is only called when NavMeshAgentConfig.MovementType is set to Navigation.MovementType.Callback."/> It can be used to implement a custom steering behavior for the agent using the desiredDirection which is an outcome of the pathfinding and avoidance systems.

Parameters

entity	Agent entity
desiredDirection	Desired movement direction

Implemented in Quantum.Core.NavigationSystem.