Kiln API / kiln / SaveSlots

Class: SaveSlots

Save slots: res.mut(Saves).save('slot1') writes now; .load('slot1') applies at the start of the next frame and emits Loaded. Also has, delete, slots(). What is saved comes from savePlugin({ resources, traits }).

Constructors

Constructor

new SaveSlots(app, opts): SaveSlots;

Parameters

Parameter	Type
app	App
opts	{ resources: Resource<any>[]; traits: Trait[]; key: string; storage: SaveStorage; }
opts.resources	Resource<any>[]
opts.traits	Trait[]
opts.key	string
opts.storage	SaveStorage

Returns

SaveSlots

Properties

pendingLoad

pendingLoad: string | null = null;

A load requested this frame, applied at the next frame start.

Methods

save()

save(slot?): string;

Writes the slot now and emits Saved. Returns the JSON written.

Parameters

Parameter	Type	Default value
slot	string	'auto'

Returns

string

---

load()

load(slot?): boolean;

Loads the slot at the start of the next frame. Returns false (and does nothing) if it doesn't exist.

Parameters

Parameter	Type	Default value
slot	string	'auto'

Returns

boolean

---

has()

has(slot?): boolean;

Parameters

Parameter	Type	Default value
slot	string	'auto'

Returns

boolean

---

delete()

delete(slot?): void;

Parameters

Parameter	Type	Default value
slot	string	'auto'

Returns

void

---

slots()

slots(): string[];

Slot names that exist, sorted.

Returns

string[]

---

toJSON()

toJSON(): object;

Returns

object

slots

slots: string[];

pendingLoad

pendingLoad: string | null;