Class: CSavedGameWrapper
Lightweight view over save-game metadata.
Source
C++ class CSavedGameWrapper
Custom Constructor
CSavedGameWrapper
Remarks
Looks for both current and legacy save extensions under $game_saves$. A missing file asserts; an existing file with an incompatible header returns fallback metadata instead.
Extends
Constructors
Constructor
new CSavedGameWrapper(name: string): CSavedGameWrapper;Open save-game metadata by save name.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Save name without extension. |
Returns
CSavedGameWrapper
Throws
If the save file does not exist.
Overrides
Methods
actor_health()
actor_health(): number;Get actor health stored in the save.
Returns
number
Actor health.
Remarks
Invalid save headers return 1.
game_time()
game_time(): CTime;Get in-game time stored in the save.
Returns
Game time.
Remarks
Invalid save headers return the default ALife time instead of throwing.
level_id()
level_id(): number;Get active level id stored in the save.
Returns
number
Level id.
Remarks
Returns 255 when level metadata cannot be resolved.
level_name()
level_name(): string;Get active level name stored in the save.
Returns
string
Level name, or an empty/error value when metadata cannot be resolved.
Remarks
Returns an empty string when level metadata cannot be resolved. Returns the translated error string when the game graph has no matching level id.
Properties
__name
readonly __name: string;LuaBind instance constructor name.
Inherited from
__name
readonly static __name: string;LuaBind class constructor name.