# AvatarEditorService

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/AvatarEditorService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService

A service to support developer Avatar Editors.

## Methods

### BustAvatarFetchCache

```luau
AvatarEditorService:BustAvatarFetchCache()
```

- Tags: Roblox script security

### CheckApplyDefaultClothingAsync

```luau
AvatarEditorService:CheckApplyDefaultClothingAsync(humanoidDescription: HumanoidDescription): HumanoidDescription
```

- Tags: Yields, Capabilities: AvatarAppearance

Used to apply default clothing to the [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) if necessary.

Parameters:

- `humanoidDescription`: The HumanoidDescription to check if default clothing is required.

Returns: Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.

### ConformToAvatarRulesAsync

```luau
AvatarEditorService:ConformToAvatarRulesAsync(humanoidDescription: HumanoidDescription): HumanoidDescription
```

- Tags: Yields, Capabilities: AvatarAppearance

Returns a copy of the given [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) that conforms to the platform Avatar rules.

Parameters:

- `humanoidDescription`: The [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) to conform.

Returns: A new [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) that conforms to the platform Avatar rules.

### GetAccessoryType

```luau
AvatarEditorService:GetAccessoryType(avatarAssetType: Enum.AvatarAssetType): Enum.AccessoryType
```

Returns the `AccessoryType` that corresponds to the given `AvatarAssetType`.

Parameters:

- `avatarAssetType`: The `AvatarAssetType` to convert to its corresponding `AccessoryType`.

Returns: The `AccessoryType` corresponding to the given `AvatarAssetType`, or `AccessoryType.Unknown` if the asset type has no matching accessory type.

### GetAvatarRulesAsync

```luau
AvatarEditorService:GetAvatarRulesAsync(): { [string]: any }
```

- Tags: Yields

Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.

Returns: A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.

### GetBatchItemDetailsAsync

```luau
AvatarEditorService:GetBatchItemDetailsAsync(itemIds: { any }, itemType: Enum.AvatarItemType): { any }
```

- Tags: Yields, Capabilities: AssetRead

Gets the item details for a list of items at once.

Parameters:

- `itemIds`: The list of item ids to get details of.
- `itemType`: The type of the item ids provided.

Returns: Returns an array of item details.

### GetBundlesByAssetIdAsync

```luau
AvatarEditorService:GetBundlesByAssetIdAsync(assetId: number, limit: number? = 10): CatalogPages
```

- Tags: Yields, Capabilities: AssetRead

Returns a [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing bundles that include the given asset.

Parameters:

- `assetId`: The ID of the asset to find bundles for.
- `limit`: The number of results per page. Accepts `10`, `25`, `50`, and `100`.

Returns: A [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing bundles that include the given asset.

### GetFavoriteAsync

```luau
AvatarEditorService:GetFavoriteAsync(itemId: number, itemType: Enum.AvatarItemType): boolean
```

- Tags: Yields, Capabilities: AssetRead + Players

Returns if the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) has favorited the given bundle or asset.

Parameters:

- `itemId`: The ID of the specified asset or bundle.
- `itemType`: The `AvatarItemType` of the specified asset or bundle.

Returns: Whether the `LocalPlayer` has favorited the given bundle or asset.

### GetHeadShapesAsync

```luau
AvatarEditorService:GetHeadShapesAsync(): { any }
```

- Tags: Yields, Capabilities: AssetRead + Players

Returns an array of head shape names that the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) owns.

Returns: An array of strings, each identifying a head shape owned by [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md). Possible values include: `"Blockhead"`, `"Cheeks"`, `"Chiseled"`, `"ClassicFemaleV2"`, `"ClassicMaleV2"`, `"CoolThing"`, `"Default"`, `"EraserHead"`, `"FatHead"`, `"FlatTop"`, `"GoldenKorbloxGeneral"`, `"GoldenMrRobot"`, `"KnightOfChivalry"`, `"KnightOfCourage"`, `"ManHead"`, `"MercilessNinja"`, `"MrToilet"`, `"Narrow"`, `"NeoClassicFemaleV2"`, `"NeoClassicMaleV2"`, `"Paragon"`, `"Peabrain"`, `"Perfection"`, `"RobloxClassic"`, `"Roll"`, `"Roundy"`, `"RoxBox"`, `"StrongJaw"`, `"TheEngineer"`, `"Trim"`, `"WomanHead"`.

### GetInventoryAsync

```luau
AvatarEditorService:GetInventoryAsync(assetTypes: { any }): InventoryPages
```

- Tags: Yields, Capabilities: AssetRead + Players

Returns an [`InventoryPages`](https://rapi.sleaze.dev/classes/InventoryPages.md) object with information about owned items in the users inventory with the given AvatarAssetTypes.

Parameters:

- `assetTypes`: The `AvatarAssetType` that can will be checked for in the player's inventory.

Returns: An [`InventoryPages`](https://rapi.sleaze.dev/classes/InventoryPages.md) object containing information about owned items matching the given asset types.

### GetItemDetailsAsync

```luau
AvatarEditorService:GetItemDetailsAsync(itemId: number, itemType: Enum.AvatarItemType): { [string]: any }
```

- Tags: Yields, Capabilities: AssetRead

Returns the item details for the given item.

Parameters:

- `itemId`: The ID of the item whose details are being retrieved.
- `itemType`: An enum value indicating the type of item whose details are being retrieved.

Returns: A table containing the item info for the retrieved item.

### GetOutfitDetailsAsync

```luau
AvatarEditorService:GetOutfitDetailsAsync(outfitId: number): { [string]: any }
```

- Tags: Yields, Capabilities: AssetRead

Returns the outfit details for the given outfit.

Parameters:

- `outfitId`: The ID of the outfit whose details are being retrieved.

Returns: A table containing the outfit info for the retrieved outfit. See above for a sample table.

### GetOutfitsAsync

```luau
AvatarEditorService:GetOutfitsAsync(outfitSource: Enum.OutfitSource? = Enum.OutfitSource.All, outfitType: Enum.OutfitType? = Enum.OutfitType.All): OutfitPages
```

- Tags: Yields, Capabilities: AssetRead + Players

Returns outfit data for the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md).

Parameters:

- `outfitSource`: An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
- `outfitType`: An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.

Returns: An [`OutfitPages`](https://rapi.sleaze.dev/classes/OutfitPages.md) object containing the outfit data for the local player.

### GetRecommendedAssetsAsync

```luau
AvatarEditorService:GetRecommendedAssetsAsync(assetType: Enum.AvatarAssetType, contextAssetId: number? = 0): { any }
```

- Tags: Yields, Capabilities: AssetRead

Returns a list of recommended assets based on a given `AssetType` and asset ID.

Parameters:

- `assetType`: The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
- `contextAssetId`: The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.

Returns: A list of recommendations based on the given `AssetType`.

### GetRecommendedBundlesAsync

```luau
AvatarEditorService:GetRecommendedBundlesAsync(bundleId: number): { any }
```

- Tags: Yields, Capabilities: AssetRead

Returns a list of recommended bundles for a given bundle id.

Parameters:

- `bundleId`: A list of recommended bundles.

Returns: The bundle ID that the recommended bundles will be returned for.

### NoPromptApplyProfileConfiguration

```luau
AvatarEditorService:NoPromptApplyProfileConfiguration(profileConfiguration: { [string]: any }): boolean
```

- Tags: Roblox script security

### NoPromptCreateOutfit

```luau
AvatarEditorService:NoPromptCreateOutfit(humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType, name: string, gearAssetId: number? = 0, outfitOptions: { [string]: any }? = nil, outfitType: any): boolean
```

- Tags: Roblox script security

### NoPromptDeleteOutfit

```luau
AvatarEditorService:NoPromptDeleteOutfit(outfitId: number): boolean
```

- Tags: Roblox script security

### NoPromptRenameOutfit

```luau
AvatarEditorService:NoPromptRenameOutfit(outfitId: number, name: string): boolean
```

- Tags: Roblox script security

### NoPromptSaveAvatar

```luau
AvatarEditorService:NoPromptSaveAvatar(humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType, saveDict: { [string]: any }, gearAssetId: number? = 0, profileConfiguration: { [string]: any }? = nil): boolean
```

- Tags: Roblox script security

### NoPromptSaveAvatarThumbnailCustomization

```luau
AvatarEditorService:NoPromptSaveAvatarThumbnailCustomization(thumbnailType: Enum.AvatarThumbnailCustomizationType, emoteAssetId: number, cameraDistanceScale: number, yRotDeg: number, fieldOfViewDeg: number? = 0): boolean
```

- Tags: Roblox script security

### NoPromptSetFavorite

```luau
AvatarEditorService:NoPromptSetFavorite(itemId: number, itemType: Enum.AvatarItemType, shouldFavorite: boolean): boolean
```

- Tags: Roblox script security

### NoPromptUpdateOutfit

```luau
AvatarEditorService:NoPromptUpdateOutfit(outfitId: number, humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType, gearAssetId: number? = 0, outfitOptions: { [string]: any }? = nil): boolean
```

- Tags: Roblox script security

### PerformCreateOutfitWithDescription

```luau
AvatarEditorService:PerformCreateOutfitWithDescription(humanoidDescription: HumanoidDescription, name: string, profileConfiguration: { [string]: any }? = nil)
```

- Tags: Roblox script security

### PerformDeleteOutfit

```luau
AvatarEditorService:PerformDeleteOutfit()
```

- Tags: Roblox script security

### PerformRenameOutfit

```luau
AvatarEditorService:PerformRenameOutfit(name: string)
```

- Tags: Roblox script security

### PerformSaveAvatarWithDescription

```luau
AvatarEditorService:PerformSaveAvatarWithDescription(humanoidDescription: HumanoidDescription, addedAssets: { any }, removedAssets: { any })
```

- Tags: Roblox script security

### PerformSetFavorite

```luau
AvatarEditorService:PerformSetFavorite()
```

- Tags: Roblox script security

### PerformUpdateOutfit

```luau
AvatarEditorService:PerformUpdateOutfit(humanoidDescription: HumanoidDescription, profileConfiguration: { [string]: any }? = nil)
```

- Tags: Roblox script security

### PromptAllowInventoryReadAccess

```luau
AvatarEditorService:PromptAllowInventoryReadAccess()
```

- Tags: Capabilities: AssetRead + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to allow the developer to read what items the user has in their inventory and other avatar editor related information.

### PromptCreateOutfit

```luau
AvatarEditorService:PromptCreateOutfit(outfit: HumanoidDescription, rigType: Enum.HumanoidRigType, outfitOptions: { [string]: any }? = nil, outfitType: any)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to save the given [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) as an outfit.

Parameters:

- `outfit`: The `Outfit` that the player will be prompted to created.
- `rigType`: The `HumanoidRigType` that the outfit will be created for if the player confirms the prompt.
- `outfitOptions`: Reserved for future options. Must be empty or omitted.
- `outfitType`: Optional `OutfitType`. Only `Avatar` and `Makeup` values are accepted. When omitted, the type is inferred from the description.

### PromptDeleteOutfit

```luau
AvatarEditorService:PromptDeleteOutfit(outfitId: number)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to delete the given outfit.

Parameters:

- `outfitId`: The outfitId of the outfit to delete.

### PromptRenameOutfit

```luau
AvatarEditorService:PromptRenameOutfit(outfitId: number)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to rename the given outfit.

Parameters:

- `outfitId`: The outfitId of the outfit to rename.

### PromptSaveAvatar

```luau
AvatarEditorService:PromptSaveAvatar(humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to update their avatar based on the given [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) and `HumanoidRigType` of R6 or R15.

Parameters:

- `humanoidDescription`: The given [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) being prompted to save.
- `rigType`: The `HumanoidRigType` that the avatar will be saved for if the player confirms the prompt.

### PromptSetFavorite

```luau
AvatarEditorService:PromptSetFavorite(itemId: number, itemType: Enum.AvatarItemType, shouldFavorite: boolean)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to favorite or unfavorite the given asset or bundle.

Parameters:

- `itemId`: The ItemId of the item being prompted to favorite.
- `itemType`: The type of item being prompted to favorite.
- `shouldFavorite`: Whether to favorite (`true`) or unfavorite (`false`) the item.

### PromptUpdateOutfit

```luau
AvatarEditorService:PromptUpdateOutfit(outfitId: number, updatedOutfit: HumanoidDescription, rigType: Enum.HumanoidRigType)
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Prompts the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) to update the given outfit.

Parameters:

- `outfitId`: The outfitId of the outfit to update.
- `updatedOutfit`: A [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) that represents the new outfit data.
- `rigType`: The `HumanoidRigType` to update the outfit to.

### SearchCatalogAsync

```luau
AvatarEditorService:SearchCatalogAsync(searchParameters: CatalogSearchParams): CatalogPages
```

- Tags: Yields, Capabilities: AssetRead

Returns a [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing the result of the given search.

Parameters:

- `searchParameters`: An object containing the parameters used for the search.

Returns: A [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing the search results.

### SetAllowInventoryReadAccess

```luau
AvatarEditorService:SetAllowInventoryReadAccess(inventoryReadAccessGranted: boolean)
```

- Tags: Roblox script security

### SignalCreateOutfitFailed

```luau
AvatarEditorService:SignalCreateOutfitFailed()
```

- Tags: Roblox script security

### SignalCreateOutfitPermissionDenied

```luau
AvatarEditorService:SignalCreateOutfitPermissionDenied()
```

- Tags: Roblox script security

### SignalDeleteOutfitFailed

```luau
AvatarEditorService:SignalDeleteOutfitFailed()
```

- Tags: Roblox script security

### SignalDeleteOutfitPermissionDenied

```luau
AvatarEditorService:SignalDeleteOutfitPermissionDenied()
```

- Tags: Roblox script security

### SignalRenameOutfitFailed

```luau
AvatarEditorService:SignalRenameOutfitFailed()
```

- Tags: Roblox script security

### SignalRenameOutfitPermissionDenied

```luau
AvatarEditorService:SignalRenameOutfitPermissionDenied()
```

- Tags: Roblox script security

### SignalSaveAvatarFailed

```luau
AvatarEditorService:SignalSaveAvatarFailed()
```

- Tags: Roblox script security

### SignalSaveAvatarPermissionDenied

```luau
AvatarEditorService:SignalSaveAvatarPermissionDenied()
```

- Tags: Roblox script security

### SignalSetFavoriteFailed

```luau
AvatarEditorService:SignalSetFavoriteFailed()
```

- Tags: Roblox script security

### SignalSetFavoritePermissionDenied

```luau
AvatarEditorService:SignalSetFavoritePermissionDenied()
```

- Tags: Roblox script security

### SignalUpdateOutfitFailed

```luau
AvatarEditorService:SignalUpdateOutfitFailed()
```

- Tags: Roblox script security

### SignalUpdateOutfitPermissionDenied

```luau
AvatarEditorService:SignalUpdateOutfitPermissionDenied()
```

- Tags: Roblox script security

### refreshAvatarThumbnails

```luau
AvatarEditorService:refreshAvatarThumbnails(thumbnailTypes: { any })
```

- Tags: Roblox script security

### CheckApplyDefaultClothing

```luau
AvatarEditorService:CheckApplyDefaultClothing(humanoidDescription: HumanoidDescription): HumanoidDescription
```

- Tags: Deprecated, Yields, Capabilities: AvatarAppearance
- Use instead: [`AvatarEditorService.CheckApplyDefaultClothingAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Used to apply default clothing to the [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) if necessary.

Parameters:

- `humanoidDescription`: The HumanoidDescription to check if default clothing is required.

Returns: Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.

### ConformToAvatarRules

```luau
AvatarEditorService:ConformToAvatarRules(humanoidDescription: HumanoidDescription): HumanoidDescription
```

- Tags: Deprecated, Yields, Capabilities: AvatarAppearance
- Use instead: [`AvatarEditorService.ConformToAvatarRulesAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Deprecated. Returns a copy of the given [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) that conforms to the platform Avatar rules.

Parameters:

- `humanoidDescription`: The [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) to conform to the platform Avatar rules.

Returns: A new [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) that conforms to the platform Avatar rules.

### GetAvatarRules

```luau
AvatarEditorService:GetAvatarRules(): { [string]: any }
```

- Tags: Deprecated, Yields
- Use instead: [`AvatarEditorService.GetAvatarRulesAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.

Returns: A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.

### GetBatchItemDetails

```luau
AvatarEditorService:GetBatchItemDetails(itemIds: { any }, itemType: Enum.AvatarItemType): { any }
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.GetBatchItemDetailsAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Gets the item details for a list of items at once.

Parameters:

- `itemIds`: The list of item ids to get details of.
- `itemType`: The type of the item ids provided.

Returns: Returns an array of item details. See [`AvatarEditorService:GetBatchItemDetailsAsync()`](https://rapi.sleaze.dev/classes/AvatarEditorService.md) for the response format.

### GetFavorite

```luau
AvatarEditorService:GetFavorite(itemId: number, itemType: Enum.AvatarItemType): boolean
```

- Tags: Deprecated, Yields, Capabilities: AssetRead + Players
- Use instead: [`AvatarEditorService.GetFavoriteAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns if the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) has favorited the given bundle or asset.

Parameters:

- `itemId`: The ID of the specified asset or bundle.
- `itemType`: The `AvatarItemType` of the specified asset or bundle.

Returns: Whether the `LocalPlayer` has favorited the given bundle or asset.

### GetInventory

```luau
AvatarEditorService:GetInventory(assetTypes: { any }): InventoryPages
```

- Tags: Deprecated, Yields, Capabilities: AssetRead + Players
- Use instead: [`AvatarEditorService.GetInventoryAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns an [`InventoryPages`](https://rapi.sleaze.dev/classes/InventoryPages.md) object with information about owned items in the users inventory with the given AvatarAssetTypes.

Parameters:

- `assetTypes`: The `AvatarAssetType` that can will be checked for in the player's inventory.

Returns: An [`InventoryPages`](https://rapi.sleaze.dev/classes/InventoryPages.md) object containing information about owned items matching the given asset types.

### GetItemDetails

```luau
AvatarEditorService:GetItemDetails(itemId: number, itemType: Enum.AvatarItemType): { [string]: any }
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.GetItemDetailsAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns the item details for the given item.

Parameters:

- `itemId`: The ID of the item whose details are being retrieved.
- `itemType`: An enum value indicating the type of item whose details are being retrieved.

Returns: A table containing the item info for the retrieved item. See above for a sample table.

### GetOutfitDetails

```luau
AvatarEditorService:GetOutfitDetails(outfitId: number): { [string]: any }
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.GetOutfitDetailsAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns the outfit details for the given outfit.

Parameters:

- `outfitId`: The ID of the outfit whose details are being retrieved.

Returns: A table containing the outfit info for the retrieved outfit. See above for a sample table.

### GetOutfits

```luau
AvatarEditorService:GetOutfits(outfitSource: Enum.OutfitSource? = Enum.OutfitSource.All, outfitType: Enum.OutfitType? = Enum.OutfitType.All): OutfitPages
```

- Tags: Deprecated, Yields, Capabilities: AssetRead + Players
- Use instead: [`AvatarEditorService.GetOutfitsAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns outfit data for the [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md).

Parameters:

- `outfitSource`: An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
- `outfitType`: An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.

Returns: An [`OutfitPages`](https://rapi.sleaze.dev/classes/OutfitPages.md) object containing the outfit data for the local player.

### GetRecommendedAssets

```luau
AvatarEditorService:GetRecommendedAssets(assetType: Enum.AvatarAssetType, contextAssetId: number? = 0): { any }
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.GetRecommendedAssetsAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns a list of recommended assets based on a given `AssetType` and asset ID.

Parameters:

- `assetType`: The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
- `contextAssetId`: The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.

Returns: A list of recommendations based on the given `AssetType`.

### GetRecommendedBundles

```luau
AvatarEditorService:GetRecommendedBundles(bundleId: number): { any }
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.GetRecommendedBundlesAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns a list of recommended bundles for a given bundle id.

Parameters:

- `bundleId`: A list of recommended bundles.

Returns: The bundle ID that the recommended bundles will be returned for.

### SearchCatalog

```luau
AvatarEditorService:SearchCatalog(searchParameters: CatalogSearchParams): CatalogPages
```

- Tags: Deprecated, Yields, Capabilities: AssetRead
- Use instead: [`AvatarEditorService.SearchCatalogAsync`](https://rapi.sleaze.dev/classes/AvatarEditorService.md)

**Deprecated:**

Returns a [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing the result of the given search.

Parameters:

- `searchParameters`: An object containing the parameters used for the search.

Returns: A [`CatalogPages`](https://rapi.sleaze.dev/classes/CatalogPages.md) object containing the search results.

## Events

### NotifyBustAvatarFetchCache

```luau
AvatarEditorService.NotifyBustAvatarFetchCache: RBXScriptSignal<()>
```

- Tags: Hidden, Roblox engine security

### OpenAllowInventoryReadAccess

```luau
AvatarEditorService.OpenAllowInventoryReadAccess: RBXScriptSignal<()>
```

- Tags: Roblox script security

### OpenPromptCreateOufit

```luau
AvatarEditorService.OpenPromptCreateOufit: RBXScriptSignal<(humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType)>
```

- Tags: Roblox script security

### OpenPromptDeleteOutfit

```luau
AvatarEditorService.OpenPromptDeleteOutfit: RBXScriptSignal<(outfitId: number)>
```

- Tags: Roblox script security

### OpenPromptRenameOutfit

```luau
AvatarEditorService.OpenPromptRenameOutfit: RBXScriptSignal<(outfitId: number)>
```

- Tags: Roblox script security

### OpenPromptSaveAvatar

```luau
AvatarEditorService.OpenPromptSaveAvatar: RBXScriptSignal<(humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType)>
```

- Tags: Roblox script security

### OpenPromptSetFavorite

```luau
AvatarEditorService.OpenPromptSetFavorite: RBXScriptSignal<(itemId: number, itemType: Enum.AvatarItemType, shouldFavorite: boolean)>
```

- Tags: Roblox script security

### OpenPromptUpdateOutfit

```luau
AvatarEditorService.OpenPromptUpdateOutfit: RBXScriptSignal<(outfitId: number, humanoidDescription: HumanoidDescription, rigType: Enum.HumanoidRigType)>
```

- Tags: Roblox script security

### PromptAllowInventoryReadAccessCompleted

```luau
AvatarEditorService.PromptAllowInventoryReadAccessCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Capabilities: AssetRead + Players

Fires when the [`AvatarEditorService:PromptAllowInventoryReadAccess()`](https://rapi.sleaze.dev/classes/AvatarEditorService.md) prompt is responded to by the user.

### PromptApplyProfileConfigurationCompleted

```luau
AvatarEditorService.PromptApplyProfileConfigurationCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Roblox script security

### PromptCreateOutfitCompleted

```luau
AvatarEditorService.PromptCreateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult, failureType: any)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the PromptSaveOutfit operation is completed.

### PromptDeleteOutfitCompleted

```luau
AvatarEditorService.PromptDeleteOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the PromptDeleteOutfit operation is completed.

### PromptRenameOutfitCompleted

```luau
AvatarEditorService.PromptRenameOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the PromptRenameOutfit operation is completed.

### PromptSaveAvatarCompleted

```luau
AvatarEditorService.PromptSaveAvatarCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult, humanoidDescription: HumanoidDescription)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the [`AvatarEditorService:PromptSaveAvatar()`](https://rapi.sleaze.dev/classes/AvatarEditorService.md) operation is completed.

### PromptSaveAvatarThumbnailCustomizationCompleted

```luau
AvatarEditorService.PromptSaveAvatarThumbnailCustomizationCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult, failureType: any)>
```

- Tags: Roblox script security

### PromptSetFavoriteCompleted

```luau
AvatarEditorService.PromptSetFavoriteCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the [`AvatarEditorService:PromptSetFavorite()`](https://rapi.sleaze.dev/classes/AvatarEditorService.md) operation is completed.

### PromptUpdateOutfitCompleted

```luau
AvatarEditorService.PromptUpdateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
```

- Tags: Capabilities: PlatformAvatarEditing + Players

Fires when the [`AvatarEditorService:PromptUpdateOutfit()`](https://rapi.sleaze.dev/classes/AvatarEditorService.md) operation is completed.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`