Skip to main content

GeneralDataStore

Class

Class for storing and retrieving data based on keys.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

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

Index

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);
}

Extends

Extended by

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.

Returns

void

Default Value

null

Methods

clear()

clear(): void

Clears all data stored in the General Data Store.

Returns

void


create()

static create(): GeneralDataStore

Creates a General Data Store.

Returns

GeneralDataStore


getAllKeys()

getAllKeys(): string[]

Returns an array with all the keys in the store.

Returns

string[]


getBool()

getBool(key): boolean

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

Parameters

ParameterType
keystring

Returns

boolean


getBoolArray()

getBoolArray(key): boolean[]

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

Parameters

ParameterType
keystring

Returns

boolean[]


getDouble()

getDouble(key): number

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

Parameters

ParameterType
keystring

Returns

number


getFloat()

getFloat(key): number

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

Parameters

ParameterType
keystring

Returns

number


getFloat32Array()

getFloat32Array(key): Float32Array

Parameters

ParameterType
keystring

Returns

Float32Array


getFloat64Array()

getFloat64Array(key): Float64Array

Parameters

ParameterType
keystring

Returns

Float64Array


getFloatArray()

getFloatArray(key): number[]

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

Parameters

ParameterType
keystring

Returns

number[]


getInt()

getInt(key): number

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

Parameters

ParameterType
keystring

Returns

number


getInt16Array()

getInt16Array(key): Int16Array

Parameters

ParameterType
keystring

Returns

Int16Array


getInt32Array()

getInt32Array(key): Int32Array

Parameters

ParameterType
keystring

Returns

Int32Array


getInt8Array()

getInt8Array(key): Int8Array

Parameters

ParameterType
keystring

Returns

Int8Array


getIntArray()

getIntArray(key): number[]

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

Parameters

ParameterType
keystring

Returns

number[]


getMat2()

getMat2(key): mat2

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

Parameters

ParameterType
keystring

Returns

mat2


getMat2Array()

getMat2Array(key): mat2[]

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

Parameters

ParameterType
keystring

Returns

mat2[]


getMat3()

getMat3(key): mat3

Stores a mat3 value under the given key.

Parameters

ParameterType
keystring

Returns

mat3


getMat3Array()

getMat3Array(key): mat3[]

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

Parameters

ParameterType
keystring

Returns

mat3[]


getMat4()

getMat4(key): mat4

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

Parameters

ParameterType
keystring

Returns

mat4


getMat4Array()

getMat4Array(key): mat4[]

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

Parameters

ParameterType
keystring

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): quat

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

Parameters

ParameterType
keystring

Returns

quat


getQuatArray()

getQuatArray(key): quat[]

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

Parameters

ParameterType
keystring

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

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

Parameters

ParameterType
keystring

Returns

string


getStringArray()

getStringArray(key): string[]

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

Parameters

ParameterType
keystring

Returns

string[]


getTypeName()

static getTypeName(): TypeName<GeneralDataStore>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<GeneralDataStore>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


getUint16Array()

getUint16Array(key): Uint16Array

Parameters

ParameterType
keystring

Returns

Uint16Array


getUint32Array()

getUint32Array(key): Uint32Array

Parameters

ParameterType
keystring

Returns

Uint32Array


getUint8Array()

getUint8Array(key): Uint8Array

Parameters

ParameterType
keystring

Returns

Uint8Array


getVec2()

getVec2(key): vec2

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

Parameters

ParameterType
keystring

Returns

vec2


getVec2Array()

getVec2Array(key): vec2[]

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

Parameters

ParameterType
keystring

Returns

vec2[]


getVec3()

getVec3(key): vec3

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

Parameters

ParameterType
keystring

Returns

vec3


getVec3Array()

getVec3Array(key): vec3[]

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

Parameters

ParameterType
keystring

Returns

vec3[]


getVec4()

getVec4(key): vec4

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

Parameters

ParameterType
keystring

Returns

vec4


getVec4Array()

getVec4Array(key): vec4[]

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

Parameters

ParameterType
keystring

Returns

vec4[]


has()

has(key): boolean

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

Parameters

ParameterType
keystring

Returns

boolean


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame


putBool()

putBool(key, value): void

Stores a boolean value under the given key.

Parameters

ParameterType
keystring
valueboolean

Returns

void


putBoolArray()

putBoolArray(key, value): void

Stores a boolean array under the given key.

Parameters

ParameterType
keystring
valueboolean[]

Returns

void


putDouble()

putDouble(key, value): void

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

Parameters

ParameterType
keystring
valuenumber

Returns

void


putFloat()

putFloat(key, value): void

Stores a floating point value under the given key.

Parameters

ParameterType
keystring
valuenumber

Returns

void


putFloat32Array()

putFloat32Array(key, value): void

Parameters

ParameterType
keystring
valueFloat32Array

Returns

void


putFloat64Array()

putFloat64Array(key, value): void

Parameters

ParameterType
keystring
valueFloat64Array

Returns

void


putFloatArray()

putFloatArray(key, value): void

Stores a floating point array under the given key.

Parameters

ParameterType
keystring
valuenumber[]

Returns

void


putInt()

putInt(key, value): void

Stores an integer number value under the given key.

Parameters

ParameterType
keystring
valuenumber

Returns

void


putInt16Array()

putInt16Array(key, value): void

Parameters

ParameterType
keystring
valueInt16Array

Returns

void


putInt32Array()

putInt32Array(key, value): void

Parameters

ParameterType
keystring
valueInt32Array

Returns

void


putInt8Array()

putInt8Array(key, value): void

Parameters

ParameterType
keystring
valueInt8Array

Returns

void


putIntArray()

putIntArray(key, value): void

Stores an integer array under the given key.

Parameters

ParameterType
keystring
valuenumber[]

Returns

void


putMat2()

putMat2(key, value): void

Stores a mat2 value under the given key.

Parameters

ParameterType
keystring
valuemat2

Returns

void


putMat2Array()

putMat2Array(key, value): void

Stores a mat2 array under the given key.

Parameters

ParameterType
keystring
valuemat2[]

Returns

void


putMat3()

putMat3(key, value): void

Stores a mat3 value under the given key.

Parameters

ParameterType
keystring
valuemat3

Returns

void


putMat3Array()

putMat3Array(key, value): void

Stores a mat3 array under the given key.

Parameters

ParameterType
keystring
valuemat3[]

Returns

void


putMat4()

putMat4(key, value): void

Stores a mat4 value under the given key.

Parameters

ParameterType
keystring
valuemat4

Returns

void


putMat4Array()

putMat4Array(key, value): void

Stores a mat4 array under the given key.

Parameters

ParameterType
keystring
valuemat4[]

Returns

void


putQuat()

putQuat(key, value): void

Stores a quat value under the given key.

Parameters

ParameterType
keystring
valuequat

Returns

void


putQuatArray()

putQuatArray(key, value): void

Stores a quat array under the given key.

Parameters

ParameterType
keystring
valuequat[]

Returns

void


putString()

putString(key, value): void

Stores a string value under the given key.

Parameters

ParameterType
keystring
valuestring

Returns

void


putStringArray()

putStringArray(key, value): void

Stores a string array under the given key.

Parameters

ParameterType
keystring
valuestring[]

Returns

void


putUint16Array()

putUint16Array(key, value): void

Parameters

ParameterType
keystring
valueUint16Array

Returns

void


putUint32Array()

putUint32Array(key, value): void

Parameters

ParameterType
keystring
valueUint32Array

Returns

void


putUint8Array()

putUint8Array(key, value): void

Parameters

ParameterType
keystring
valueUint8Array

Returns

void


putVec2()

putVec2(key, value): void

Stores a vec2 value under the given key.

Parameters

ParameterType
keystring
valuevec2

Returns

void


putVec2Array()

putVec2Array(key, value): void

Stores a vec2 array under the given key.

Parameters

ParameterType
keystring
valuevec2[]

Returns

void


putVec3()

putVec3(key, value): void

Stores a vec3 value under the given key.

Parameters

ParameterType
keystring
valuevec3

Returns

void


putVec3Array()

putVec3Array(key, value): void

Stores a vec3 array under the given key.

Parameters

ParameterType
keystring
valuevec3[]

Returns

void


putVec4()

putVec4(key, value): void

Stores a vec4 value under the given key.

Parameters

ParameterType
keystring
valuevec4

Returns

void


putVec4Array()

putVec4Array(key, value): void

Stores a vec4 array under the given key.

Parameters

ParameterType
keystring
valuevec4[]

Returns

void


remove()

remove(key): void

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

Parameters

ParameterType
keystring

Returns

void