SimulationStateFile::CaptureCurrentState Method

Captures the current simulation state into the object.

Syntax

bool SimulationStateFile::CaptureCurrentState(
    SimulationManager@ simManager,
    bool withStatesAndInputs
)

Parameters

SimulationManager@ simManager
The simulation manager.

bool withStatesAndInputs
If the previous states and inputs should be captured as well.

Return value

bool
If the capture was successful.

Remarks

If withStatesAndInputs is specified, avoid calling this function on every tick, as saving progressively larger state/input buffers could cause performance issues or running out of memory. After capturing, the state can be then saved using the Save method.