Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AvatarCreationService

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service]

Member index 21

HistoryMember
641GenerateAvatarAsync(sessionId: string, previewId: string): string
638GenerateAvatarModelAsync(player: Player, previewJobId: string, options: Dictionary, progressCallback: Function): string
638GenerateAvatarPreviewAsync(player: Player, textPrompt: string, options: Dictionary, progressCallback: Function): string
641GenerateAvatarPreviewAsync2(sessionId: string, fileId: string, textPrompt: string): string
624GetAvatarGenerationConfig(): Dictionary
640GetValidationRules(): Dictionary
641LoadAvatarHumanoidDescriptionAsync(id: string): HumanoidDescription
620LoadAvatarModelAsync(id: string): Instance
620LoadAvatarPreviewImageAsync(avatarPreview: string): EditableImage
597PromptCreateAvatarAsync(player: Player, humanoidDescription: HumanoidDescription): Tuple
641RequestAvatarGenerationSessionAsync(player: Player, callback: Function): Tuple
626SendAnalyticsEvent(eventName: string, params: Dictionary): null
627ValidateUGCAccessoryAsync(player: Player, accessory: Instance, accessoryType: AccessoryType): Tuple
627ValidateUGCBodyPartAsync(player: Player, instance: Instance, bodyPart: BodyPart): Tuple
627ValidateUGCFullBodyAsync(player: Player, humanoidDescription: HumanoidDescription): Tuple
607UgcValidationFailure(guid: string, errorMessage: string)
607UgcValidationSuccess(guid: string, serializedModel: string)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 2

HistoryMember
641CreateAvatarGenerationSessionAsync(player: Player): AvatarGenerationSession

Description

History 28

Members 21

GenerateAvatarAsync

Parameters (2)
sessionIdstring
previewIdstring
Returns (1)
string
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GenerateAvatarModelAsync

Parameters (4)
playerPlayer
previewJobIdstring
optionsDictionary
progressCallbackFunction
Returns (1)
string
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GenerateAvatarPreviewAsync

Parameters (4)
playerPlayer
textPromptstring
optionsDictionary
progressCallbackFunction
Returns (1)
string
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GenerateAvatarPreviewAsync2

Parameters (3)
sessionIdstring
fileIdstring
textPromptstring
Returns (1)
string
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GetAvatarGenerationConfig

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GetValidationRules

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

LoadAvatarHumanoidDescriptionAsync

Parameters (1)
idstring
Returns (1)
HumanoidDescription
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

LoadAvatarModelAsync

Parameters (1)
idstring
Returns (1)
Instance
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

LoadAvatarPreviewImageAsync

Parameters (1)
avatarPreviewstring
Returns (1)
EditableImage
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

PromptCreateAvatarAsync

Parameters (2)
playerPlayer
humanoidDescriptionHumanoidDescription
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

RequestAvatarGenerationSessionAsync

Parameters (2)
playerPlayer
callbackFunction
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

SendAnalyticsEvent

Parameters (2)
eventNamestring
paramsDictionary
Returns (1)
null
Thread safetyUnsafe

History 1

UgcValidationFailure

Parameters (2)
guidstring
errorMessagestring
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

UgcValidationSuccess

Parameters (2)
guidstring
serializedModelstring
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

ValidateUGCAccessoryAsync

Parameters (3)
playerPlayer
accessoryInstance
accessoryTypeAccessoryType
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

ValidateUGCBodyPartAsync

Parameters (3)
playerPlayer
instanceInstance
bodyPartBodyPart
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

ValidateUGCFullBodyAsync

Parameters (2)
playerPlayer
humanoidDescriptionHumanoidDescription
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

Removed members 2

CreateAvatarGenerationSessionAsync

Parameters (1)
playerPlayer
Returns (1)
AvatarGenerationSession
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

Settings