Skip to main content

DataStoreWithScene

Class

A GeneralDataStore that persists data across multiple Snaps within the same Lens session.

  • 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.

Since Lens Scripting v354

A GeneralDataStore that persists data across multiple Snaps within the same Lens session. Data is retained until a different Lens is opened. Unlike PersistentStorageSystem#store, this store supports saving procedural assets such as MeshBuilder meshes and ProceduralTextureProvider textures. Retrieved via PersistentStorageSystem.sessionStore.

Index

Extends

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

Inherited from

GeneralDataStore.onStoreFull

Methods

clear()

clear(): void

Clears all data stored in the General Data Store.

Returns

void

Inherited from

GeneralDataStore.clear


create()

static create(): GeneralDataStore

Creates a General Data Store.

Returns

GeneralDataStore

Inherited from

GeneralDataStore.create


getAllKeys()

getAllKeys(): string[]

Returns an array with all the keys in the store.

Returns

string[]

Inherited from

GeneralDataStore.getAllKeys


getAsset()

getAsset(name, successCallback, failureCallback): void

Parameters

ParameterType
namestring
successCallback(asset) => void
failureCallback(error, description) => void

Returns

void

Since

Lens Scripting Version 354


getBool()

getBool(key): boolean

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

Parameters

ParameterType
keystring

Returns

boolean

Inherited from

GeneralDataStore.getBool


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[]

Inherited from

GeneralDataStore.getBoolArray


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

Inherited from

GeneralDataStore.getDouble


getFloat()

getFloat(key): number

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

Parameters

ParameterType
keystring

Returns

number

Inherited from

GeneralDataStore.getFloat


getFloat32Array()

getFloat32Array(key): Float32Array

Parameters

ParameterType
keystring

Returns

Float32Array

Inherited from

GeneralDataStore.getFloat32Array


getFloat64Array()

getFloat64Array(key): Float64Array

Parameters

ParameterType
keystring

Returns

Float64Array

Inherited from

GeneralDataStore.getFloat64Array


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[]

Inherited from

GeneralDataStore.getFloatArray


getInt()

getInt(key): number

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

Parameters

ParameterType
keystring

Returns

number

Inherited from

GeneralDataStore.getInt


getInt16Array()

getInt16Array(key): Int16Array

Parameters

ParameterType
keystring

Returns

Int16Array

Inherited from

GeneralDataStore.getInt16Array


getInt32Array()

getInt32Array(key): Int32Array

Parameters

ParameterType
keystring

Returns

Int32Array

Inherited from

GeneralDataStore.getInt32Array


getInt8Array()

getInt8Array(key): Int8Array

Parameters

ParameterType
keystring

Returns

Int8Array

Inherited from

GeneralDataStore.getInt8Array


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[]

Inherited from

GeneralDataStore.getIntArray


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

Inherited from

GeneralDataStore.getMat2


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[]

Inherited from

GeneralDataStore.getMat2Array


getMat3()

getMat3(key): mat3

Stores a mat3 value under the given key.

Parameters

ParameterType
keystring

Returns

mat3

Inherited from

GeneralDataStore.getMat3


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[]

Inherited from

GeneralDataStore.getMat3Array


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

Inherited from

GeneralDataStore.getMat4


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[]

Inherited from

GeneralDataStore.getMat4Array


getMaxSizeInBytes()

getMaxSizeInBytes(): number

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

Returns

number

Inherited from

GeneralDataStore.getMaxSizeInBytes


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

Inherited from

GeneralDataStore.getQuat


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[]

Inherited from

GeneralDataStore.getQuatArray


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

Inherited from

GeneralDataStore.getSizeInBytes


getString()

getString(key): string

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

Parameters

ParameterType
keystring

Returns

string

Inherited from

GeneralDataStore.getString


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[]

Inherited from

GeneralDataStore.getStringArray


getTypeName()

static getTypeName(): TypeName<DataStoreWithScene>

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<DataStoreWithScene>

Since

Lens Scripting Version 354

Overrides

GeneralDataStore.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

GeneralDataStore.getTypeName


getUint16Array()

getUint16Array(key): Uint16Array

Parameters

ParameterType
keystring

Returns

Uint16Array

Inherited from

GeneralDataStore.getUint16Array


getUint32Array()

getUint32Array(key): Uint32Array

Parameters

ParameterType
keystring

Returns

Uint32Array

Inherited from

GeneralDataStore.getUint32Array


getUint8Array()

getUint8Array(key): Uint8Array

Parameters

ParameterType
keystring

Returns

Uint8Array

Inherited from

GeneralDataStore.getUint8Array


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

Inherited from

GeneralDataStore.getVec2


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[]

Inherited from

GeneralDataStore.getVec2Array


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

Inherited from

GeneralDataStore.getVec3


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[]

Inherited from

GeneralDataStore.getVec3Array


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

Inherited from

GeneralDataStore.getVec4


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[]

Inherited from

GeneralDataStore.getVec4Array


has()

has(key): boolean

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

Parameters

ParameterType
keystring

Returns

boolean

Inherited from

GeneralDataStore.has


hasAsset()

hasAsset(name): boolean

Parameters

ParameterType
namestring

Returns

boolean

Since

Lens Scripting Version 354


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

GeneralDataStore.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

GeneralDataStore.isSame


putBool()

putBool(key, value): void

Stores a boolean value under the given key.

Parameters

ParameterType
keystring
valueboolean

Returns

void

Inherited from

GeneralDataStore.putBool


putBoolArray()

putBoolArray(key, value): void

Stores a boolean array under the given key.

Parameters

ParameterType
keystring
valueboolean[]

Returns

void

Inherited from

GeneralDataStore.putBoolArray


putDouble()

putDouble(key, value): void

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

Parameters

ParameterType
keystring
valuenumber

Returns

void

Inherited from

GeneralDataStore.putDouble


putFloat()

putFloat(key, value): void

Stores a floating point value under the given key.

Parameters

ParameterType
keystring
valuenumber

Returns

void

Inherited from

GeneralDataStore.putFloat


putFloat32Array()

putFloat32Array(key, value): void

Parameters

ParameterType
keystring
valueFloat32Array

Returns

void

Inherited from

GeneralDataStore.putFloat32Array


putFloat64Array()

putFloat64Array(key, value): void

Parameters

ParameterType
keystring
valueFloat64Array

Returns

void

Inherited from

GeneralDataStore.putFloat64Array


putFloatArray()

putFloatArray(key, value): void

Stores a floating point array under the given key.

Parameters

ParameterType
keystring
valuenumber[]

Returns

void

Inherited from

GeneralDataStore.putFloatArray


putInt()

putInt(key, value): void

Stores an integer number value under the given key.

Parameters

ParameterType
keystring
valuenumber

Returns

void

Inherited from

GeneralDataStore.putInt


putInt16Array()

putInt16Array(key, value): void

Parameters

ParameterType
keystring
valueInt16Array

Returns

void

Inherited from

GeneralDataStore.putInt16Array


putInt32Array()

putInt32Array(key, value): void

Parameters

ParameterType
keystring
valueInt32Array

Returns

void

Inherited from

GeneralDataStore.putInt32Array


putInt8Array()

putInt8Array(key, value): void

Parameters

ParameterType
keystring
valueInt8Array

Returns

void

Inherited from

GeneralDataStore.putInt8Array


putIntArray()

putIntArray(key, value): void

Stores an integer array under the given key.

Parameters

ParameterType
keystring
valuenumber[]

Returns

void

Inherited from

GeneralDataStore.putIntArray


putMat2()

putMat2(key, value): void

Stores a mat2 value under the given key.

Parameters

ParameterType
keystring
valuemat2

Returns

void

Inherited from

GeneralDataStore.putMat2


putMat2Array()

putMat2Array(key, value): void

Stores a mat2 array under the given key.

Parameters

ParameterType
keystring
valuemat2[]

Returns

void

Inherited from

GeneralDataStore.putMat2Array


putMat3()

putMat3(key, value): void

Stores a mat3 value under the given key.

Parameters

ParameterType
keystring
valuemat3

Returns

void

Inherited from

GeneralDataStore.putMat3


putMat3Array()

putMat3Array(key, value): void

Stores a mat3 array under the given key.

Parameters

ParameterType
keystring
valuemat3[]

Returns

void

Inherited from

GeneralDataStore.putMat3Array


putMat4()

putMat4(key, value): void

Stores a mat4 value under the given key.

Parameters

ParameterType
keystring
valuemat4

Returns

void

Inherited from

GeneralDataStore.putMat4


putMat4Array()

putMat4Array(key, value): void

Stores a mat4 array under the given key.

Parameters

ParameterType
keystring
valuemat4[]

Returns

void

Inherited from

GeneralDataStore.putMat4Array


putQuat()

putQuat(key, value): void

Stores a quat value under the given key.

Parameters

ParameterType
keystring
valuequat

Returns

void

Inherited from

GeneralDataStore.putQuat


putQuatArray()

putQuatArray(key, value): void

Stores a quat array under the given key.

Parameters

ParameterType
keystring
valuequat[]

Returns

void

Inherited from

GeneralDataStore.putQuatArray


putString()

putString(key, value): void

Stores a string value under the given key.

Parameters

ParameterType
keystring
valuestring

Returns

void

Inherited from

GeneralDataStore.putString


putStringArray()

putStringArray(key, value): void

Stores a string array under the given key.

Parameters

ParameterType
keystring
valuestring[]

Returns

void

Inherited from

GeneralDataStore.putStringArray


putUint16Array()

putUint16Array(key, value): void

Parameters

ParameterType
keystring
valueUint16Array

Returns

void

Inherited from

GeneralDataStore.putUint16Array


putUint32Array()

putUint32Array(key, value): void

Parameters

ParameterType
keystring
valueUint32Array

Returns

void

Inherited from

GeneralDataStore.putUint32Array


putUint8Array()

putUint8Array(key, value): void

Parameters

ParameterType
keystring
valueUint8Array

Returns

void

Inherited from

GeneralDataStore.putUint8Array


putVec2()

putVec2(key, value): void

Stores a vec2 value under the given key.

Parameters

ParameterType
keystring
valuevec2

Returns

void

Inherited from

GeneralDataStore.putVec2


putVec2Array()

putVec2Array(key, value): void

Stores a vec2 array under the given key.

Parameters

ParameterType
keystring
valuevec2[]

Returns

void

Inherited from

GeneralDataStore.putVec2Array


putVec3()

putVec3(key, value): void

Stores a vec3 value under the given key.

Parameters

ParameterType
keystring
valuevec3

Returns

void

Inherited from

GeneralDataStore.putVec3


putVec3Array()

putVec3Array(key, value): void

Stores a vec3 array under the given key.

Parameters

ParameterType
keystring
valuevec3[]

Returns

void

Inherited from

GeneralDataStore.putVec3Array


putVec4()

putVec4(key, value): void

Stores a vec4 value under the given key.

Parameters

ParameterType
keystring
valuevec4

Returns

void

Inherited from

GeneralDataStore.putVec4


putVec4Array()

putVec4Array(key, value): void

Stores a vec4 array under the given key.

Parameters

ParameterType
keystring
valuevec4[]

Returns

void

Inherited from

GeneralDataStore.putVec4Array


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

Inherited from

GeneralDataStore.remove


removeAsset()

removeAsset(name): void

Parameters

ParameterType
namestring

Returns

void

Since

Lens Scripting Version 354


saveAsset()

saveAsset(asset, name): void

Parameters

ParameterType
assetAsset
namestring

Returns

void

Since

Lens Scripting Version 354