Skip to main content

NamedValues

Class

A type containing two arrays which map positionally to each other.

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

A type containing two arrays which map positionally to each other. For example, this is used by FaceRenderObjectProvider, to provide a names array which contains the list of expresion names on the face, while the values array which contains the weight of each expression.

Index

Extends

Indexable

[index: string]: any

Properties

names

readonly names: string[]

The array of names which positionally correspond to the value array property.

Since

Lens Scripting Version 306


values

readonly values: Float32Array

The array of values which positionally correspond to the names array property.

Since

Lens Scripting Version 306

Methods

getTypeName()

static getTypeName(): TypeName<NamedValues>

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

Since

Lens Scripting Version 306

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


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