Skip to content

Class: MockCSavedGameWrapper

Mock of the X-Ray engine CSavedGameWrapper.

Implements

  • CSavedGameWrapper

Constructors

Constructor

ts
new MockCSavedGameWrapper(_name?: string): MockCSavedGameWrapper;

Parameters

ParameterTypeDefault value
_namestring""

Returns

MockCSavedGameWrapper

Methods

actor_health()

ts
actor_health(): number;

Get actor health stored in the save.

Returns

number

Actor health.

Remarks

Invalid save headers return 1.

Implementation of

ts
CSavedGameWrapper.actor_health

game_time()

ts
game_time(): MockCTime;

Get in-game time stored in the save.

Returns

MockCTime

Game time.

Remarks

Invalid save headers return the default ALife time instead of throwing.

Implementation of

ts
CSavedGameWrapper.game_time

level_id()

ts
level_id(): number;

Get active level id stored in the save.

Returns

number

Level id.

Remarks

Returns 255 when level metadata cannot be resolved.

Implementation of

ts
CSavedGameWrapper.level_id

level_name()

ts
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.

Implementation of

ts
CSavedGameWrapper.level_name

create()

ts
static create(name?: string): MockCSavedGameWrapper;

Parameters

ParameterTypeDefault value
namestring""

Returns

MockCSavedGameWrapper


mock()

ts
static mock(name?: string): CSavedGameWrapper;

Parameters

ParameterTypeDefault value
namestring""

Returns

CSavedGameWrapper

Properties

__name

ts
__name: string = "CSavedGameWrapper";

LuaBind instance constructor name.

Implementation of

ts
CSavedGameWrapper.__name