Skip to main content

Bitmoji3DOptions.ParamSet

Class

Set of parameters used to customize specific parts of avatar such as garment, outerwear etc.

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

Index

Extends

Properties

optionId

optionId: string

Unique identifier of the category defined using this ParamSet.

Default Value

""

params

params: object

Used to set the parameters.

Index Signature

[key: string]: string | number | vec4

Default Value

{}

Methods

create()

static create(): ParamSet

Used to create the parameter set for customizing specific parts of avatar such as garment, outerwear etc.

Returns

ParamSet

Since

Lens Scripting Version 256


getTypeName()

static getTypeName(): TypeName<ParamSet>

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

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