Class default

Hierarchy

Host<ISaveManagerEvents>
- default

Constructors

constructor

new default(game: Game, waywardPreload: undefined | IWaywardPreload): default
Parameters
- game: Game
- waywardPreload: undefined | IWaywardPreload
Returns default
Overrides EventEmitter.Host<ISaveManagerEvents>.constructor
- Defined in src/game/save/SaveManager.ts:59

Properties

`Readonly` event

event: IEventEmitter<default, ISaveManagerEvents>

`Readonly` game

game: Game

lastLoadedVersion

lastLoadedVersion: Info

Accessors

isLoading

get isLoading(): boolean
Returns boolean
- Defined in src/game/save/SaveManager.ts:55

Methods

clearMultiplayerSlotData

clearMultiplayerSlotData(): void
Returns void
- Defined in src/game/save/SaveManager.ts:65

compressSave

compressSave(slot: number, saveObject: ISaveObject): void
Parameters
- slot: number
- saveObject: ISaveObject
Returns void
- Defined in src/game/save/SaveManager.ts:675

copySave

copySave(slot?: number, target?: number): Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>
Parameters
- slot: number = ...
- Optional target: number
Returns Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>
- Defined in src/game/save/SaveManager.ts:628

decompressSave

decompressSave(slot: undefined | number, saveObject: ISaveObject, legacyDecompressAllProperties?: boolean): void
Parameters
- slot: undefined | number
- saveObject: ISaveObject
- legacyDecompressAllProperties: boolean = false
Returns void
- Defined in src/game/save/SaveManager.ts:710

deleteAllData

deleteAllData(): Promise<void>
Returns Promise<void>
- Defined in src/game/save/SaveManager.ts:665

deleteAllSlots

deleteAllSlots(): Promise<void>
Returns Promise<void>
- Defined in src/game/save/SaveManager.ts:655

deleteSlot

deleteSlot(slot?: number): Promise<void>
Parameters
- slot: number = ...
Returns Promise<void>
- Defined in src/game/save/SaveManager.ts:645

doesSaveLookWaywardy

doesSaveLookWaywardy(saveObject: ISaveObject, slot?: number): boolean
Parameters
- saveObject: ISaveObject
- Optional slot: number
Returns boolean
- Defined in src/game/save/SaveManager.ts:700

downloadGameStateAsJson

downloadGameStateAsJson(cleanup?: boolean): void
Parameters
- cleanup: boolean = true
Returns void
- Defined in src/game/save/SaveManager.ts:938

exportSaveObjectAsUint8Array

exportSaveObjectAsUint8Array(saveObject: ISaveObject): Uint8Array
Exports a saveObject into a Uint8Array format that can be used with importSave
Parameters
- saveObject: ISaveObject
Returns Uint8Array
- Defined in src/game/save/SaveManager.ts:474

exportSlotAsUint8Array

exportSlotAsUint8Array(slot: number): Promise<Uint8Array>
Exports the specified slot into a Uint8Array format that can be used with importSave
Parameters
- slot: number
Returns Promise<Uint8Array>
- Defined in src/game/save/SaveManager.ts:463

getClientStore

getClientStore(player: default): IClientStore
Returns the players ClientStore
Parameters
- player: default
Returns IClientStore
- Defined in src/game/save/SaveManager.ts:149

getFirstFreeSlot

getFirstFreeSlot(): Promise<number>
Returns the index of the first free slot

Returns Promise<number>
- Defined in src/game/save/SaveManager.ts:132

getGameStateAsJson

getGameStateAsJson(cleanup: undefined | boolean, pretty: undefined | boolean, compress: true): Uint8Array
Parameters
- cleanup: undefined | boolean
- pretty: undefined | boolean
- compress: true
Returns Uint8Array
- Defined in src/game/save/SaveManager.ts:752
getGameStateAsJson(cleanup?: boolean, pretty?: boolean, compress?: false): string
Parameters
- Optional cleanup: boolean
- Optional pretty: boolean
- Optional compress: false
Returns string
- Defined in src/game/save/SaveManager.ts:753

getMostRecentSlot

getMostRecentSlot(): Promise<undefined | number>
Gets the most recently saved slot

Returns Promise<undefined | number>
- Defined in src/game/save/SaveManager.ts:211

getSaveObjectFromUint8Array

getSaveObjectFromUint8Array(data: Uint8Array): ISaveObject
Converts a Uint8Array into a SaveObject Used in conjection with exportSlotAsUint8Array / exportSaveObjectAsUint8Array
Parameters
- data: Uint8Array
Returns ISaveObject
- Defined in src/game/save/SaveManager.ts:488

getSerializer

getSerializer(): ISerializer
Returns ISerializer
- Defined in src/game/save/SaveManager.ts:732

getUsedSlots

getUsedSlots(): Promise<number[]>
Returns the indices of the used slots

Returns Promise<number[]>
- Defined in src/game/save/SaveManager.ts:114

getUsedSlotsSorted

getUsedSlotsSorted(sortBy: SaveSort, direction?: SortDirection): Promise<number[]>
Gets the used slots, ordered by one of a few properties of the savedData in that slot
Parameters
- sortBy: SaveSort
- direction: SortDirection = SortDirection.Ascending
Returns Promise<number[]>
- Defined in src/game/save/SaveManager.ts:164

importSave

importSave(slot: number, saveObject: string | Uint8Array | ISaveObject): Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>
Imports saves from multiple formats
1. ISaveObject - games imported while joining a multiplayer server
2. string - From legacy exported save games to files or to steam
3. Uint8Array - From exported save games
Returns
the number of bytes the save takes up, or undefined, if an error occurs
Parameters
- slot: number
- saveObject: string | Uint8Array | ISaveObject
Returns Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>
- Defined in src/game/save/SaveManager.ts:546

importSaveToObject

importSaveToObject(slot: undefined | number, saveObject: string | Uint8Array | ISaveObject): ISaveObject | {
error: SaveImportErrorReason;
}
Parameters
- slot: undefined | number
- saveObject: string | Uint8Array | ISaveObject
Returns ISaveObject | {
error: SaveImportErrorReason;
}
- Defined in src/game/save/SaveManager.ts:580

importSaves

importSaves(saveObjects: FileUploadResult[], onImportSave?: ((result: ISaveImportSuccess, index: number) => any)): Promise<SaveImportResult[]>
Parameters
- saveObjects: FileUploadResult[]
- Optional onImportSave: ((result: ISaveImportSuccess, index: number) => any)
  - - (result: ISaveImportSuccess, index: number): any
    - Parameters
      
      result: ISaveImportSuccess
      
      index: number
      
      Returns any
Returns Promise<SaveImportResult[]>
- Defined in src/game/save/SaveManager.ts:500

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in src/game/save/SaveManager.ts:73

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in src/game/save/SaveManager.ts:69

isSlotUsed

isSlotUsed(slot: number): Promise<boolean>
Returns whether or not the slot is used
Parameters
- slot: number
Returns Promise<boolean>
- Defined in src/game/save/SaveManager.ts:121

load

load(slot: number): Promise<boolean>
Returns whether or not it succeeded
Parameters
- slot: number
Returns Promise<boolean>
- Defined in src/game/save/SaveManager.ts:257

loadSpecificData

loadSpecificData(slotOrSaveObject: number | ISaveObject, keys: Set<AnyPropertyToSerialize>): Promise<Record<AnyPropertyToSerialize, any>>
Parameters
- slotOrSaveObject: number | ISaveObject
- keys: Set<AnyPropertyToSerialize>
Returns Promise<Record<AnyPropertyToSerialize, any>>
- Defined in src/game/save/SaveManager.ts:324

loadSpecificDataResilient

loadSpecificDataResilient(slotOrSaveObject: number | ISaveObject, keys: Set<AnyPropertyToSerialize>): Promise<{
errors: Map<AnyPropertyToSerialize, Error>;
result: Record<AnyPropertyToSerialize, any>;
}>
Attempts to load all the given keys from the slot at once. Upon failure, instead loads each separately.

Returns
an object of results, and an object of errors, both indexed by the given keys.
Parameters
- slotOrSaveObject: number | ISaveObject
- keys: Set<AnyPropertyToSerialize>
Returns Promise<{
errors: Map<AnyPropertyToSerialize, Error>;
result: Record<AnyPropertyToSerialize, any>;
}>
- Defined in src/game/save/SaveManager.ts:362

loadSpecificDatas

loadSpecificDatas(slots: number[], keys: Set<AnyPropertyToSerialize>): Promise<Map<number, Record<AnyPropertyToSerialize, any>>>
Parameters
- slots: number[]
- keys: Set<AnyPropertyToSerialize>
Returns Promise<Map<number, Record<AnyPropertyToSerialize, any>>>
- Defined in src/game/save/SaveManager.ts:383

save

save(slot: number): Promise<undefined | ISaveInfo>
Saves Keep this in sync with saveSynchronous
Parameters
- slot: number
Returns Promise<undefined | ISaveInfo>
- Defined in src/game/save/SaveManager.ts:220

saveSpecificData

saveSpecificData(slot: number, object: any, keys: Set<AnyPropertyToSerialize | "checksums">): Promise<number>
Returns the number of bytes the save takes up
Parameters
- slot: number
- object: any
- keys: Set<AnyPropertyToSerialize | "checksums">
Returns Promise<number>
- Defined in src/game/save/SaveManager.ts:424

saveSynchronous

saveSynchronous(slot: number): undefined | ISaveInfo
Saves synchronously Keep this in sync with save
Parameters
- slot: number
Returns undefined | ISaveInfo
- Defined in src/game/save/SaveManager.ts:239

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

game: Game

waywardPreload: undefined | IWaywardPreload

Returns default

Properties

Readonly event

Readonly game

lastLoadedVersion

Accessors

isLoading

Returns boolean

Methods

clearMultiplayerSlotData

Returns void

compressSave

Parameters

slot: number

saveObject: ISaveObject

Returns void

copySave

Parameters

slot: number = ...

Optional target: number

Returns Promise<{ bytes: number; } | { error: SaveImportErrorReason; }>

decompressSave

Parameters

slot: undefined | number

saveObject: ISaveObject

legacyDecompressAllProperties: boolean = false

Returns void

deleteAllData

Returns Promise<void>

deleteAllSlots

Returns Promise<void>

deleteSlot

Parameters

slot: number = ...

Returns Promise<void>

doesSaveLookWaywardy

Parameters

saveObject: ISaveObject

Optional slot: number

Returns boolean

downloadGameStateAsJson

Parameters

cleanup: boolean = true

Returns void

exportSaveObjectAsUint8Array

Parameters

saveObject: ISaveObject

Returns Uint8Array

exportSlotAsUint8Array

Parameters

slot: number

Returns Promise<Uint8Array>

getClientStore

Parameters

player: default

Returns IClientStore

getFirstFreeSlot

Returns Promise<number>

getGameStateAsJson

Parameters

cleanup: undefined | boolean

pretty: undefined | boolean

compress: true

Returns Uint8Array

Parameters

Optional cleanup: boolean

Optional pretty: boolean

Optional compress: false

`Readonly` event

`Readonly` game

`Optional` target: number

Returns Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>

`Optional` slot: number

`Optional` cleanup: boolean

`Optional` pretty: boolean

`Optional` compress: false

Returns Promise<{
bytes: number;
} | {
error: SaveImportErrorReason;
}>

Returns ISaveObject | {
error: SaveImportErrorReason;
}

`Optional` onImportSave: ((result: ISaveImportSuccess, index: number) => any)

Returns Promise<{
errors: Map<AnyPropertyToSerialize, Error>;
result: Record<AnyPropertyToSerialize, any>;
}>