Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Const deleteElementFromJSONFile

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

Const elementExistsInJSONFile

  • elementExistsInJSONFile(name: string, elementPath: string): 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

Const readStringFromJSONFile

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

Const writeStringInJSONFile

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

Generated using TypeDoc