Photon Quantum 3.0.0

Public Member Functions | Protected Member Functions | Properties | List of all members
Quantum.SystemMainThreadGroup Class Reference

A Quantum main thread system that has a system hierarchy. More...

Inheritance diagram for Quantum.SystemMainThreadGroup:
Quantum.SystemMainThread Quantum.SystemBase

Public Member Functions

 SystemMainThreadGroup (string name, params SystemMainThread[] children)
 Create a new system group. More...
 
override void OnDisabled (Frame f)
 Is called when the system was disabled for example after Frame.SystemDisable(Type).
 
override 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).
 
sealed override void Update (Frame f)
 Override to add the workload. More...
 
- Public Member Functions inherited from Quantum.SystemMainThread
 SystemMainThread ()
 Create a new system. More...
 
 SystemMainThread (string name)
 Create a new system with a custom name. More...
 
- Public Member Functions inherited from Quantum.SystemBase
 SystemBase ()
 Constructor. More...
 
 SystemBase (string scheduleSample)
 Create a new instance and setting the sample name. 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)
 Override to add additional tasks.
 
- Protected Member Functions inherited from Quantum.SystemMainThread
TaskHandle ScheduleUpdate (Frame f, TaskHandle taskHandle)
 Adds the basic update callback. More...
 

Properties

sealed override IEnumerable< SystemBaseChildSystems [get]
 Returns all child systems of this instance. More...
 
- Properties inherited from Quantum.SystemBase
virtual 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...
 
Int32 RuntimeIndex [get, set]
 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

A Quantum main thread system that has a system hierarchy.

Constructor & Destructor Documentation

◆ SystemMainThreadGroup()

Quantum.SystemMainThreadGroup.SystemMainThreadGroup ( string  name,
params SystemMainThread[]  children 
)
inline

Create a new system group.

Parameters
nameThe system name.
childrenThe system children.

Member Function Documentation

◆ Update()

sealed override void Quantum.SystemMainThreadGroup.Update ( Frame  f)
inlinevirtual

Override to add the workload.

Parameters
fThe current frame.

Implements Quantum.SystemMainThread.

Property Documentation

◆ ChildSystems

sealed override IEnumerable<SystemBase> Quantum.SystemMainThreadGroup.ChildSystems
get

Returns all child systems of this instance.