Skip to main content

API Reference

This page will list all APIs available in the Genies Avatar SDK.

tip

Checkout the framework pages for User Login, Load an Avatar, and Avatar Editor to see more information on the APIs and examples on how they are used.

Namespaces​

GeniesSdk​

namespace Genies.Sdk

The main namespace for all Genies SDK tools.

Classes​

AvatarSdk​

class Genies.Sdk.AvatarSdk

The main class with the methods, events, and parameters for the Genies Avatar SDK.

ManagedAvatar​

class Genies.Sdk.ManagedAvatar

Represents an in-game or in-editor Avatar instance that can be loaded, modified, and managed through the SDK.

Interfaces​

IGeniesUser​

interface Genies.Sdk.IGeniesUser

Provides access to user-related data such as unique ID and username.

Enums​

AssetType​

enum Genies.Sdk.AssetType

Asset types available in the avatar system.

AvatarColorKind​

enum Genies.Sdk.AvatarColorKind

Identifies which IColor type to get (HairColor, FacialHairColor, EyeBrowsColor, EyeLashColor, SkinColor, or EyeColor). Used with GetColorAsync to return the corresponding color value from the avatar.

AvatarFeatureCategory​

enum Genies.Sdk.AvatarFeatureCategory

Avatar feature category for GetDefaultAvatarFeaturesByCategory (e.g. Eyes, Jaw, Lips, Nose).

AvatarFeatureStat​

enum Genies.Sdk.AvatarFeatureStat

Unified enum for all avatar feature stats. Used as keys for GetAvatarFeatureStats. Category-prefixed to avoid name clashes (e.g. Width exists in Jaw, Lips, Nose).

AvatarFeatureStatType​

enum Genies.Sdk.AvatarFeatureStatType

Identifies which avatar feature stat category to query (Body, EyeBrows, Eyes, Jaw, Lips, Nose). Used with GetAllAvatarFeatureStats to retrieve all stat values for that category.

AvatarMakeupCategory​

enum Genies.Sdk.AvatarMakeupCategory

Makeup category for GetDefaultMakeupByCategoryAsync (e.g. Stickers, Lipstick, Freckles, FaceGems, Eyeshadow, Blush).

BodySize​

enum Genies.Sdk.BodySize

Represents the types of body sizes an Avatar can be set.

BodyStats​

enum Genies.Sdk.BodyStats

Body statistics that can be modified on the avatar.

ColorSource​

enum Genies.Sdk.ColorSource

Source type for color preset retrieval (All, User, or Default).

ColorType​

enum Genies.Sdk.ColorType

Type of color preset to retrieve.

EyeBrowsStats​

enum Genies.Sdk.EyeBrowsStats

Eyebrow statistics that can be modified on the avatar.

EyeStats​

enum Genies.Sdk.EyeStats

Eye statistics that can be modified on the avatar.

FeatureType​

enum Genies.Sdk.FeatureType

Feature type for avatar feature modification (eyes, jawline, lips, nose, eyebrows, eyelashes, etc.).

Gender Types​

enum Genies.Sdk.GenderType

Represents the types of genders an Avatar can be set.

HairType​

enum Genies.Sdk.HairType

Hair/flair type for color modification (hair, facial hair, eyebrows, or eyelashes).

JawStats​

enum Genies.Sdk.JawStats

Jaw statistics that can be modified on the avatar.

LipsStats​

enum Genies.Sdk.LipsStats

Lip statistics that can be modified on the avatar.

MegaSkinTattooSlot​

enum Genies.Sdk.MegaSkinTattooSlot

Types of places on the body a tattoo can be placed.

NoseStats​

enum Genies.Sdk.NoseStats

Nose statistics that can be modified on the avatar.

UserColorType​

enum Genies.Sdk.UserColorType

Type of user color preset to retrieve.

UserWearablesCategory​

enum Genies.Sdk.UserWearablesCategory

Subset of WearablesCategory for user wearable asset APIs (e.g. GetUserWearablesByCategoryAsync).

WardrobeSubcategory​

enum Genies.Sdk.WardrobeSubcategory

Wardrobe subcategory types for filtering wearable assets.

WearableAssetSource​

enum Genies.Sdk.WearableAssetSource

Source type for wearable asset retrieval (All, User, or Default).

WearablesCategory​

enum Genies.Sdk.WearablesCategory

Wearable category types (non-hair wardrobe subcategories). Excludes hair, eyebrows, eyelashes, facialHair.

Events​

AvatarEditorClosed​

System.Action AvatarSdk.Events.AvatarEditorClosed

Event raised when the Avatar Editor is closed.

AvatarEditorOpened​

System.Action AvatarSdk.Events.AvatarEditorOpened

Event raised when the Avatar Editor is opened.

LoginAnonymousFailed​

System.Action<(string applicationId, string failReason)> AvatarSdk.Events.LoginAnonymousFailed

Invoked when an anonymous sign-in fails. Provides the applicationId and failure reason.

LoginAnonymousSucceeded​

System.Action<string> AvatarSdk.Events.LoginAnonymousSucceeded

Invoked when an anonymous sign-in succeeds. Provides the applicationId used.

LoginEmailOtpCodeRequestFailed​

System.Action<(string email, string failReason)> AvatarSdk.Events.LoginEmailOtpCodeRequestFailed

Triggered when a request to send an email OTP (one-time passcode) fails. Provides the email and reason for failure.

LoginEmailOtpCodeRequestSucceeded​

System.Action<string> AvatarSdk.Events.LoginEmailOtpCodeRequestSucceeded

Triggered when an email OTP code is successfully sent to the user’s email address.

LoginEmailOtpCodeSubmissionFailed​

System.Action<(string code, string failReason)> AvatarSdk.Events.LoginEmailOtpCodeSubmissionFailed

Triggered when the user submits an invalid or expired OTP code. Provides the code and failure reason.

LoginEmailOtpCodeSubmissionSucceeded​

System.Action<string> AvatarSdk.Events.LoginEmailOtpCodeSubmissionSucceeded

Triggered when the OTP code submission is successful and login continues.

UserLoggedIn​

System.Action AvatarSdk.Events.UserLoggedIn

Triggered when a user has successfully logged in to the Genies platform.

UserLoggedOut​

System.Action AvatarSdk.Events.UserLoggedOut

Triggered when the currently logged-in user logs out.

Parameters​

IsAvatarEditorOpen​

bool AvatarSdk.IsAvatarEditorOpen { get; }

Indicates whether the Avatar Editor UI is currently open.

IsAwaitingEmailOtpCode​

bool AvatarSdk.IsAwaitingEmailOtpCode { get; }

Indicates if the SDK is waiting for the user to enter an email OTP code.

IsLoggedIn​

bool AvatarSdk.IsLoggedIn { get; }

Indicates whether a user is currently authenticated within the SDK.

IsLoggedInAnonymously​

bool AvatarSdk.IsLoggedInAnonymously { get; }

Checks if the current logged in user is anonymous.

UrlGeniesHubSignUp​

string AvatarSdk.UrlGeniesHubSignUp { get; }

Returns the URL for signing up or creating a Developer Portal account.

Methods​

CloseAvatarEditorAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.CloseAvatarEditorAsync(bool revertAvatar)

Closes the currently open Avatar Editor asynchronously. It also will revert the Avatar back to its original definition if flagged.

CreateEyeBrowsColor​

EyeBrowsColor AvatarSdk.CreateEyeBrowsColor(Color baseColor, Color baseColor2)

Creates an EyeBrowsColor instance for use with SetColorAsync.

CreateEyeLashColor​

EyeLashColor AvatarSdk.CreateEyeLashColor(Color baseColor, Color baseColor2)

Creates an EyeLashColor instance for use with SetColorAsync.

CreateFacialHairColor​

FacialHairColor AvatarSdk.CreateFacialHairColor(Color baseColor, Color colorR, Color colorG, Color colorB)

Creates a FacialHairColor instance for use with SetColorAsync.

CreateHairColor​

HairColor AvatarSdk.CreateHairColor(Color baseColor, Color colorR, Color colorG, Color colorB)

A HairColor instance that can be passed to SetColorAsync.

CreateMakeupColor​

MakeupColor AvatarSdk.CreateMakeupColor(AvatarMakeupCategory makeupCategory, Color baseColor, Color colorR, Color colorG, Color colorB)

Creates a MakeupColor instance for use with SetColorAsync.

CreateSkinColor​

SkinColor AvatarSdk.CreateSkinColor(Color skinColor)

Creates a SkinColor instance for use with SetColorAsync.

EquipHairAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipHairAsync(ManagedAvatar avatar, WearableAssetInfo hairAsset, [System.Threading.CancellationToken cancellationToken = default])

Equips a hair style on the specified avatar. Supports both regular hair and facial hair.

EquipHairByHairAssetIdAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipHairByHairAssetIdAsync(ManagedAvatar avatar, string hairAssetId, [System.Threading.CancellationToken cancellationToken = default])

Equips a hair style on the specified avatar. Supports both regular hair and facial hair.

EquipMakeupAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipMakeupAsync(ManagedAvatar avatar, AvatarMakeupInfo asset, [System.Threading.CancellationToken cancellationToken = default])

Sets avatar makeup by equipping the asset (e.g. from GetDefaultMakeupByCategoryAsync). Uses the asset's AssetId.

EquipOutfitAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipOutfitAsync(ManagedAvatar avatar, string wearableId, [System.Threading.CancellationToken cancellationToken = default])

Equips a wearable item (such as clothing, accessories - any item in the Outftit category) on the specified Avatar.

EquipTattooAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipTattooAsync(ManagedAvatar avatar, AvatarTattooInfo asset, MegaSkinTattooSlot tattooSlot, [System.Threading.CancellationToken cancellationToken = default])

Equips a tattoo on the specified avatar at the given slot using AvatarItemInfo (e.g. from GetDefaultTattoosAsync).

EquipWearableAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipWearableAsync(ManagedAvatar avatar, WearableAssetInfo wearableAssetInfo, [System.Threading.CancellationToken cancellationToken = default])

Equips a Wearable by wearable asset info on the specified avatar.

EquipWearableByWearableIdAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.EquipWearableByWearableIdAsync(ManagedAvatar avatar, string wearableId, [System.Threading.CancellationToken cancellationToken = default])

Equips a Wearable by wearable ID on the specified avatar.

GetAvatarEditorAvatar​

ManagedAvatar AvatarSdk.GetAvatarEditorAvatar()

Returns the Avatar instance being edited from the Avatar Editor.

GetAvatarFeatureStats​

Dictionary<AvatarFeatureStat, float> AvatarSdk.GetAvatarFeatureStats(ManagedAvatar avatar, AvatarFeatureStatType statType)

Gets current values for a given avatar feature stat type (e.g. all nose stats, all body stats).

GetColorAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<IAvatarColor> AvatarSdk.GetColorAsync(ManagedAvatar avatar, AvatarColorKind colorKind, [System.Threading.CancellationToken cancellationToken = default])

Gets the current color from the avatar for the specified color kind (Hair, FacialHair, EyeBrows, EyeLash, Skin, Eyes, Makeup categories). Note: For certain categories, this method will only work reliably after a SetColor call has been call on the avatar once.

GetDefaultAvatarFeaturesByCategory​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<AvatarFeaturesInfo>> AvatarSdk.GetDefaultAvatarFeaturesByCategory(AvatarFeatureCategory category, [System.Threading.CancellationToken cancellationToken = default])

Gets default avatar feature data filtered by category from the default inventory service.

GetDefaultColorsAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<IAvatarColor>> AvatarSdk.GetDefaultColorsAsync(ColorType colorType, [System.Threading.CancellationToken cancellationToken = default])

Gets default (curated) color presets for the specified color type.

GetDefaultHairAssets​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<WearableAssetInfo>> AvatarSdk.GetDefaultHairAssets(HairType hairType, [System.Threading.CancellationToken cancellationToken = default])

Gets default hair wearable assets for the given hair type.

GetDefaultMakeupByCategoryAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<AvatarMakeupInfo>> AvatarSdk.GetDefaultMakeupByCategoryAsync(AvatarMakeupCategory category, [System.Threading.CancellationToken cancellationToken = default])

Gets default avatar makeup assets filtered by category from the default inventory service.

GetDefaultTattoosAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<AvatarTattooInfo>> AvatarSdk.GetDefaultTattoosAsync([System.Threading.CancellationToken cancellationToken = default])

Gets default tattoo assets from the default inventory service (image library category "Tattoos").

GetDefaultWearablesByCategoryAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<WearableAssetInfo>> AvatarSdk.GetDefaultWearablesByCategoryAsync(WearablesCategory wearableCategory, [System.Threading.CancellationToken cancellationToken = default])

Gets default wearable assets for the given wearable categories (non-hair). Maps each WearablesCategory to WardrobeSubcategory and returns default assets only.

GetLoggedInUserAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<IGeniesUser> AvatarSdk.GetLoggedInUserAsync()

Retrieves the user data of the currently logged-in user.

GetUserAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<IGeniesUser> AvatarSdk.GetUserAsync(string userId, string username)

Fetches user information for a specified user ID or username.

GetUserAvatarDefinition​

(awaitable) Cysharp.Threading.Tasks.UniTask<string> AvatarSdk.GetUserAvatarDefinition([string userId])

Gets the authenticated user's avatar definition as a JSON string. This fetches the latest user avatar definition from the server or uses the user ID whose avatar definition to retrieve if provided. The returned definition can be cached and used with AvatarSdk.LoadAvatarByDefinitionAsync(string, string, Transform, RuntimeAnimatorController) for optimized loading. User must be logged in.

GetUserColorsAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<IAvatarColor>> AvatarSdk.GetUserColorsAsync(UserColorType colorType, [System.Threading.CancellationToken cancellationToken = default])

Gets user (custom) color presets for the specified color type. Only Hair and Skin support custom colors.

GetUserIdAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<string> AvatarSdk.GetUserIdAsync()

Retrieves the logged-in user’s unique Genies ID.

GetUserNameAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<string> AvatarSdk.GetUserNameAsync()

Retrieves the logged-in user’s username.

GetUsersAssetsAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<WearableAssetInfo>> AvatarSdk.GetUsersAssetsAsync()

Gets the assets of the logged in user. Returns a list of WearableAssetInfo structs containing AssetId, AssetType, Name, and Category.

GetUserWearablesByCategoryAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<List<WearableAssetInfo>> AvatarSdk.GetUserWearablesByCategoryAsync(UserWearablesCategory userWearableCategory, [System.Threading.CancellationToken cancellationToken = default])

Gets user wearable assets for the given wearable categories (non-hair). Maps each UserWearablesCategory to WardrobeSubcategory and returns user assets only.

GetWearableAssetInfoListAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<System.Collections.Generic.List<Genies.AvatarEditor.Core.WearableAssetInfo>> AvatarSdk.GetWearableAssetInfoListAsync([System.Threading.CancellationToken cancellationToken = default])

Returns a list of all wearable asset metadata available to the current Avatar or user.

GiveAssetToUserAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool, string)> AvatarSdk.GiveAssetToUserAsync(string assetId)

Grants an asset specified by the assetId to a user, adding it to their inventory. If the user already has the asset, the method will return true with a string noting that the user already has the asset.

InitializeAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.InitializeAsync()

Initializes the Avatar SDK. Is automatically called before using other API functions. Returns whether initialization succeeded.

LoadAvatarByDefinitionAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadAvatarByDefinitionAsync(string definition, [string avatarName = null], [Transform parent = null], [RuntimeAnimatorController playerAnimationController = null])

Loads an avatar based on a provided JSON definition.

LoadDefaultAvatarAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadDefaultAvatarAsync([string avatarName = null], [Transform parent = null], [RuntimeAnimatorController playerAnimationController = null])

Loads a default Avatar model into the scene.

LoadFromLocalAvatarDefinitionAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadFromLocalAvatarDefinitionAsync(string profileId, CancellationToken cancellationToken = default)

Loads an Avatar definition from a local persistent json file. Returns a ManagedAvatar or null if failed.

LoadFromLocalGameObjectAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadFromLocalGameObjectAsync(string profileId, CancellationToken cancellationToken = default)

Loads an Avatar from a local GameObject. Returns a ManagedAvatar or null if failed.

LoadTestAvatarAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadTestAvatarAsync([string avatarName = null], [Transform parent = null], [RuntimeAnimatorController playerAnimationController = null])

Loads a test Avatar.

LoadUserAvatarAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadUserAvatarAsync([string avatarName = null], [Transform parent = null], [RuntimeAnimatorController playerAnimationController = null])

Loads the logged-in user’s saved Avatar into the scene.

LoadUserAvatarByUserIdAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<ManagedAvatar> AvatarSdk.LoadUserAvatarByUserIdAsync(string userId, [string avatarName = null], [Transform parent = null], [RuntimeAnimatorController playerAnimationController = null])

Loads an avatar based on a provided UserId.

LogOutAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.LogOutAsync()

Logs out the current user and clears authentication state.

ModifyAvatarFeatureStat​

bool AvatarSdk.ModifyAvatarFeatureStat(ManagedAvatar avatar, AvatarFeatureStat stat, float value, [System.Threading.CancellationToken cancellationToken = default])

Modifies a single avatar feature stat. Value is clamped to -1.0..1.0.

ModifyAvatarFeatureStats​

bool AvatarSdk.ModifyAvatarFeatureStats(ManagedAvatar avatar, Dictionary<AvatarFeatureStat, float> stats, [System.Threading.CancellationToken cancellationToken = default])

Modifies multiple avatar feature stats at once. Values are clamped to -1.0..1.0.

OpenAvatarEditorAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.OpenAvatarEditorAsync(ManagedAvatar avatar, [Camera camera = null])

Opens the Avatar Editor for the specified Avatar instance, optionally targeting a specific camera.

PrecacheAvatarAssetsByDefinitionAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.PrecacheAvatarAssetsByDefinitionAsync(string definition)

Pre-caches assets required for an avatar based on a JSON definition without loading it. This downloads and caches all assets needed for the avatar, improving subsequent load times. User must be logged in.

PrecacheDefaultAvatarAssetsAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.PrecacheDefaultAvatarAssetsAsync([System.Threading.CancellationToken cancellationToken = default])

Pre-caches assets required for a default avatar without loading it. This downloads and caches all assets needed for the avatar, improving subsequent load times.

PrecacheUserAvatarAssetsAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.PrecacheUserAvatarAssetsAsync([System.Threading.CancellationToken cancellationToken = default])

Pre-caches assets required for the authenticated user's avatar without loading it. This downloads and caches all assets needed for the avatar, improving subsequent load times. User must be logged in.

ResendEmailCodeAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool succeeded, string failReason)> AvatarSdk.ResendEmailCodeAsync()

Re-sends the email verification or OTP code. Returns whether the resend succeeded.

SaveAvatarDefinitionLocallyAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SaveAvatarDefinitionLocallyAsync(ManagedAvatar avatar, string profileId = null)

Saves the current Avatar definition to both json on device for local persistent data as well as to a scriptable object in Resources. The profileId is the name it saves to.

SaveUserAvatarDefinitionAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SaveUserAvatarDefinitionAsync(ManagedAvatar avatar)

Saves the current avatar definition to the user's avatar.

SetAvatarBodyTypeAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetAvatarBodyTypeAsync(ManagedAvatar avatar, GenderType genderType, BodySize bodySize, CancellationToken cancellationToken = default)

Sets the Avatar body type with specified gender and body size.

SetAvatarFeatureAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.SetAvatarFeatureAsync(ManagedAvatar avatar, AvatarFeaturesInfo feature, [System.Threading.CancellationToken cancellationToken = default])

Sets an avatar feature by equipping the specified asset. Provides a unified interface for modifying various facial features.

SetColorAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<bool> AvatarSdk.SetColorAsync(ManagedAvatar avatar, IAvatarColor color, [System.Threading.CancellationToken cancellationToken = default])

Sets hair, eyebrow, eyelash, skin, or eye color on the avatar. Use CreateHairColor, CreateSkinColor, etc. to build the color.

SetEditorSaveLocallyAndContinueAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetEditorSaveLocallyAndContinueAsync(string profileId)

Sets the Avatar Editor to save locally and continue editing.

SetEditorSaveLocallyAndExitAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetEditorSaveLocallyAndExitAsync(string profileId)

Sets the Avatar Editor to save locally and exit the editor.

SetEditorSaveRemotelyAndContinueAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetEditorSaveRemotelyAndContinueAsync()

Sets the Avatar Editor to save to the cloud and continue editing.

SetEditorSaveRemotelyAndExitAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetEditorSaveRemotelyAndExitAsync()

Sets the Avatar Editor to save to the cloud and exit the editor.

SetSkinColorAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.SetSkinColorAsync(ManagedAvatar avatar, Color skinColor, [System.Threading.CancellationToken cancellationToken = default])

Changes the Avatar’s skin color to the specified value.

StartLoginAnonymousAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool succeeded, string failReason)> AvatarSdk.StartLoginAnonymousAsync([string applicationId = ""])

Starts the anonymous login flow by signing in with the given applicationId.

StartLoginEmailOtpAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool succeeded, string failReason)> AvatarSdk.StartLoginEmailOtpAsync(string email)

Initiates an email-based OTP login flow by sending a one-time code to the specified email.

SubmitEmailOtpCodeAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool succeeded, string failReason)> AvatarSdk.SubmitEmailOtpCodeAsync(string code)

Submits the OTP code received by email to complete login.

TryInstantLoginAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<(bool isLoggedIn, string username)> AvatarSdk.TryInstantLoginAsync()

Attempts an automatic login using stored credentials.

UnEquipHairAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.UnEquipHairAsync(ManagedAvatar avatar, HairType hairType, [System.Threading.CancellationToken cancellationToken = default])

Unequips a hair style from the specified avatar. Automatically finds the currently equipped hair asset and unequips it. Supports both regular hair and facial hair.

UnEquipMakeupAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.UnEquipMakeupAsync(ManagedAvatar avatar, AvatarMakeupInfo asset, [System.Threading.CancellationToken cancellationToken = default])

Unequips a makeup asset from the specified avatar using the given AvatarItemInfo's AssetId.

UnEquipOutfitAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.UnEquipOutfitAsync(ManagedAvatar avatar, string wearableId, [System.Threading.CancellationToken cancellationToken = default])

Removes a wearable item from the Avatar.

UnEquipTattooAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask<string> AvatarSdk.UnEquipTattooAsync(ManagedAvatar avatar, MegaSkinTattooSlot tattooSlot, [System.Threading.CancellationToken cancellationToken = default])

Unequips a tattoo from the specified avatar at the given slot.

UnEquipWearableAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.UnEquipWearableAsync(ManagedAvatar avatar, WearableAssetInfo wearableAssetInfo, [System.Threading.CancellationToken cancellationToken = default])

Unequips a Wearable by wearable ID from the specified avatar.

UnEquipWearableByWearableIdAsync​

(awaitable) Cysharp.Threading.Tasks.UniTask AvatarSdk.UnEquipWearableByWearableIdAsync(ManagedAvatar avatar, string wearableId, [System.Threading.CancellationToken cancellationToken = default])

Unequips a Wearable by wearable ID from the specified avatar.