Namespace storage

Functions to store and load basic values (strings or numbers), organized into objects:

Each object has a name
Each value can be accessed using a path-like string (for example: Root/Some folder/MyValueName), where each segment is separated by a slash.

These objects are persisted into the environment localStorage - which might not always be available (if not, objects won't be persisted).

Index

Functions

Functions

Const clearJSONFile

clearJSONFile(name: string): any

Parameters
- name: string
Returns any

Const deleteElementFromJSONFile

deleteElementFromJSONFile(name: string, elementPath: string): any

Parameters
- name: string
- elementPath: string
Returns any

Const elementExistsInJSONFile

elementExistsInJSONFile(name: string, elementPath: string): any

Parameters
- name: string
- elementPath: string
Returns any

Const loadJSONFileFromStorage

loadJSONFileFromStorage(name: string): void

Load into memory a JSON serialized object, from the local storage provided by the browser/environment.

The object name is prefixed with GDJS_ in localStorage.

Parameters
- name: string
  
  The name of the object to load
Returns void

Const readNumberFromJSONFile

readNumberFromJSONFile(name: string, elementPath: string, instanceContainer: null | RuntimeInstanceContainer, variable: Variable): any

Parameters
- name: string
- elementPath: string
- instanceContainer: null | RuntimeInstanceContainer
- variable: Variable
Returns any

Const readStringFromJSONFile

readStringFromJSONFile(name: string, elementPath: string, instanceContainer: null | RuntimeInstanceContainer, variable: Variable): any

Parameters
- name: string
- elementPath: string
- instanceContainer: null | RuntimeInstanceContainer
- variable: Variable
Returns any

Const unloadJSONFile

unloadJSONFile(name: string): void

Unload from memory an object, which is then serialized as JSON and stored in the local storage provided by the browser/environment.

The object name is prefixed with GDJS_ in localStorage.

Parameters
- name: string
  
  The name of the object to load
Returns void

Const writeNumberInJSONFile

writeNumberInJSONFile(name: string, elementPath: string, val: any): any

Parameters
- name: string
- elementPath: string
- val: any
Returns any

Const writeStringInJSONFile

writeStringInJSONFile(name: string, elementPath: string, str: any): any

Parameters
- name: string
- elementPath: string
- str: any
Returns any

Generated using TypeDoc