Quantum 3 3.1.0

Public Member Functions | Public Attributes | List of all members
Quantum.QuantumRunnerLocalReplay Class Reference

An example of how to start a Quantum replay simulation from a replay file. Also works for loading a snapshot to start a local session from. More...

Inheritance diagram for Quantum.QuantumRunnerLocalReplay:
Quantum.QuantumMonoBehaviour

Public Member Functions

void Start ()
 Unity start event, will start the Quantum runner and simulation after deserializing the replay file. More...
 
void Update ()
 Unity Update event will update the simulation if a custom SimulationSpeedMultiplier was set. More...
 

Public Attributes

TextAsset DatabaseFile
 Quantum asset database Json file. More...
 
SimulationUpdateTime DeltaTimeType = SimulationUpdateTime.EngineDeltaTime
 Set the DeltaTimeType to SimulationUpdateTime.EngineDeltaTime to not progress the simulation time during break points. More...
 
InstantReplaySettings InstantReplayConfig = InstantReplaySettings.Default
 Set InstantReplaySettings to enable instant replays. More...
 
TextAsset ReplayFile
 Replay JSON file. More...
 
bool ShowReplayLabel
 Toggle the replay gui label on/off. More...
 
float SimulationSpeedMultiplier = 1.0f
 Simulation speed multiplier to playback the replay in a different speed. More...
 

Detailed Description

An example of how to start a Quantum replay simulation from a replay file. Also works for loading a snapshot to start a local session from.

Member Function Documentation

◆ Start()

void Quantum.QuantumRunnerLocalReplay.Start ( )
inline

Unity start event, will start the Quantum runner and simulation after deserializing the replay file.

◆ Update()

void Quantum.QuantumRunnerLocalReplay.Update ( )
inline

Unity Update event will update the simulation if a custom SimulationSpeedMultiplier was set.

Member Data Documentation

◆ ReplayFile

TextAsset Quantum.QuantumRunnerLocalReplay.ReplayFile

Replay JSON file.

◆ DatabaseFile

TextAsset Quantum.QuantumRunnerLocalReplay.DatabaseFile

Quantum asset database Json file.

◆ SimulationSpeedMultiplier

float Quantum.QuantumRunnerLocalReplay.SimulationSpeedMultiplier = 1.0f

Simulation speed multiplier to playback the replay in a different speed.

◆ ShowReplayLabel

bool Quantum.QuantumRunnerLocalReplay.ShowReplayLabel

Toggle the replay gui label on/off.

◆ DeltaTimeType

SimulationUpdateTime Quantum.QuantumRunnerLocalReplay.DeltaTimeType = SimulationUpdateTime.EngineDeltaTime

Set the DeltaTimeType to SimulationUpdateTime.EngineDeltaTime to not progress the simulation time during break points.

◆ InstantReplayConfig

InstantReplaySettings Quantum.QuantumRunnerLocalReplay.InstantReplayConfig = InstantReplaySettings.Default

Set InstantReplaySettings to enable instant replays.