HumanoidDescription

A JSON formatted array of Layered clothing where each table in the entry in the array describes an accessory's AssetId, AccessoryType, Order, and (optionally) Puffiness as key-value pairs. This can be edited in the properties windows for the HumanoidDescription.

To make changes from Luau (which is recommended over editing the JSON directly), use HumanoidDescription:SetAccessories() and HumanoidDescription:GetAccessories(). These methods can also be enabled to work with rigid accessories by setting IncludeRigidAccessories parameters to true.

BackAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied. The list cannot contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• FaceAccessory, FrontAccessory, HairAccessory, HatAccessory, NeckAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one

BodyTypeScale determines the factor by which the shape of a Humanoid is interpolated from the standard R15 body shape (0) to a taller and more slender body type (1). Values outside the range of 0 to 1 are clamped. When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a BodyTypeScale NumberValue within the Humanoid.

Note that when the value of this property is 0, the ProportionScale property has no effect.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• ProportionScale, which also affects rig proportions when this property is non-zero
• WidthScale, HeightScale and DepthScale, which provide finer control over the dimensions of a rig
• HeadScale, which provides specific control over the scale of the rig's head

When this description is applied to a Humanoid, ClimbAnimation determines the Animation.AnimationId to play when its state is Climbing.

See also:

• FallAnimation, IdleAnimation, JumpAnimation, RunAnimation, SwimAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

DepthScale determines by what factor the depth (back-to-front distance) of a Humanoid is scaled, as well as all accessories not attached to its head. When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a BodyDepthScale NumberValue within the Humanoid.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• BodyTypeScale and ProportionScale, which can provide more realistic rig proportions
• WidthScale and HeightScale

Face determines the asset ID of the Face to be applied to a Humanoid. The type of the asset ID provided must be for a Face type asset and not a Decal or Image type asset.

The actual face texture is rendered using a Decal in the Head named "face" or "Face".

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• GraphicTShirt, Shirt and Pants, which also apply textures to a rig
• Head, which can change the mesh of the head
• FaceAccessory, which can apply one or more Accessory objects to the face

FaceAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to the front of its face (such as glasses). The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FrontAccessory, HairAccessory, HatAccessory, NeckAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one
• Face, a property that determines what Face texture is used on the head

When this description is applied to a Humanoid, FallAnimation determines the Animation.AnimationId to play when its state is Freefall.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, IdleAnimation, JumpAnimation, RunAnimation, SwimAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

FrontAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to front of its torso (such as medals or ties). The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, HairAccessory, HatAccessory, NeckAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one

GraphicTShirt determines the Graphic used by a ShirtGraphic instance when Humanoid:ApplyDescriptionAsync() is called on a Humanoid. The asset type must be for a T‑Shirt, not a Decal or Image.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• Shirt, which can provide the same functionality in addition to providing textures for the entire torso and arms
• TorsoColor, which can change the color of the torso underneath the t-shirt texture

HairAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to its head resembling hair. The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, FrontAccessory, HatAccessory, NeckAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one

HatAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to its head. The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, FrontAccessory, HairAccessory, NeckAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one

Head determines the asset ID of the Head to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Torso, RightArm, LeftArm, RightLeg and LeftLeg, which are similar properties that also control body part
• HeadColor, which controls the color of this limb
• HatAccessory, HairAccessory and FaceAccessory, which all can apply Accessory objects which are joined to the head

HeadColor determines the BodyColors.HeadColor3 and BodyColors.HeadColor of a Humanoid when the description is applied.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• TorsoColor, LeftArmColor, RightArmColor, LeftLegColor, and RightLegColor, which are similar properties that also control body colors
• Head, which controls the mesh used for the head
• Face, which applies a texture to the front of the head

HeadScale determines by what factor the Head object of a Humanoid is scaled, as well as any accessories attached to it (such as those specified by HatAccessory and HairAccessory). When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a HeadScale NumberValue within the Humanoid.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• BodyTypeScale and ProportionScale, which can provide realistic rig proportions
• WidthScale, HeightScale and DepthScale, which provide finer control over other dimensions of a rig

HeightScale determines by what factor the height (top-to-bottom distance) of a Humanoid is scaled, as well as all accessories not attached to its head. When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a BodyHeightScale NumberValue within the Humanoid.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• BodyTypeScale and ProportionScale, which can provide more realistic rig proportions
• WidthScale and DepthScale

When this description is applied to a Humanoid, IdleAnimation determines the Animation.AnimationId to play when its state is Running at a speed near zero.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, FallAnimation, JumpAnimation, RunAnimation, SwimAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

When this description is applied to a Humanoid, JumpAnimation determines the Animation.AnimationId to play when its state is Jumping.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, FallAnimation, IdleAnimation, RunAnimation, SwimAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

LeftArm determines the asset ID of the LeftArm to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Head, Torso, RightArm, RightLeg and LeftLeg, which are similar properties that also control body part
• LeftArmColor, which controls the color of this limb

LeftArmColor determines the BodyColors.LeftArmColor3 and BodyColors.LeftArmColor of a Humanoid when the description is applied. For R15 and Rthro rigs, this property controls both the upper, lower, and hand parts of the left arm.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• HeadColor, TorsoColor, RightArmColor, LeftLegColor, and RightLegColor, which are similar properties that also control body colors
• LeftArm, which controls the mesh used for this limb
• Shirt, which can apply a texture to this limb

LeftLeg determines the asset ID of the LeftLeg to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Head, Torso, RightArm, LeftArm, and RightLeg, which are similar properties that also control body part
• LeftLegColor, which controls the color of this limb

LeftLegColor determines the BodyColors.LeftLegColor3 and BodyColors.LeftLegColor of a Humanoid when the description is applied. For R15 and Rthro rigs, this property controls both the upper, lower, and foot parts of the left leg.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• HeadColor, TorsoColor, LeftArmColor, RightArmColor, and RightLegColor, which are similar properties that also control body colors
• LeftLeg, which controls the mesh used for this limb
• Pants, which can apply a texture to this limb

When this description is applied to a Humanoid, this property sets the asset ID of the mood animation to apply. The asset ID must be for a Mood animation asset. Defaults to 0, in which case the character's face uses its neutral rest pose.

A mood animation applies a static facial pose to a character with a Dynamic Head, giving the face a characteristic expression (such as a smile) that persists while the head is otherwise idle.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• StaticFacialAnimation, which disables animated facial movement so that a Dynamic Head displays a static mood pose instead

NeckAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to its neck (such as scarves or necklaces). The list does not contain duplicates.

Any accessory can used in this property, even if it is meant to go in a different accessory spot. For example, an accessory meant to go on your back (such as a cape) could be included in HairAccessory. An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, FrontAccessory, HairAccessory, HatAccessory, ShouldersAccessory and WaistAccessory, which are similar properties that apply accessories like this one

Pants determines the PantsTemplate used by a Pants instance when Humanoid:ApplyDescriptionAsync() is called on a Humanoid. The asset type must be for Pants, not a Decal or Image.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• Shirt, a similar property which applies to a Shirt object
• TorsoColor, LeftLegColor and RightLegColor, which can change the color of the body parts underneath the pants texture

ProportionScale determines how wide (0) or narrow (1) a Humanoid rig is. Values outside the range of 0 to 1 are clamped. When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a BodyProportionScale NumberValue within the Humanoid.

Note that when the value of BodyTypeScale is 0, this property has no effect.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• BodyTypeScale, which also affects rig proportions
• WidthScale, HeightScale and DepthScale, which provide finer control over the dimensions of a rig
• HeadScale, which provides specific control over the scale of the rig's head

RightArm determines the asset ID of the RightArm to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Head, Torso, LeftArm, RightLeg and LeftLeg, which are similar properties that also control body part
• RightArmColor, which controls the color of this limb

RightArmColor determines the BodyColors.RightArmColor3 and BodyColors.RightArmColor of a Humanoid when the description is applied. For R15 and Rthro rigs, this property controls both the upper, lower, and hand parts of the right arm.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• HeadColor, TorsoColor, LeftArmColor, LeftLegColor, and RightLegColor, which are similar properties that also control body colors
• RightArm, which controls the mesh used for this limb
• Shirt, which can apply a texture to this limb

RightLeg determines the asset ID of the RightLeg to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Head, Torso, RightArm, LeftArm and LeftLeg, which are similar properties that also control body part
• RightLegColor, which controls the color of this limb

RightLegColor determines the BodyColors.RightLegColor3 and BodyColors.RightLegColor of a Humanoid when the description is applied. For R15 and Rthro rigs, this property controls both the upper, lower, and foot parts of the right leg.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• HeadColor, TorsoColor, LeftArmColor, RightArmColor, and LeftLegColor, which are similar properties that also control body colors
• RightLeg, which controls the mesh used for this limb
• Pants, which can apply a texture to this limb

When this description is applied to a Humanoid, RunAnimation determines the Animation.AnimationId to play when its state is Running at a moderate speed.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, FallAnimation, IdleAnimation, JumpAnimation, SwimAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

Shirt determines the ShirtTemplate used by a Shirt instance when Humanoid:ApplyDescriptionAsync() is called on a Humanoid. The asset type must be for Shirt, not a Decal or Image.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• Pants, a similar property which applies to a Pants object
• GraphicTShirt, a similar property which applies to a ShirtGraphic object
• TorsoColor, LeftArmColor and RightArmColor, which can change the color of the body parts underneath the shirt texture

ShouldersAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to its shoulders (such as shoulder-mounted critters). The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, FrontAccessory, HairAccessory, HatAccessory, NeckAccessory and WaistAccessory, which are similar properties that apply accessories like this one

StaticFacialAnimation controls whether facial animations play when this description is applied to a Humanoid with a Dynamic Head. When set to true, the head displays a static mood pose without any animated facial movement, achieving visual parity with classic face decals.

Even with StaticFacialAnimation set to true, MoodAnimation still applies a static pose to give the face its characteristic expression. Setting StaticFacialAnimation to true is different from setting MoodAnimation to 0, which would result in the Dynamic Head's neutral rest pose.

This is a per-description setting and does not affect other descriptions or the user's avatar globally.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.

When this description is applied to a Humanoid, SwimAnimation determines the Animation.AnimationId to play when its state is Swimming

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, FallAnimation, IdleAnimation, JumpAnimation, RunAnimation and WalkAnimation, which are similar properties that determine animations to play on the rig

Torso determines the asset ID of the Torso to be applied to a Humanoid.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• Head, RightArm, LeftArm, RightLeg and LeftLeg, which are similar properties that also control body part
• TorsoColor, which controls the color of this limb

TorsoColor determines the BodyColors.TorsoColor3 and BodyColors.TorsoColor of a Humanoid when the description is applied. For R15 and Rthro rigs, this property controls both the upper and lower parts of the torso.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• HeadColor, TorsoColor, LeftArmColor, RightArmColor, LeftLegColor, and RightLegColor, which are similar properties that also control body colors
• Torso, which controls the mesh used for this body part
• GraphicTShirt and Shirt, which can apply a texture to this body part

When true, Humanoid:ApplyDescriptionAsync or Players:CreateHumanoidModelFromDescriptionAsync will also apply the Avatar Settings set for the universe to the model.

WaistAccessory is a comma-separated list of asset IDs that determine what accessories should be added when the description is applied, usually those attached to its waist (such as belts). The list does not contain duplicates.

An error is thrown if you try to apply a new description which shares any assets with the existing description but a different accessory property.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• BackAccessory, FaceAccessory, FrontAccessory, HairAccessory, HatAccessory, NeckAccessory and ShouldersAccessory, which are similar properties that apply accessories like this one

When this description is applied to a Humanoid, WalkAnimation determines the Animation.AnimationId to play when its state is Running at a low speed

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• ClimbAnimation, FallAnimation, IdleAnimation, JumpAnimation, RunAnimation and SwimAnimation, which are similar properties that determine animations to play on the rig

WidthScale determines by what factor the width (left-to-right distance) of a Humanoid is scaled, as well as all accessories not attached to its head. When the description is applied through Humanoid:ApplyDescriptionAsync(), this value maps to a BodyWidthScale NumberValue within the Humanoid.

See Also#

• HumanoidDescription System, for more information on HumanoidDescription.
• BodyTypeScale and ProportionScale, which can provide more realistic rig proportions
• HeightScale and DepthScale

AddEmote will add an Emote asset to the description given a name and its asset ID. The asset ID must be for an "Emote" asset (see Featured emotes in the Catalog).

You can add multiple emotes of the same name. All emotes of the same name can be removed using RemoveEmote. If an emote with the same ID is added under the same name, EmotesChanged fires.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• GetEmotes, which can be used to retrieve the emotes that have been added by this function
• SetEmotes and RemoveEmote, which also manipulate what emotes have been added
• EmotesChanged, which fires after this function is called

Returns a table of an avatar's current accessories. If the second parameter (includeRigidAccessories) is true then the returned table will also include entries for rigid accessories from the rigid accessory properties.

GetEmotes returns a dictionary of emotes that have been added or set to this description. The keys of this dictionary are the names of the emotes, and the values are a non-empty array of emote IDs for that name.

Example#

local hd = Instance.new("HumanoidDescription")
hd:AddEmote("Salute", 3360689775)
local emotes = hd:GetEmotes()
for name, ids in emotes do
    print(("The emote %s has %d ids:"):format(name, #ids))
    for _, id in ids do
        print(id)
    end
end

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• SetEmotes and AddEmote, which can add emotes that may be returned by this function
• EmotesChanged, which fires with the value returned this function after it may have changed

GetEquippedEmotes returns an array of tables which indicate the Name and Slot of each equipped emote as it was set by SetEquippedEmotes.

Example#

local hd = Instance.new("HumanoidDescription")
hd:SetEmotes({Salute = {3360689775}, Agree = {4849487550}})
hd:SetEquippedEmotes({"Salute", "Agree"})
-- Iterate over the equipped emotes:
for _, t in hd:GetEquippedEmotes() do
    print(("In slot %d: emote %s is equipped"):format(t.Slot, t.Name))
end

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• SetEquippedEmotes, which sets the currently equipped emotes and changes what this function returns
• EquippedEmotesChanged, which fires when the function returned by this value may have changed

RemoveEmote removes all emotes from the description that have been added or set under the given name. If there are no added emotes with the given name, no error is thrown and EmotesChanged does not fire.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• SetEmotes and AddEmote, which can add emotes that may be removed
• GetEmotes, which can retrieve a dictionary of emotes that may be removed

Accepts a table that sets the accessories and related properties for an avatar. If the second parameter (includeRigidAccessories) is true, then this function can also be used to set the rigid accessories in the rigid accessory properties. In this case any table entry that does not have an Order will be considered a rigid accessory and put in the appropriate property according to the AccessoryType.

SetEmotes sets all of the emotes on this description given a table similar to that returned by GetEmotes. It fires EmotesChanged

Example#

local emotes = {
    Salute = {3360689775}, -- Syntax note: can also use ["Salute"] = ...
    Agree = {4849487550},
    Disagree = {4849495710}
}
local hd = Instance.new("HumanoidDescription")
hd:SetEmotes(emotes)

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• AddEmote and RemoveEmote which can modify the added emotes on an individual level
• EmotesChanged, which fires when this function is called

SetEquippedEmotes sets the currently equipped emotes given an array of emote names as they were passed to AddEmote or SetEmotes. It can also take an array of tables similar to that returned by GetEquippedEmotes. Calling this function fires EquippedEmotesChanged.

Example#

local hd = Instance.new("HumanoidDescription")
hd:SetEmotes({Salute = {3360689775}, Agree = {4849487550}})
-- Can provide either an array of strings... (index is slot number)
hd:SetEquippedEmotes({"Salute", "Agree"})
-- ...or an array of tables as returned by GetEquippedEmotes (Slot and Name keys set)
hd:SetEquippedEmotes({{Slot = 1, Name = "Salute"}, {Slot = 2, Name = "Agree"}})

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• GetEquippedEmotes, which returns a value describing the equipped emotes set by this function
• EquippedEmotesChanged, which fires when this function is called

EmotesChanged fires when emotes are added, removed or set on the description. The event fires with the new emote table as returned by GetEmotes.

If AddEmote is called with the same name and ID as an existing emote, this event fires.

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• AddEmote, RemoveEmote and HumanoidDescription:SetEmotes(), which can cause this event to be fired

EquippedEmotesChanged fires when the equipped emotes are set on this description using SetEquippedEmotes. It provides the new equipped emotes in a table like that returned by GetEquippedEmotes.

Example#

local hd = Instance.new("HumanoidDescription")
hd.EquippedEmotesChanged:Connect(function(equippedEmotes)
    print(("We have %d emotes equipped"):format(#equippedEmotes))
    for _, t in equippedEmotes do
        print(("In slot %d: emote %s is equipped"):format(t.Slot, t.Name))
    end
end)
hd:SetEquippedEmotes({"Salute", "Agree"}) --> We have 2 emotes equipped

See also:

• HumanoidDescription System, for more information on HumanoidDescription.
• SetEquippedEmotes, which fires this event
• GetEquippedEmotes, which can be used to query the currently equipped emotes without this event firing