AvatarEditorService

Deprecated in favor of AvatarEditorService:CheckApplyDefaultClothingAsync(). This method has the same behavior: it returns a new HumanoidDescription with the Shirt and Pants properties updated if necessary, or 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.

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.

Deprecated in favor of AvatarEditorService:ConformToAvatarRulesAsync(). Clones the given description and adjusts scale values, accessory counts, accessory adjustments, default clothing, and layered-clothing limits to comply with the platform Avatar rules. It also remaps classic face and classic head assets to their corresponding Dynamic Head asset IDs.

This method also remaps classic face and classic head assets to their corresponding Dynamic Head asset IDs, with the appropriate HeadShape pre-applied. This remapping happens automatically and requires no code changes.

Returns the AccessoryType that corresponds to the given AvatarAssetType, which is useful for grouping avatar assets by the accessory slot they occupy.

The mapping covers accessory asset types — for example, AvatarAssetType.HairAccessory maps to AccessoryType.Hair, and layered-clothing types such as AvatarAssetType.ShirtAccessory map to AccessoryType.Shirt. An AvatarAssetType that does not correspond to an accessory (for example, an animation or a body part) returns AccessoryType.Unknown.

This method returns immediately; it does not yield or perform a web request.

Deprecated in favor of AvatarEditorService:GetAvatarRulesAsync(). This method has the same behavior: it returns a dictionary containing the platform Avatar rules. See AvatarEditorService:GetAvatarRulesAsync() for the response format.

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:

{
  "PlayerAvatarTypes": [
    "R6"
  ],
  "Scales": {},
  "WearableAssetTypes": [
    {
      "MaxNumber": 0,
      "Id": 0,
      "Name": "string"
    }
  ],
  "BodyColorsPalette": [
    {
      "BrickColorId": 0,
      "NexColor": "string",
      "Name": "string"
    }
  ],
  "BasicBodyColorsPalette": [
    {
      "BrickColorId": 0,
      "HexColor": "string",
      "Name": "string"
    }
  ],
  "MinimumDeltaEBodyColorDifference": 0,
  "ProportionsAndBodyTypeEnabledForUser": true,
  "DefaultClothingAssetLists": {
    "DefaultShirtAssetIds": [
      0
    ],
    "DefaultPantAssetIds": [
      0
    ]
  },
  "BundlesEnabledForUser": true,
  "EmotesEnabledForUser": true
}

Deprecated in favor of AvatarEditorService:GetBatchItemDetailsAsync(). This method has the same behavior: it gets the item details for a list of items at once and returns an array of item details in the Item Details Response format.

Gets the item details for a list of items at once. More efficient than AvatarEditorService:GetItemDetailsAsync() if you need to get the item details for multiple items.

Returns an array of items (see Item Details Response above in summary). Each item includes the TimedOptions field when the asset supports timed ownership.

Returns a paginated list of bundles that contain the specified asset. Results are returned in ascending order by date created. Each page entry uses the Item Details Response format (see service description above).

Deprecated in favor of AvatarEditorService:GetFavoriteAsync(). This method has the same behavior: it returns whether the Players.LocalPlayer has favorited the given bundle or asset.

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

Each head shape corresponds to a classic head owned by the user and can be applied to any Dynamic Head that supports shape swapping (see BodyPartDescription.HeadShape).

This method requires the user to have accepted the AvatarEditorService:PromptAllowInventoryReadAccess() prompt.

Deprecated in favor of AvatarEditorService:GetInventoryAsync(). This method has the same behavior: it returns an InventoryPages object with information about items owned by the Players.LocalPlayer that match the given AvatarAssetTypes. See AvatarEditorService:GetInventoryAsync() for the response format.

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

The returned table includes the following fields:

[
    {
      "AssetId": 0,
      "AssetType": "string",
      "Created": "string",
      "Name": "string",
      "CreatedTime": DateTime,
      "ExpirationTime": DateTime,
    }
]

Deprecated in favor of AvatarEditorService:GetItemDetailsAsync(). This method has the same behavior: it returns a table containing the item details for the given item. See AvatarEditorService:GetItemDetailsAsync() for the response format.

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 AvatarItemType.

The response includes all fields from Item Details Response (see above in summary), plus the following additional fields specific to single-item queries:

Deprecated in favor of AvatarEditorService:GetOutfitDetailsAsync(). This method has the same behavior: it returns a table containing the outfit details for the given outfit. See AvatarEditorService:GetOutfitDetailsAsync() for the response format.

This function returns the outfit details for the given outfit. It accepts one parameter: the ID of the outfit.

Data returns in the following format:

{
  "Assets": [
    {
      "AssetType": {
        "Id": 31,
        "Name": "RightLeg"
      },
      "CurrentVersionId": 16447385805,
      "Id": 11584239464,
      "Name": "Anime Female - Right Leg",
      "SupportsHeadShapes": false
    }
  ],
  "BodyColors": {
    "HeadColor": Color3(204, 142, 105),
    "LeftArmColor": Color3(204, 142, 105),
    "LeftLegColor": Color3(204, 142, 105),
    "RightArmColor": Color3(204, 142, 105),
    "RightLegColor": Color3(204, 142, 105),
    "TorsoColor": Color3(204, 142, 105)
  },
  "Id": 14703770624,
  "IsEditable": true,
  "Name": "Your Costume",
  "OutfitType": "Avatar",
  "PlayerAvatarType": "R15",
  "Scale": {
    "BodyType": 0,
    "Depth": 1,
    "Head": 1,
    "Height": 1,
    "Proportion": 0,
    "Width": 1
  },
}

Deprecated in favor of AvatarEditorService:GetOutfitsAsync(). This method has the same behavior: it returns outfit data for the Players.LocalPlayer. See AvatarEditorService:GetOutfitsAsync() for the response format.

This function returns outfit data for the Players.LocalPlayer. This would be used with Players:GetHumanoidDescriptionFromOutfitIdAsync() 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:

[
    {
      "Id": 0,
      "Name": "string",
      "IsEditable": true
    }
]

Deprecated in favor of AvatarEditorService:GetRecommendedAssetsAsync(). This method has the same behavior: it returns a list of recommended assets based on the given AvatarAssetType and context asset ID. See AvatarEditorService:GetRecommendedAssetsAsync() for the response format.

Returns a list of recommended assets based on a given AssetType and asset ID. Use this to gather a list of similar assets to the asset provided. Take a look at the code sample below for more information on possible usages for this function.

Data is in the format:

[
    {
      "Item": {
        "AssetId": 0,
        "Name": "string",
        "Price": 0,
        "PremiumPrice": 0
      },
      "Creator": {
        "CreatorId": 0,
        "CreatorType": "string",
        "Name": "string"
      },
      "Product": {
        "Id": 0,
        "PriceInRobux": 0,
        "IsForSale": true,
        "IsResellable": true,
        "IsLimited": true,
        "IsLimitedUnique": true,
        "TotalPrivateSales": 0,
        "OffsaleDeadline": "string",
        "IsFree": true
      }
    }
]

Deprecated in favor of AvatarEditorService:GetRecommendedBundlesAsync(). This method has the same behavior: it returns a list of recommended bundles for a given bundle ID. See AvatarEditorService:GetRecommendedBundlesAsync() for the response format.

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

Data is in the format:

[
    {
      "Id": 0,
      "Name": "string",
      "Description": "string",
      "BundleType": "string",
      "Items": [
        {
          "Owned": true,
          "Id": 0,
          "Name": "string",
          "Type": "string",
          "AssetType": "string",
          "SupportsHeadShapes": false
        }
      ],
      "Creator": {
        "Id": 0,
        "Name": "string",
        "Type": "string"
      },
      "Product": {
        "Id": 0,
        "Type": "string",
        "IsPublicDomain": true,
        "IsForSale": true,
        "PriceInRobux": 0,
        "PremiumPricing": {
          "PremiumDiscountPercentage": 0,
          "PremiumPriceInRobux": 0
        }
      }
    }
]

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:GetInventoryAsync(), AvatarEditorService:GetOutfitsAsync() and AvatarEditorService:GetFavoriteAsync(). 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 rename 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 HumanoidRigType (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.

Deprecated in favor of AvatarEditorService:SearchCatalogAsync(). This method has the same behavior: it returns a CatalogPages object containing the result of the given search. See AvatarEditorService:SearchCatalogAsync() for details on the response format.

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

Each item in the returned pages uses the Item Details Response format (see above in summary), including the TimedOptions field for assets that support timed ownership.

Use SalesTypeFilter.TimedOptions in CatalogSearchParams to filter results to only items with timed options available.

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.