Simulator API

Groups the types that describe the state of the DeterministicSession simulator during an update. More...

Classes
class	Photon.Deterministic.SimulatorContext
	Carries metadata about the DeterministicSession simulator in the current Update. More...

Enumerations
enum	Photon.Deterministic.SimulatorStage
	The different stages a DeterministicSession simulator can be in. During a Session Update the simulator will advance through the following stages in order: BeforeVerification > Verification > AfterVerification > BeforePrediction > Prediction > AfterPrediction. More...

Detailed Description

Groups the types that describe the state of the DeterministicSession simulator during an update.

Enumeration Type Documentation

SimulatorStage

enum Photon.Deterministic.SimulatorStage

strong

The different stages a DeterministicSession simulator can be in. During a Session Update the simulator will advance through the following stages in order: BeforeVerification > Verification > AfterVerification > BeforePrediction > Prediction > AfterPrediction.

Every stage is entered and finished even when it has no frames to simulate, so the stage callbacks always run in this order. A lockstep session is the exception: it never predicts and stops after AfterVerification.

Enumerator
BeforeVerification	Initial simulator stage, before any frames are simulated.
Verification	First simulation loop where frames with verified input sets are simulated.
AfterVerification	Intermediate stage after the verified loop is finished.
BeforePrediction	Intermediate stage before the predicted simulations start.
Prediction	Second simulation loop where frames with predicted input sets are simulated.
AfterPrediction	Final simulator stage, after both Verified and/or Predicted frames were simulated.