Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AvatarEditorService

A service to support developer Avatar Editors.

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.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 62

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
647refreshAvatarThumbnails(thumbnailTypes: Array): 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
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
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
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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

Description

AvatarEditorService is a service to support developer Avatar Editors. It provides methods to modify the player's platform avatar, request information about a user's inventory, and request information about the catalog.

For more information regarding the Avatar Editor, see Avatar Editor Service.

Throttling

The following endpoints on AvatarEditorService have experience-level throttling:

For each experience, this throttling allows you to send up to 100 requests per second to these AvatarEditorService endpoints, regardless of the number of servers or user count. Exceeding these limits returns a 429 Too Many Requests error.

If you find that your experience requires an adjustment to this throttling, you can submit a feature request.

History 221

Members 62

CheckApplyDefaultClothing

Parameters (1)
humanoidDescriptionHumanoidDescription
Returns (1)
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 yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 7

Tags: [Yields]

ConformToAvatarRules

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

History 7

Tags: [Yields]

GetAccessoryType

Parameters (1)
avatarAssetTypeAvatarAssetType
Returns (1)
AccessoryType
Thread safetyUnsafe

History 1

GetAvatarRules

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

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
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "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
}
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetBatchItemDetails

Parameters (2)
itemIdsArray
itemTypeAvatarItemType
Returns (1)
Array

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 yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetFavorite

Parameters (2)
itemIdint64
itemTypeAvatarItemType
Returns (1)
bool

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

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 4

Tags: [Yields]

GetInventory

Parameters (1)
assetTypesArray
Returns (1)
InventoryPages

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
4
5
6
7
8

[
    {
      "AssetId": 0,
      "AssetType" : "string",
      "Created": "string",
      "Name": "string",
    }
]
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 5

Tags: [Yields]

GetItemDetails

Parameters (2)
itemIdint64
itemTypeAvatarItemType
Returns (1)
Dictionary

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

Data returned in the format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
  "IsForRent": true,
  "ExpectedSellerId": 0,
  "Owned": true,
  "IsPurchasable": true,
  "Id": 0,
  "ItemType": "Asset",
  "AssetType": "Image",
  "BundleType": "BodyParts",
  "Name": "string",
  "Description": "string",
  "ProductId": 0,
  "Genres": [
    "All"
  ],
  "BundledItems": [
    {
      "Owned": true,
      "Id": 0,
      "Name": "string",
      "Type": "string"
    }
  ],
  "ItemStatus": [
    "New"
  ],
  "ItemRestrictions": [
    "ThirteenPlus"
  ],
  "CreatorType": "User",
  "CreatorTargetId": 0,
  "CreatorName": "string",
  "Price": 0,
  "PremiumPricing": {
    "PremiumDiscountPercentage": 0,
    "PremiumPriceInRobux": 0
  },
  "LowestPrice": 0,
  "PriceStatus": "string",
  "UnitsAvailableForConsumption": 0,
  "PurchaseCount": 0,
  "FavoriteCount": 0
}



To query for limited or unlimited assets, use the following itemRestrictions values:

itemRestrictionsLimited or Unlimited
emptyUnlimited
CollectibleUGC Limited
LimitedRoblox Limited
LimitedUniqueRoblox Limited Unique
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 3

Tags: [Yields]

GetOutfitDetails

Parameters (1)
outfitIdint64
Returns (1)
Dictionary

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{
  "Assets": [
    {
      "AssetType": {
        "Id": 31,
        "Name": "RightLeg"
      }
      "CurrentVersionId": 16447385805,
      "Id": 11584239464,
      "Name": "Anime Female - Right Leg"
    }
  ],
  "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
  },
}
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GetOutfits

Parameters (2)Default
outfitSourceOutfitSourceAll
outfitTypeOutfitTypeAll
Returns (1)
OutfitPages

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
4
5
6
7

[
    {
      "Id": 0,
      "Name": "string",
      "IsEditable": true
    }
]
NametypeDescription
idint
namestring
isEditableboolean
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 7

Tags: [Yields]

GetRecommendedAssets

Parameters (2)Default
assetTypeAvatarAssetType
contextAssetIdint640
Returns (1)
Array

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

[
    {
      "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
      }
    }
]
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 4

Tags: [Yields]

GetRecommendedBundles

Parameters (1)
bundleIdint64
Returns (1)
Array

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

Data is in the format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

[
    {
      "Id": 0,
      "Name": "string",
      "Description": "string",
      "BundleType": "string",
      "Items": [
        {
          "Owned": true,
          "Id": 0,
          "Name": "string",
          "Type": "string"
        }
      ],
      "Creator": {
        "Id": 0,
        "Name": "string",
        "Type": "string"
      },
      "Product": {
        "Id": 0,
        "Type": "string",
        "IsPublicDomain": true,
        "IsForSale": true,
        "PriceInRobux": 0,
        "PremiumPricing": {
          "PremiumDiscountPercentage": 0,
          "PremiumPriceInRobux": 0
        }
      }
    }
]
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 4

Tags: [Yields]

NoPromptCreateOutfit

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

History 3

NoPromptDeleteOutfit

Parameters (1)
outfitIdint64
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

NoPromptRenameOutfit

Parameters (2)
outfitIdint64
namestring
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

NoPromptSaveAvatar

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

History 1

NoPromptSaveAvatarThumbnailCustomization

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

History 2

NoPromptSetFavorite

Parameters (3)
itemIdint64
itemTypeAvatarItemType
shouldFavoritebool
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

NoPromptUpdateOutfit

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

History 2

OpenAllowInventoryReadAccess

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

OpenPromptCreateOufit

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

OpenPromptDeleteOutfit

Parameters (1)
outfitIdint64
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OpenPromptRenameOutfit

Parameters (1)
outfitIdint64
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OpenPromptSaveAvatar

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

OpenPromptSetFavorite

Parameters (3)
itemIdint64
itemTypeAvatarItemType
shouldFavoritebool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

OpenPromptUpdateOutfit

Parameters (3)
outfitIdint64
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

PerformCreateOutfitWithDescription

Parameters (2)
humanoidDescriptionHumanoidDescription
namestring
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 6

PerformDeleteOutfit

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

PerformRenameOutfit

Parameters (1)
namestring
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

PerformSaveAvatarWithDescription

Parameters (3)
humanoidDescriptionHumanoidDescription
addedAssetsArray
removedAssetsArray
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 6

PerformSetFavorite

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

PerformUpdateOutfit

Parameters (1)
humanoidDescriptionHumanoidDescription
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

PromptAllowInventoryReadAccess

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

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.

Thread safetyUnsafe

History 5

PromptAllowInventoryReadAccessCompleted

Parameters (1)
resultAvatarPromptResult

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.

Thread safetyUnsafe

History 4

PromptCreateOutfit

Parameters (2)
outfitHumanoidDescription
rigTypeHumanoidRigType
Returns (1)
null

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.

Thread safetyUnsafe

History 6

PromptCreateOutfitCompleted

Parameters (2)
resultAvatarPromptResult
failureTypeVariant

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.

Thread safetyUnsafe

History 5

PromptDeleteOutfit

Parameters (1)
outfitIdint64
Returns (1)
null

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

Thread safetyUnsafe

History 2

PromptDeleteOutfitCompleted

Parameters (1)
resultAvatarPromptResult

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.

Thread safetyUnsafe

History 1

PromptRenameOutfit

Parameters (1)
outfitIdint64
Returns (1)
null

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

Thread safetyUnsafe

History 2

PromptRenameOutfitCompleted

Parameters (1)
resultAvatarPromptResult

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.

Thread safetyUnsafe

History 1

PromptSaveAvatar

Parameters (2)
humanoidDescriptionHumanoidDescription
rigTypeHumanoidRigType
Returns (1)
null

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.

Thread safetyUnsafe

History 6

PromptSaveAvatarCompleted

Parameters (2)
resultAvatarPromptResult
humanoidDescriptionHumanoidDescription

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.

Thread safetyUnsafe

History 5

PromptSaveAvatarThumbnailCustomizationCompleted

Parameters (2)
resultAvatarPromptResult
failureTypeVariant
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

PromptSetFavorite

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

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

Thread safetyUnsafe

History 5

PromptSetFavoriteCompleted

Parameters (1)
resultAvatarPromptResult

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.

Thread safetyUnsafe

History 4

PromptUpdateOutfit

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

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

Thread safetyUnsafe

History 2

PromptUpdateOutfitCompleted

Parameters (1)
resultAvatarPromptResult

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.

Thread safetyUnsafe

History 1

SearchCatalog

Parameters (1)
searchParametersCatalogSearchParams
Returns (1)
CatalogPages

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

The returned data has the format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

[
    {
      "Id": 0,
      "ItemType": "Asset",
      "AssetType": "Image",
      "BundleType": "BodyParts",
      "Name": "string",
      "Description": "string",
      "ProductId": 0,
      "Genres": [
        "All"
      ],
      "BundledItems": [
        {
          "Owned": true,
          "Id": 0,
          "Name": "string",
          "Type": "string"
        }
      ],
      "ItemStatus": [
        "New"
      ],
      "ItemRestrictions": [
        "ThirteenPlus"
      ],
      "CreatorType": "User",
      "CreatorTargetId": 0,
      "CreatorName": "string",
      "Price": 0,
      "PremiumPricing": {
        "PremiumDiscountPercentage": 0,
        "PremiumPriceInRobux": 0
      },
      "LowestPrice": 0,
      "PriceStatus": "string",
      "UnitsAvailableForConsumption": 0,
      "PurchaseCount": 0,
      "FavoriteCount": 0
    }
]
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 3

Tags: [Yields]

SetAllowInventoryReadAccess

Parameters (1)
inventoryReadAccessGrantedbool
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalCreateOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalCreateOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalDeleteOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SignalDeleteOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SignalRenameOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SignalRenameOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SignalSaveAvatarFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalSaveAvatarPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalSetFavoriteFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalSetFavoritePermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

SignalUpdateOutfitFailed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SignalUpdateOutfitPermissionDenied

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

refreshAvatarThumbnails

Parameters (1)
thumbnailTypesArray
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Removed members 5

GetRecommendedAssetsV2

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

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.
Thread safetyUnsafe

History 2

Tags: [Yields]

PerformCreateOutfit

Parameters (1)
namestring
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

PerformSaveAvatar

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

PerformSaveAvatarNew

Parameters (2)
addedAssetsArray
removedAssetsArray
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Settings