Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AvatarEditorService

This class is not replicated. Its interface does not cross the network boundary.
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.
Tags: [NotCreatable, Service, NotReplicated]

Member index 61

HistoryMember
483CheckApplyDefaultClothing(humanoidDescription: HumanoidDescription): HumanoidDescription
542ConformToAvatarRules(humanoidDescription: HumanoidDescription): HumanoidDescription
544GetAccessoryType(avatarAssetType: AvatarAssetType): AccessoryType
462GetAvatarRules(): Dictionary
462GetBatchItemDetails(itemIds: Array, itemType: AvatarItemType): Array
462GetFavorite(itemId: int64, itemType: AvatarItemType): bool
483GetInventory(assetTypes: Array): InventoryPages
462GetItemDetails(itemId: int64, itemType: AvatarItemType): Dictionary
578GetOutfitDetails(outfitId: int64): Dictionary
539GetOutfits(outfitSource: OutfitSource = All, outfitType: OutfitType = All): OutfitPages
550GetRecommendedAssets(assetType: AvatarAssetType, contextAssetId: int64 = 0): Array
550GetRecommendedBundles(bundleId: int64): Array
607NoPromptCreateOutfit(humanoidDescription: HumanoidDescription, rigType: HumanoidRigType, name: string, gearAssetId: int64 = 0): bool
492NoPromptDeleteOutfit(outfitId: int64): bool
496NoPromptRenameOutfit(outfitId: int64, name: string): bool
484NoPromptSaveAvatar(humanoidDescription: HumanoidDescription, rigType: HumanoidRigType, saveDict: Dictionary, gearAssetId: int64 = 0): bool
564NoPromptSaveAvatarThumbnailCustomization(thumbnailType: AvatarThumbnailCustomizationType, emoteAssetId: int64, cameraDistanceScale: float, yRotDeg: float, fieldOfViewDeg: float = 0): bool
481NoPromptSetFavorite(itemId: int64, itemType: AvatarItemType, shouldFavorite: bool): bool
607NoPromptUpdateOutfit(outfitId: int64, humanoidDescription: HumanoidDescription, rigType: HumanoidRigType, gearAssetId: int64 = 0): bool
573PerformCreateOutfitWithDescription(humanoidDescription: HumanoidDescription, name: string): null
573PerformDeleteOutfit(): null
573PerformRenameOutfit(name: string): null
573PerformSaveAvatarWithDescription(humanoidDescription: HumanoidDescription, addedAssets: Array, removedAssets: Array): null
573PerformSetFavorite(): null
573PerformUpdateOutfit(humanoidDescription: HumanoidDescription): null
573PromptAllowInventoryReadAccess(): null
573PromptCreateOutfit(outfit: HumanoidDescription, rigType: HumanoidRigType): null
573PromptDeleteOutfit(outfitId: int64): null
573PromptRenameOutfit(outfitId: int64): null
573PromptSaveAvatar(humanoidDescription: HumanoidDescription, rigType: HumanoidRigType): null
573PromptSetFavorite(itemId: int64, itemType: AvatarItemType, shouldFavorite: bool): null
573PromptUpdateOutfit(outfitId: int64, updatedOutfit: HumanoidDescription, rigType: HumanoidRigType): null
483SearchCatalog(searchParameters: CatalogSearchParams): CatalogPages
573SetAllowInventoryReadAccess(inventoryReadAccessGranted: bool): null
573SignalCreateOutfitFailed(): null
573SignalCreateOutfitPermissionDenied(): null
573SignalDeleteOutfitFailed(): null
573SignalDeleteOutfitPermissionDenied(): null
573SignalRenameOutfitFailed(): null
573SignalRenameOutfitPermissionDenied(): null
573SignalSaveAvatarFailed(): null
573SignalSaveAvatarPermissionDenied(): null
573SignalSetFavoriteFailed(): null
573SignalSetFavoritePermissionDenied(): null
573SignalUpdateOutfitFailed(): null
573SignalUpdateOutfitPermissionDenied(): null
462OpenAllowInventoryReadAccess()
483OpenPromptCreateOufit(humanoidDescription: HumanoidDescription, rigType: HumanoidRigType)
492OpenPromptDeleteOutfit(outfitId: int64)
496OpenPromptRenameOutfit(outfitId: int64)
483OpenPromptSaveAvatar(humanoidDescription: HumanoidDescription, rigType: HumanoidRigType)
462OpenPromptSetFavorite(itemId: int64, itemType: AvatarItemType, shouldFavorite: bool)
501OpenPromptUpdateOutfit(outfitId: int64, humanoidDescription: HumanoidDescription, rigType: HumanoidRigType)
462PromptAllowInventoryReadAccessCompleted(result: AvatarPromptResult)
482PromptCreateOutfitCompleted(result: AvatarPromptResult, failureType: Variant)
492PromptDeleteOutfitCompleted(result: AvatarPromptResult)
496PromptRenameOutfitCompleted(result: AvatarPromptResult)
484PromptSaveAvatarCompleted(result: AvatarPromptResult, humanoidDescription: HumanoidDescription)
557PromptSaveAvatarThumbnailCustomizationCompleted(result: AvatarPromptResult, failureType: Variant)
462PromptSetFavoriteCompleted(result: AvatarPromptResult)
501PromptUpdateOutfitCompleted(result: AvatarPromptResult)
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
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 5

HistoryMember
550GetRecommendedAssetsV2(assetType: AvatarAssetType, assetId: int64, numItems: int, includeDetails: bool): Array
550GetRecommendedBundlesV2(bundleType: BundleType, bundleId: int64, numItems: int, includeDetails: bool): Array
512PerformCreateOutfit(name: string): void
503PerformSaveAvatar(): void
512PerformSaveAvatarNew(addedAssets: Array, removedAssets: Array): void

History 220

Members 61

CheckApplyDefaultClothing

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

History 7

Tags: [Yields]

ConformToAvatarRules

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

History 7

Tags: [Yields]

GetAccessoryType

Parameters (1)
avatarAssetTypeAvatarAssetType
Returns (1)
AccessoryType

History 1

GetAvatarRules

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

History 2

Tags: [Yields]

GetBatchItemDetails

Parameters (2)
itemIdsArray
itemTypeAvatarItemType
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetFavorite

Parameters (2)
itemIdint64
itemTypeAvatarItemType
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

GetInventory

Parameters (1)
assetTypesArray
Returns (1)
InventoryPages
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

GetItemDetails

Parameters (2)
itemIdint64
itemTypeAvatarItemType
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetOutfitDetails

Parameters (1)
outfitIdint64
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetOutfits

Parameters (2)Default
outfitSourceOutfitSourceAll
outfitTypeOutfitTypeAll
Returns (1)
OutfitPages
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

GetRecommendedAssets

Parameters (2)Default
assetTypeAvatarAssetType
contextAssetIdint640
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

GetRecommendedBundles

Parameters (1)
bundleIdint64
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

NoPromptCreateOutfit

Parameters (4)Default
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
namestring
gearAssetIdint640
Returns (1)
bool

History 3

NoPromptDeleteOutfit

Parameters (1)
outfitIdint64
Returns (1)
bool

History 1

NoPromptRenameOutfit

Parameters (2)
outfitIdint64
namestring
Returns (1)
bool

History 1

NoPromptSaveAvatar

Parameters (4)Default
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
saveDictDictionary
gearAssetIdint640
Returns (1)
bool

History 1

NoPromptSaveAvatarThumbnailCustomization

Parameters (5)Default
thumbnailTypeAvatarThumbnailCustomizationType
emoteAssetIdint64
cameraDistanceScalefloat
yRotDegfloat
fieldOfViewDegfloat0
Returns (1)
bool

History 2

NoPromptSetFavorite

Parameters (3)
itemIdint64
itemTypeAvatarItemType
shouldFavoritebool
Returns (1)
bool

History 1

NoPromptUpdateOutfit

Parameters (4)Default
outfitIdint64
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
gearAssetIdint640
Returns (1)
bool

History 2

OpenAllowInventoryReadAccess

Parameters (0)
No parameters.

History 4

OpenPromptCreateOufit

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType

History 5

OpenPromptDeleteOutfit

Parameters (1)
outfitIdint64

History 1

OpenPromptRenameOutfit

Parameters (1)
outfitIdint64

History 1

OpenPromptSaveAvatar

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType

History 5

OpenPromptSetFavorite

Parameters (3)
itemIdint64
itemTypeAvatarItemType
shouldFavoritebool

History 4

OpenPromptUpdateOutfit

Parameters (3)
outfitIdint64
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType

History 1

PerformCreateOutfitWithDescription

Parameters (2)
humanoidDescriptionHumanoidDescription
namestring
Returns (1)
null

History 6

PerformDeleteOutfit

Parameters (0)
No parameters.
Returns (1)
null

History 2

PerformRenameOutfit

Parameters (1)
namestring
Returns (1)
null

History 2

PerformSaveAvatarWithDescription

Parameters (3)
humanoidDescriptionHumanoidDescription
addedAssetsArray
removedAssetsArray
Returns (1)
null

History 6

PerformSetFavorite

Parameters (0)
No parameters.
Returns (1)
null

History 5

PerformUpdateOutfit

Parameters (1)
humanoidDescriptionHumanoidDescription
Returns (1)
null

History 2

PromptAllowInventoryReadAccess

Parameters (0)
No parameters.
Returns (1)
null

History 5

PromptAllowInventoryReadAccessCompleted

Parameters (1)
resultAvatarPromptResult

History 4

PromptCreateOutfit

Parameters (2)
outfitHumanoidDescription
rigTypeHumanoidRigType
Returns (1)
null

History 6

PromptCreateOutfitCompleted

Parameters (2)
resultAvatarPromptResult
failureTypeVariant

History 5

PromptDeleteOutfit

Parameters (1)
outfitIdint64
Returns (1)
null

History 2

PromptDeleteOutfitCompleted

Parameters (1)
resultAvatarPromptResult

History 1

PromptRenameOutfit

Parameters (1)
outfitIdint64
Returns (1)
null

History 2

PromptRenameOutfitCompleted

Parameters (1)
resultAvatarPromptResult

History 1

PromptSaveAvatar

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
Returns (1)
null

History 6

PromptSaveAvatarCompleted

Parameters (2)
resultAvatarPromptResult
humanoidDescriptionHumanoidDescription

History 5

PromptSaveAvatarThumbnailCustomizationCompleted

Parameters (2)
resultAvatarPromptResult
failureTypeVariant

History 1

PromptSetFavorite

Parameters (3)
itemIdint64
itemTypeAvatarItemType
shouldFavoritebool
Returns (1)
null

History 5

PromptSetFavoriteCompleted

Parameters (1)
resultAvatarPromptResult

History 4

PromptUpdateOutfit

Parameters (3)
outfitIdint64
updatedOutfitHumanoidDescription
rigTypeHumanoidRigType
Returns (1)
null

History 2

PromptUpdateOutfitCompleted

Parameters (1)
resultAvatarPromptResult

History 1

SearchCatalog

Parameters (1)
searchParametersCatalogSearchParams
Returns (1)
CatalogPages
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

SetAllowInventoryReadAccess

Parameters (1)
inventoryReadAccessGrantedbool
Returns (1)
null

History 5

SignalCreateOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalCreateOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalDeleteOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null

History 2

SignalDeleteOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 2

SignalRenameOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null

History 2

SignalRenameOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 2

SignalSaveAvatarFailed

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalSaveAvatarPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalSetFavoriteFailed

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalSetFavoritePermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 5

SignalUpdateOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null

History 2

SignalUpdateOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null

History 2

Removed members 5

GetRecommendedAssetsV2

Parameters (4)
assetTypeAvatarAssetType
assetIdint64
numItemsint
includeDetailsbool
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetRecommendedBundlesV2

Parameters (4)
bundleTypeBundleType
bundleIdint64
numItemsint
includeDetailsbool
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

PerformCreateOutfit

Parameters (1)
namestring
Returns (1)
void

History 5

PerformSaveAvatar

Parameters (0)
No parameters.
Returns (1)
void

History 5

PerformSaveAvatarNew

Parameters (2)
addedAssetsArray
removedAssetsArray
Returns (1)
void

History 3

Settings