SimulationStateFile::Load Method

Loads a .bin simulation state file from the given path (relative to the States folder).

Syntax

bool SimulationStateFile::Load(
    const string&in stateRelativePath,
    string&out error
)

Parameters

const string&in stateRelativePath
The path to the state file, relative to the States folder.

string&out error
The error message if the state file could not be loaded.

Return value

bool
true if the state file was loaded successfully, false otherwise.

Remarks

None.