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 category | Instances |
|---|
Member index 26
Removed member index 2
| History | Member | |
|---|---|---|
| 641 | CreateAvatarGenerationSessionAsync(player: Player): AvatarGenerationSession |
Description
History 37
- 648 Change ReturnType of LoadAvatarPreviewImageAsync from EditableImage to Object
- 648 Add DeserializeAvatarModel
- 647 Change Parameters of UgcValidationSuccess from (guid: string, serializedModel: string) to (guid: string, serializedModel: string, price: int64)
- 647 Change Parameters of PromptCreateAvatarAsync from (player: Player, humanoidDescription: HumanoidDescription) to (tokenId: string, player: Player, humanoidDescription: HumanoidDescription)
- 646 Add GetBatchTokenDetailsAsync
- 646 Change Parameters of GenerateAvatarPreviewAsync2 from (sessionId: string, fileId: string, textPrompt: string) to (sessionId: string, fileId: string, textPrompt: string, options: Dictionary)
- 645 Add
- 645 Add
- 645 Add PromptSelectAvatarGenerationImageAsync
- 642 Add
- 642 Add
- 641 Add RequestAvatarGenerationSessionAsync
- 641 Add LoadAvatarHumanoidDescriptionAsync
- 641 Add GenerateAvatarPreviewAsync2
- 641 Add GenerateAvatarAsync
- 641 Remove CreateAvatarGenerationSessionAsync
- 640 Add GetValidationRules
- 638 Add GenerateAvatarPreviewAsync
- 638 Add GenerateAvatarModelAsync
- 627 Add ValidateUGCFullBodyAsync
- 627 Add ValidateUGCBodyPartAsync
- 627 Add ValidateUGCAccessoryAsync
- 626 Add SendAnalyticsEvent
- 624 Add GetAvatarGenerationConfig
- 622 Remove
- 622 Add
- 622 Add CreateAvatarGenerationSessionAsync
- 620 Add
- 620 Change Parameters of from (serializedModel: string, bufferMap: Dictionary) to (id: string, serializedModel: string, bufferMap: Dictionary)
- 620 Add LoadAvatarPreviewImageAsync
- 620 Add LoadAvatarModelAsync
- 618 Add
- 607 Add UgcValidationSuccess
- 607 Add UgcValidationFailure
- 607 Change Tags of AvatarCreationService from [NotCreatable, Service, NotReplicated] to [NotCreatable, Service]
- 597 Add PromptCreateAvatarAsync
- 597 Add AvatarCreationService
Members 26
DeserializeAvatarModel
| Parameters (1) | ||
|---|---|---|
| serializedModel | string | |
| Returns (1) | ||
| Instance | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GenerateAvatarAsync
| Parameters (2) | ||
|---|---|---|
| sessionId | string | |
| previewId | string | |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GenerateAvatarModelAsync
| Parameters (4) | ||
|---|---|---|
| player | Player | |
| previewJobId | string | |
| options | Dictionary | |
| progressCallback | Function | |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GenerateAvatarPreviewAsync
| Parameters (4) | ||
|---|---|---|
| player | Player | |
| textPrompt | string | |
| options | Dictionary | |
| progressCallback | Function | |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GenerateAvatarPreviewAsync2
| Parameters (4) | ||
|---|---|---|
| sessionId | string | |
| fileId | string | |
| textPrompt | string | |
| options | Dictionary | |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 646 Change Parameters of GenerateAvatarPreviewAsync2 from (sessionId: string, fileId: string, textPrompt: string) to (sessionId: string, fileId: string, textPrompt: string, options: Dictionary)
- 641 Add GenerateAvatarPreviewAsync2
GetAvatarGenerationConfig
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GetBatchTokenDetailsAsync
| Parameters (1) | ||
|---|---|---|
| tokenIds | Array | |
| Returns (1) | ||
| Array | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GetValidationRules
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
This function has a custom internal state. It may behave in a non-standard way.
| Thread safety | Unsafe |
|---|
History 1
LoadAvatarHumanoidDescriptionAsync
| Parameters (1) | ||
|---|---|---|
| id | string | |
| Returns (1) | ||
| HumanoidDescription | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
LoadAvatarModelAsync
| Parameters (1) | ||
|---|---|---|
| id | string | |
| Returns (1) | ||
| Instance | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
LoadAvatarPreviewImageAsync
| Parameters (1) | ||
|---|---|---|
| avatarPreview | string | |
| Returns (1) | ||
| Object | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 648 Change ReturnType of LoadAvatarPreviewImageAsync from EditableImage to Object
- 620 Add LoadAvatarPreviewImageAsync
PromptCreateAvatarAsync
| Parameters (3) | ||
|---|---|---|
| tokenId | string | |
| player | Player | |
| humanoidDescription | HumanoidDescription | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 647 Change Parameters of PromptCreateAvatarAsync from (player: Player, humanoidDescription: HumanoidDescription) to (tokenId: string, player: Player, humanoidDescription: HumanoidDescription)
- 597 Add PromptCreateAvatarAsync
PromptSelectAvatarGenerationImageAsync
| Parameters (1) | ||
|---|---|---|
| player | Player | |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
RequestAvatarGenerationSessionAsync
| Parameters (2) | ||
|---|---|---|
| player | Player | |
| callback | Function | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
SendAnalyticsEvent
| Parameters (2) | ||
|---|---|---|
| eventName | string | |
| params | Dictionary | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
UgcValidationFailure
| Parameters (2) | |
|---|---|
| guid | string |
| errorMessage | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
UgcValidationSuccess
| Parameters (3) | |
|---|---|
| guid | string |
| serializedModel | string |
| price | int64 |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 647 Change Parameters of UgcValidationSuccess from (guid: string, serializedModel: string) to (guid: string, serializedModel: string, price: int64)
- 607 Add UgcValidationSuccess
ValidateUGCAccessoryAsync
| Parameters (3) | ||
|---|---|---|
| player | Player | |
| accessory | Instance | |
| accessoryType | AccessoryType | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
ValidateUGCBodyPartAsync
| Parameters (3) | ||
|---|---|---|
| player | Player | |
| instance | Instance | |
| bodyPart | BodyPart | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
ValidateUGCFullBodyAsync
| Parameters (2) | ||
|---|---|---|
| player | Player | |
| humanoidDescription | HumanoidDescription | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
Removed members 2
CreateAvatarGenerationSessionAsync
| Parameters (1) | ||
|---|---|---|
| player | Player | |
| Returns (1) | ||
| AvatarGenerationSession | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|