HumanoidDescription¶
Not yet Class
Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes.
Not implemented yet
Modern avatar descriptions are not implemented.
Workaround: Apply legacy body-part meshes and clothing assets directly.
0 Nova members · 56 modern Roblox members not implemented yet
Description¶
HumanoidDescription is an object that stores a description of a Humanoid for R6 and R15 rigs. It can be applied in order to set a rig's scaling, clothing (Shirt, Pants, ShirtGraphic), Accessories, Animations and BodyColors.
You can get a HumanoidDescription by using the following functions:
- Players.GetHumanoidDescriptionFromUserIdAsync(), for an outfit currently being worn by a user on Roblox.
- Players.GetHumanoidDescriptionFromOutfitIdAsync(), for an outfit created by a user on Roblox.
- You can create a Humanoid rig model from a HumanoidDescription through Players.CreateHumanoidModelFromDescriptionAsync().
See also:
- HumanoidDescription System, for more information on HumanoidDescription.
Inheritance¶
Object → Instance → HumanoidDescription
Properties¶
| Member | Signature | Summary |
|---|---|---|
AccessoryBlob |
AccessoryBlob: string |
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… |
BackAccessory |
BackAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
BodyTypeScale |
BodyTypeScale: float |
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). |
ClimbAnimation |
ClimbAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
DepthScale |
DepthScale: float |
Determines by what factor the depth (back-to-front distance) of a Humanoid is scaled. |
EmotesDataInternal |
EmotesDataInternal: string |
— |
EquippedEmotesDataInternal |
EquippedEmotesDataInternal: string |
— |
Face |
Face: int64 |
Determines the asset ID of the Face to be applied to the Humanoid. |
FaceAccessory |
FaceAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
FallAnimation |
FallAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
FrontAccessory |
FrontAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
GraphicTShirt |
GraphicTShirt: int64 |
Determines the Graphic used by a ShirtGraphic. |
HairAccessory |
HairAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
HatAccessory |
HatAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
Head |
Head: int64 |
Determines the asset ID of the Head to be applied to the Humanoid. |
HeadColor |
HeadColor: Color3 |
Determines the BodyColors.HeadColor3 and BodyColors.HeadColor of a Humanoid when [applied](Humanoid… |
HeadScale |
HeadScale: float |
Determines by what factor the Head object of a Humanoid is scaled, as well as any accessories attached to it. |
HeightScale |
HeightScale: float |
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. |
IdleAnimation |
IdleAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
JumpAnimation |
JumpAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
LeftArm |
LeftArm: int64 |
Determines the asset ID of the LeftArm to be applied to the Humanoid. |
LeftArmColor |
LeftArmColor: Color3 |
Determines the BodyColors.LeftArmColor3 and BodyColors.LeftArmColor of a Humanoid when applie… |
LeftLeg |
LeftLeg: int64 |
Determines the asset ID of the LeftLeg to be applied to the Humanoid. |
LeftLegColor |
LeftLegColor: Color3 |
Determines the BodyColors.LeftLegColor3 and BodyColors.LeftLegColor of a Humanoid when applie… |
MoodAnimation |
MoodAnimation: int64 |
When this description is applied to a Humanoid, this determines the asset ID of the mood animation that gives the cha… |
NeckAccessory |
NeckAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
NumberEmotesLoaded |
NumberEmotesLoaded: int |
— |
Pants |
Pants: int64 |
Determines the PantsTemplate used by a Pants instance. |
ProportionScale |
ProportionScale: float |
Determines how wide (0) or narrow (1) a Humanoid rig is. |
ResetIncludesBodyParts |
ResetIncludesBodyParts: bool |
— |
RightArm |
RightArm: int64 |
Determines the asset ID of the RightArm to be applied to the Humanoid. |
RightArmColor |
RightArmColor: Color3 |
Determines the BodyColors.RightArmColor3 and BodyColors.RightArmColor of a Humanoid when applied. |
RightLeg |
RightLeg: int64 |
Determines the asset ID of the RightLeg to be applied to the Humanoid. |
RightLegColor |
RightLegColor: Color3 |
Determines the BodyColors.RightLegColor3 and BodyColors.RightLegColor of a Humanoid when applied. |
RunAnimation |
RunAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
Shirt |
Shirt: int64 |
Determines the ShirtTemplate used by a Shirt instance. |
ShouldersAccessory |
ShouldersAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
StaticFacialAnimation |
StaticFacialAnimation: bool |
When true, disables facial animations on a Dynamic Head, displaying a static mood pose instead. Defaults to false. |
SwimAnimation |
SwimAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
Torso |
Torso: int64 |
Determines the asset ID of the Torso to be applied to the Humanoid. |
TorsoColor |
TorsoColor: Color3 |
Determines the BodyColors.TorsoColor3 and BodyColors.TorsoColor of a Humanoid when applied. |
UseAvatarSettings |
UseAvatarSettings: bool |
When true, applying this description also applies the experience's Avatar Settings to the resulting model. Defaults to false. |
WaistAccessory |
WaistAccessory: string |
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied,… |
WalkAnimation |
WalkAnimation: int64 |
When this description is applied to a Humanoid, this determines the Animation.AnimationId… |
WidthScale |
WidthScale: float |
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. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
AddEmote |
HumanoidDescription:AddEmote(name: string, assetId: int64): null |
Adds the emote to the description given a name and its asset ID. |
GetAccessories |
HumanoidDescription:GetAccessories(includeRigidAccessories: bool): Array |
Returns a table of an avatar's current accessories. |
GetEmotes |
HumanoidDescription:GetEmotes(): Dictionary |
Returns a dictionary of emotes that have been added or set to this description. |
GetEquippedEmotes |
HumanoidDescription:GetEquippedEmotes(): Array |
Returns an array of tables describing the equipped emotes that have been set. |
RemoveEmote |
HumanoidDescription:RemoveEmote(name: string): null |
Removes any emotes that have been added under the given name. |
SetAccessories |
HumanoidDescription:SetAccessories(accessories: Array, includeRigidAccessories: bool): null |
Accepts a table that sets the accessories and related properties for an avatar. |
SetEmotes |
HumanoidDescription:SetEmotes(emotes: Dictionary): null |
Sets all of the emotes on this description. |
SetEquippedEmotes |
HumanoidDescription:SetEquippedEmotes(equippedEmotes: Array): null |
Sets the currently equipped emotes given an array of emote names. |
Events¶
| Member | Signature | Summary |
|---|---|---|
EmotesChanged |
EmotesChanged(newEmotes: Dictionary) |
Fires when emotes are added, removed or set on this description. |
EquippedEmotesChanged |
EquippedEmotesChanged(newEquippedEmotes: Array) |
Fires when the equipped emotes are set on this description. |
Roblox reference: HumanoidDescription
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.