Class StorageProperty<TStorageType>

Provides classes and helper functions used for storing data in RealtimeStores.

Type Parameters

TStorageType extends StorageTypes

Index

Constructors

Properties

currentOrPendingValue currentValue equalsCheck getterFunc key markedDirty needToSendUpdate onAnyChange onLocalChange onPendingValueChange onRemoteChange pendingValue propertyType sendsPerSecondLimit setterFunc

Methods

applyRemoteValue applySnapshotSmoothing auto autoBool autoBoolArray autoDouble autoDoubleArray autoFloat autoFloatArray autoInt autoIntArray autoMat2 autoMat2Array autoMat3 autoMat3Array autoMat4 autoMat4Array autoQuat autoQuatArray autoString autoStringArray autoVec2 autoVec2Array autoVec3 autoVec3Array autoVec4 autoVec4Array checkLocalValueChanged checkWithinSendLimit forMaterialProperty forMeshVisualBaseColor forMeshVisualProperty forPosition forRotation forScale forTextText forTransform getStoreValueDynamic isSmoothingEnabled manual manualBool manualBoolArray manualDouble manualDoubleArray manualFloat manualFloatArray manualInt manualIntArray manualMat2 manualMat2Array manualMat3 manualMat3Array manualMat4 manualMat4Array manualQuat manualQuatArray manualString manualStringArray manualVec2 manualVec2Array manualVec3 manualVec3Array manualVec4 manualVec4Array putCurrentValue setPendingValue setValueImmediate silentSetCurrentValue wrapProperty

Constructors

constructor

new StorageProperty<TStorageType extends StorageTypes>(
    key: string,
    propertyType: TStorageType,
    smoothingOptions?: SnapshotBufferOptions<TStorageType>,
): StorageProperty<TStorageType>
Type Parameters
- TStorageType extends StorageTypes
Parameters
- key: string
  Key to identify and store the StorageProperty
- propertyType: TStorageType
  Use StorageTypes
- OptionalsmoothingOptions: SnapshotBufferOptions<TStorageType>
  Options for automatically applied smoothing
Returns StorageProperty<TStorageType>

Properties

currentOrPendingValue

currentOrPendingValue: StorageTypeToPrimitive[TStorageType] = null

The most recently changed local value, whether that's current or pending. In most cases when you want a very up-to-date local value, this is what you want to read from.

currentValue

currentValue: StorageTypeToPrimitive[TStorageType] = null

The current value that we believe to be synced across the network. In most simple cases, this is what you want to read from.

equalsCheck

equalsCheck: (
a: StorageTypeToPrimitive[TStorageType],
b: StorageTypeToPrimitive[TStorageType],
) => boolean = ...

The function used to check for a change in the property value. It should return true if two values are equal, or reasonably close to equal.

getterFunc

getterFunc: () => StorageTypeToPrimitive[TStorageType] = null

If defined, this function is called to automatically update the property value each frame.

key

key: string

Key used to identify and store the property. This key matches defines how the property is accessed in a RealtimeStore. It can also be used to identify the property in a StoragePropertySet.

markedDirty

markedDirty: boolean = false

Can be used to manually mark the property dirty and skip equals check

needToSendUpdate

needToSendUpdate: boolean = false

If true, we have a value change that needs to be sent at the next opportunity.

onAnyChange

onAnyChange: EventWrapper<
    [
        StorageTypeToPrimitive[TStorageType],
        StorageTypeToPrimitive[TStorageType],
        RealtimeStoreUpdateInfo,
    ],
> = ...

Event triggered when the currentValue is changed by any user (either local or remote).

onLocalChange

onLocalChange: EventWrapper<
    [
        StorageTypeToPrimitive[TStorageType],
        StorageTypeToPrimitive[TStorageType],
    ],
> = ...

Event triggered when the currentValue is changed by the local user.

onPendingValueChange

onPendingValueChange: EventWrapper<
    [
        StorageTypeToPrimitive[TStorageType],
        StorageTypeToPrimitive[TStorageType],
    ],
> = ...

Event triggered when the pending value changes.

onRemoteChange

onRemoteChange: EventWrapper<
    [
        StorageTypeToPrimitive[TStorageType],
        StorageTypeToPrimitive[TStorageType],
        RealtimeStoreUpdateInfo,
    ],
> = ...

Event triggered when the currentValue is changed by a remote user.

pendingValue

pendingValue: StorageTypeToPrimitive[TStorageType] = null

The local value that can potentially be sent to the network at the next available chance. It may be the same as currentValue, but may not be.

propertyType

propertyType: TStorageType

used - by the property.

sendsPerSecondLimit

sendsPerSecondLimit: number = -1

If greater than or equal to zero, this limits how often the property sends updates to the network about its value changing. This is useful to avoid rate limiting when a value updates very frequently, for example if a position is changing every frame. When using this feature, currentValue will only be updated when the value is actually sent to the network. To get the most recent local version of a value, you can always check currentOrPendingValue.

setterFunc

setterFunc: (val: StorageTypeToPrimitive[TStorageType]) => void = null

If defined, this function is called to automatically apply the property value.

Methods

applyRemoteValue

applyRemoteValue(
    newValue: StorageTypeToPrimitive[TStorageType],
    dontTriggerEvents: boolean,
    updateInfo: RealtimeStoreUpdateInfo,
    isInitialValue: boolean,
): void
Parameters
- newValue: StorageTypeToPrimitive[TStorageType]
  New value to apply
- dontTriggerEvents: boolean
  If true, events will not be triggered
- updateInfo: RealtimeStoreUpdateInfo
  Information about the update
- isInitialValue: boolean
Returns void

applySnapshotSmoothing

applySnapshotSmoothing(): void
Returns void

`Static`auto

auto<TPropertyType extends StorageTypes>(
    key: string,
    propertyType: TPropertyType,
    getterFunc: () => StorageTypeToPrimitive[TPropertyType],
    setterFunc: (v: StorageTypeToPrimitive[TPropertyType]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<TPropertyType>
        | SnapshotBufferOptionsObj<TPropertyType>,
): StorageProperty<TPropertyType>
Creates an automatically updated StorageProperty based on getter and setter functions.
Type Parameters
- TPropertyType extends StorageTypes
Parameters
- key: string
  Key to identify the property
- propertyType: TPropertyType
  the type of value
- getterFunc: () => StorageTypeToPrimitive[TPropertyType]
  Function that returns the current local value for the property
- setterFunc: (v: StorageTypeToPrimitive[TPropertyType]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<TPropertyType> | SnapshotBufferOptionsObj<TPropertyType>
  Options for automatically applied smoothing
Returns StorageProperty<TPropertyType>
Newly created StorageProperty

`Static`autoBool

autoBool(
    key: string,
    getterFunc: () => boolean,
    setterFunc: (val: boolean) => void,
): StorageProperty<bool>
Creates an automatically updated boolean property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => boolean
  Function that returns the current local value for the property
- setterFunc: (val: boolean) => void
  Function that applies incoming new values for the property
Returns StorageProperty<bool>
Newly created StorageProperty

`Static`autoBoolArray

autoBoolArray(
    key: string,
    getterFunc: () => boolean[],
    setterFunc: (val: boolean[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<boolArray>
        | SnapshotBufferOptionsObj<boolArray>,
): StorageProperty<boolArray>
Creates an automatically updated boolean[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => boolean[]
  Function that returns the current local value for the property
- setterFunc: (val: boolean[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<boolArray> | SnapshotBufferOptionsObj<boolArray>
  Options for automatically applied smoothing
Returns StorageProperty<boolArray>
Newly created StorageProperty

`Static`autoDouble

autoDouble(
    key: string,
    getterFunc: () => number,
    setterFunc: (val: number) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<double>
        | SnapshotBufferOptionsObj<double>,
): StorageProperty<double>
Creates an automatically updated double property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number
  Function that returns the current local value for the property
- setterFunc: (val: number) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<double> | SnapshotBufferOptionsObj<double>
  Options for automatically applied smoothing
Returns StorageProperty<double>
Newly created StorageProperty

`Static`autoDoubleArray

autoDoubleArray(
    key: string,
    getterFunc: () => number[],
    setterFunc: (val: number[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<doubleArray>
        | SnapshotBufferOptionsObj<doubleArray>,
): StorageProperty<doubleArray>
Creates an automatically updated double[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number[]
  Function that returns the current local value for the property
- setterFunc: (val: number[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<doubleArray> | SnapshotBufferOptionsObj<doubleArray>
  Options for automatically applied smoothing
Returns StorageProperty<doubleArray>
Newly created StorageProperty

`Static`autoFloat

autoFloat(
    key: string,
    getterFunc: () => number,
    setterFunc: (val: number) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<float>
        | SnapshotBufferOptionsObj<float>,
): StorageProperty<float>
Creates an automatically updated float property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number
  Function that returns the current local value for the property
- setterFunc: (val: number) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<float> | SnapshotBufferOptionsObj<float>
  Options for automatically applied smoothing
Returns StorageProperty<float>
Newly created StorageProperty

`Static`autoFloatArray

autoFloatArray(
    key: string,
    getterFunc: () => number[],
    setterFunc: (val: number[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<floatArray>
        | SnapshotBufferOptionsObj<floatArray>,
): StorageProperty<floatArray>
Creates an automatically updated float[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number[]
  Function that returns the current local value for the property
- setterFunc: (val: number[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<floatArray> | SnapshotBufferOptionsObj<floatArray>
  Options for automatically applied smoothing
Returns StorageProperty<floatArray>
Newly created StorageProperty

`Static`autoInt

autoInt(
    key: string,
    getterFunc: () => number,
    setterFunc: (val: number) => void,
): StorageProperty<int>
Creates an automatically updated int property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number
  Function that returns the current local value for the property
- setterFunc: (val: number) => void
  Function that applies incoming new values for the property
Returns StorageProperty<int>
Newly created StorageProperty

`Static`autoIntArray

autoIntArray(
    key: string,
    getterFunc: () => number[],
    setterFunc: (val: number[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<intArray>
        | SnapshotBufferOptionsObj<intArray>,
): StorageProperty<intArray>
Creates an automatically updated int[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => number[]
  Function that returns the current local value for the property
- setterFunc: (val: number[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<intArray> | SnapshotBufferOptionsObj<intArray>
  Options for automatically applied smoothing
Returns StorageProperty<intArray>
Newly created StorageProperty

`Static`autoMat2

autoMat2(
    key: string,
    getterFunc: () => mat2,
    setterFunc: (val: mat2) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat2>
        | SnapshotBufferOptionsObj<mat2>,
): StorageProperty<mat2>
Creates an automatically updated mat2 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat2
  Function that returns the current local value for the property
- setterFunc: (val: mat2) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat2> | SnapshotBufferOptionsObj<mat2>
  Options for automatically applied smoothing
Returns StorageProperty<mat2>
Newly created StorageProperty

`Static`autoMat2Array

autoMat2Array(
    key: string,
    getterFunc: () => mat2[],
    setterFunc: (val: mat2[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat2Array>
        | SnapshotBufferOptionsObj<mat2Array>,
): StorageProperty<mat2Array>
Creates an automatically updated mat2[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat2[]
  Function that returns the current local value for the property
- setterFunc: (val: mat2[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat2Array> | SnapshotBufferOptionsObj<mat2Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat2Array>
Newly created StorageProperty

`Static`autoMat3

autoMat3(
    key: string,
    getterFunc: () => mat3,
    setterFunc: (val: mat3) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat3>
        | SnapshotBufferOptionsObj<mat3>,
): StorageProperty<mat3>
Creates an automatically updated mat3 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat3
  Function that returns the current local value for the property
- setterFunc: (val: mat3) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat3> | SnapshotBufferOptionsObj<mat3>
  Options for automatically applied smoothing
Returns StorageProperty<mat3>
Newly created StorageProperty

`Static`autoMat3Array

autoMat3Array(
    key: string,
    getterFunc: () => mat3[],
    setterFunc: (val: mat3[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat3Array>
        | SnapshotBufferOptionsObj<mat3Array>,
): StorageProperty<mat3Array>
Creates an automatically updated mat3[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat3[]
  Function that returns the current local value for the property
- setterFunc: (val: mat3[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat3Array> | SnapshotBufferOptionsObj<mat3Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat3Array>
Newly created StorageProperty

`Static`autoMat4

autoMat4(
    key: string,
    getterFunc: () => mat4,
    setterFunc: (val: mat4) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat4>
        | SnapshotBufferOptionsObj<mat4>,
): StorageProperty<mat4>
Creates an automatically updated mat4 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat4
  Function that returns the current local value for the property
- setterFunc: (val: mat4) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat4> | SnapshotBufferOptionsObj<mat4>
  Options for automatically applied smoothing
Returns StorageProperty<mat4>
Newly created StorageProperty

`Static`autoMat4Array

autoMat4Array(
    key: string,
    getterFunc: () => mat4[],
    setterFunc: (val: mat4[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<mat4Array>
        | SnapshotBufferOptionsObj<mat4Array>,
): StorageProperty<mat4Array>
Creates an automatically updated mat4[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => mat4[]
  Function that returns the current local value for the property
- setterFunc: (val: mat4[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat4Array> | SnapshotBufferOptionsObj<mat4Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat4Array>
Newly created StorageProperty

`Static`autoQuat

autoQuat(
    key: string,
    getterFunc: () => quat,
    setterFunc: (val: quat) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<quat>
        | SnapshotBufferOptionsObj<quat>,
): StorageProperty<quat>
Creates an automatically updated quat property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => quat
  Function that returns the current local value for the property
- setterFunc: (val: quat) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<quat> | SnapshotBufferOptionsObj<quat>
  Options for automatically applied smoothing
Returns StorageProperty<quat>
Newly created StorageProperty

`Static`autoQuatArray

autoQuatArray(
    key: string,
    getterFunc: () => quat[],
    setterFunc: (val: quat[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<quatArray>
        | SnapshotBufferOptionsObj<quatArray>,
): StorageProperty<quatArray>
Creates an automatically updated quat[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => quat[]
  Function that returns the current local value for the property
- setterFunc: (val: quat[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<quatArray> | SnapshotBufferOptionsObj<quatArray>
  Options for automatically applied smoothing
Returns StorageProperty<quatArray>
Newly created StorageProperty

`Static`autoString

autoString(
    key: string,
    getterFunc: () => string,
    setterFunc: (val: string) => void,
): StorageProperty<string>
Creates an automatically updated string property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => string
  Function that returns the current local value for the property
- setterFunc: (val: string) => void
  Function that applies incoming new values for the property
Returns StorageProperty<string>
Newly created StorageProperty

`Static`autoStringArray

autoStringArray(
    key: string,
    getterFunc: () => string[],
    setterFunc: (val: string[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<stringArray>
        | SnapshotBufferOptionsObj<stringArray>,
): StorageProperty<stringArray>
Creates an automatically updated string[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => string[]
  Function that returns the current local value for the property
- setterFunc: (val: string[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<stringArray> | SnapshotBufferOptionsObj<stringArray>
  Options for automatically applied smoothing
Returns StorageProperty<stringArray>
Newly created StorageProperty

`Static`autoVec2

autoVec2(
    key: string,
    getterFunc: () => vec2,
    setterFunc: (val: vec2) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec2>
        | SnapshotBufferOptionsObj<vec2>,
): StorageProperty<vec2>
Creates an automatically updated vec2 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec2
  Function that returns the current local value for the property
- setterFunc: (val: vec2) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec2> | SnapshotBufferOptionsObj<vec2>
  Options for automatically applied smoothing
Returns StorageProperty<vec2>
Newly created StorageProperty

`Static`autoVec2Array

autoVec2Array(
    key: string,
    getterFunc: () => vec2[],
    setterFunc: (val: vec2[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec2Array>
        | SnapshotBufferOptionsObj<vec2Array>,
): StorageProperty<vec2Array>
Creates an automatically updated vec2[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec2[]
  Function that returns the current local value for the property
- setterFunc: (val: vec2[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec2Array> | SnapshotBufferOptionsObj<vec2Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec2Array>
Newly created StorageProperty

`Static`autoVec3

autoVec3(
    key: string,
    getterFunc: () => vec3,
    setterFunc: (val: vec3) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec3>
        | SnapshotBufferOptionsObj<vec3>,
): StorageProperty<vec3>
Creates an automatically updated vec3 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec3
  Function that returns the current local value for the property
- setterFunc: (val: vec3) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3> | SnapshotBufferOptionsObj<vec3>
  Options for automatically applied smoothing
Returns StorageProperty<vec3>
Newly created StorageProperty

`Static`autoVec3Array

autoVec3Array(
    key: string,
    getterFunc: () => vec3[],
    setterFunc: (val: vec3[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec3Array>
        | SnapshotBufferOptionsObj<vec3Array>,
): StorageProperty<vec3Array>
Creates an automatically updated vec3[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec3[]
  Function that returns the current local value for the property
- setterFunc: (val: vec3[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3Array> | SnapshotBufferOptionsObj<vec3Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec3Array>
Newly created StorageProperty

`Static`autoVec4

autoVec4(
    key: string,
    getterFunc: () => vec4,
    setterFunc: (val: vec4) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec4>
        | SnapshotBufferOptionsObj<vec4>,
): StorageProperty<vec4>
Creates an automatically updated vec4 property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec4
  Function that returns the current local value for the property
- setterFunc: (val: vec4) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec4> | SnapshotBufferOptionsObj<vec4>
  Options for automatically applied smoothing
Returns StorageProperty<vec4>
Newly created StorageProperty

`Static`autoVec4Array

autoVec4Array(
    key: string,
    getterFunc: () => vec4[],
    setterFunc: (val: vec4[]) => void,
    smoothingOptions?:
        | SnapshotBufferOptions<vec4Array>
        | SnapshotBufferOptionsObj<vec4Array>,
): StorageProperty<vec4Array>
Creates an automatically updated vec4[] property based on getter and setter functions.
Parameters
- key: string
  Key to identify the property
- getterFunc: () => vec4[]
  Function that returns the current local value for the property
- setterFunc: (val: vec4[]) => void
  Function that applies incoming new values for the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec4Array> | SnapshotBufferOptionsObj<vec4Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec4Array>
Newly created StorageProperty

checkLocalValueChanged

checkLocalValueChanged(): boolean
Returns boolean
True if the value was changed

checkWithinSendLimit

checkWithinSendLimit(timestamp: number): boolean
Returns true if we are allowed to send updated values to the network based on the sendsPerSecondLimit and timestamp.
Parameters
- timestamp: number
  Time in seconds
Returns boolean
True if we are allowed to send updated values to the network

`Static`forMaterialProperty

forMaterialProperty<TStorageType extends StorageTypes>(
    material: Material,
    propertyName: string,
    storageType: TStorageType,
): StorageProperty<TStorageType>
Creates an automatically updated property that mirrors a value on a Material's mainPass.
Type Parameters
- TStorageType extends StorageTypes
Parameters
- material: Material
  Material to watch
- propertyName: string
  Name of a property on the material
- storageType: TStorageType
  the type of value
Returns StorageProperty<TStorageType>
Newly created StorageProperty

`Static`forMeshVisualBaseColor

forMeshVisualBaseColor(
visual: MaterialMeshVisual,
clone?: boolean,
): StorageProperty<vec4>
Creates an automatically updated property that mirrors the baseColor of a MaterialMeshVisual.
Parameters
- visual: MaterialMeshVisual
  Visual to watch
- Optionalclone: boolean
  If true, the material will be cloned and applied back to the visual. Useful if multiple objects use the same material
Returns StorageProperty<vec4>
Newly created StorageProperty

`Static`forMeshVisualProperty

forMeshVisualProperty<TStorageType extends StorageTypes>(
    visual: MaterialMeshVisual,
    propertyName: string,
    storageType: TStorageType,
    clone?: boolean,
): StorageProperty<TStorageType>
Creates an automatically updated property that mirrors a value on a MaterialMeshVisual's mainMaterial. There is also an option to clone the material in-place.
Type Parameters
- TStorageType extends StorageTypes
Parameters
- visual: MaterialMeshVisual
  Visual to watch
- propertyName: string
  Name of a property on the visual
- storageType: TStorageType
  the type of value
- Optionalclone: boolean
  If true, the material will be cloned and applied back to the visual. Useful if multiple objects use the same material
Returns StorageProperty<TStorageType>
Newly created StorageProperty

`Static`forPosition

forPosition(
    permissiveTransform: SceneObject | Component | Transform,
    propertyType: PropertyType,
    smoothingOptions?:
        | SnapshotBufferOptions<vec3>
        | SnapshotBufferOptionsObj<vec3>,
): StorageProperty<vec3>
Parameters
- permissiveTransform: SceneObject | Component | Transform
- propertyType: PropertyType
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3> | SnapshotBufferOptionsObj<vec3>
  Options for automatically applied smoothing
Returns StorageProperty<vec3>
Newly created StorageProperty

`Static`forRotation

forRotation(
    permissiveTransform: SceneObject | Component | Transform,
    propertyType: PropertyType,
    smoothingOptions?:
        | SnapshotBufferOptions<quat>
        | SnapshotBufferOptionsObj<quat>,
): StorageProperty<quat>
Parameters
- permissiveTransform: SceneObject | Component | Transform
- propertyType: PropertyType
- OptionalsmoothingOptions: SnapshotBufferOptions<quat> | SnapshotBufferOptionsObj<quat>
  Options for automatically applied smoothing
Returns StorageProperty<quat>
Newly created StorageProperty

`Static`forScale

forScale(
    permissiveTransform: SceneObject | Component | Transform,
    propertyType: PropertyType,
    smoothingOptions?:
        | SnapshotBufferOptions<vec3>
        | SnapshotBufferOptionsObj<vec3>,
): StorageProperty<vec3>
Parameters
- permissiveTransform: SceneObject | Component | Transform
- propertyType: PropertyType
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3> | SnapshotBufferOptionsObj<vec3>
  Options for automatically applied smoothing
Returns StorageProperty<vec3>
Newly created StorageProperty

`Static`forTextText

forTextText(text: Text): StorageProperty<string>
Creates an automatically updated property that mirrors a Text's text property.
Parameters
- text: Text
Returns StorageProperty<string>
Newly created StorageProperty

`Static`forTransform

forTransform(
    permissiveTransform: SceneObject | Component | Transform,
    positionPropertyType: PropertyType,
    rotationPropertyType: PropertyType,
    scalePropertyType: PropertyType,
    smoothingOptions?:
        | SnapshotBufferOptions<packedTransform>
        | SnapshotBufferOptionsObj<packedTransform>,
): StorageProperty<packedTransform>
Creates an automatically updated property that mirrors a Transform position/rotation/scale.
Parameters
- permissiveTransform: SceneObject | Component | Transform
- positionPropertyType: PropertyType
- rotationPropertyType: PropertyType
- scalePropertyType: PropertyType
- OptionalsmoothingOptions:
  | SnapshotBufferOptions<packedTransform>
  | SnapshotBufferOptionsObj<packedTransform>
  Options for automatically applied smoothing
Returns StorageProperty<packedTransform>
Newly created StorageProperty

`Static`getStoreValueDynamic

getStoreValueDynamic<T>(
    store: GeneralDataStore,
    key: string,
    propertyType: StorageTypes,
): T
Helper function that reads a value from a store, given a key and StorageType | StorageType
Type Parameters
- T
Parameters
- store: GeneralDataStore
  Store to read value from
- key: string
  Key identifying the value
- propertyType: StorageTypes
Returns T
Value - found (or default value if none found)

isSmoothingEnabled

isSmoothingEnabled(): boolean
Returns boolean
True if the property has a snapshot buffer and is currently smoothing

`Static`manual

manual<
    TPropertyType extends StorageTypes,
    TStartingValue extends

            | string
            | number
            | boolean
            | number[]
            | string[]
            | vec4
            | vec3
            | quat
            | mat4
            | vec2
            | vec3[]
            | vec2[]
            | vec4[]
            | mat3
            | mat2
            | boolean[]
            | quat[]
            | mat2[]
            | mat3[]
            | mat4[],
>(
    key: string,
    propertyType: TPropertyType,
    startingValue?: TStartingValue,
    smoothingOptions?:
        | SnapshotBufferOptions<TPropertyType>
        | SnapshotBufferOptionsObj<TPropertyType>,
): StorageProperty<TPropertyType>
Creates a simple StorageProperty that should be updated manually.
Type Parameters
- TPropertyType extends StorageTypes
- TStartingValue extends
      | string
      | number
      | boolean
      | number[]
      | string[]
      | vec4
      | vec3
      | quat
      | mat4
      | vec2
      | vec3[]
      | vec2[]
      | vec4[]
      | mat3
      | mat2
      | boolean[]
      | quat[]
      | mat2[]
      | mat3[]
      | mat4[]
Parameters
- key: string
  Key to identify the property
- propertyType: TPropertyType
  the type of value
- OptionalstartingValue: TStartingValue
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<TPropertyType> | SnapshotBufferOptionsObj<TPropertyType>
  Options for automatically applied smoothing
Returns StorageProperty<TPropertyType>
Newly created manual StorageProperty

`Static`manualBool

manualBool(key: string, startingValue?: boolean): StorageProperty<bool>
Creates a simple boolean property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: boolean
  Optional starting value to assign to the property
Returns StorageProperty<bool>
Newly created StorageProperty

`Static`manualBoolArray

manualBoolArray(
    key: string,
    startingValue?: boolean[],
    smoothingOptions?:
        | SnapshotBufferOptions<boolArray>
        | SnapshotBufferOptionsObj<boolArray>,
): StorageProperty<boolArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: boolean[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<boolArray> | SnapshotBufferOptionsObj<boolArray>
  Options for automatically applied smoothing
Returns StorageProperty<boolArray>
Newly created StorageProperty

`Static`manualDouble

manualDouble(
    key: string,
    startingValue?: number,
    smoothingOptions?:
        | SnapshotBufferOptions<double>
        | SnapshotBufferOptionsObj<double>,
): StorageProperty<double>
Creates a simple double property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<double> | SnapshotBufferOptionsObj<double>
  Options for automatically applied smoothing
Returns StorageProperty<double>
Newly created StorageProperty

`Static`manualDoubleArray

manualDoubleArray(
    key: string,
    startingValue?: number[],
    smoothingOptions?:
        | SnapshotBufferOptions<doubleArray>
        | SnapshotBufferOptionsObj<doubleArray>,
): StorageProperty<doubleArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<doubleArray> | SnapshotBufferOptionsObj<doubleArray>
  Options for automatically applied smoothing
Returns StorageProperty<doubleArray>
Newly created StorageProperty

`Static`manualFloat

manualFloat(
    key: string,
    startingValue?: number,
    smoothingOptions?:
        | SnapshotBufferOptions<float>
        | SnapshotBufferOptionsObj<float>,
): StorageProperty<float>
Creates a simple float property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<float> | SnapshotBufferOptionsObj<float>
  Options for automatically applied smoothing
Returns StorageProperty<float>
Newly created StorageProperty

`Static`manualFloatArray

manualFloatArray(
    key: string,
    startingValue?: number[],
    smoothingOptions?:
        | SnapshotBufferOptions<floatArray>
        | SnapshotBufferOptionsObj<floatArray>,
): StorageProperty<floatArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<floatArray> | SnapshotBufferOptionsObj<floatArray>
  Options for automatically applied smoothing
Returns StorageProperty<floatArray>
Newly created StorageProperty

`Static`manualInt

manualInt(key: string, startingValue?: number): StorageProperty<int>
Creates a simple integer property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number
  Optional starting value to assign to the property
Returns StorageProperty<int>
Newly created StorageProperty

`Static`manualIntArray

manualIntArray(
    key: string,
    startingValue?: number[],
    smoothingOptions?:
        | SnapshotBufferOptions<intArray>
        | SnapshotBufferOptionsObj<intArray>,
): StorageProperty<intArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: number[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<intArray> | SnapshotBufferOptionsObj<intArray>
  Options for automatically applied smoothing
Returns StorageProperty<intArray>
Newly created StorageProperty

`Static`manualMat2

manualMat2(
    key: string,
    startingValue?: mat2,
    smoothingOptions?:
        | SnapshotBufferOptions<mat2>
        | SnapshotBufferOptionsObj<mat2>,
): StorageProperty<mat2>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat2
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat2> | SnapshotBufferOptionsObj<mat2>
  Options for automatically applied smoothing
Returns StorageProperty<mat2>
Newly created StorageProperty

`Static`manualMat2Array

manualMat2Array(
    key: string,
    startingValue?: mat2[],
    smoothingOptions?:
        | SnapshotBufferOptions<mat2Array>
        | SnapshotBufferOptionsObj<mat2Array>,
): StorageProperty<mat2Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat2[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat2Array> | SnapshotBufferOptionsObj<mat2Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat2Array>
Newly created StorageProperty

`Static`manualMat3

manualMat3(
    key: string,
    startingValue?: mat3,
    smoothingOptions?:
        | SnapshotBufferOptions<mat3>
        | SnapshotBufferOptionsObj<mat3>,
): StorageProperty<mat3>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat3
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat3> | SnapshotBufferOptionsObj<mat3>
  Options for automatically applied smoothing
Returns StorageProperty<mat3>
Newly created StorageProperty

`Static`manualMat3Array

manualMat3Array(
    key: string,
    startingValue?: mat3[],
    smoothingOptions?:
        | SnapshotBufferOptions<mat3Array>
        | SnapshotBufferOptionsObj<mat3Array>,
): StorageProperty<mat3Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat3[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat3Array> | SnapshotBufferOptionsObj<mat3Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat3Array>
Newly created StorageProperty

`Static`manualMat4

manualMat4(
    key: string,
    startingValue?: mat4,
    smoothingOptions?:
        | SnapshotBufferOptions<mat4>
        | SnapshotBufferOptionsObj<mat4>,
): StorageProperty<mat4>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat4
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat4> | SnapshotBufferOptionsObj<mat4>
  Options for automatically applied smoothing
Returns StorageProperty<mat4>
Newly created StorageProperty

`Static`manualMat4Array

manualMat4Array(
    key: string,
    startingValue?: mat4[],
    smoothingOptions?:
        | SnapshotBufferOptions<mat4Array>
        | SnapshotBufferOptionsObj<mat4Array>,
): StorageProperty<mat4Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: mat4[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<mat4Array> | SnapshotBufferOptionsObj<mat4Array>
  Options for automatically applied smoothing
Returns StorageProperty<mat4Array>
Newly created StorageProperty

`Static`manualQuat

manualQuat(
    key: string,
    startingValue?: quat,
    smoothingOptions?:
        | SnapshotBufferOptions<quat>
        | SnapshotBufferOptionsObj<quat>,
): StorageProperty<quat>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: quat
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<quat> | SnapshotBufferOptionsObj<quat>
  Options for automatically applied smoothing
Returns StorageProperty<quat>
Newly created StorageProperty

`Static`manualQuatArray

manualQuatArray(
    key: string,
    startingValue?: quat[],
    smoothingOptions?:
        | SnapshotBufferOptions<quatArray>
        | SnapshotBufferOptionsObj<quatArray>,
): StorageProperty<quatArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: quat[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<quatArray> | SnapshotBufferOptionsObj<quatArray>
  Options for automatically applied smoothing
Returns StorageProperty<quatArray>
Newly created StorageProperty

`Static`manualString

manualString(key: string, startingValue?: string): StorageProperty<string>
Creates a simple string property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: string
  Optional starting value to assign to the property
Returns StorageProperty<string>
Newly created StorageProperty

`Static`manualStringArray

manualStringArray(
    key: string,
    startingValue?: string[],
    smoothingOptions?:
        | SnapshotBufferOptions<stringArray>
        | SnapshotBufferOptionsObj<stringArray>,
): StorageProperty<stringArray>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: string[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<stringArray> | SnapshotBufferOptionsObj<stringArray>
  Options for automatically applied smoothing
Returns StorageProperty<stringArray>
Newly created StorageProperty

`Static`manualVec2

manualVec2(
    key: string,
    startingValue?: vec2,
    smoothingOptions?:
        | SnapshotBufferOptions<vec2>
        | SnapshotBufferOptionsObj<vec2>,
): StorageProperty<vec2>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec2
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec2> | SnapshotBufferOptionsObj<vec2>
  Options for automatically applied smoothing
Returns StorageProperty<vec2>
Newly created StorageProperty

`Static`manualVec2Array

manualVec2Array(
    key: string,
    startingValue?: vec2[],
    smoothingOptions?:
        | SnapshotBufferOptions<vec2Array>
        | SnapshotBufferOptionsObj<vec2Array>,
): StorageProperty<vec2Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec2[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec2Array> | SnapshotBufferOptionsObj<vec2Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec2Array>
Newly created StorageProperty

`Static`manualVec3

manualVec3(
    key: string,
    startingValue?: vec3,
    smoothingOptions?:
        | SnapshotBufferOptions<vec3>
        | SnapshotBufferOptionsObj<vec3>,
): StorageProperty<vec3>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec3
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3> | SnapshotBufferOptionsObj<vec3>
  Options for automatically applied smoothing
Returns StorageProperty<vec3>
Newly created StorageProperty

`Static`manualVec3Array

manualVec3Array(
    key: string,
    startingValue?: vec3[],
    smoothingOptions?:
        | SnapshotBufferOptions<vec3Array>
        | SnapshotBufferOptionsObj<vec3Array>,
): StorageProperty<vec3Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec3[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec3Array> | SnapshotBufferOptionsObj<vec3Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec3Array>
Newly created StorageProperty

`Static`manualVec4

manualVec4(
    key: string,
    startingValue?: vec4,
    smoothingOptions?:
        | SnapshotBufferOptions<vec4>
        | SnapshotBufferOptionsObj<vec4>,
): StorageProperty<vec4>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec4
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec4> | SnapshotBufferOptionsObj<vec4>
  Options for automatically applied smoothing
Returns StorageProperty<vec4>
Newly created StorageProperty

`Static`manualVec4Array

manualVec4Array(
    key: string,
    startingValue?: vec4[],
    smoothingOptions?:
        | SnapshotBufferOptions<vec4Array>
        | SnapshotBufferOptionsObj<vec4Array>,
): StorageProperty<vec4Array>
Creates a simple property that should be updated manually.
Parameters
- key: string
  Key to identify the property
- OptionalstartingValue: vec4[]
  Optional starting value to assign to the property
- OptionalsmoothingOptions: SnapshotBufferOptions<vec4Array> | SnapshotBufferOptionsObj<vec4Array>
  Options for automatically applied smoothing
Returns StorageProperty<vec4Array>
Newly created StorageProperty

putCurrentValue

putCurrentValue(store: GeneralDataStore, timeStamp?: number): void
Parameters
- store: GeneralDataStore
  Store to write value to
- OptionaltimeStamp: number
  Time in seconds
Returns void

setPendingValue

setPendingValue(newValue: StorageTypeToPrimitive[TStorageType]): void
Sets the pending value to newValue. This value will be sent to the network at the end of the frame, as soon as it's allowed to do so (we have permission to modify the SyncEntity, and sendsPerSecondLimit hasn't been reached).
Parameters
- newValue: StorageTypeToPrimitive[TStorageType]
  New pending value to set
Returns void

setValueImmediate

setValueImmediate(
store: GeneralDataStore,
newValue: StorageTypeToPrimitive[TStorageType],
): boolean
Immediately set the current value. Only use this if you are sure that we have permission to modify the store.
Parameters
- store: GeneralDataStore
  Store to write value to
- newValue: StorageTypeToPrimitive[TStorageType]
  New value to set
Returns boolean
True if the value was changed

silentSetCurrentValue

silentSetCurrentValue(newValue: StorageTypeToPrimitive[TStorageType]): void
Parameters
- newValue: StorageTypeToPrimitive[TStorageType]
  New value to set
Returns void

`Static`wrapProperty

wrapProperty<
    TObject extends Record<TKey, TValue>,
    TKey extends string | number | symbol,
    TPropertyType extends StorageTypes,
    TValue,
>(
    key: string,
    target: TObject,
    propName: TKey,
    propertyType: TPropertyType,
    smoothingOptions?: SnapshotBufferOptions<TPropertyType>,
): StorageProperty<TPropertyType>
Creates an automatically updated property based on a target object and property name. The propName should be the name of a property on the target object.
Type Parameters
- TObject extends Record<TKey, TValue>
- TKey extends string | number | symbol
- TPropertyType extends StorageTypes
- TValue
Parameters
- key: string
  Key to identify the property
- target: TObject
  Target object to watch
- propName: TKey
  Name of a property on target that should be watched
- propertyType: TPropertyType
  the type of value
- OptionalsmoothingOptions: SnapshotBufferOptions<TPropertyType>
  Options for automatically applied smoothing
Returns StorageProperty<TPropertyType>
Newly created StorageProperty

Class StorageProperty<TStorageType>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StorageProperty<TStorageType>

Properties

currentOrPendingValue

currentValue

equalsCheck

getterFunc

key

markedDirty

needToSendUpdate

onAnyChange

onLocalChange

onPendingValueChange

onRemoteChange

pendingValue

propertyType

sendsPerSecondLimit

setterFunc

Methods

applyRemoteValue

Parameters

Returns void

applySnapshotSmoothing

Returns void

Staticauto

Type Parameters

Parameters

Returns StorageProperty<TPropertyType>

StaticautoBool

Parameters

Returns StorageProperty<bool>

StaticautoBoolArray

Parameters

Returns StorageProperty<boolArray>

StaticautoDouble

Parameters

Returns StorageProperty<double>

StaticautoDoubleArray

Parameters

Returns StorageProperty<doubleArray>

StaticautoFloat

Parameters

Returns StorageProperty<float>

StaticautoFloatArray

Parameters

Returns StorageProperty<floatArray>

StaticautoInt

Parameters

Returns StorageProperty<int>

StaticautoIntArray

Parameters

Returns StorageProperty<intArray>

StaticautoMat2

Parameters

Returns StorageProperty<mat2>

StaticautoMat2Array

Parameters

Returns StorageProperty<mat2Array>

StaticautoMat3

Parameters

Returns StorageProperty<mat3>

StaticautoMat3Array

Parameters

Returns StorageProperty<mat3Array>

StaticautoMat4

Parameters

Returns StorageProperty<mat4>

StaticautoMat4Array

Parameters

Returns StorageProperty<mat4Array>

StaticautoQuat

`Static`auto

`Static`autoBool

`Static`autoBoolArray

`Static`autoDouble

`Static`autoDoubleArray

`Static`autoFloat

`Static`autoFloatArray

`Static`autoInt

`Static`autoIntArray

`Static`autoMat2

`Static`autoMat2Array

`Static`autoMat3

`Static`autoMat3Array

`Static`autoMat4

`Static`autoMat4Array

`Static`autoQuat

`Static`autoQuatArray

`Static`autoString

`Static`autoStringArray

`Static`autoVec2

`Static`autoVec2Array

`Static`autoVec3

`Static`autoVec3Array

`Static`autoVec4

`Static`autoVec4Array

`Static`forMaterialProperty

`Static`forMeshVisualBaseColor

`Static`forMeshVisualProperty

`Static`forPosition

`Static`forRotation

`Static`forScale

`Static`forTextText

`Static`forTransform

`Static`getStoreValueDynamic

`Static`manual