import StorageSystem from 'oxygen-core/systems/StorageSystem.js'

public class | source

StorageSystem

Extends:

System → StorageSystem

Permanent and session data storage.

Example:

const system = new StorageSystem({ id: 'my-game' });
system.load();
system.storage.score = (system.storage.score || 0) + 1;
system.save();

Constructor Summary

Public Constructor
public	constructor(id: string) Constructor.

Member Summary

Public Members
public get	events: Events
public get	storage: *
public get	storageSession: *

Method Summary

Public Methods
public	clear() Clear permanent storage.
public	clearSession() Clear session storage.
public	dispose() Destructor (disposes internal resources).
public	load() Load browser permanent storage data into memory.
public	loadSession() Load browser session storage data into memory.
public	onRegister()
public	onUnregister()
public	save() Save memory permanent storage into browser.
public	saveSession() Save memory session storage into browser.

Inherited Summary

From class System
public static get	events: Events
public static get	systems: *
public static	dispose() Dispose and remove all registered systems.
public static	get(typename: string): System \| null Returns system instance of given type name.
public static	register(typename: string, system: System): System Register new system instance under given name.
public static	unregister(typename: string): System Unregister given system.
public	dispose() Destructor (disposes all internal resources).
public	onRegister() Event called after system gets registered.
public	onUnregister() Event called before system gets unregistered.

Public Constructors

public constructor(id: string) source

Constructor.

Params:

Name	Type	Attribute	Description
id	string		application storage unique id.

Public Members

public get events: Events source

Override:

System#events

public get storage: * source

public get storageSession: * source

Public Methods

public clear() source

Clear permanent storage.

public clearSession() source

Clear session storage.

public dispose() source

Destructor (disposes internal resources).

Override:

System#dispose

Example:

system.dispose();
system = null;

public load() source

Load browser permanent storage data into memory.

Example:

system.load();
console.log(system.storage.score);

public loadSession() source

Load browser session storage data into memory.

Example:

system.loadSession();
console.log(system.storageSession.score);

public onRegister() source

Event called after system gets registered.

Override:

System#onRegister

public onUnregister() source

Event called before system gets unregistered.

Override:

System#onUnregister

public save() source

Save memory permanent storage into browser.

Example:

system.storage.score = 10;
system.save();

public saveSession() source

Save memory session storage into browser.

Example:

system.storageSession.score = 10;
system.saveSession();