PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. HumanoidDescription

HumanoidDescription

Show deprecated
Hide content
  1. apireference
  2. humanoiddescription

HumanoidDescription

Show deprecated

HumanoidDescription is an object that stores a description a Humanoid for R6 and R15 rigs. It can be Humanoid/ApplyDescription|applied in order to set a rig’s scaling, clothing (Shirt, Pants, ShirtGraphic), Accessory|Accessories, Animation|Animations and BodyColors.

You can get a HumanoidDescription by using the following functions:

  • Players/GetHumanoidDescriptionFromUserId, for an outfit currently being worn by a user on Roblox.com

  • Players/GetHumanoidDescriptionFromOutfitId, for an outfits created by a user on Roblox.com

  • You can create a Humanoid rig model from a HumanoidDescription through Players/CreateHumanoidModelFromDescription.

See also

  • articles/humanoiddescription system|HumanoidDescription System, for more information on HumanoidDescription

Properties

string

AccessoryBlob

[NotScriptable]

A JSON formatted array of Layered Accessorys where each table in the entry in the array describes an accessory’s AssetId, AccessoryType, Order, and (optionally) Puffiness as key-value pairs.
string

BackAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its back (such as capes)
float

BodyTypeScale

Determines the factor by which the shape of a Humanoid rig is interpolated from the standard R15 body shape (0) to a taller and more slender body type (1); when Humanoid/ApplyDescription|applied, maps to the “BodyTypeScale” NumberValue within the HumanoidDescription
int64

ClimbAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Climbing
float

DepthScale

Determines by what factor the depth (back-to-front distance) of a Humanoid rig is scaled; when Humanoid/ApplyDescription|applied, maps to the “DepthScale” NumberValue within the Humanoid
int64

Face

Determines the asset ID of the Face to be applied to the Humanoid
string

FaceAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to the front of its face (such as glasses)
int64

FallAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Freefall
string

FrontAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to front of its torso (such as medals or ties)
int64

GraphicTShirt

Determines the ShirtGraphic/Graphic|Graphic used by a ShirtGraphic when Humanoid/ApplyDescription|applied
string

HairAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its head resembling hair
string

HatAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its head
int64

Head

Determines the asset ID of the Head to be applied to the Humanoid
Color3

HeadColor

Determines the BodyColors/HeadColor3 of a Humanoid when Humanoid/ApplyDescription|applied
float

HeadScale

Determines by what factor the Head of a Humanoid is scaled; when Humanoid/ApplyDescription|applied, maps to the “HeadScale” NumberValue within the Humanoid
float

HeightScale

Determines by what factor the height (top-to-bottom distance) of a Humanoid rig is scaled; when Humanoid/ApplyDescription|applied, maps to the “HeightScale” NumberValue within the Humanoid
int64

IdleAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Running at a speed near zero
int64

JumpAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Jumping
int64

LeftArm

Determines the asset ID of the LeftArm to be applied to the Humanoid
Color3

LeftArmColor

Determines the BodyColors/LeftArmColor3 of a Humanoid when applied
int64

LeftLeg

Determines the asset ID of the LeftLeg to be applied to the Humanoid
Color3

LeftLegColor

Determines the BodyColors/LeftLegColor3 of a Humanoid when applied
string

NeckAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its neck (such as scarves or necklaces)
int

NumberEmotesLoaded

[Hidden]
int64

Pants

Determines the Pants/PantsTemplate|PantsTemplate used by a Pants when Humanoid/ApplyDescription|applied
float

ProportionScale

Determines how wide (0) or narrow (1) a Humanoid rig is; when Humanoid/ApplyDescription|applied, maps to the “BodyProportionScale” NumberValue within the Humanoid.
int64

RightArm

Determines the asset ID of the RightArm to be applied to the Humanoid
Color3

RightArmColor

Determines the BodyColors/RightArmColor3 of a Humanoid when applied
int64

RightLeg

Determines the asset ID of the RightLeg to be applied to the Humanoid
Color3

RightLegColor

Determines the BodyColors/RightLegColor3 of a Humanoid when applied
int64

RunAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Running at a moderate speed.
int64

Shirt

Determines the Shirt/ShirtTemplate|ShirtTemplate used by a Shirt when Humanoid/ApplyDescription|applied
string

ShouldersAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its shoulders (such as shoulder-mounted critters)
int64

SwimAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Swimming
int64

Torso

Determines the asset ID of the Torso to be applied to the Humanoid
Color3

TorsoColor

Determines the BodyColors/TorsoColor3 of a Humanoid when applied
string

WaistAccessory

A comma-separated list of asset IDs that will be added as Accessory|Accessories to a Humanoid rig when Humanoid/ApplyDescription|applied, usually those attached to its waist (such as belts)
int64

WalkAnimation

When this description is Humanoid/ApplyDescription|applied to a Humanoid, this determines the Animation/AnimationId to play when its Humanoid/GetState|state is enum/HumanoidStateType|Running at a low speed
float

WidthScale

Determines by what factor the width (left-to-right distance) of a Humanoid is scaled; when Humanoid/ApplyDescription|applied, maps to the “BodyWidthScale” NumberValue within the Humanoid

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

void

AddEmote ( string name , int64 assetId )

Adds the emote to the description given a name and its asset ID
Array

GetAccessories ( bool includeRigidAccessories )

Returns a table of an avatar’s current accessories.
Dictionary

GetEmotes ( )

Returns a dictionary of emotes that have been HumanoidDescription/AddEmote|added or HumanoidDescription/SetEmotes|set to this description
Array

GetEquippedEmotes ( )

Returns an array of tables describing the equipped emotes that have been HumanoidDescription/SetEquippedEmotes|set
void

RemoveEmote ( string name )

Removes any emotes that have been added under the given name
void

SetAccessories ( Array accessories , bool includeRigidAccessories )

Accepts a table that sets the accessories and related properties for an avatar.
void

SetEmotes ( Dictionary emotes )

Sets all of the emotes on this description
void

SetEquippedEmotes ( Array equippedEmotes )

Sets the currently equipped emotes given an array of emote names

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 FullName (or partial FullName).
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

EmotesChanged ( Dictionary newEmotes )

Fires when emotes are added, removed or set on this description
RBXScriptSignal

EquippedEmotesChanged ( Array newEquippedEmotes )

Fires when the equipped emotes are HumanoidDescription/SetEquippedEmotes|set on this description

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 when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

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

Destroying ( )

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]
Humanoid Pants