HumanoidDescription

Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes.

Memory category: Instances
Own members: 55
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties68

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byHumanoidDescription45

Property categoryAccessories

HumanoidDescription.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 as key-value pairs.
- Not replicated
- Not scriptable
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.BackAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its back (such as capes).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.FaceAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to the front of its face (such as glasses).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.FrontAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to front of its torso (such as medals or ties).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.HairAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its head resembling hair.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.HatAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its head.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.NeckAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its neck (such as scarves or necklaces).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.ShouldersAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its shoulders (such as shoulder-mounted critters).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.WaistAccessory: string = ""
A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its waist (such as belts).
- Not replicated
- Read capabilities: AvatarAppearance
- Load only

Property categoryAnimation

HumanoidDescription.ClimbAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Climbing.
- Read capabilities: AvatarAppearance
HumanoidDescription.FallAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Freefall.
- Read capabilities: AvatarAppearance
HumanoidDescription.IdleAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a speed near zero.
- Read capabilities: AvatarAppearance
HumanoidDescription.JumpAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Jumping.
- Read capabilities: AvatarAppearance
HumanoidDescription.MoodAnimation: number = 0
When this description is applied to a Humanoid, this determines the asset ID of the mood animation that gives the character's face its persistent expression.
- Read capabilities: AvatarAppearance
HumanoidDescription.NumberEmotesLoaded: number = -1
- Hidden
- Roblox script security
- Read capabilities: AvatarAppearance
HumanoidDescription.RunAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a moderate speed.
- Read capabilities: AvatarAppearance
HumanoidDescription.StaticFacialAnimation: boolean = false
When true, disables facial animations on a Dynamic Head, displaying a static mood pose instead. Defaults to false.
- Capabilities: AvatarAppearance
HumanoidDescription.SwimAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Swimming.
- Read capabilities: AvatarAppearance
HumanoidDescription.WalkAnimation: number = 0
When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a low speed.
- Read capabilities: AvatarAppearance

Property categoryBody Colors

HumanoidDescription.HeadColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.HeadColor3 and BodyColors.HeadColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.LeftArmColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.LeftArmColor3 and BodyColors.LeftArmColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.LeftLegColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.LeftLegColor3 and BodyColors.LeftLegColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.RightArmColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.RightArmColor3 and BodyColors.RightArmColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.RightLegColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.RightLegColor3 and BodyColors.RightLegColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.TorsoColor: Color3 = Color3.new(0, 0, 0)
Determines the BodyColors.TorsoColor3 and BodyColors.TorsoColor of a Humanoid when applied.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only

Property categoryBody Parts

HumanoidDescription.Face: number = 0
Determines the asset ID of the Face to be applied to the Humanoid.
- Read capabilities: AvatarAppearance
HumanoidDescription.Head: number = 0
Determines the asset ID of the Head to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.LeftArm: number = 0
Determines the asset ID of the LeftArm to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.LeftLeg: number = 0
Determines the asset ID of the LeftLeg to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.RightArm: number = 0
Determines the asset ID of the RightArm to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.RightLeg: number = 0
Determines the asset ID of the RightLeg to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only
HumanoidDescription.Torso: number = 0
Determines the asset ID of the Torso to be applied to the Humanoid.
- Not replicated
- Read capabilities: AvatarAppearance
- Load only

Property categoryClothes

HumanoidDescription.GraphicTShirt: number = 0
Determines the Graphic used by a ShirtGraphic.
- Read capabilities: AvatarAppearance
HumanoidDescription.Pants: number = 0
Determines the PantsTemplate used by a Pants instance.
- Read capabilities: AvatarAppearance
HumanoidDescription.Shirt: number = 0
Determines the ShirtTemplate used by a Shirt instance.
- Read capabilities: AvatarAppearance

Property categoryData

HumanoidDescription.EmotesDataInternal: string = ""
- Hidden
- Not scriptable
- Read capabilities: AvatarAppearance
HumanoidDescription.EquippedEmotesDataInternal: string = ""
- Hidden
- Not scriptable
- Read capabilities: AvatarAppearance
HumanoidDescription.ResetIncludesBodyParts: boolean = true
- Hidden
- Roblox script security
- Read capabilities: AvatarAppearance
HumanoidDescription.UseAvatarSettings: boolean = false
When true, applying this description also applies the experience's Avatar Settings to the resulting model. Defaults to false.
- Read capabilities: AvatarAppearance

Property categoryScale

HumanoidDescription.BodyTypeScale: number = 0.300000012
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).
- Read capabilities: AvatarAppearance
HumanoidDescription.DepthScale: number = 1
Determines by what factor the depth (back-to-front distance) of a Humanoid is scaled.
- Read capabilities: AvatarAppearance
HumanoidDescription.HeadScale: number = 1
Determines by what factor the Head object of a Humanoid is scaled, as well as any accessories attached to it.
- Read capabilities: AvatarAppearance
HumanoidDescription.HeightScale: number = 1
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.
- Read capabilities: AvatarAppearance
HumanoidDescription.ProportionScale: number = 1
Determines how wide (0) or narrow (1) a Humanoid rig is.
- Read capabilities: AvatarAppearance
HumanoidDescription.WidthScale: number = 1
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.
- Read capabilities: AvatarAppearance

Methods50

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byHumanoidDescription8

HumanoidDescription:AddEmote(name: string, assetId: number)
Adds the emote to the description given a name and its asset ID.
- Capabilities: AvatarAppearance
Parameters
Parameter Description
name: string
A string that identifies what emote is being added. Example: "Salute".
assetId: number
An emote asset ID.

HumanoidDescription:GetAccessories(includeRigidAccessories: boolean): { any }

Returns a table of an avatar's current accessories.

Parameters
Parameter	Description
`includeRigidAccessories: boolean`	Set to true if rigid accessories from the rigid accessory properties should also be included in the return array. False means only include layered clothing accessories from the AccessoryBlob.

Returns
Type	Description
`{ any }`	Returns an array where each entry specifies for an individual accessory the AccessoryType, AssetId, IsLayered, Order and Puffiness.

HumanoidDescription:GetEmotes(): { [string]: any }

Returns a dictionary of emotes that have been added or set to this description.

Returns
Type	Description
`{ [string]: any }`	A dictionary of emotes where the key is the emote name and the value is an array of emote asset IDs. Example: `{ Salute = {3360689775}, Agree = {4849487550}, Disagree = {4849495710} }` .

HumanoidDescription:GetEquippedEmotes(): { any }

Returns an array of tables describing the equipped emotes that have been set.

Returns
Type	Description
`{ any }`	An array of tables describing the name and slot which each emote is equipped. Example: `{ {Slot = 3, Name = "Salute"}, {Slot = 2, Name = "Agree"}, {Slot = 1, Name = "Disagree"}, }` .

HumanoidDescription:RemoveEmote(name: string)
Removes any emotes that have been added under the given name.
- Capabilities: AvatarAppearance
Parameters
Parameter Description
name: string
The name of the emote as it was set or added.

HumanoidDescription:SetAccessories(accessories: { any },includeRigidAccessories: boolean,)

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

Parameters
Parameter	Description
`accessories: { any }`	Each entry specifies for an individual accessory the AccessoryType, AssetId, IsLayered, Order and Puffiness.
`includeRigidAccessories: boolean`	Set to true if rigid accessories are also included in the passed in array (they would have to not specify Order).

HumanoidDescription:SetEmotes(emotes: { [string]: any })

Sets all of the emotes on this description.

Parameters
Parameter	Description
`emotes: { [string]: any }`	A dictionary of emotes where the key is the emote name and the value is an array of emote asset IDs. Example: `{ Salute = {3360689775}, Agree = {4849487550}, Disagree = {4849495710} }` .

HumanoidDescription:SetEquippedEmotes(equippedEmotes: { any })

Sets the currently equipped emotes given an array of emote names.

Parameters
Parameter	Description
`equippedEmotes: { any }`	An array of emote names. Example: `{ "Disagree", "Agree", "Salute" }` – OR – An array of tables describing the name and slot which each emote is equipped. Example: `{ {Slot = 3, Name = "Salute"}, {Slot = 2, Name = "Agree"}, {Slot = 1, Name = "Disagree"}, }` .

Events12

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byHumanoidDescription2

HumanoidDescription.EmotesChanged: RBXScriptSignal<(newEmotes: { [string]: any })>
Fires when emotes are added, removed or set on this description.
- Capabilities: AvatarAppearance
Parameters
Parameter
newEmotes: { [string]: any }
HumanoidDescription.EquippedEmotesChanged: RBXScriptSignal<(newEquippedEmotes: { any })>
Fires when the equipped emotes are set on this description.
- Capabilities: AvatarAppearance
Parameters
Parameter
newEquippedEmotes: { any }