The Developer Hub is now deprecated and information on this page may no longer be accurate. Instead, you should go to our new and improved documentation. You can also learn more about the future of documentation.
Collapse Sidebar


This function returns information about a player’s avatar (ignoring gear) on the Roblox website in the form of a dictionary. It is not to be confused with Players/GetCharacterAppearanceAsync|GetCharacterAppearanceAsync, which actually loads the assets described by this method. You can use InsertService/LoadAsset to load the assets that are used in the player’s avatar. The structure of the returned dictionary is as follows:

Name Type Description
bodyColorstable (see below)Describes the BrickColor values for each limb
assetstable (see below)Describes the equipped assets (hats, body parts, etc)
defaultPantsAppliedboolDescribes whether default pants are applied
defaultShirtAppliedboolDescribes whether default shirt is applied
playerAvatarTypestringEither "R15" or "R6"
scalestable (see below)Describes various body scaling factors

Assets sub-table

The assets table is an array of tables containing the following keys that describe the assets currently equipped by the player:

Name Type Description
idnumberThe asset ID of the equipped asset
assetTypetableA table with name and id fields, each describing the kind of asset equipped ("Hat", "Face", etc.)
namestringThe name of the equipped asset

Scales sub-table

The scales table has the following keys, each a number corresponding to one Humanoid scaling property:
bodyType, head, height, proportion, depth, width

Body Colors sub-table

The body colors table has the following keys, each a number corresponding to a DataType/BrickColor ID number which can be used with BrickColor.new(id):
leftArmColorId, torsoColorId, rightArmColorId, headColorId, leftLegColorId, rightLegColorId


Name Type Default Description

The *userId of the specified player.


Return Type Summary

A dictionary containing information about the character appearance of a given user.

Code Samples

Example Return Character Appearance Dictionary

Sometimes it is best to see an example of the returned dictionary structure in pure Lua. Here is one such example of a player whose avatar uses a package and wears several hats. Can you guess who it is?