API:Class/Humanoid

This page is about the Humanoid class. For the SelectionLasso property, see API:Class/SelectionLasso/Humanoid.

Humanoid icon.pngHumanoid : Object Icon.pngInstance

The Humanoid is a special object that gives models the functionality of a character. It grants the model with the ability to physically walk around and interact with various components of a ROBLOX level.

Humanoids are always parented inside of a Model, and the model is expected to be an assembly of Parts and Motor6Ds; the root part of the assembly is expected to be named HumanoidRootPart. It also expects a part named Head to be connected to the character's torso part, either directly or indirectly.

By default, there are two official types of character rigs supplied by ROBLOX, each with their own set of rules:

R6

  • A basic character rig that uses 6 parts for limbs.
  • The Head part must be attached to a part named Torso, or the Humanoid will die immediately.
  • BodyPart appearances are applied using CharacterMesh objects.
  • Certain properties, such as LeftLeg and RightLeg, only work with R6.

R15

  • More complex than R6, but also far more flexible and robust.
  • Uses 15 parts for limbs.
  • The Head part must be attached to a part named UpperTorso or the Humanoid will die immediately.
  • BodyPart appearances have to be assembled directly.
  • Can be dynamically rescaled by using special NumberValue objects parented inside of the Humanoid.
    • The Humanoid will automatically create Vector3Value objects named OriginalSize inside of each limb.
    • If a NumberValue is parented inside of the Humanoid and is named one of the following, it will be used to control the scaling functionality:
      • BodyDepthScale
      • BodyHeightScale
      • BodyWidthScale
      • HeadScale

Properties

PropertiesmemberhiddenProperties [toggle]

boolAutoJumpEnabled

Sets whether the character will automatically jump when they hit an obstacle on a mobile device.

|RMD member="API:Class/Humanoid/AutoJumpEnabled"|Sets whether the character will automatically jump when they hit an obstacle on a mobile device.|/RMD|
boolAutoRotate

Sets whether the character model automatically orients itself to the direction the player is moving their character.

|RMD member="API:Class/Humanoid/AutoRotate"|Sets whether the character model automatically orients itself to the direction the player is moving their character.|/RMD|
Vector3CameraOffset

Allows you to set the camera's offset from the character's HumanoidRootPart, when a Humanoid is the target of the camera.

|RMD member="API:Class/Humanoid/CameraOffset"|Allows you to set the camera's offset from the character's HumanoidRootPart, when a Humanoid is the target of the camera.|/RMD|
HumanoidDisplayDistanceTypeDisplayDistanceType

Sets how the Humanoid's parent Model displays name and health info.

|RMD member="API:Class/Humanoid/DisplayDistanceType"|Sets how the Humanoid's parent Model displays name and health info.|/RMD|
MaterialFloorMaterial [readonly]

This property contains the Material of the part or terrain cell that the Humanoid is currently standing on.

|RMD member="API:Class/Humanoid/FloorMaterial"|This property contains the Material of the part or terrain cell that the Humanoid is currently standing on.|/RMD|
floatHealth

The amount of health a humanoid character has, from 0 to MaxHealth, defaults to 100.

|RMD member="API:Class/Humanoid/Health"|The amount of health a humanoid character has, from 0 to MaxHealth, defaults to 100.|/RMD|
floatHealthDisplayDistance

Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see health or how far this humanoid's health displays. See Humanoid view distance for more info.

|RMD member="API:Class/Humanoid/HealthDisplayDistance"|Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see health or how far this humanoid's health displays. See Humanoid view distance for more info.|/RMD|
HumanoidHealthDisplayTypeHealthDisplayType

Controls how the Humanoid's health is displayed.

|RMD member="API:Class/Humanoid/HealthDisplayType"|Controls how the Humanoid's health is displayed.|/RMD|
floatHipHeight

Sets how many studs off the ground the Humanoid's Torso should be, relative to its default height of 1.35 studs off the ground.

|RMD member="API:Class/Humanoid/HipHeight"|Sets how many studs off the ground the Humanoid's Torso should be, relative to its default height of 1.35 studs off the ground.|/RMD|
boolJump

Whether the Humanoid is jumping. If set to true, it will cause the Humanoid to jump.

|RMD member="API:Class/Humanoid/Jump"|Whether the Humanoid is jumping. If set to true, it will cause the Humanoid to jump.|/RMD|
floatJumpPower

The amount of power of the jump, which determines the height.

|RMD member="API:Class/Humanoid/JumpPower"|The amount of power of the jump, which determines the height.|/RMD|
floatMaxHealth

The maximum amount of health a humanoid character can get, defaults to 100.

|RMD member="API:Class/Humanoid/MaxHealth"|The maximum amount of health a humanoid character can get, defaults to 100.|/RMD|
floatMaxSlopeAngle

The max angle of a slope a humanoid can run up, in degrees.

|RMD member="API:Class/Humanoid/MaxSlopeAngle"|The max angle of a slope a humanoid can run up, in degrees.|/RMD|
Vector3MoveDirection [readonly]

Displays the direction that the Humanoid has been set to move (using the Move method).

|RMD member="API:Class/Humanoid/MoveDirection"|Displays the direction that the Humanoid has been set to move (using the Move method).|/RMD|
floatNameDisplayDistance

Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see names or how far this humanoid's name displays. See Humanoid view distance for more info.

|RMD member="API:Class/Humanoid/NameDisplayDistance"|Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see names or how far this humanoid's name displays. See Humanoid view distance for more info.|/RMD|
NameOcclusionNameOcclusion

Controls whether a Humanoid's name can be seen behind walls or other objects. This property applies based on the viewing players Humanoid. If the viewing player's Humanoid.NameOcclusion is set to OccludeAll, all humanoid name tags will be occluded for that player.

|RMD member="API:Class/Humanoid/NameOcclusion"|Controls whether a Humanoid's name can be seen behind walls or other objects. This property applies based on the viewing players Humanoid. If the viewing player's Humanoid.NameOcclusion is set to OccludeAll, all humanoid name tags will be occluded for that player.|/RMD|
boolPlatformStand

Forces a Humanoid into a PlatformStand, making them unable to move. Can be forcefully released, by script, by toggling the Sit or Jump properties.

|RMD member="API:Class/Humanoid/PlatformStand"|Forces a Humanoid into a PlatformStand, making them unable to move. Can be forcefully released, by script, by toggling the Sit or Jump properties.|/RMD|
HumanoidRigTypeRigType

Describes whether a character is using the new R15 rig, or the legacy R6 rig.

|RMD member="API:Class/Humanoid/RigType"|Describes whether a character is using the new R15 rig, or the legacy R6 rig.|/RMD|
Ref<BasePart>RootPart [readonly]

Used as a reference to point to the Humanoid's root driving part.

|RMD member="API:Class/Humanoid/RootPart"|Used as a reference to point to the Humanoid's root driving part.|/RMD|
Ref<Seat, VehicleSeat>SeatPart [readonly]

The current seat the humanoid is sitting on.

|RMD member="API:Class/Humanoid/SeatPart"|The current seat the humanoid is sitting on.|/RMD|
boolSit

Forces the Humanoid to sit, causing the legs and arms to bend 90 degrees.

|RMD member="API:Class/Humanoid/Sit"|Forces the Humanoid to sit, causing the legs and arms to bend 90 degrees.|/RMD|
Vector3TargetPoint

The Vector3 position the Humanoid is attempting to reach.

|RMD member="API:Class/Humanoid/TargetPoint"|The Vector3 position the Humanoid is attempting to reach.|/RMD|
floatWalkSpeed

Used to set how quickly a Humanoid can walk in studs per second. The default value is 16.

|RMD member="API:Class/Humanoid/WalkSpeed"|Used to set how quickly a Humanoid can walk in studs per second. The default value is 16.|/RMD|
Ref<BasePart>WalkToPart

The BasePart that the Humanoid is attempting to reach.

|RMD member="API:Class/Humanoid/WalkToPart"|The BasePart that the Humanoid is attempting to reach.|/RMD|
Vector3WalkToPoint

The 3D position the Humanoid is attempting to reach.

|RMD member="API:Class/Humanoid/WalkToPoint"|The 3D position the Humanoid is attempting to reach.|/RMD|
RefLeftLeg [deprecated] [hidden]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/LeftLeg"|Deprecated. Do not use.|/RMD|
RefRightLeg [deprecated] [hidden]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/RightLeg"|Deprecated. Do not use.|/RMD|
RefTorso [deprecated] [hidden]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/Torso"|Deprecated. Do not use.|/RMD|
floatmaxHealth [deprecated]

Deprecated in favor of MaxHealth.

|RMD member="API:Class/Humanoid/maxHealth"|Deprecated in favor of MaxHealth.|/RMD|
Sets whether the character will automatically jump when they hit an obstacle on a mobile device.
Sets whether the character model automatically orients itself to the direction the player is moving their character.
Allows you to set the camera's offset from the character's HumanoidRootPart, when a Humanoid is the target of the camera.
Sets how the Humanoid's parent Model displays name and health info.
FloorMaterial [readonly]
This property contains the Material of the part or terrain cell that the Humanoid is currently standing on.
The amount of health a humanoid character has, from 0 to MaxHealth, defaults to 100.
Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see health or how far this humanoid's health displays. See Humanoid view distance for more info.
Controls how the Humanoid's health is displayed.
Sets how many studs off the ground the Humanoid's Torso should be, relative to its default height of 1.35 studs off the ground.
Whether the Humanoid is jumping. If set to true, it will cause the Humanoid to jump.
The amount of power of the jump, which determines the height.
The maximum amount of health a humanoid character can get, defaults to 100.
The max angle of a slope a humanoid can run up, in degrees.
MoveDirection [readonly]
Displays the direction that the Humanoid has been set to move (using the Move method).
Used in conjunction with DisplayDistanceType to either determine how far a player controlling this Humanoid can see names or how far this humanoid's name displays. See Humanoid view distance for more info.
Controls whether a Humanoid's name can be seen behind walls or other objects. This property applies based on the viewing players Humanoid. If the viewing player's Humanoid.NameOcclusion is set to OccludeAll, all humanoid name tags will be occluded for that player.
Forces a Humanoid into a PlatformStand, making them unable to move. Can be forcefully released, by script, by toggling the Sit or Jump properties.
Describes whether a character is using the new R15 rig, or the legacy R6 rig.
RootPart [readonly]
Used as a reference to point to the Humanoid's root driving part.
SeatPart [readonly]
The current seat the humanoid is sitting on.
Forces the Humanoid to sit, causing the legs and arms to bend 90 degrees.
The Vector3 position the Humanoid is attempting to reach.
Used to set how quickly a Humanoid can walk in studs per second. The default value is 16.
The BasePart that the Humanoid is attempting to reach.
The 3D position the Humanoid is attempting to reach.
LeftLeg [deprecated] [hidden]
Deprecated. Do not use.
RightLeg [deprecated] [hidden]
Deprecated. Do not use.
Torso [deprecated] [hidden]
Deprecated. Do not use.
maxHealth [deprecated]
Deprecated in favor of MaxHealth.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

|RMD member="API:Class/Instance/RobloxLocked"|If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

voidAddAccessory ( Accessory accessory )

Attaches an Accoutrement icon.pngAccessory to the Humanoid.

|RMD member="API:Class/Humanoid/AddAccessory"|Attaches an Accoutrement icon.pngAccessory to the Humanoid.|/RMD|
voidBuildRigFromAttachments ( )

Assembles a Motor6D hierarchy of joints based on attachments with a "RigAttachment" suffix in their name. Rig attachments that share the same name will be fused into a Motor6D joint.

|RMD member="API:Class/Humanoid/BuildRigFromAttachments"|Assembles a Motor6D hierarchy of joints based on attachments with a "RigAttachment" suffix in their name.

Rig attachments that share the same name will be fused into a Motor6D joint.|/RMD|

voidChangeState ( HumanoidStateType state = None )

Sets the current activity that the Humanoid is carrying out.

|RMD member="API:Class/Humanoid/ChangeState"|Sets the current activity that the Humanoid is carrying out.|/RMD|
voidEquipTool ( BackpackItem tool )

Used to forcefully equip a tool.

|RMD member="API:Class/Humanoid/EquipTool"|Used to forcefully equip a tool.|/RMD|
array<Accessory>GetAccessories ( )

Returns a list of Accessories that are attached to this Humanoid.

|RMD member="API:Class/Humanoid/GetAccessories"|Returns a list of Accessories that are attached to this Humanoid.|/RMD|
LimbGetLimb ( BasePart part )

Returns the Limb that is associated with the given part.

|RMD member="API:Class/Humanoid/GetLimb"|Returns the Limb that is associated with the given part.|/RMD|
array<AnimationTrack>GetPlayingAnimationTracks ( )

Returns an array of the AnimationTracks currently being played on the Humanoid.

|RMD member="API:Class/Humanoid/GetPlayingAnimationTracks"|Returns an array of the AnimationTracks currently being played on the Humanoid.|/RMD|
HumanoidStateTypeGetState ( )

Returns the Enum of the current activity being carried out by Humanoid.

|RMD member="API:Class/Humanoid/GetState"|Returns the Enum of the current activity being carried out by Humanoid.|/RMD|
boolGetStateEnabled ( HumanoidStateType state )

Gets whether or not a HumanoidStateType is allowed to be fired/selected.

|RMD member="API:Class/Humanoid/GetStateEnabled"|Gets whether or not a HumanoidStateType is allowed to be fired/selected.|/RMD|
AnimationTrackLoadAnimation ( Animation animation )

Used to load an animation into the Humanoid as a variable.

|RMD member="API:Class/Humanoid/LoadAnimation"|Used to load an animation into the Humanoid as a variable.|/RMD|
voidMove ( Vector3 moveDirection, bool relativeToCamera = false )

Causes the Humanoid to walk in a given direction.

|RMD member="API:Class/Humanoid/Move"|Causes the Humanoid to walk in a given direction.|/RMD|
voidMoveTo ( Vector3 location, BasePart part = nil )

Causes the Humanoid to attempt to walk to the given location.

|RMD member="API:Class/Humanoid/MoveTo"|Causes the Humanoid to attempt to walk to the given location.|/RMD|
voidRemoveAccessories ( )

Removes all Accessories from the humanoid.

|RMD member="API:Class/Humanoid/RemoveAccessories"|Removes all Accessories from the humanoid.|/RMD|
voidSetStateEnabled ( HumanoidStateType state, bool enabled )

Sets whether or not a HumanoidStateType is allowed to be fired/selected.

|RMD member="API:Class/Humanoid/SetStateEnabled"|Sets whether or not a HumanoidStateType is allowed to be fired/selected.|/RMD|
voidTakeDamage ( float amount )

Subtracts the damage from the health of the targeted humanoid unless the character has a ForceField.

|RMD member="API:Class/Humanoid/TakeDamage"|Subtracts the damage from the health of the targeted humanoid unless the character has a ForceField.|/RMD|
voidUnequipTools ( )

Unequips all tools that the humanoid might have equipped at the time of use.

|RMD member="API:Class/Humanoid/UnequipTools"|Unequips all tools that the humanoid might have equipped at the time of use.|/RMD|
boolAddCustomStatus ( string status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/AddCustomStatus"|Deprecated. Do not use.|/RMD|
boolAddStatus ( Status status = Poison ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/AddStatus"|Deprecated. Do not use.|/RMD|
arrayGetStatuses ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/GetStatuses"|Deprecated. Do not use.|/RMD|
boolHasCustomStatus ( string status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/HasCustomStatus"|Deprecated. Do not use.|/RMD|
boolHasStatus ( Status status = Poison ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/HasStatus"|Deprecated. Do not use.|/RMD|
boolRemoveCustomStatus ( string status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/RemoveCustomStatus"|Deprecated. Do not use.|/RMD|
boolRemoveStatus ( Status status = Poison ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/RemoveStatus"|Deprecated. Do not use.|/RMD|
InstanceloadAnimation ( Instance animation ) [deprecated]

Deprecated in favor of LoadAnimation.

|RMD member="API:Class/Humanoid/loadAnimation"|Deprecated in favor of LoadAnimation.|/RMD|
voidtakeDamage ( float amount ) [deprecated]

Deprecated in favor of TakeDamage.

|RMD member="API:Class/Humanoid/takeDamage"|Deprecated in favor of TakeDamage.|/RMD|
AddAccessory ( Accessory accessory )
Attaches an Accoutrement icon.pngAccessory to the Humanoid.
Assembles a Motor6D hierarchy of joints based on attachments with a "RigAttachment" suffix in their name. Rig attachments that share the same name will be fused into a Motor6D joint.
Sets the current activity that the Humanoid is carrying out.
Used to forcefully equip a tool.
Returns a list of Accessories that are attached to this Humanoid.
GetLimb ( BasePart part )
Returns the Limb that is associated with the given part.
Returns an array of the AnimationTracks currently being played on the Humanoid.
Returns the Enum of the current activity being carried out by Humanoid.
Gets whether or not a HumanoidStateType is allowed to be fired/selected.
LoadAnimation ( Animation animation )
Used to load an animation into the Humanoid as a variable.
Move ( Vector3 moveDirection, bool relativeToCamera = false )
Causes the Humanoid to walk in a given direction.
MoveTo ( Vector3 location, BasePart part = nil )
Causes the Humanoid to attempt to walk to the given location.
Removes all Accessories from the humanoid.
Sets whether or not a HumanoidStateType is allowed to be fired/selected.
TakeDamage ( float amount )
Subtracts the damage from the health of the targeted humanoid unless the character has a ForceField.
Unequips all tools that the humanoid might have equipped at the time of use.
AddCustomStatus ( string status ) [deprecated]
Deprecated. Do not use.
AddStatus ( Status status = Poison ) [deprecated]
Deprecated. Do not use.
GetStatuses ( ) [deprecated]
Deprecated. Do not use.
HasCustomStatus ( string status ) [deprecated]
Deprecated. Do not use.
HasStatus ( Status status = Poison ) [deprecated]
Deprecated. Do not use.
RemoveCustomStatus ( string status ) [deprecated]
Deprecated. Do not use.
RemoveStatus ( Status status = Poison ) [deprecated]
Deprecated. Do not use.
loadAnimation ( Instance animation ) [deprecated]
Deprecated in favor of LoadAnimation.
takeDamage ( float amount ) [deprecated]
Deprecated in favor of TakeDamage.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

AnimationPlayed ( AnimationTrack animationTrack )

Fires whenever the Humanoid in question begins playing an animation.

|RMD member="API:Class/Humanoid/AnimationPlayed"|Fires whenever the Humanoid in question begins playing an animation.|/RMD|
Climbing ( float speed )

Fired when a player is climbing either bricks or truss. The value of speed is 70% of the Humanoid's WalkSpeed.

|RMD member="API:Class/Humanoid/Climbing"|Fired when a player is climbing either bricks or truss. The value of speed is 70% of the Humanoid's WalkSpeed.|/RMD|
Died ( )

Fired after a character has entered the dead state, usually when their health reaches 0. Which could be caused either by disconnecting their head from their torso, or directly setting the health property.

|RMD member="API:Class/Humanoid/Died"|Fired after a character has entered the dead state, usually when their health reaches 0. Which could be caused either by disconnecting their head from their torso, or directly setting the health property.|/RMD|
FallingDown ( bool active )

Fired when the Humanoid is falling due to being tripped over.

|RMD member="API:Class/Humanoid/FallingDown"|Fired when the Humanoid is falling due to being tripped over.|/RMD|
FreeFalling ( bool active )

Fired when the Humanoid is falling.

|RMD member="API:Class/Humanoid/FreeFalling"|Fired when the Humanoid is falling.|/RMD|
GettingUp ( bool active )

Fired when a Humanoid gets up after falling over.

|RMD member="API:Class/Humanoid/GettingUp"|Fired when a Humanoid gets up after falling over.|/RMD|
HealthChanged ( float health )

Fired when the Humanoid's Health changes to a value equal to or below the Humanoid's MaxHealth value.

|RMD member="API:Class/Humanoid/HealthChanged"|Fired when the Humanoid's Health changes to a value equal to or below the Humanoid's MaxHealth value.|/RMD|
Jumping ( bool active )

Fired when the Humanoid jumps.

|RMD member="API:Class/Humanoid/Jumping"|Fired when the Humanoid jumps.|/RMD|
MoveToFinished ( bool reached )

Fires when the Humanoid finishes walking to a goal declared by MoveTo.

|RMD member="API:Class/Humanoid/MoveToFinished"|Fires when the Humanoid finishes walking to a goal declared by MoveTo.|/RMD|
PlatformStanding ( bool active )

Fired when the Humanoid's PlatformStand property is changed.

|RMD member="API:Class/Humanoid/PlatformStanding"|Fired when the Humanoid's PlatformStand property is changed.|/RMD|
Ragdoll ( bool active )

Fires when a player gets hit by a large, fast-moving object, causing the character to get tripped and get shoved in the direction it was hit.

|RMD member="API:Class/Humanoid/Ragdoll"|Fires when a player gets hit by a large, fast-moving object, causing the character to get tripped and get shoved in the direction it was hit.|/RMD|
Running ( float speed )

Fired after the Humanoid starts or stops running.

|RMD member="API:Class/Humanoid/Running"|Fired after the Humanoid starts or stops running.|/RMD|
Seated ( bool active, Variant<Seat, VehicleSeat> currentSeatPart )

Fired when a Humanoid sits.

|RMD member="API:Class/Humanoid/Seated"|Fired when a Humanoid sits.|/RMD|
StateChanged ( HumanoidStateType old, HumanoidStateType new )

Fired when the state of the Humanoid is changed.

|RMD member="API:Class/Humanoid/StateChanged"|Fired when the state of the Humanoid is changed.|/RMD|
StateEnabledChanged ( HumanoidStateType state, bool isEnabled )

Fired when SetStateEnabled is called on the Humanoid.

|RMD member="API:Class/Humanoid/StateEnabledChanged"|Fired when SetStateEnabled is called on the Humanoid.|/RMD|
Strafing ( bool active )

Fired when the player is strafing.

|RMD member="API:Class/Humanoid/Strafing"|Fired when the player is strafing.|/RMD|
Swimming ( float speed )

Fired when a humanoid is swimming in water created with the terrain. The average speed of a Humanoid swimming is 87.5% of their WalkSpeed per second.

|RMD member="API:Class/Humanoid/Swimming"|Fired when a humanoid is swimming in water created with the terrain. The average speed of a Humanoid swimming is 87.5% of their WalkSpeed per second.|/RMD|
Touched ( BasePart touchingPart, BasePart humanoidPart )

Fires when one of the Humanoid's limbs come in contact with another part.

|RMD member="API:Class/Humanoid/Touched"|Fires when one of the Humanoid's limbs come in contact with another part.|/RMD|
CustomStatusAdded ( string status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/CustomStatusAdded"|Deprecated. Do not use.|/RMD|
CustomStatusRemoved ( string status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/CustomStatusRemoved"|Deprecated. Do not use.|/RMD|
StatusAdded ( Status status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/StatusAdded"|Deprecated. Do not use.|/RMD|
StatusRemoved ( Status status ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Humanoid/StatusRemoved"|Deprecated. Do not use.|/RMD|
AnimationPlayed ( AnimationTrack animationTrack )
Fires whenever the Humanoid in question begins playing an animation.
Climbing ( float speed )
Fired when a player is climbing either bricks or truss. The value of speed is 70% of the Humanoid's WalkSpeed.
Died ( )
Fired after a character has entered the dead state, usually when their health reaches 0. Which could be caused either by disconnecting their head from their torso, or directly setting the health property.
FallingDown ( bool active )
Fired when the Humanoid is falling due to being tripped over.
FreeFalling ( bool active )
Fired when the Humanoid is falling.
GettingUp ( bool active )
Fired when a Humanoid gets up after falling over.
HealthChanged ( float health )
Fired when the Humanoid's Health changes to a value equal to or below the Humanoid's MaxHealth value.
Jumping ( bool active )
Fired when the Humanoid jumps.
MoveToFinished ( bool reached )
Fires when the Humanoid finishes walking to a goal declared by MoveTo.
Fired when the Humanoid's PlatformStand property is changed.
Ragdoll ( bool active )
Fires when a player gets hit by a large, fast-moving object, causing the character to get tripped and get shoved in the direction it was hit.
Running ( float speed )
Fired after the Humanoid starts or stops running.
Seated ( bool active, Variant<Seat, VehicleSeat> currentSeatPart )
Fired when a Humanoid sits.
Fired when the state of the Humanoid is changed.
Fired when SetStateEnabled is called on the Humanoid.
Strafing ( bool active )
Fired when the player is strafing.
Swimming ( float speed )
Fired when a humanoid is swimming in water created with the terrain. The average speed of a Humanoid swimming is 87.5% of their WalkSpeed per second.
Touched ( BasePart touchingPart, BasePart humanoidPart )
Fires when one of the Humanoid's limbs come in contact with another part.
CustomStatusAdded ( string status ) [deprecated]
Deprecated. Do not use.
CustomStatusRemoved ( string status ) [deprecated]
Deprecated. Do not use.
StatusAdded ( Status status ) [deprecated]
Deprecated. Do not use.
StatusRemoved ( Status status ) [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

|RMD member="API:Class/Humanoid"|The Humanoid is a special object that gives models the functionality of a character. It grants the model with the ability to physically walk around and interact with various components of a ROBLOX level. Humanoids are always parented inside of a Model, and the model is expected to be an assembly of Parts and Motor6Ds; the root part of the assembly is expected to be named HumanoidRootPart. It also expects a part named Head to be connected to the character's torso part, either directly or indirectly. By default, there are two official types of character rigs supplied by ROBLOX, each with their own set of rules: ===R6=== * A basic character rig that uses 6 parts for limbs. * The Head part must be attached to a part named Torso, or the Humanoid will die immediately. * BodyPart appearances are applied using CharacterMesh objects. * Certain properties, such as LeftLeg and RightLeg, only work with R6. ===R15=== * More complex than R6, but also far more flexible and robust. * Uses 15 parts for limbs. * The Head part must be attached to a part named UpperTorso or the Humanoid will die immediately. * BodyPart appearances have to be assembled directly. * Can be dynamically rescaled by using special NumberValue objects parented inside of the Humanoid. ** The Humanoid will automatically create Vector3Value objects named OriginalSize inside of each limb. ** If a NumberValue is parented inside of the Humanoid and is named one of the following, it will be used to control the scaling functionality: *** BodyDepthScale *** BodyHeightScale *** BodyWidthScale *** HeadScale |/RMD|