AvatarCreationService¶

Not yet Class Services NotCreatable Service

A service to support developer avatar creators.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 33 modern Roblox members not implemented yet

Description¶

AvatarCreationService is a service that supports developer avatar creators, providing methods that support the prompting of avatar creation from within experiences.

Inheritance¶

Object → Instance → AvatarCreationService

Methods¶

Member	Signature	Summary
`AutoSetupAvatarAsync`	`AvatarCreationService:AutoSetupAvatarAsync(player: Player, autoSetupParams: Dictionary, progressCallback: Function?): string`	Automatically sets up a custom Model and/or avatar accessories.
`CreateCageMeshPartsWithScaleForExportAsync`	`AvatarCreationService:CreateCageMeshPartsWithScaleForExportAsync(model: Model): Folder`	—
`DeserializeAvatarModel`	`AvatarCreationService:DeserializeAvatarModel(serializedModel: string): Instance`	—
`GenerateAvatar2DPreviewAsync`	`AvatarCreationService:GenerateAvatar2DPreviewAsync(avatarGeneration2dPreviewParams: Dictionary, progressCallback: Function?): string`	Creates a 2D avatar preview and returns a `previewId`.
`GenerateAvatarAsync`	`AvatarCreationService:GenerateAvatarAsync(avatarGenerationParams: Dictionary, progressCallback: Function?): string`	Generates an avatar and returns a generationId.
`GetBatchTokenDetailsAsync`	`AvatarCreationService:GetBatchTokenDetailsAsync(tokenIds: Array): Array`	Gets the avatar creation token details for a list of avatar creation tokens at once.
`GetValidationRules`	`AvatarCreationService:GetValidationRules(): Dictionary`	Gets data regarding rules that assets must abide by to pass UGC validation.
`HandleSelfieConsentResult`	`AvatarCreationService:HandleSelfieConsentResult(consentAccepted: bool): null`	—
`HandleSelfieQRResult`	`AvatarCreationService:HandleSelfieQRResult(success: bool, resultString: string): null`	—
`LoadAvatar2DPreviewAsync`	`AvatarCreationService:LoadAvatar2DPreviewAsync(previewId: string): EditableImage`	Load an AvatarGeneration 2D preview on the client from a previewId.
`LoadGeneratedAvatarAsync`	`AvatarCreationService:LoadGeneratedAvatarAsync(generationId: string): HumanoidDescription`	Loads a generated avatar using an avatar generation ID.
`PrepareAvatarForPreviewAsync`	`AvatarCreationService:PrepareAvatarForPreviewAsync(humanoidModel: Model): null`	Prepares in-experience avatar for preview.
`PromptCreateAvatarAssetAsync`	`AvatarCreationService:PromptCreateAvatarAssetAsync(tokenId: string, player: Player, assetInstance: Instance, assetType: AvatarAssetType): Tuple`	Prompts a Player to purchase and create an avatar asset from an Instance.
`PromptCreateAvatarAsync`	`AvatarCreationService:PromptCreateAvatarAsync(tokenId: string, player: Player, humanoidDescription: HumanoidDescription): Tuple`	Prompts a Player to purchase and create an avatar from a HumanoidDescription.
`PromptCreateMakeupAsync`	`AvatarCreationService:PromptCreateMakeupAsync(player: Player, makeupAssetEntries: Array, thumbnailHeadColor: Color3? = nil): Tuple`	Prompts a Player to create and publish a makeup look from multiple makeup assets.
`PromptSelectAvatarGenerationImageAsync`	`AvatarCreationService:PromptSelectAvatarGenerationImageAsync(player: Player): string`	Prompt the Player to take a selfie and return the FileId.
`RequestAvatarGenerationSessionAsync`	`AvatarCreationService:RequestAvatarGenerationSessionAsync(player: Player, callback: Function): Tuple`	Request an AvatarGeneration session for a Player.
`ValidateUGCAccessoryAsync`	`AvatarCreationService:ValidateUGCAccessoryAsync(player: Player, accessory: Instance, accessoryType: AccessoryType): Tuple`	Studio only. Runs UGC validation for an AccessoryType.
`ValidateUGCBodyPartAsync`	`AvatarCreationService:ValidateUGCBodyPartAsync(player: Player, instance: Instance, bodyPart: BodyPart): Tuple`	Studio only. Runs UGC validation for an BodyPart.
`ValidateUGCFullBodyAsync`	`AvatarCreationService:ValidateUGCFullBodyAsync(player: Player, humanoidDescription: HumanoidDescription): Tuple`	Studio only. Runs UGC validation for a whole body.

Events¶

Member	Signature	Summary
`AvatarAssetModerationCompleted`	`AvatarAssetModerationCompleted(assetId: int64, moderationStatus: ModerationStatus)`	Fires when an in-experience-created avatar asset's moderation status has been updated from pending.
`AvatarModerationCompleted`	`AvatarModerationCompleted(outfitId: int64, moderationStatus: ModerationStatus)`	Fires when an in-experience-created avatar's moderation status has been updated from pending.
`AvatarOutfitModerationCompleted`	`AvatarOutfitModerationCompleted(outfitId: int64, moderationStatus: ModerationStatus, outfitType: OutfitType)`	Fires on the client when moderation completes for an in-experience-created outfit.
`OpenSelfieConsent`	`OpenSelfieConsent()`	—
`OpenSelfieQRCode`	`OpenSelfieQRCode(url: string, jobId: string)`	—
`ReplicateAvatarGenerationImageIdWithErrorType`	`ReplicateAvatarGenerationImageIdWithErrorType(fileId: string, errorType: int, errorMsg: string)`	—
`ReplicateAvatarModel`	`ReplicateAvatarModel(id: string, success: bool, serializedModel: string, bufferTable: Dictionary)`	—
`ReplicateAvatarPreviewUrl`	`ReplicateAvatarPreviewUrl(id: string, downloadUrl: string)`	—
`RequestAvatarGenerationImage`	`RequestAvatarGenerationImage()`	—
`RequestAvatarModel`	`RequestAvatarModel(id: string)`	—
`RequestAvatarPreviewUrl`	`RequestAvatarPreviewUrl(id: string)`	—
`UgcValidationFailure`	`UgcValidationFailure(guid: string, errorMessage: string)`	—
`UgcValidationSuccess`	`UgcValidationSuccess(guid: string, serializedModel: string, price: int64)`	—

Roblox reference: AvatarCreationService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.