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 Host.constructor
- Defined in src/game/save/SaveManager.ts:57

Properties

`Readonly` event

event: IEventEmitter<default, ISaveManagerEvents> = ...

`Readonly` game

game: Game

lastLoadedVersion

lastLoadedVersion: IVersionInfo

Accessors

isLoading

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

Methods

clearMultiplayerSlotData

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

compressSave

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

copySave

copySave(slot?: number, target?: number): Promise<undefined | number>
Parameters
- slot: number = ...
- Optional target: number
Returns Promise<undefined | number>
- Defined in src/game/save/SaveManager.ts:543

decompressSave

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

deleteAllData

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

deleteAllSlots

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

deleteSlot

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

downloadGameStateAsJson

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

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:431

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:420

getClientStore

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

getFirstFreeSlot

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

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

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:657
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:658

getMostRecentSlot

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

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

getSaveObjectFromUint8Array

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

getSerializer

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

getUsedSlots

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

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

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.More
Returns Promise<number[]>
- Defined in src/game/save/SaveManager.ts:151

importSave

importSave(slot: number, saveObject: string | Uint8Array | ISaveObject): Promise<undefined | number>
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<undefined | number>
- Defined in src/game/save/SaveManager.ts:503

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:457

initialize

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

isEnabled

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

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:108

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:244

loadSpecificData

loadSpecificData(slot: number, keys: Set<string>): Promise<Record<string, any>>
Parameters
- slot: number
- keys: Set<string>
Returns Promise<Record<string, any>>
- Defined in src/game/save/SaveManager.ts:302

loadSpecificDataResilient

loadSpecificDataResilient(slot: number, keys: Set<string>): Promise<{
errors: Map<string, Error>;
result: Record<string, 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
- slot: number
- keys: Set<string>
Returns Promise<{
errors: Map<string, Error>;
result: Record<string, any>;
}>
- Defined in src/game/save/SaveManager.ts:336

loadSpecificDatas

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

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:207

saveSpecificData

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

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:226

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<undefined | number>

decompressSave

Parameters

slot: number

saveObject: ISaveObject

legacyDecompressAllProperties: boolean = false

Returns void

deleteAllData

Returns Promise<void>

deleteAllSlots

Returns Promise<void>

deleteSlot

Parameters

slot: number = ...

Returns Promise<void>

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

Returns string

getMostRecentSlot

Returns Promise<undefined | number>

getSaveObjectFromUint8Array

Parameters

`Readonly` event

`Readonly` game

`Optional` target: number

`Optional` cleanup: boolean

`Optional` pretty: boolean

`Optional` compress: false

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

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