AvatarEditorService

Show Deprecated
Not Creatable
Service
Not Replicated

Summary

Properties

Methods

GetAccessoryType

Parameters

avatarAssetType: Enum.AvatarAssetType
Default Value: ""

Returns

PromptAllowInventoryReadAccess

()

Returns

()

PromptCreateOutfit

()

Parameters

Default Value: ""
Default Value: ""

Returns

()

PromptDeleteOutfit

()

Parameters

outfitId: number
Default Value: ""

Returns

()

PromptRenameOutfit

()

Parameters

outfitId: number
Default Value: ""

Returns

()

PromptSaveAvatar

()

Parameters

humanoidDescription: HumanoidDescription
Default Value: ""
Default Value: ""

Returns

()

PromptSetFavorite

()

Parameters

itemId: number
Default Value: ""
Default Value: ""
shouldFavorite: boolean
Default Value: ""

Returns

()

PromptUpdateOutfit

()

Parameters

outfitId: number
Default Value: ""
updatedOutfit: HumanoidDescription
Default Value: ""
Default Value: ""

Returns

()

CheckApplyDefaultClothing

Yields

Parameters

humanoidDescription: HumanoidDescription
Default Value: ""

Returns

ConformToAvatarRules

Yields

Parameters

humanoidDescription: HumanoidDescription
Default Value: ""

Returns

GetAvatarRules

Yields

Returns

GetBatchItemDetails

Yields

Parameters

itemIds: Array
Default Value: ""
Default Value: ""

Returns

GetFavorite

Yields

Parameters

itemId: number
Default Value: ""
Default Value: ""

Returns

GetInventory

Yields

Parameters

assetTypes: Array
Default Value: ""

Returns

GetItemDetails

Yields

Parameters

itemId: number
Default Value: ""
Default Value: ""

Returns

GetOutfitDetails

Yields

Parameters

outfitId: number
Default Value: ""

Returns

GetOutfits

Yields

Parameters

outfitSource: Enum.OutfitSource
Default Value: "All"
outfitType: Enum.OutfitType
Default Value: "All"

Returns

GetRecommendedAssets

Yields

Parameters

Default Value: ""
contextAssetId: number
Default Value: 0

Returns

Code Samples

Getting a Hat Recommendation

local AvatarEditorService = game:GetService("AvatarEditorService")
local assets = AvatarEditorService:GetRecommendedAssets(Enum.AvatarAssetType.Hat, 9255093)
for _, asset in ipairs(assets) do
print(asset.Item.Name)
end

GetRecommendedBundles

Yields

Parameters

bundleId: number
Default Value: ""

Returns

SearchCatalog

Yields

Parameters

searchParameters: CatalogSearchParams
Default Value: ""

Returns

Events

PromptAllowInventoryReadAccessCompleted

Parameters


PromptCreateOutfitCompleted

Parameters

failureType: Variant

PromptDeleteOutfitCompleted

Parameters


PromptRenameOutfitCompleted

Parameters


PromptSaveAvatarCompleted

Parameters

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Parameters


PromptUpdateOutfitCompleted

Parameters