AvatarEditorService

A service to support developer Avatar Editors.

Memory category: Instances
Own members: 80
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties23

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Methods105

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byAvatarEditorService63

AvatarEditorService:BustAvatarFetchCache()
- Roblox script security
AvatarEditorService:CheckApplyDefaultClothingAsync(humanoidDescription: HumanoidDescription): HumanoidDescription
Used to apply default clothing to the HumanoidDescription if necessary.
- Yields
- Capabilities: AvatarAppearance
Parameters
Parameter Description
humanoidDescription: HumanoidDescription
The HumanoidDescription to check if default clothing is required.
Returns
Type Description
HumanoidDescription
Returns a HumanoidDescription if default clothing was necessary. Otherwise returns nil.
AvatarEditorService:ConformToAvatarRulesAsync(humanoidDescription: HumanoidDescription): HumanoidDescription
Returns a copy of the given HumanoidDescription that conforms to the platform Avatar rules.
- Yields
- Capabilities: AvatarAppearance
Parameters
Parameter Description
humanoidDescription: HumanoidDescription
The HumanoidDescription to conform.
Returns
Type Description
HumanoidDescription
A new HumanoidDescription that conforms to the platform Avatar rules.
AvatarEditorService:GetAccessoryType(avatarAssetType: Enum.AvatarAssetType): Enum.AccessoryType
Returns the AccessoryType that corresponds to the given AvatarAssetType.
Parameters
Parameter Description
avatarAssetType: Enum.AvatarAssetType
The AvatarAssetType to convert to its corresponding AccessoryType.
Returns
Type Description
Enum.AccessoryType
The AccessoryType corresponding to the given AvatarAssetType, or AccessoryType.Unknown if the asset type has no matching accessory type.

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

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

Returns
Type	Description
`{ [string]: any }`	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.

AvatarEditorService:GetBatchItemDetailsAsync(itemIds: { any },itemType: Enum.AvatarItemType,): { any }
Gets the item details for a list of items at once.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
itemIds: { any }
The list of item ids to get details of.
itemType: Enum.AvatarItemType
The type of the item ids provided.
Returns
Type Description
{ any }
Returns an array of item details.
AvatarEditorService:GetBundlesByAssetIdAsync(assetId: number,limit: number? = 10,): CatalogPages
Returns a CatalogPages object containing bundles that include the given asset.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
assetId: number
The ID of the asset to find bundles for.
limit: number? = 10
The number of results per page. Accepts 10, 25, 50, and 100.
Returns
Type Description
CatalogPages
A CatalogPages object containing bundles that include the given asset.
AvatarEditorService:GetFavoriteAsync(itemId: number,itemType: Enum.AvatarItemType,): boolean
Returns if the Players.LocalPlayer has favorited the given bundle or asset.
- Yields
- Capabilities: AssetRead + Players
Parameters
Parameter Description
itemId: number
The ID of the specified asset or bundle.
itemType: Enum.AvatarItemType
The AvatarItemType of the specified asset or bundle.
Returns
Type Description
boolean
Whether the LocalPlayer has favorited the given bundle or asset.

AvatarEditorService:GetHeadShapesAsync(): { any }

Returns an array of head shape names that the Players.LocalPlayer owns.

Returns
Type	Description
`{ any }`	An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. 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"`.

AvatarEditorService:GetInventoryAsync(assetTypes: { any }): InventoryPages
Returns an InventoryPages object with information about owned items in the users inventory with the given AvatarAssetTypes.
- Yields
- Capabilities: AssetRead + Players
Parameters
Parameter Description
assetTypes: { any }
The AvatarAssetType that can will be checked for in the player's inventory.
Returns
Type Description
InventoryPages
An InventoryPages object containing information about owned items matching the given asset types.

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

Returns the item details for the given item.

Parameters
Parameter	Description
`itemId: number`	The ID of the item whose details are being retrieved.
`itemType: Enum.AvatarItemType`	An enum value indicating the type of item whose details are being retrieved.

Returns
Type	Description
`{ [string]: any }`	A table containing the item info for the retrieved item.

AvatarEditorService:GetOutfitDetailsAsync(outfitId: number): { [string]: any }
Returns the outfit details for the given outfit.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
outfitId: number
The ID of the outfit whose details are being retrieved.
Returns
Type Description
{ [string]: any }
A table containing the outfit info for the retrieved outfit. See above for a sample table.

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

Returns outfit data for the Players.LocalPlayer.

Parameters
Parameter	Description
`outfitSource: Enum.OutfitSource? = Enum.OutfitSource.All`	An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
`outfitType: Enum.OutfitType? = Enum.OutfitType.All`	An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.

Returns
Type	Description
`OutfitPages`	An `OutfitPages` object containing the outfit data for the local player.

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

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

Parameters
Parameter	Description
`assetType: Enum.AvatarAssetType`	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: number? = 0`	The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.

Returns
Type	Description
`{ any }`	A list of recommendations based on the given `AssetType`.

AvatarEditorService:GetRecommendedBundlesAsync(bundleId: number): { any }
Returns a list of recommended bundles for a given bundle id.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
bundleId: number
A list of recommended bundles.
Returns
Type Description
{ any }
The bundle ID that the recommended bundles will be returned for.
AvatarEditorService:NoPromptApplyProfileConfiguration(profileConfiguration: { [string]: any }): boolean
- Roblox script security
Parameters
Parameter
profileConfiguration: { [string]: any }
Returns
Type
boolean
AvatarEditorService:NoPromptCreateOutfit(humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,name: string,gearAssetId: number? = 0,outfitOptions: { [string]: any }? = nil,outfitType: any,): boolean
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
name: string
gearAssetId: number? = 0
outfitOptions: { [string]: any }? = nil
outfitType: any
Returns
Type
boolean
AvatarEditorService:NoPromptDeleteOutfit(outfitId: number): boolean
- Roblox script security
Parameters
Parameter
outfitId: number
Returns
Type
boolean
AvatarEditorService:NoPromptRenameOutfit(outfitId: number,name: string,): boolean
- Roblox script security
Parameters
Parameter
outfitId: number
name: string
Returns
Type
boolean
AvatarEditorService:NoPromptSaveAvatar(humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,saveDict: { [string]: any },gearAssetId: number? = 0,profileConfiguration: { [string]: any }? = nil,): boolean
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
saveDict: { [string]: any }
gearAssetId: number? = 0
profileConfiguration: { [string]: any }? = nil
Returns
Type
boolean
AvatarEditorService:NoPromptSaveAvatarThumbnailCustomization(thumbnailType: Enum.AvatarThumbnailCustomizationType,emoteAssetId: number,cameraDistanceScale: number,yRotDeg: number,fieldOfViewDeg: number? = 0,): boolean
- Roblox script security
Parameters
Parameter
thumbnailType: Enum.AvatarThumbnailCustomizationType
emoteAssetId: number
cameraDistanceScale: number
yRotDeg: number
fieldOfViewDeg: number? = 0
Returns
Type
boolean
AvatarEditorService:NoPromptSetFavorite(itemId: number,itemType: Enum.AvatarItemType,shouldFavorite: boolean,): boolean
- Roblox script security
Parameters
Parameter
itemId: number
itemType: Enum.AvatarItemType
shouldFavorite: boolean
Returns
Type
boolean
AvatarEditorService:NoPromptUpdateOutfit(outfitId: number,humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,gearAssetId: number? = 0,outfitOptions: { [string]: any }? = nil,): boolean
- Roblox script security
Parameters
Parameter
outfitId: number
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
gearAssetId: number? = 0
outfitOptions: { [string]: any }? = nil
Returns
Type
boolean
AvatarEditorService:PerformCreateOutfitWithDescription(humanoidDescription: HumanoidDescription,name: string,profileConfiguration: { [string]: any }? = nil,)
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
name: string
profileConfiguration: { [string]: any }? = nil
AvatarEditorService:PerformDeleteOutfit()
- Roblox script security
AvatarEditorService:PerformRenameOutfit(name: string)
- Roblox script security
Parameters
Parameter
name: string
AvatarEditorService:PerformSaveAvatarWithDescription(humanoidDescription: HumanoidDescription,addedAssets: { any },removedAssets: { any },)
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
addedAssets: { any }
removedAssets: { any }
AvatarEditorService:PerformSetFavorite()
- Roblox script security
AvatarEditorService:PerformUpdateOutfit(humanoidDescription: HumanoidDescription,profileConfiguration: { [string]: any }? = nil,)
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
profileConfiguration: { [string]: any }? = nil
AvatarEditorService:PromptAllowInventoryReadAccess()
Prompts the Players.LocalPlayer to allow the developer to read what items the user has in their inventory and other avatar editor related information.
- Capabilities: AssetRead + Players

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

Prompts the Players.LocalPlayer to save the given HumanoidDescription as an outfit.

Parameters
Parameter	Description
`outfit: HumanoidDescription`	The `Outfit` that the player will be prompted to created.
`rigType: Enum.HumanoidRigType`	The `HumanoidRigType` that the outfit will be created for if the player confirms the prompt.
`outfitOptions: { [string]: any }? = nil`	Reserved for future options. Must be empty or omitted.
`outfitType: any`	Optional `OutfitType`. Only `Avatar` and `Makeup` values are accepted. When omitted, the type is inferred from the description.

AvatarEditorService:PromptDeleteOutfit(outfitId: number)
Prompts the Players.LocalPlayer to delete the given outfit.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter Description
outfitId: number
The outfitId of the outfit to delete.
AvatarEditorService:PromptRenameOutfit(outfitId: number)
Prompts the Players.LocalPlayer to rename the given outfit.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter Description
outfitId: number
The outfitId of the outfit to rename.

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

Prompts the Players.LocalPlayer to update their avatar based on the given HumanoidDescription and HumanoidRigType of R6 or R15.

Parameters
Parameter	Description
`humanoidDescription: HumanoidDescription`	The given `HumanoidDescription` being prompted to save.
`rigType: Enum.HumanoidRigType`	The `HumanoidRigType` that the avatar will be saved for if the player confirms the prompt.

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

Prompts the Players.LocalPlayer to favorite or unfavorite the given asset or bundle.

Parameters
Parameter	Description
`itemId: number`	The ItemId of the item being prompted to favorite.
`itemType: Enum.AvatarItemType`	The type of item being prompted to favorite.
`shouldFavorite: boolean`	Whether to favorite (`true`) or unfavorite (`false`) the item.

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

Prompts the Players.LocalPlayer to update the given outfit.

Parameters
Parameter	Description
`outfitId: number`	The outfitId of the outfit to update.
`updatedOutfit: HumanoidDescription`	A `HumanoidDescription` that represents the new outfit data.
`rigType: Enum.HumanoidRigType`	The `HumanoidRigType` to update the outfit to.

AvatarEditorService:SearchCatalogAsync(searchParameters: CatalogSearchParams): CatalogPages
Returns a CatalogPages object containing the result of the given search.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
searchParameters: CatalogSearchParams
An object containing the parameters used for the search.
Returns
Type Description
CatalogPages
A CatalogPages object containing the search results.
AvatarEditorService:SetAllowInventoryReadAccess(inventoryReadAccessGranted: boolean)
- Roblox script security
Parameters
Parameter
inventoryReadAccessGranted: boolean
AvatarEditorService:SignalCreateOutfitFailed()
- Roblox script security
AvatarEditorService:SignalCreateOutfitPermissionDenied()
- Roblox script security
AvatarEditorService:SignalDeleteOutfitFailed()
- Roblox script security
AvatarEditorService:SignalDeleteOutfitPermissionDenied()
- Roblox script security
AvatarEditorService:SignalRenameOutfitFailed()
- Roblox script security
AvatarEditorService:SignalRenameOutfitPermissionDenied()
- Roblox script security
AvatarEditorService:SignalSaveAvatarFailed()
- Roblox script security
AvatarEditorService:SignalSaveAvatarPermissionDenied()
- Roblox script security
AvatarEditorService:SignalSetFavoriteFailed()
- Roblox script security
AvatarEditorService:SignalSetFavoritePermissionDenied()
- Roblox script security
AvatarEditorService:SignalUpdateOutfitFailed()
- Roblox script security
AvatarEditorService:SignalUpdateOutfitPermissionDenied()
- Roblox script security
AvatarEditorService:refreshAvatarThumbnails(thumbnailTypes: { any })
- Roblox script security
Parameters
Parameter
thumbnailTypes: { any }
AvatarEditorService:CheckApplyDefaultClothing(humanoidDescription: HumanoidDescription): HumanoidDescription
Deprecated:
Used to apply default clothing to the HumanoidDescription if necessary.
- Deprecated
- Yields
- Capabilities: AvatarAppearance
Parameters
Parameter Description
humanoidDescription: HumanoidDescription
The HumanoidDescription to check if default clothing is required.
Returns
Type Description
HumanoidDescription
Returns a HumanoidDescription if default clothing was necessary. Otherwise returns nil.
Use CheckApplyDefaultClothingAsync instead.
AvatarEditorService:ConformToAvatarRules(humanoidDescription: HumanoidDescription): HumanoidDescription
Deprecated:
Deprecated. Returns a copy of the given HumanoidDescription that conforms to the platform Avatar rules.
- Deprecated
- Yields
- Capabilities: AvatarAppearance
Parameters
Parameter Description
humanoidDescription: HumanoidDescription
The HumanoidDescription to conform to the platform Avatar rules.
Returns
Type Description
HumanoidDescription
A new HumanoidDescription that conforms to the platform Avatar rules.
Use ConformToAvatarRulesAsync instead.

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

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

Returns
Type	Description
`{ [string]: any }`	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.

Use GetAvatarRulesAsync instead.

AvatarEditorService:GetBatchItemDetails(itemIds: { any },itemType: Enum.AvatarItemType,): { any }
Deprecated:
Gets the item details for a list of items at once.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
itemIds: { any }
The list of item ids to get details of.
itemType: Enum.AvatarItemType
The type of the item ids provided.
Returns
Type Description
{ any }
Returns an array of item details. See AvatarEditorService:GetBatchItemDetailsAsync() for the response format.
Use GetBatchItemDetailsAsync instead.
AvatarEditorService:GetFavorite(itemId: number,itemType: Enum.AvatarItemType,): boolean
Deprecated:
Returns if the Players.LocalPlayer has favorited the given bundle or asset.
- Deprecated
- Yields
- Capabilities: AssetRead + Players
Parameters
Parameter Description
itemId: number
The ID of the specified asset or bundle.
itemType: Enum.AvatarItemType
The AvatarItemType of the specified asset or bundle.
Returns
Type Description
boolean
Whether the LocalPlayer has favorited the given bundle or asset.
Use GetFavoriteAsync instead.
AvatarEditorService:GetInventory(assetTypes: { any }): InventoryPages
Deprecated:
Returns an InventoryPages object with information about owned items in the users inventory with the given AvatarAssetTypes.
- Deprecated
- Yields
- Capabilities: AssetRead + Players
Parameters
Parameter Description
assetTypes: { any }
The AvatarAssetType that can will be checked for in the player's inventory.
Returns
Type Description
InventoryPages
An InventoryPages object containing information about owned items matching the given asset types.
Use GetInventoryAsync instead.

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

Deprecated:
Returns the item details for the given item.

Parameters
Parameter	Description
`itemId: number`	The ID of the item whose details are being retrieved.
`itemType: Enum.AvatarItemType`	An enum value indicating the type of item whose details are being retrieved.

Returns
Type	Description
`{ [string]: any }`	A table containing the item info for the retrieved item. See above for a sample table.

Use GetItemDetailsAsync instead.

AvatarEditorService:GetOutfitDetails(outfitId: number): { [string]: any }
Deprecated:
Returns the outfit details for the given outfit.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
outfitId: number
The ID of the outfit whose details are being retrieved.
Returns
Type Description
{ [string]: any }
A table containing the outfit info for the retrieved outfit. See above for a sample table.
Use GetOutfitDetailsAsync instead.

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

Deprecated:
Returns outfit data for the Players.LocalPlayer.

Parameters
Parameter	Description
`outfitSource: Enum.OutfitSource? = Enum.OutfitSource.All`	An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
`outfitType: Enum.OutfitType? = Enum.OutfitType.All`	An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.

Returns
Type	Description
`OutfitPages`	An `OutfitPages` object containing the outfit data for the local player.

Use GetOutfitsAsync instead.

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

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

Parameters
Parameter	Description
`assetType: Enum.AvatarAssetType`	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: number? = 0`	The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.

Returns
Type	Description
`{ any }`	A list of recommendations based on the given `AssetType`.

Use GetRecommendedAssetsAsync instead.

AvatarEditorService:GetRecommendedBundles(bundleId: number): { any }
Deprecated:
Returns a list of recommended bundles for a given bundle id.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
bundleId: number
A list of recommended bundles.
Returns
Type Description
{ any }
The bundle ID that the recommended bundles will be returned for.
Use GetRecommendedBundlesAsync instead.
AvatarEditorService:SearchCatalog(searchParameters: CatalogSearchParams): CatalogPages
Deprecated:
Returns a CatalogPages object containing the result of the given search.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
searchParameters: CatalogSearchParams
An object containing the parameters used for the search.
Returns
Type Description
CatalogPages
A CatalogPages object containing the search results.
Use SearchCatalogAsync instead.

Events27

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byAvatarEditorService17

AvatarEditorService.NotifyBustAvatarFetchCache: RBXScriptSignal<()>
- Hidden
- Roblox engine security
AvatarEditorService.OpenAllowInventoryReadAccess: RBXScriptSignal<()>
- Roblox script security
AvatarEditorService.OpenPromptCreateOufit: RBXScriptSignal<(humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,)>
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
AvatarEditorService.OpenPromptDeleteOutfit: RBXScriptSignal<(outfitId: number)>
- Roblox script security
Parameters
Parameter
outfitId: number
AvatarEditorService.OpenPromptRenameOutfit: RBXScriptSignal<(outfitId: number)>
- Roblox script security
Parameters
Parameter
outfitId: number
AvatarEditorService.OpenPromptSaveAvatar: RBXScriptSignal<(humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,)>
- Roblox script security
Parameters
Parameter
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
AvatarEditorService.OpenPromptSetFavorite: RBXScriptSignal<(itemId: number,itemType: Enum.AvatarItemType,shouldFavorite: boolean,)>
- Roblox script security
Parameters
Parameter
itemId: number
itemType: Enum.AvatarItemType
shouldFavorite: boolean
AvatarEditorService.OpenPromptUpdateOutfit: RBXScriptSignal<(outfitId: number,humanoidDescription: HumanoidDescription,rigType: Enum.HumanoidRigType,)>
- Roblox script security
Parameters
Parameter
outfitId: number
humanoidDescription: HumanoidDescription
rigType: Enum.HumanoidRigType
AvatarEditorService.PromptAllowInventoryReadAccessCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
Fires when the AvatarEditorService:PromptAllowInventoryReadAccess() prompt is responded to by the user.
- Capabilities: AssetRead + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
AvatarEditorService.PromptApplyProfileConfigurationCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
- Roblox script security
Parameters
Parameter
result: Enum.AvatarPromptResult
AvatarEditorService.PromptCreateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult,failureType: any,)>
Fires when the PromptSaveOutfit operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
failureType: any
AvatarEditorService.PromptDeleteOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
Fires when the PromptDeleteOutfit operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
AvatarEditorService.PromptRenameOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
Fires when the PromptRenameOutfit operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
AvatarEditorService.PromptSaveAvatarCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult,humanoidDescription: HumanoidDescription,)>
Fires when the AvatarEditorService:PromptSaveAvatar() operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
humanoidDescription: HumanoidDescription
AvatarEditorService.PromptSaveAvatarThumbnailCustomizationCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult,failureType: any,)>
- Roblox script security
Parameters
Parameter
result: Enum.AvatarPromptResult
failureType: any
AvatarEditorService.PromptSetFavoriteCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
Fires when the AvatarEditorService:PromptSetFavorite() operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult
AvatarEditorService.PromptUpdateOutfitCompleted: RBXScriptSignal<(result: Enum.AvatarPromptResult)>
Fires when the AvatarEditorService:PromptUpdateOutfit() operation is completed.
- Capabilities: PlatformAvatarEditing + Players
Parameters
Parameter
result: Enum.AvatarPromptResult

Parameter	Description
`attribute: string`	The name of the attribute being set.
`value: any`	The value to set the specified attribute to.

Parameter	Description
`childName: string`	The `Instance.Name` to be looked for.
`timeOut: number`	An optional time out parameter.

Parameter	Description
`itemIds: { any }`	The list of item ids to get details of.
`itemType: Enum.AvatarItemType`	The type of the item ids provided.

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

Parameter	Description
`itemId: number`	The ID of the specified asset or bundle.
`itemType: Enum.AvatarItemType`	The `AvatarItemType` of the specified asset or bundle.