AvatarEditorService

This event fires when the AvatarEditorService:PromptAllowInventoryReadAccess() prompt is responded to by the user. It can only return the Success or PermissionDenied enum statuses as it does not perform any web requests which could fail.

This event fires when the PromptSaveOutfit operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

Fires when the PromptDeleteOutfit operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

Fires when the PromptRenameOutfit operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

This event fires when the AvatarEditorService:PromptSaveAvatar() operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

Fires when the AvatarEditorService:PromptSetFavorite() operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

Fires when the AvatarEditorService:PromptUpdateOutfit() operation is completed. It gives a status enum indicating whether the prompt succeeded, failed or permission was not granted by the user.

Prompts the Players.LocalPlayer to allow the developer to read what items the user has in their inventory and other avatar editor related information. The prompt needs to be confirmed by the user for the developer to use AvatarEditorService:GetInventory(), AvatarEditorService:GetOutfits() and AvatarEditorService:GetFavorite(). Permission does not persist between sessions.

Prompts the Players.LocalPlayer to save the given HumanoidDescription as an outfit. Does not yield. The result can be retrieved by listening to the AvatarEditorService.PromptCreateOutfitCompleted event.

Prompts the Players.LocalPlayer to delete the given outfit. Does not yield. The result can be retrieved by listening to the AvatarEditorService.PromptDeleteOutfitCompleted event.

Prompts the Players.LocalPlayer to delete the given outfit. Does not yield. The result can be retrieved by listening to the AvatarEditorService.PromptRenameOutfitCompleted event.

This function prompts the Players.LocalPlayer to update their avatar based on the given HumanoidDescription and RigType (R6 or R15). Does not yield and can get the result by listening to the PromptSaveAvatarCompleted event. This is similar to how other prompts such as PromptPurchase work.

This function prompts the Players.LocalPlayer to favorite or unfavorite the given asset or bundle.

Prompts the Players.LocalPlayer to update the given outfit with the given HumanoidDescription.

Returns a new HumanoidDescription with the Shirt and Pants properties updated if necessary. Returns nil if default clothing was not needed.

Default clothing is necessary if the HumanoidDescription does not currently have Shirt and Pants equipped and the body colors are too similar.

This function returns the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect.

The returned table includes the following fields:

1{
2  "PlayerAvatarTypes": [
3    "R6"
4  ],
5  "Scales": {},
6  "WearableAssetTypes": [
7    {
8      "MaxNumber": 0,
9      "Id": 0,
10      "Name": "string"
11    }
12  ],
13  "BodyColorsPalette": [
14    {
15      "BrickColorId": 0,
16      "NexColor": "string",
17      "Name": "string"
18    }
19  ],
20  "BasicBodyColorsPalette": [
21    {
22      "BrickColorId": 0,
23      "HexColor": "string",
24      "Name": "string"
25    }
26  ],
27  "MinimumDeltaEBodyColorDifference": 0,
28  "ProportionsAndBodyTypeEnabledForUser": true,
29  "DefaultClothingAssetLists": {
30    "DefaultShirtAssetIds": [
31      0
32    ],
33    "DefaultPantAssetIds": [
34      0
35    ]
36  },
37  "BundlesEnabledForUser": true,
38  "EmotesEnabledForUser": true
39}
40

Gets the item details for a list of items at once. More efficient than AvatarEditorService:GetItemDetails if you need to get all the item details of a list.

This function returns if the Players.LocalPlayer has favorited the given bundle or asset.

Returns an InventoryPages object with information about owned items in the users inventory with the given AvatarAssetTypes.

The returned table includes the following fields:

1[
2    {
3      "AssetName": "string",
4      "AssetId": 0,
5      "SerialNumber": 0,
6      "AssetType" : "string",
7    }
8]
9

This function returns the item details for the given item. It accepts two parameters - the first indicating the ID of the item being retrieved and the second indicating its Enum.ItemType.

Data returned in the format:

1{
2  "IsForRent": true,
3  "ExpectedSellerId": 0,
4  "Owned": true,
5  "IsPurchasable": true,
6  "Id": 0,
7  "ItemType": "Asset",
8  "AssetType": "Image",
9  "BundleType": "BodyParts",
10  "Name": "string",
11  "Description": "string",
12  "ProductId": 0,
13  "Genres": [
14    "All"
15  ],
16  "BundledItems": [
17    {
18      "Owned": true,
19      "Id": 0,
20      "Name": "string",
21      "Type": "string"
22    }
23  ],
24  "ItemStatus": [
25    "New"
26  ],
27  "ItemRestrictions": [
28    "ThirteenPlus"
29  ],
30  "CreatorType": "User",
31  "CreatorTargetId": 0,
32  "CreatorName": "string",
33  "Price": 0,
34  "PremiumPricing": {
35    "PremiumDiscountPercentage": 0,
36    "PremiumPriceInRobux": 0
37  },
38  "LowestPrice": 0,
39  "PriceStatus": "string",
40  "UnitsAvailableForConsumption": 0,
41  "PurchaseCount": 0,
42  "FavoriteCount": 0
43}
44

This function returns outfit data for the Players.LocalPlayer. This would be used with Players:GetHumanoidDescriptionFromOutfitId() to update the players character to the outfit. Access to this would also depend on AvatarEditorService:PromptAllowInventoryReadAccess() being accepted by the user.

The returned table includes the following fields:

1[
2    {
3      "Id": 0,
4      "Name": "string",
5      "IsEditable": true
6    }
7]
8

This function returns a list of recommendations based on the given AssetType. Take a look at the code sample below for more information on possible usages for this function.

Data is in the format:

1[
2    {
3      "Item": {
4        "AssetId": 0,
5        "Name": "string",
6        "Price": 0,
7        "PremiumPrice": 0,
8        "AbsoluteUrl": "string",
9        "AudioUrl": "string"
10      },
11      "Creator": {
12        "CreatorId": 0,
13        "CreatorType": "string",
14        "Name": "string",
15        "CreatorProfileLink": "string"
16      },
17      "Product": {
18        "Id": 0,
19        "PriceInRobux": 0,
20        "IsForSale": true,
21        "IsPublicDomain": true,
22        "IsResellable": true,
23        "IsLimited": true,
24        "IsLimitedUnique": true,
25        "SerialNumber": 0,
26        "IsRental": true,
27        "RentalDurationInHours": 0,
28        "BcRequirement": 0,
29        "TotalPrivateSales": 0,
30        "SellerId": 0,
31        "SellerName": "string",
32        "LowestPrivateSaleUserAssetId": 0,
33        "IsXboxExclusiveItem": true,
34        "OffsaleDeadline": "string",
35        "NoPriceText": "string",
36        "IsFree": true
37      }
38    }
39]
40

This function returns a list of recommended bundles for a given bundle id.

Data is in the format:

1[
2    {
3      "Id": 0,
4      "Name": "string",
5      "Description": "string",
6      "BundleType": "string",
7      "Items": [
8        {
9          "Owned": true,
10          "Id": 0,
11          "Name": "string",
12          "Type": "string"
13        }
14      ],
15      "Creator": {
16        "Id": 0,
17        "Name": "string",
18        "Type": "string"
19      },
20      "Product": {
21        "Id": 0,
22        "Type": "string",
23        "IsPublicDomain": true,
24        "IsForSale": true,
25        "PriceInRobux": 0,
26        "PremiumPricing": {
27          "PremiumDiscountPercentage": 0,
28          "PremiumPriceInRobux": 0
29        }
30      }
31    }
32]
33

This function returns a CatalogPages object containing the result of the given search.

The returned data has the format:

1[
2    {
3      "Id": 0,
4      "ItemType": "Asset",
5      "AssetType": "Image",
6      "BundleType": "BodyParts",
7      "Name": "string",
8      "Description": "string",
9      "ProductId": 0,
10      "Genres": [
11        "All"
12      ],
13      "BundledItems": [
14        {
15          "Owned": true,
16          "Id": 0,
17          "Name": "string",
18          "Type": "string"
19        }
20      ],
21      "ItemStatus": [
22        "New"
23      ],
24      "ItemRestrictions": [
25        "ThirteenPlus"
26      ],
27      "CreatorType": "User",
28      "CreatorTargetId": 0,
29      "CreatorName": "string",
30      "Price": 0,
31      "PremiumPricing": {
32        "PremiumDiscountPercentage": 0,
33        "PremiumPriceInRobux": 0
34      },
35      "LowestPrice": 0,
36      "PriceStatus": "string",
37      "UnitsAvailableForConsumption": 0,
38      "PurchaseCount": 0,
39      "FavoriteCount": 0
40    }
41]
42