DataStoreWithScene
ClassA GeneralDataStore that persists data across multiple Snaps within the same Lens session.
- Available on all platforms
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
Properties
Methods
- clear
- create
- getAllKeys
- getAsset
- 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
- hasAsset
- 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
- removeAsset
- saveAsset
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
Methods
clear()
clear():
void
Clears all data stored in the General Data Store.
Returns
void
Inherited from
create()
staticcreate():GeneralDataStore
Creates a General Data Store.
Returns
Inherited from
getAllKeys()
getAllKeys():
string[]
Returns an array with all the keys in the store.
Returns
string[]
Inherited from
getAsset()
getAsset(
name,successCallback,failureCallback):void
Parameters
| Parameter | Type |
|---|---|
name | string |
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
| Parameter | Type |
|---|---|
key | string |
Returns
boolean
Inherited from
getBoolArray()
getBoolArray(
key):boolean[]
Returns a boolean array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
boolean[]
Inherited from
getDouble()
getDouble(
key):number
Returns a double precision floating point number stored under the given key, or 0 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
number
Inherited from
getFloat()
getFloat(
key):number
Returns a floating point value stored under the given key, or 0 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
number
Inherited from
getFloat32Array()
getFloat32Array(
key):Float32Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Float32Array
Inherited from
GeneralDataStore.getFloat32Array
getFloat64Array()
getFloat64Array(
key):Float64Array
Parameters
| Parameter | Type |
|---|---|
key | string |
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
| Parameter | Type |
|---|---|
key | string |
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
| Parameter | Type |
|---|---|
key | string |
Returns
number
Inherited from
getInt16Array()
getInt16Array(
key):Int16Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Int16Array
Inherited from
GeneralDataStore.getInt16Array
getInt32Array()
getInt32Array(
key):Int32Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Int32Array
Inherited from
GeneralDataStore.getInt32Array
getInt8Array()
getInt8Array(
key):Int8Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Int8Array
Inherited from
getIntArray()
getIntArray(
key):number[]
Returns an integer array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
number[]
Inherited from
getMat2()
getMat2(
key):mat2
Returns a mat2 value stored under the given key, or a default mat2 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getMat2Array()
getMat2Array(
key):mat2[]
Returns a mat2 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
mat2[]
Inherited from
getMat3()
getMat3(
key):mat3
Stores a mat3 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getMat3Array()
getMat3Array(
key):mat3[]
Returns a mat3 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
mat3[]
Inherited from
getMat4()
getMat4(
key):mat4
Returns a mat4 value stored under the given key, or a default mat4 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getMat4Array()
getMat4Array(
key):mat4[]
Returns a mat4 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
mat4[]
Inherited from
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
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getQuatArray()
getQuatArray(
key):quat[]
Returns a quat array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
quat[]
Inherited from
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
| Parameter | Type |
|---|---|
key | string |
Returns
string
Inherited from
getStringArray()
getStringArray(
key):string[]
Returns a string array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
string[]
Inherited from
GeneralDataStore.getStringArray
getTypeName()
staticgetTypeName():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
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
getUint16Array()
getUint16Array(
key):Uint16Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Uint16Array
Inherited from
GeneralDataStore.getUint16Array
getUint32Array()
getUint32Array(
key):Uint32Array
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Uint32Array
Inherited from
GeneralDataStore.getUint32Array
getUint8Array()
getUint8Array(
key):Uint8Array
Parameters
| Parameter | Type |
|---|---|
key | string |
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
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getVec2Array()
getVec2Array(
key):vec2[]
Returns a vec2 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
vec2[]
Inherited from
getVec3()
getVec3(
key):vec3
Returns a vec3 value stored under the given key, or a default vec3 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getVec3Array()
getVec3Array(
key):vec3[]
Returns a vec3 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
vec3[]
Inherited from
getVec4()
getVec4(
key):vec4
Returns a vec4 value stored under the given key, or a default vec4 if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Inherited from
getVec4Array()
getVec4Array(
key):vec4[]
Returns a vec4 array being stored under the given key, or an empty array if none exists.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
vec4[]
Inherited from
has()
has(
key):boolean
Returns true if a value is being stored under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
boolean
Inherited from
hasAsset()
hasAsset(
name):boolean
Parameters
| Parameter | Type |
|---|---|
name | string |
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
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
putBool()
putBool(
key,value):void
Stores a boolean value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | boolean |
Returns
void
Inherited from
putBoolArray()
putBoolArray(
key,value):void
Stores a boolean array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | boolean[] |
Returns
void
Inherited from
putDouble()
putDouble(
key,value):void
Stores a double precision floating point number under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | number |
Returns
void
Inherited from
putFloat()
putFloat(
key,value):void
Stores a floating point value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | number |
Returns
void
Inherited from
putFloat32Array()
putFloat32Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Float32Array |
Returns
void
Inherited from
GeneralDataStore.putFloat32Array
putFloat64Array()
putFloat64Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Float64Array |
Returns
void
Inherited from
GeneralDataStore.putFloat64Array
putFloatArray()
putFloatArray(
key,value):void
Stores a floating point array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | number[] |
Returns
void
Inherited from
GeneralDataStore.putFloatArray
putInt()
putInt(
key,value):void
Stores an integer number value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | number |
Returns
void
Inherited from
putInt16Array()
putInt16Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Int16Array |
Returns
void
Inherited from
GeneralDataStore.putInt16Array
putInt32Array()
putInt32Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Int32Array |
Returns
void
Inherited from
GeneralDataStore.putInt32Array
putInt8Array()
putInt8Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Int8Array |
Returns
void
Inherited from
putIntArray()
putIntArray(
key,value):void
Stores an integer array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | number[] |
Returns
void
Inherited from
putMat2()
putMat2(
key,value):void
Stores a mat2 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat2 |
Returns
void
Inherited from
putMat2Array()
putMat2Array(
key,value):void
Stores a mat2 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat2[] |
Returns
void
Inherited from
putMat3()
putMat3(
key,value):void
Stores a mat3 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat3 |
Returns
void
Inherited from
putMat3Array()
putMat3Array(
key,value):void
Stores a mat3 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat3[] |
Returns
void
Inherited from
putMat4()
putMat4(
key,value):void
Stores a mat4 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat4 |
Returns
void
Inherited from
putMat4Array()
putMat4Array(
key,value):void
Stores a mat4 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | mat4[] |
Returns
void
Inherited from
putQuat()
putQuat(
key,value):void
Stores a quat value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | quat |
Returns
void
Inherited from
putQuatArray()
putQuatArray(
key,value):void
Stores a quat array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | quat[] |
Returns
void
Inherited from
putString()
putString(
key,value):void
Stores a string value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | string |
Returns
void
Inherited from
putStringArray()
putStringArray(
key,value):void
Stores a string array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | string[] |
Returns
void
Inherited from
GeneralDataStore.putStringArray
putUint16Array()
putUint16Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Uint16Array |
Returns
void
Inherited from
GeneralDataStore.putUint16Array
putUint32Array()
putUint32Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Uint32Array |
Returns
void
Inherited from
GeneralDataStore.putUint32Array
putUint8Array()
putUint8Array(
key,value):void
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Uint8Array |
Returns
void
Inherited from
GeneralDataStore.putUint8Array
putVec2()
putVec2(
key,value):void
Stores a vec2 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec2 |
Returns
void
Inherited from
putVec2Array()
putVec2Array(
key,value):void
Stores a vec2 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec2[] |
Returns
void
Inherited from
putVec3()
putVec3(
key,value):void
Stores a vec3 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec3 |
Returns
void
Inherited from
putVec3Array()
putVec3Array(
key,value):void
Stores a vec3 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec3[] |
Returns
void
Inherited from
putVec4()
putVec4(
key,value):void
Stores a vec4 value under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec4 |
Returns
void
Inherited from
putVec4Array()
putVec4Array(
key,value):void
Stores a vec4 array under the given key.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | vec4[] |
Returns
void
Inherited from
remove()
remove(
key):void
Removes the value being stored under the given key. If no value exists under the key, nothing will happen.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
void
Inherited from
removeAsset()
removeAsset(
name):void
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Since
Lens Scripting Version 354
saveAsset()
saveAsset(
asset,name):void
Parameters
| Parameter | Type |
|---|---|
asset | Asset |
name | string |
Returns
void
Since
Lens Scripting Version 354