Skip to main content

Bitmoji3DOptions.CustomParams

Class

The custom params can be used for requesting bitmoji assets like garments.

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

The custom params can be used for requesting bitmoji assets like garments. These can be set as custom params of Bitmoji3D options.

Index

Extends

Properties

avatarScope

avatarScope: AvatarScope

The Bitmoji3DOptions.AvatarScope to use for the request.

Default Value

Bitmoji3DOptions.AvatarScope.Unset

bag

bag: ParamSet

Parameter set to customize the bag of the avatar.

Default Value

null

bottomWear

bottomWear: ParamSet

Parameter set to customize the bottom wear of the avatar.

Default Value

null

clothingType

clothingType: ClothingType

Parameter set to customize the clothing tyoe of the avatar.

Default Value

Bitmoji3DOptions.ClothingType.Unset

cranium

cranium: string

Parameter set to customize the cranium of the avatar.

Default Value

null

footWear

footWear: ParamSet

Parameter set to customize the foot wear of the avatar.

Default Value

null

glasses

glasses: string

Parameter set to customize the glasses of the avatar.

Default Value

null

hat

hat: ParamSet

Parameter set to customize the hat of the avatar.

Default Value

null

outerWear

outerWear: ParamSet

Parameter set to customize the outerwear of the avatar.

Default Value

null

sock

sock: ParamSet

Parameter set to customize the sock of the avatar.

Default Value

null

top

top: ParamSet

Parameter set to customize the top of the avatar.

Default Value

null

Methods

create()

static create(): CustomParams

The rendering options can be used for customizing bitmoj3D avatars. These can be set as overridden options of Bitmoji3D options.

Returns

CustomParams

Since

Lens Scripting Version 256


getTypeName()

static getTypeName(): TypeName<CustomParams>

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

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