Roblox API Reference

AvatarEditorService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Member index (57)

Type Member History
HumanoidDescription CheckApplyDefaultClothing (HumanoidDescription humanoidDescription) 459 458 459 460 483 483
HumanoidDescription ConformToAvatarRules (HumanoidDescription humanoidDescription) 459 458 459 483 483
Dictionary GetAvatarRules ()
Array GetBatchItemDetails (Array itemIds, AvatarItemType itemType) 460
bool GetFavorite (int64 itemId, AvatarItemType itemType) 453 452 454
InventoryPages GetInventory (Array assetTypes) 453 452 454 483
Dictionary GetItemDetails (int64 itemId, AvatarItemType itemType) 451
OutfitPages GetOutfits (OutfitSource outfitSource = All) 453 452 454 481 483
Array GetRecommendedAssets (AvatarAssetType assetType, int64 contextAssetId = 0)
Array GetRecommendedBundles (int64 bundleId)
bool NoPromptCreateOutfit (HumanoidDescription humanoidDescription, HumanoidRigType rigType, string name) 481 483
bool NoPromptDeleteOutfit (int64 outfitId) 492
bool NoPromptRenameOutfit (int64 outfitId, string name) 496
bool NoPromptSaveAvatar (HumanoidDescription humanoidDescription, HumanoidRigType rigType, Dictionary saveDict, int64 gearAssetId = 0) 484
bool NoPromptSetFavorite (int64 itemId, AvatarItemType itemType, bool shouldFavorite) 481
bool NoPromptUpdateOutfit (int64 outfitId, HumanoidDescription humanoidDescription, HumanoidRigType rigType) 501
void PerformCreateOutfitWithDescription (HumanoidDescription humanoidDescription, string name) 459 458 459 483
void PerformDeleteOutfit () 492
void PerformRenameOutfit (string name) 496
void PerformSaveAvatarWithDescription (HumanoidDescription humanoidDescription, Array addedAssets, Array removedAssets) 459 458 459 483
void PerformSetFavorite () 453 452 454
void PerformUpdateOutfit (HumanoidDescription humanoidDescription) 501
void PromptAllowInventoryReadAccess () 453 452 454
void PromptCreateOutfit (HumanoidDescription outfit, HumanoidRigType rigType) 453 452 454 483
void PromptDeleteOutfit (int64 outfitId) 492
void PromptRenameOutfit (int64 outfitId) 496
void PromptSaveAvatar (HumanoidDescription humanoidDescription, HumanoidRigType rigType) 453 452 454 483
void PromptSetFavorite (int64 itemId, AvatarItemType itemType, bool shouldFavorite) 453 452 454
void PromptUpdateOutfit (int64 outfitId, HumanoidDescription updatedOutfit, HumanoidRigType rigType) 501
CatalogPages SearchCatalog (CatalogSearchParams searchParameters) 451 483
void SetAllowInventoryReadAccess (bool inventoryReadAccessGranted) 453 452 454
void SignalCreateOutfitFailed () 459 458 459
void SignalCreateOutfitPermissionDenied () 453 452 454
void SignalDeleteOutfitFailed () 492
void SignalDeleteOutfitPermissionDenied () 492
void SignalRenameOutfitFailed () 496
void SignalRenameOutfitPermissionDenied () 496
void SignalSaveAvatarFailed () 453 452 454
void SignalSaveAvatarPermissionDenied () 453 452 454
void SignalSetFavoriteFailed () 453 452 454
void SignalSetFavoritePermissionDenied () 453 452 454
void SignalUpdateOutfitFailed () 501
void SignalUpdateOutfitPermissionDenied () 501
OpenAllowInventoryReadAccess () 453 452 454
OpenPromptCreateOufit (HumanoidDescription humanoidDescription, HumanoidRigType rigType) 453 452 454 483
OpenPromptDeleteOutfit (int64 outfitId) 492
OpenPromptRenameOutfit (int64 outfitId) 496
OpenPromptSaveAvatar (HumanoidDescription humanoidDescription, HumanoidRigType rigType) 453 452 454 483
OpenPromptSetFavorite (int64 itemId, AvatarItemType itemType, bool shouldFavorite) 453 452 454
OpenPromptUpdateOutfit (int64 outfitId, HumanoidDescription humanoidDescription, HumanoidRigType rigType) 501
PromptAllowInventoryReadAccessCompleted (AvatarPromptResult result) 453 452 454
PromptCreateOutfitCompleted (AvatarPromptResult result, Variant failureType) 453 452 454 482
PromptDeleteOutfitCompleted (AvatarPromptResult result) 492
PromptRenameOutfitCompleted (AvatarPromptResult result) 496
PromptSaveAvatarCompleted (AvatarPromptResult result, HumanoidDescription humanoidDescription) 453 452 454 484
PromptSetFavoriteCompleted (AvatarPromptResult result) 453 452 454
PromptUpdateOutfitCompleted (AvatarPromptResult result) 501
51 members inherited from Instance

Removed member index (3)

Type Member History
void PerformCreateOutfit (string name) 453 452 454 512
void PerformSaveAvatar () 453 452 454 503
void PerformSaveAvatarNew (Array addedAssets, Array removedAssets) 454 512

History

Members

CheckApplyDefaultClothing On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
humanoidDescription HumanoidDescription none

History

Tags: [Yields]

ConformToAvatarRules On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
humanoidDescription HumanoidDescription none

History

Tags: [Yields]

GetAvatarRules On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

Tags: [Yields]

GetBatchItemDetails On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
itemIds Array none
itemType AvatarItemType none

History

Tags: [Yields]

GetFavorite On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
itemId int64 none
itemType AvatarItemType none

History

Tags: [Yields]

GetInventory On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
assetTypes Array none

History

Tags: [Yields]

GetItemDetails On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
itemId int64 none
itemType AvatarItemType none

History

Tags: [Yields]

GetOutfits On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
outfitSource OutfitSource All

History

Tags: [Yields]

GetRecommendedAssets On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
assetType AvatarAssetType none
contextAssetId int64 0

Tags: [Yields]

GetRecommendedBundles On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
bundleId int64 none

Tags: [Yields]

NoPromptCreateOutfit On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none
name string none

History

NoPromptDeleteOutfit On DevHub

Name Type Default
outfitId int64 none

History

NoPromptRenameOutfit On DevHub

Name Type Default
outfitId int64 none
name string none

History

NoPromptSaveAvatar On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none
saveDict Dictionary none
gearAssetId int64 0

History

NoPromptSetFavorite On DevHub

Name Type Default
itemId int64 none
itemType AvatarItemType none
shouldFavorite bool none

History

NoPromptUpdateOutfit On DevHub

Name Type Default
outfitId int64 none
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none

History

OpenAllowInventoryReadAccess On DevHub

Name Type Default
No parameters.

History

OpenPromptCreateOufit On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none

History

OpenPromptDeleteOutfit On DevHub

Name Type Default
outfitId int64 none

History

OpenPromptRenameOutfit On DevHub

Name Type Default
outfitId int64 none

History

OpenPromptSaveAvatar On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none

History

OpenPromptSetFavorite On DevHub

Name Type Default
itemId int64 none
itemType AvatarItemType none
shouldFavorite bool none

History

OpenPromptUpdateOutfit On DevHub

Name Type Default
outfitId int64 none
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none

History

PerformCreateOutfitWithDescription On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
name string none

History

PerformDeleteOutfit On DevHub

Name Type Default
No parameters.

History

PerformRenameOutfit On DevHub

Name Type Default
name string none

History

PerformSaveAvatarWithDescription On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
addedAssets Array none
removedAssets Array none

History

PerformSetFavorite On DevHub

Name Type Default
No parameters.

History

PerformUpdateOutfit On DevHub

Name Type Default
humanoidDescription HumanoidDescription none

History

PromptAllowInventoryReadAccess On DevHub

Name Type Default
No parameters.

History

PromptAllowInventoryReadAccessCompleted On DevHub

Name Type Default
result AvatarPromptResult none

History

PromptCreateOutfit On DevHub

Name Type Default
outfit HumanoidDescription none
rigType HumanoidRigType none

History

PromptCreateOutfitCompleted On DevHub

Name Type Default
result AvatarPromptResult none
failureType Variant none

History

PromptDeleteOutfit On DevHub

Name Type Default
outfitId int64 none

History

PromptDeleteOutfitCompleted On DevHub

Name Type Default
result AvatarPromptResult none

History

PromptRenameOutfit On DevHub

Name Type Default
outfitId int64 none

History

PromptRenameOutfitCompleted On DevHub

Name Type Default
result AvatarPromptResult none

History

PromptSaveAvatar On DevHub

Name Type Default
humanoidDescription HumanoidDescription none
rigType HumanoidRigType none

History

PromptSaveAvatarCompleted On DevHub

Name Type Default
result AvatarPromptResult none
humanoidDescription HumanoidDescription none

History

PromptSetFavorite On DevHub

Name Type Default
itemId int64 none
itemType AvatarItemType none
shouldFavorite bool none

History

PromptSetFavoriteCompleted On DevHub

Name Type Default
result AvatarPromptResult none

History

PromptUpdateOutfit On DevHub

Name Type Default
outfitId int64 none
updatedOutfit HumanoidDescription none
rigType HumanoidRigType none

History

PromptUpdateOutfitCompleted On DevHub

Name Type Default
result AvatarPromptResult none

History

SearchCatalog On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
searchParameters CatalogSearchParams none

History

Tags: [Yields]

SetAllowInventoryReadAccess On DevHub

Name Type Default
inventoryReadAccessGranted bool none

History

SignalCreateOutfitFailed On DevHub

Name Type Default
No parameters.

History

SignalCreateOutfitPermissionDenied On DevHub

Name Type Default
No parameters.

History

SignalDeleteOutfitFailed On DevHub

Name Type Default
No parameters.

History

SignalDeleteOutfitPermissionDenied On DevHub

Name Type Default
No parameters.

History

SignalRenameOutfitFailed On DevHub

Name Type Default
No parameters.

History

SignalRenameOutfitPermissionDenied On DevHub

Name Type Default
No parameters.

History

SignalSaveAvatarFailed On DevHub

Name Type Default
No parameters.

History

SignalSaveAvatarPermissionDenied On DevHub

Name Type Default
No parameters.

History

SignalSetFavoriteFailed On DevHub

Name Type Default
No parameters.

History

SignalSetFavoritePermissionDenied On DevHub

Name Type Default
No parameters.

History

SignalUpdateOutfitFailed On DevHub

Name Type Default
No parameters.

History

SignalUpdateOutfitPermissionDenied On DevHub

Name Type Default
No parameters.

History

Removed members

PerformCreateOutfit

Name Type Default
name string none

History

PerformSaveAvatar

Name Type Default
No parameters.

History

PerformSaveAvatarNew

Name Type Default
addedAssets Array none
removedAssets Array none

History

Relevant classes (4)

Relevant enums (5)