Humanoid

Humanoid
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Category	Avatar
Memory category	Instances
Inheritance
Object Instance Humanoid

The Humanoid class inherits from Instance. It gives Models the function of a character and allow it to move and physically interact with physical objects.

Properties

AutoJumpEnabled: bool

If set to true, this humanoid's character will automatically jump when hitting an object on a mobile device. This property has no effect for devices other than mobile devices.

• Category: Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

AutoRotate: bool

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/AutoRotate.

• Category: Control.
• Serialization: can save and load.
• Thread safety: read safe

AutomaticScalingEnabled: bool

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/AutomaticScalingEnabled.

• Category: Game.
• Serialization: can save and load.
• Thread safety: read safe

BreakJointsOnDeath: bool

If set to true, all of the joints within the character will break when the Humanoid dies.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

CameraOffset: Vector3

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/CameraOffset.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

CollisionType: HumanoidCollisionType

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/CollisionType.

• Category: Behavior.
• Write security: PluginSecurity.
• Serialization: can save and load.
• Thread safety: read safe

DisplayDistanceType: HumanoidDisplayDistanceType

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/DisplayDistanceType.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

DisplayName: string

The DisplayName property of a Humanoid, when non-empty, will replace the text the Humanoid displays above the Head of the character from the character's name to the string in the property.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

EvaluateStateMachine: bool

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/EvaluateStateMachine.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

FloorMaterial: Material

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Describes the Material a Humanoid is currently standing on. If the Humanoid is not standing on the ground, this property's value will be Air.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

Health: float

• Not replicatedThis member is not replicated across the network boundary.

Health is a property of Humanoid that determines the current health of a character. Whenever the health becomes zero or below, the character dies. If a player's character dies, the player respawns after a certain amount of time. The MaxHealth property specifies the maximum health. Like other Humanoid properties, the health properties, along with other health-related properties, can be manipulated by a script or through StarterPlayer.

Roblox uses a health bar to show how much health a character has. There are two main health bars that are shown: the GUI within the HUD that displays the health of the player's character (along with the red flashes around the screen that appear whenever the player is hurt), and the health bar shown above other characters. Both can be changed through the Roblox API.

• Category: Game.
• Serialization: can load only.
• Thread safety: read safe

HealthDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/HealthDisplayDistance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

HealthDisplayType: HumanoidHealthDisplayType

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/HealthDisplayType.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

HipHeight: float

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/HipHeight.

• Category: Game.
• Serialization: can save and load.
• Thread safety: read safe

InternalDisplayName: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/InternalDisplayName.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

Jump: bool

• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/Jump.

• Category: Control.
• Serialization: can load only.
• Thread safety: read safe

JumpHeight: float

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/JumpHeight.

• Category: Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

JumpPower: float

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/JumpPower.

• Category: Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

LeftLeg: BasePart

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/LeftLeg.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

MaxHealth: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/MaxHealth.

• Category: Game.
• Serialization: can save and load.
• Thread safety: read safe

MaxSlopeAngle: float

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/MaxSlopeAngle.

• Category: Game.
• Serialization: can save and load.
• Thread safety: read safe

MoveDirection: Vector3

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/MoveDirection.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

NameDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/NameDisplayDistance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

NameOcclusion: NameOcclusion

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/NameOcclusion.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

PlatformStand: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/PlatformStand.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

RequiresNeck: bool

Indicates whether or not the Humanoid requires an active Neck joint between the Head and Torso in order to remain alive. If set to true, breaking the Neck joint will kill the Humanoid.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

RigType: HumanoidRigType

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/RigType.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

RightLeg: BasePart

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/RightLeg.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

RootPart: BasePart

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/RootPart.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

SeatPart: BasePart

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

The Seat/VehicleSeat this character is sitting on, or nil if this character is not sitting.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

Sit: bool

Causes the character to sit in the given location. If set to false, Jump will be set to true, causing the character to jump back to normal.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

TargetPoint: Vector3

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/TargetPoint.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

Torso: BasePart

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/Torso.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

UseJumpPower: bool

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/UseJumpPower.

• Category: Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

WalkSpeed: float

WalkSpeed is a property of the Humanoid object that determines the model's speed when being controlled by a player or when MoveTo() is activated. WalkSpeed is most often changed for running or sprinting mechanics, or lowered as a part of crouching mechanics.

The default WalkSpeed for Roblox characters is 16 studs/second. A higher number equals a higher speed, and a lower number equals a lower speed.

• Category: Game.
• Serialization: can save and load.
• Thread safety: read safe

WalkToPart: BasePart

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/WalkToPart.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

WalkToPoint: Vector3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/WalkToPoint.

• Category: Control.
• Serialization: cannot load or save.
• Thread safety: read safe

maxHealth: float

• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use MaxHealth instead.

• Category: Game.
• Serialization: can load only.
• Thread safety: read safe

Methods

AddAccessory(accessory: Instance): null

Parameters

Name	Type
accessory	Instance

• Thread safety: unsafe

AddCustomStatus(status: string): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	string

• Thread safety: unsafe

AddStatus(status: Status = Poison): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type	Default
status	Status	Poison

• Thread safety: unsafe

ApplyDescription(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
humanoidDescription	HumanoidDescription
assetTypeVerification	AssetTypeVerification	Default

• Thread safety: unsafe

ApplyDescriptionClientServer(humanoidDescription: HumanoidDescription): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
humanoidDescription	HumanoidDescription

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ApplyDescriptionReset(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
humanoidDescription	HumanoidDescription
assetTypeVerification	AssetTypeVerification	Default

• Thread safety: unsafe

BuildRigFromAttachments(): null

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/BuildRigFromAttachments.

• Thread safety: unsafe

CacheDefaults(): null

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/CacheDefaults.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ChangeState(state: HumanoidStateType = None): null

Parameters

Name	Type	Default
state	HumanoidStateType	None

• Thread safety: unsafe

EquipTool(tool: Instance): null

Parameters

Name	Type
tool	Instance

Forces the Humanoid to hold the specified Tool. If another Tool is equipped when this is invoked, that Tool will be unequipped.

• Thread safety: unsafe

GetAccessories(): Array

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetAccessories.

• Thread safety: unsafe

GetAccessoryHandleScale(instance: Instance, partType: BodyPartR15): Vector3

Parameters

Name	Type
instance	Instance
partType	BodyPartR15

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetAppliedDescription(): HumanoidDescription

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetAppliedDescription.

• Thread safety: unsafe

GetBodyPartR15(part: Instance): BodyPartR15

Parameters

Name	Type
part	Instance

• Thread safety: unsafe

GetLimb(part: Instance): Limb

Parameters

Name	Type
part	Instance

• Thread safety: unsafe

GetMoveVelocity(): Vector3

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetMoveVelocity.

• Thread safety: unsafe

GetPlayingAnimationTracks(): Array

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetPlayingAnimationTracks.

• Thread safety: unsafe

GetState(): HumanoidStateType

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetState.

• Thread safety: safe

GetStateEnabled(state: HumanoidStateType): bool

Parameters

Name	Type
state	HumanoidStateType

• Thread safety: safe

GetStatuses(): Array

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/GetStatuses.

• Thread safety: unsafe

HasCustomStatus(status: string): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	string

• Thread safety: unsafe

HasStatus(status: Status = Poison): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type	Default
status	Status	Poison

• Thread safety: unsafe

LoadAnimation(animation: Animation): AnimationTrack

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
animation	Animation

• Thread safety: unsafe

Move(moveDirection: Vector3, relativeToCamera: bool = false): null

Parameters

Name	Type	Default
moveDirection	Vector3
relativeToCamera	bool	false

• Thread safety: unsafe

MoveTo(location: Vector3, part: Instance = nil): null

Parameters

Name	Type	Default
location	Vector3
part	Instance	nil

• Thread safety: unsafe

PlayEmote(emoteName: string): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
emoteName	string

• Thread safety: unsafe

PlayEmoteAndGetAnimTrackById(emoteId: int64): Tuple

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
emoteId	int64

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

RemoveAccessories(): null

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/RemoveAccessories.

• Thread safety: unsafe

RemoveCustomStatus(status: string): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	string

• Thread safety: unsafe

RemoveStatus(status: Status = Poison): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type	Default
status	Status	Poison

• Thread safety: unsafe

ReplaceBodyPartR15(bodyPart: BodyPartR15, part: BasePart): bool

Parameters

Name	Type
bodyPart	BodyPartR15
part	BasePart

• Thread safety: unsafe

SetClickToWalkEnabled(enabled: bool): null

Parameters

Name	Type
enabled	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetStateEnabled(state: HumanoidStateType, enabled: bool): null

Parameters

Name	Type
state	HumanoidStateType
enabled	bool

• Thread safety: unsafe

TakeDamage(amount: float): null

Parameters

Name	Type
amount	float

• Thread safety: unsafe

UnequipTools(): null

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/UnequipTools.

• Thread safety: unsafe

loadAnimation(animation: Animation): AnimationTrack

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
animation	Animation

• Thread safety: unsafe

takeDamage(amount: float): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
amount	float

Use TakeDamage instead.

• Thread safety: unsafe

Events

AnimationPlayed(animationTrack: AnimationTrack)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
animationTrack	AnimationTrack

• Thread safety: unsafe

ApplyDescriptionFinished(description: HumanoidDescription)

Parameters

Name	Type
description	HumanoidDescription

• Thread safety: unsafe

Climbing(speed: float)

Parameters

Name	Type
speed	float

• Thread safety: unsafe

ClusterCompositionFinished()

This class member is missing documentation. Create or add to its subpage at Class:Humanoid/ClusterCompositionFinished.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CustomStatusAdded(status: string)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	string

• Thread safety: unsafe

CustomStatusRemoved(status: string)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	string

• Thread safety: unsafe

Died()

Fired when the Humanoid dies. A Humanoid is considered dead when its Health is set to 0, when its Humanoid state is set to Dead, or when the character's Neck joint is broken if RequiresNeck is true.

• Thread safety: unsafe

EmoteTriggered(success: bool, animationTrack: AnimationTrack)

Parameters

Name	Type
success	bool
animationTrack	AnimationTrack

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

FallingDown(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

FreeFalling(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

GettingUp(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

HealthChanged(health: float)

Parameters

Name	Type
health	float

• Thread safety: unsafe

Jumping(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

MoveToFinished(reached: bool)

Parameters

Name	Type
reached	bool

• Thread safety: unsafe

PlatformStanding(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

Ragdoll(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

Running(speed: float)

Parameters

Name	Type
speed	float

• Thread safety: unsafe

Seated(active: bool, currentSeatPart: BasePart)

Parameters

Name	Type
active	bool
currentSeatPart	BasePart

• Thread safety: unsafe

StateChanged(old: HumanoidStateType, new: HumanoidStateType)

Parameters

Name	Type
old	HumanoidStateType
new	HumanoidStateType

• Thread safety: unsafe

StateEnabledChanged(state: HumanoidStateType, isEnabled: bool)

Parameters

Name	Type
state	HumanoidStateType
isEnabled	bool

• Thread safety: unsafe

StatusAdded(status: Status)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	Status

• Thread safety: unsafe

StatusRemoved(status: Status)

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
status	Status

• Thread safety: unsafe

Strafing(active: bool)

Parameters

Name	Type
active	bool

• Thread safety: unsafe

Swimming(speed: float)

Parameters

Name	Type
speed	float

• Thread safety: unsafe

Touched(touchingPart: BasePart, humanoidPart: BasePart)

Parameters

Name	Type
touchingPart	BasePart
humanoidPart	BasePart

• Thread safety: unsafe

Removed members

Methods

• ApplyDescriptionBlocking
• PlayEmoteById

Properties

• WalkX
• WalkZ
• WalkRotate
• WalkingSound
• WalkingVolume
• JumpSound
• GettingUpSound
• FallingDownSound
• Strafe
• RagdollCriteria

External links

• Humanoid in the Roblox Creator Documentation
• Humanoid in the Roblox API Reference