Type Alias: SaveSlot

SaveSlot = object

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:18

One slot of a save browser: the save it holds, if any, plus the actions that act on that slot.

Properties

data

data: GameSave | null

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:20

The save occupying this slot, or null when it is empty

---

delete()

delete: () => Promise<SaveResult>

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:26

Empty this slot

Returns

Promise<SaveResult>

---

load()

load: () => Promise<SaveResult>

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:24

Restore the run this slot holds

Returns

Promise<SaveResult>

---

save()

save: (options?) => Promise<SaveResult>

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:22

Capture the current run into this slot

Parameters

options?

SaveOptions

Returns

Promise<SaveResult>

---

update()

update: (changes) => Promise<SaveResult>

Defined in: packages/core/src/saves/hooks/useSaveSlots.ts:28

Edit the label or metadata without recapturing state or moving the timestamp

Parameters

changes

SaveUpdate

Returns

Promise<SaveResult>