Lens Scripting API
    Preparing search index...

    Class BitmojiModule

    Provides access to functionalities related to Bitmoji avatar.

    Bitmoji Overview guide.

    // @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);
    }

    Hierarchy (View Summary)

    Index

    Properties

    name uniqueIdentifier

    Methods

    createMockUser getTypeName isOfType isSame requestBaseBitmoji3DResourceWithOptions requestBitmoji2DResource requestBitmoji3DResource requestBitmoji3DResourceWithOptions

    Properties

    name: string

    The name of the Asset in Lens Studio.

    uniqueIdentifier: string

    Methods

    • Creates a mock user with a deterministic Bitmoji avatar. The returned user can be set on Bitmoji3DOptions.user or Bitmoji2DOptions.user to load a Bitmoji without requiring a real Snapchat user. The same seed value always produces the same avatar within a given lens, while different seeds produce different avatars.

      Parameters

      • seed: string

        A non-empty string used to deterministically select the avatar.

      Returns SafeSnapchatUser

    • Returns the name of this object's type.

      Returns string

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

      Parameters

      • type: string

      Returns 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

    • Request a base Bitmoji3D resource with explicit body customization options. Uses the default base avatar and applies body parameters from baseBodyParams if provided. If baseBodyParams is not provided or missing values, falls back to cached avatar data.

      Parameters

      Returns void

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

      Parameters

      Returns void

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

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods