Class GeneralDataStore

Class for storing and retrieving data based on keys. Used by PersistentStorageSystem. For more information, see the Persistent Storage guide.

Example

// Get the data store from PersistentStorageSystem
var store = global.persistentStorageSystem.store;

// Load score from previous Lens session. Defaults to 0 if data isn't found for this key
var score = store.getFloat("totalScore");
print("loaded score: " + score);

function increaseScore() {
    // Increase score, then write it to the data store
    score += 1;
    store.putFloat("totalScore", score);
    print("new score: " + score);
}

// Increase score on tap event
script.createEvent("TapEvent").bind(increaseScore);

// Check Launch Params for a certain string value
var stringParamName = "testString";
if (global.launchParams && global.launchParams.has(stringParamName)) {
    var myString = global.launchParams.getString(stringParamName);
}

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

onStoreFull

Methods

clear create getAllKeys getBool getBoolArray getDouble getFloat getFloat32Array getFloat64Array getFloatArray getInt getInt16Array getInt32Array getInt8Array getIntArray getMat2 getMat2Array getMat3 getMat3Array getMat4 getMat4Array getMaxSizeInBytes getQuat getQuatArray getSizeInBytes getString getStringArray getTypeName getUint16Array getUint32Array getUint8Array getVec2 getVec2Array getVec3 getVec3Array getVec4 getVec4Array has isOfType isSame putBool putBoolArray putDouble putFloat putFloat32Array putFloat64Array putFloatArray putInt putInt16Array putInt32Array putInt8Array putIntArray putMat2 putMat2Array putMat3 putMat3Array putMat4 putMat4Array putQuat putQuatArray putString putStringArray putUint16Array putUint32Array putUint8Array putVec2 putVec2Array putVec3 putVec3Array putVec4 putVec4Array remove

Constructors

Protectedconstructor

Properties

onStoreFull

onStoreFull: () => void

Callback function that gets called when the allowed storage limit has been passed. The store won't be saved if it is full, so if this is called make sure to remove data until back under the limit.

Methods

clear

  • clear(): void

    Clears all data stored in the General Data Store.

    Returns void

Staticcreate

getAllKeys

  • getAllKeys(): string[]

    Returns an array with all the keys in the store.

    Returns string[]

getBool

  • getBool(key: string): boolean

    Returns a boolean value stored under the given key, or false if none exists.

    Parameters

    • key: string

    Returns boolean

getBoolArray

  • getBoolArray(key: string): boolean[]

    Returns a boolean array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns boolean[]

getDouble

  • getDouble(key: string): number

    Returns a double precision floating point number stored under the given key, or 0 if none exists.

    Parameters

    • key: string

    Returns number

getFloat

  • getFloat(key: string): number

    Returns a floating point value stored under the given key, or 0 if none exists.

    Parameters

    • key: string

    Returns number

getFloat32Array

  • getFloat32Array(key: string): Float32Array

    Parameters

    • key: string

    Returns Float32Array

getFloat64Array

  • getFloat64Array(key: string): any

    Parameters

    • key: string

    Returns any

getFloatArray

  • getFloatArray(key: string): number[]

    Returns a floating point array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns number[]

getInt

  • getInt(key: string): number

    Returns an integer number stored under the given key, or 0 if none exists.

    Parameters

    • key: string

    Returns number

getInt16Array

  • getInt16Array(key: string): any

    Parameters

    • key: string

    Returns any

getInt32Array

  • getInt32Array(key: string): any

    Parameters

    • key: string

    Returns any

getInt8Array

  • getInt8Array(key: string): any

    Parameters

    • key: string

    Returns any

getIntArray

  • getIntArray(key: string): number[]

    Returns an integer array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns number[]

getMat2

  • getMat2(key: string): mat2

    Returns a mat2 value stored under the given key, or a default mat2 if none exists.

    Parameters

    • key: string

    Returns mat2

getMat2Array

  • getMat2Array(key: string): mat2[]

    Returns a mat2 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns mat2[]

getMat3

  • getMat3(key: string): mat3

    Stores a mat3 value under the given key.

    Parameters

    • key: string

    Returns mat3

getMat3Array

  • getMat3Array(key: string): mat3[]

    Returns a mat3 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns mat3[]

getMat4

  • getMat4(key: string): mat4

    Returns a mat4 value stored under the given key, or a default mat4 if none exists.

    Parameters

    • key: string

    Returns mat4

getMat4Array

  • getMat4Array(key: string): mat4[]

    Returns a mat4 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns mat4[]

getMaxSizeInBytes

  • getMaxSizeInBytes(): number

    Returns the maximum total size allowed, in bytes, of all data stored in this General Data Store.

    Returns number

getQuat

  • getQuat(key: string): quat

    Returns a quat value stored under the given key, or a default quat if none exists.

    Parameters

    • key: string

    Returns quat

getQuatArray

  • getQuatArray(key: string): quat[]

    Returns a quat array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns quat[]

getSizeInBytes

  • getSizeInBytes(): number

    If onStoreFull has been set, this method returns the current total size, in bytes, of all data stored in this General Data Store. Otherwise, 0 is returned.

    Returns number

getString

  • getString(key: string): string

    Returns a string value stored under the given key, or empty string if none exists.

    Parameters

    • key: string

    Returns string

getStringArray

  • getStringArray(key: string): string[]

    Returns a string array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns string[]

getTypeName

getUint16Array

  • getUint16Array(key: string): Uint16Array

    Parameters

    • key: string

    Returns Uint16Array

getUint32Array

  • getUint32Array(key: string): Uint32Array

    Parameters

    • key: string

    Returns Uint32Array

getUint8Array

  • getUint8Array(key: string): Uint8Array

    Parameters

    • key: string

    Returns Uint8Array

getVec2

  • getVec2(key: string): vec2

    Returns a vec2 value stored under the given key, or a default vec2 if none exists.

    Parameters

    • key: string

    Returns vec2

getVec2Array

  • getVec2Array(key: string): vec2[]

    Returns a vec2 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns vec2[]

getVec3

  • getVec3(key: string): vec3

    Returns a vec3 value stored under the given key, or a default vec3 if none exists.

    Parameters

    • key: string

    Returns vec3

getVec3Array

  • getVec3Array(key: string): vec3[]

    Returns a vec3 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns vec3[]

getVec4

  • getVec4(key: string): vec4

    Returns a vec4 value stored under the given key, or a default vec4 if none exists.

    Parameters

    • key: string

    Returns vec4

getVec4Array

  • getVec4Array(key: string): vec4[]

    Returns a vec4 array being stored under the given key, or an empty array if none exists.

    Parameters

    • key: string

    Returns vec4[]

has

  • has(key: string): boolean

    Returns true if a value is being stored under the given key.

    Parameters

    • key: string

    Returns boolean

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

putBool

  • putBool(key: string, value: boolean): void

    Stores a boolean value under the given key.

    Parameters

    • key: string
    • value: boolean

    Returns void

putBoolArray

  • putBoolArray(key: string, value: boolean[]): void

    Stores a boolean array under the given key.

    Parameters

    • key: string
    • value: boolean[]

    Returns void

putDouble

  • putDouble(key: string, value: number): void

    Stores a double precision floating point number under the given key.

    Parameters

    • key: string
    • value: number

    Returns void

putFloat

  • putFloat(key: string, value: number): void

    Stores a floating point value under the given key.

    Parameters

    • key: string
    • value: number

    Returns void

putFloat32Array

  • putFloat32Array(key: string, value: Float32Array): void

    Parameters

    • key: string
    • value: Float32Array

    Returns void

putFloat64Array

  • putFloat64Array(key: string, value: any): void

    Parameters

    • key: string
    • value: any

    Returns void

putFloatArray

  • putFloatArray(key: string, value: number[]): void

    Stores a floating point array under the given key.

    Parameters

    • key: string
    • value: number[]

    Returns void

putInt

  • putInt(key: string, value: number): void

    Stores an integer number value under the given key.

    Parameters

    • key: string
    • value: number

    Returns void

putInt16Array

  • putInt16Array(key: string, value: any): void

    Parameters

    • key: string
    • value: any

    Returns void

putInt32Array

  • putInt32Array(key: string, value: any): void

    Parameters

    • key: string
    • value: any

    Returns void

putInt8Array

  • putInt8Array(key: string, value: any): void

    Parameters

    • key: string
    • value: any

    Returns void

putIntArray

  • putIntArray(key: string, value: number[]): void

    Stores an integer array under the given key.

    Parameters

    • key: string
    • value: number[]

    Returns void

putMat2

  • putMat2(key: string, value: mat2): void

    Stores a mat2 value under the given key.

    Parameters

    • key: string
    • value: mat2

    Returns void

putMat2Array

  • putMat2Array(key: string, value: mat2[]): void

    Stores a mat2 array under the given key.

    Parameters

    • key: string
    • value: mat2[]

    Returns void

putMat3

  • putMat3(key: string, value: mat3): void

    Stores a mat3 value under the given key.

    Parameters

    • key: string
    • value: mat3

    Returns void

putMat3Array

  • putMat3Array(key: string, value: mat3[]): void

    Stores a mat3 array under the given key.

    Parameters

    • key: string
    • value: mat3[]

    Returns void

putMat4

  • putMat4(key: string, value: mat4): void

    Stores a mat4 value under the given key.

    Parameters

    • key: string
    • value: mat4

    Returns void

putMat4Array

  • putMat4Array(key: string, value: mat4[]): void

    Stores a mat4 array under the given key.

    Parameters

    • key: string
    • value: mat4[]

    Returns void

putQuat

  • putQuat(key: string, value: quat): void

    Stores a quat value under the given key.

    Parameters

    • key: string
    • value: quat

    Returns void

putQuatArray

  • putQuatArray(key: string, value: quat[]): void

    Stores a quat array under the given key.

    Parameters

    • key: string
    • value: quat[]

    Returns void

putString

  • putString(key: string, value: string): void

    Stores a string value under the given key.

    Parameters

    • key: string
    • value: string

    Returns void

putStringArray

  • putStringArray(key: string, value: string[]): void

    Stores a string array under the given key.

    Parameters

    • key: string
    • value: string[]

    Returns void

putUint16Array

  • putUint16Array(key: string, value: Uint16Array): void

    Parameters

    • key: string
    • value: Uint16Array

    Returns void

putUint32Array

  • putUint32Array(key: string, value: Uint32Array): void

    Parameters

    • key: string
    • value: Uint32Array

    Returns void

putUint8Array

  • putUint8Array(key: string, value: Uint8Array): void

    Parameters

    • key: string
    • value: Uint8Array

    Returns void

putVec2

  • putVec2(key: string, value: vec2): void

    Stores a vec2 value under the given key.

    Parameters

    • key: string
    • value: vec2

    Returns void

putVec2Array

  • putVec2Array(key: string, value: vec2[]): void

    Stores a vec2 array under the given key.

    Parameters

    • key: string
    • value: vec2[]

    Returns void

putVec3

  • putVec3(key: string, value: vec3): void

    Stores a vec3 value under the given key.

    Parameters

    • key: string
    • value: vec3

    Returns void

putVec3Array

  • putVec3Array(key: string, value: vec3[]): void

    Stores a vec3 array under the given key.

    Parameters

    • key: string
    • value: vec3[]

    Returns void

putVec4

  • putVec4(key: string, value: vec4): void

    Stores a vec4 value under the given key.

    Parameters

    • key: string
    • value: vec4

    Returns void

putVec4Array

  • putVec4Array(key: string, value: vec4[]): void

    Stores a vec4 array under the given key.

    Parameters

    • key: string
    • value: vec4[]

    Returns void

remove

  • remove(key: string): void

    Removes the value being stored under the given key. If no value exists under the key, nothing will happen.

    Parameters

    • key: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR