PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. AvatarEditorService

AvatarEditorService

Show deprecated
Hide content
  1. apireference
  2. avatareditorservice

AvatarEditorService

Show deprecated

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.

See also

For more information regarding the Avatar Editor, take a look at the articles/avatar editor service article.

Properties

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

HumanoidDescription

CheckApplyDefaultClothing ( HumanoidDescription humanoidDescription )

[Yields]

Used to apply default clothing to the HumanoidDescription if necessary.
HumanoidDescription

ConformToAvatarRules ( HumanoidDescription humanoidDescription )

[Yields]
Dictionary

GetAvatarRules ( )

[Yields]

Returns the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect.
Array

GetBatchItemDetails ( Array itemIds , AvatarItemType itemType )

[Yields]

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

GetFavorite ( int64 itemId , AvatarItemType itemType )

[Yields]

Returns if the Players/LocalPlayer has favorited the given bundle or asset
InventoryPages

GetInventory ( Array assetTypes )

[Yields]

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

GetItemDetails ( int64 itemId , AvatarItemType itemType )

[Yields]

Returns the item details for the given item
OutfitPages

GetOutfits ( OutfitSource outfitSource )

[Yields]

Returns outfit data for the Players/LocalPlayer
Array

GetRecommendedAssets ( AvatarAssetType assetType , int64 contextAssetId )

[Yields]

Returns a list of recommendations based on the given Enum/AssetType
Array

GetRecommendedBundles ( int64 bundleId )

[Yields]

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

NoPromptCreateOutfit ( HumanoidDescription humanoidDescription , HumanoidRigType rigType , string name )

bool

NoPromptDeleteOutfit ( int64 outfitId )

bool

NoPromptRenameOutfit ( int64 outfitId , string name )

bool

NoPromptSaveAvatar ( HumanoidDescription humanoidDescription , HumanoidRigType rigType , Dictionary saveDict , int64 gearAssetId )

bool

NoPromptSetFavorite ( int64 itemId , AvatarItemType itemType , bool shouldFavorite )

bool

NoPromptUpdateOutfit ( int64 outfitId , HumanoidDescription humanoidDescription , HumanoidRigType rigType )

void

PerformCreateOutfit ( string name )

void

PerformCreateOutfitWithDescription ( HumanoidDescription humanoidDescription , string name )

void

PerformDeleteOutfit ( )

void

PerformRenameOutfit ( string name )

void

PerformSaveAvatarNew ( Array addedAssets , Array removedAssets )

void

PerformSaveAvatarWithDescription ( HumanoidDescription humanoidDescription , Array addedAssets , Array removedAssets )

void

PerformSetFavorite ( )

void

PerformUpdateOutfit ( HumanoidDescription humanoidDescription )

void

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
void

PromptCreateOutfit ( HumanoidDescription outfit , HumanoidRigType rigType )

Prompts the Players/LocalPlayer to save the given HumanoidDescription as an outfit
void

PromptDeleteOutfit ( int64 outfitId )

Prompts the Players/LocalPlayer to delete the given outfit.
void

PromptRenameOutfit ( int64 outfitId )

Prompts the Players/LocalPlayer to rename the given outfit.
void

PromptSaveAvatar ( HumanoidDescription humanoidDescription , HumanoidRigType rigType )

Prompts the Players/LocalPlayer to update their avatar based on the given HumanoidDescription and Enum/RigType of R6 or R15
void

PromptSetFavorite ( int64 itemId , AvatarItemType itemType , bool shouldFavorite )

Prompts the Players/LocalPlayer to favorite or unfavorite the given asset or bundle
void

PromptUpdateOutfit ( int64 outfitId , HumanoidDescription updatedOutfit , HumanoidRigType rigType )

Prompts the Players/LocalPlayer to update the given outfit.
CatalogPages

SearchCatalog ( CatalogSearchParams searchParameters )

[Yields]

Returns a CatalogPages object containing the result of the given search
void

SetAllowInventoryReadAccess ( bool inventoryReadAccessGranted )

void

SignalCreateOutfitFailed ( )

void

SignalCreateOutfitPermissionDenied ( )

void

SignalDeleteOutfitFailed ( )

void

SignalDeleteOutfitPermissionDenied ( )

void

SignalRenameOutfitFailed ( )

void

SignalRenameOutfitPermissionDenied ( )

void

SignalSaveAvatarFailed ( )

void

SignalSaveAvatarPermissionDenied ( )

void

SignalSetFavoriteFailed ( )

void

SignalSetFavoritePermissionDenied ( )

void

SignalUpdateOutfitFailed ( )

void

SignalUpdateOutfitPermissionDenied ( )

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

OpenAllowInventoryReadAccess ( )

RBXScriptSignal

OpenPromptCreateOufit ( HumanoidDescription humanoidDescription , HumanoidRigType rigType )

RBXScriptSignal

OpenPromptDeleteOutfit ( int64 outfitId )

RBXScriptSignal

OpenPromptRenameOutfit ( int64 outfitId )

RBXScriptSignal

OpenPromptSaveAvatar ( HumanoidDescription humanoidDescription , HumanoidRigType rigType )

RBXScriptSignal

OpenPromptSetFavorite ( int64 itemId , AvatarItemType itemType , bool shouldFavorite )

RBXScriptSignal

OpenPromptUpdateOutfit ( int64 outfitId , HumanoidDescription humanoidDescription , HumanoidRigType rigType )

RBXScriptSignal

PromptAllowInventoryReadAccessCompleted ( AvatarPromptResult result )

Fires when the AvatarEditorService/PromptAllowInventoryReadAccess prompt is responded to by the user
RBXScriptSignal

PromptCreateOutfitCompleted ( AvatarPromptResult result , Variant failureType )

Fires when the PromptSaveOutfit operation is completed
RBXScriptSignal

PromptDeleteOutfitCompleted ( AvatarPromptResult result )

Fires when the PromptDeleteOutfit operation is completed.
RBXScriptSignal

PromptRenameOutfitCompleted ( AvatarPromptResult result )

Fires when the PromptRenameOutfit operation is completed.
RBXScriptSignal

PromptSaveAvatarCompleted ( AvatarPromptResult result , HumanoidDescription humanoidDescription )

Fires when the AvatarEditorService/PromptSaveAvatar operation is completed
RBXScriptSignal

PromptSetFavoriteCompleted ( AvatarPromptResult result )

Fires when the AvatarEditorService/PromptSetFavorite operation is completed.
RBXScriptSignal

PromptUpdateOutfitCompleted ( AvatarPromptResult result )

Fires when the AvatarEditorService/PromptUpdateOutfit operation is completed.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]