Quantum 3 3.0.10

Public Member Functions | Protected Member Functions | List of all members
Quantum.Core.NavigationSystem Class Reference

The Quantum core navigation system. More...

Inheritance diagram for Quantum.Core.NavigationSystem:
Quantum.SystemBase 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.
 
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.
 
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.
 
- Public Member Functions inherited from Quantum.SystemBase
 SystemBase ()
 Constructor. More...
 
 SystemBase (params SystemBase[] children)
 Create a new instance of a system with children. More...
 
 SystemBase (string scheduleSample)
 Create a new instance and setting the sample name. More...
 
virtual void OnDisabled (Frame f)
 Is called when the system was disabled for example after Frame.SystemDisable(Type). More...
 
virtual void OnEnabled (Frame f)
 Is called when the system was enabled for example after calling Frame.SystemEnable<T>() or during QuantumGame.InitSystems(Photon.Deterministic.DeterministicFrame). More...
 
virtual void OnInit (Frame f)
 Is called when the system is initialized. More...
 
TaskHandle OnSchedule (Frame f, TaskHandle taskHandle)
 Creates the task graph for the system. More...
 

Protected Member Functions

override TaskHandle Schedule (Frame f, TaskHandle taskHandle)
 Create the navigation system update task graph. More...
 

Additional Inherited Members

- Properties inherited from Quantum.SystemBase
IEnumerable< SystemBaseChildSystems [get]
 The enumerable child systems. More...
 
IEnumerable< SystemBaseHierarchy [get]
 Creates the complete sub graph of child systems. More...
 
SystemBase ParentSystem [get]
 The parent system in the system hierarchy. More...
 
string ProfilerName [get]
 Profiler name. More...
 
Int32 RuntimeIndex [get]
 A unique index assigned to identify systems at runtime. More...
 
virtual Boolean StartEnabled [get, set]
 Set to true when the simulation should start with this system enabled. More...
 

Detailed Description

The Quantum core navigation system.

Member Function Documentation

◆ Schedule()

override TaskHandle Quantum.Core.NavigationSystem.Schedule ( Frame  f,
TaskHandle  taskHandle 
)
inlineprotectedvirtual

Create the navigation system update task graph.

Parameters
fThe frame reference.
taskHandleThe root task handle used to create new tasks.
Returns
Updated task handle with the navigation update graph.

Implements Quantum.SystemBase.