SimulationStateFile::Save Method

Saves a .bin simulation state file from the given path (relative to the States folder). Remember to call CaptureCurrentSate or loading a different state before saving the state file.

Syntax

bool SimulationStateFile::Save(
    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 saved.

Return value

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

Remarks

None.