Interface BitmojiModule

Provides access to getting information about the current user's Bitmoji.

Example

// @input Asset.BitmojiModule bitmojiModule
// @input Asset.RemoteMediaModule remoteMediaModule
// @input Asset.Material pbrMaterialHolder

script.bitmojiModule.requestBitmoji3DResource(
    function (bitmoji3DResource) {
      script.remoteMediaModule.loadResourceAsGltfAsset(
        bitmoji3DResource,
        onDownloaded,
        onFail
      )
    }
  )

function onDownloaded (gltfAsset){
  var root = scene.createSceneObject("BitmojiAvatar");
  var gltfSettings = GltfSettings.create();
  gltfSettings.convertMetersToCentimeters = true;
  var avatar = gltfAsset.tryInstantiateWithSetting(root, script.pbrMaterialHolder, gltfSettings);
}

function onFail (e){
    print(e);
}
interface BitmojiModule {
    name: string;
    uniqueIdentifier: string;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    requestBitmoji2DResource(options: Bitmoji2DOptions, callback: ((resource: Bitmoji2DResource) => void)): void;
    requestBitmoji3DResource(callback: ((resource: Bitmoji3DResource) => void)): void;
    requestBitmoji3DResourceWithOptions(options: Bitmoji3DOptions, callback: ((resource: Bitmoji3DResource) => void)): void;
}

Hierarchy (view full)

Properties

name uniqueIdentifier

Methods

getTypeName isOfType isSame requestBitmoji2DResource requestBitmoji3DResource requestBitmoji3DResourceWithOptions

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

requestBitmoji2DResource

  • requestBitmoji2DResource(options, callback): void

  • Returns a DynamicResource via the provided callback, which can be resolved into a texture using RemoteMediaModule.

    Parameters

    Returns void

requestBitmoji3DResource

  • requestBitmoji3DResource(callback): void

  • Request the current user's 3D Bitmoji avatar.

    Parameters

    Returns void

requestBitmoji3DResourceWithOptions

Settings

Member Visibility

On This Page

Properties
Methods