This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.
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:
|table (see below)||Describes the BrickColor values for each limb|
|table (see below)||Describes the equipped assets (hats, body parts, etc)|
|bool||Describes whether default pants are applied|
|bool||Describes whether default shirt is applied|
|string||Either "R15" or "R6"|
|table (see below)||Describes various body scaling factors|
The assets table is an array of tables containing the following keys that describe the assets currently equipped by the player:
|number||The asset ID of the equipped asset|
|table||A table with |
|string||The name of the equipped asset|
The scales table has the following keys, each a number corresponding to one
Humanoid scaling property:
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
The *userId of the specified player.
A dictionary containing information about the character appearance of a given user.
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?