Humanoid
Humanoid : Instance
Overview
Properties
AutoJumpEnabled
bool
AutoJumpEnabled allows for enabling or disabling automatic jumping functionality in humanoid characters.
Code Samples
AutoRotate
bool
AutoRotate is used for controlling the auto-rotation behavior of the humanoid.
Code Samples
AutomaticScalingEnabled
bool
AutomaticScalingEnabled property is a boolean flag used to manage the automatic scaling of objects, adjusting sizes.
Code Samples
CameraOffset
Vector3
The CameraOffset property is a vector3, used to adjust the camera's position.
Code Samples
DisplayDistanceType
Enum.HumanoidDisplayDistanceType
DisplayDistanceType defines an enum type that specifies the behavior for displaying a Humanoid's name and health information based
Code Samples
DisplayName
string
DisplayName is represented as an String type and displays a custom name above the head of the humanoid character in-game
Code Samples
Health
number
Health represents the current health of the character and can be affected by damage, healing, or regeneration.
Code Samples
humanoid.Health = 0HealthDisplayDistance
number
HealthDisplayDistance property determines the distance at which a character's health indicator is visible above their head.
Code Samples
HipHeight
number
HipHeight is height of a character's hips (or pelvis) relative to the ground plane.
Code Samples
Jump
bool
It represents the state of whether the character attached to this component perform a jump
Code Samples
JumpHeight
number
JumpHeight represent the maximum height a character can jump within a world.
Code Samples
JumpPower
number
JumpPower property is a number value used to control the power of a humanoid character's jump.
Code Samples
humanoid.JumpPower = 0MaxHealth
number
MaxHealth represent the maximum health value for humanoid character.
Code Samples
print(humanoid.MaxHealth)MaxSlopeAngle
number
"MaxSlopeAngle"is used to specify the maximum angle at which an character can walk uphill.
Code Samples
MoveDirection
Vector3
MoveDirection property represents the direction of movement for an character within a world.
Code Samples
RootPart
BasePart
The Root Part of a Humanoid Character
Code Samples
Sit
bool
Sit property is often a boolean variable that indicates whether a humanoid character sit down or stand up.
Code Samples
WalkSpeed
number
WalkSpeed is primarily associated with the movement speed of a humanoid character or avatar in world.
Code Samples
humanoid.WalkSpeed = 4000WalkToPoint
Vector3
WalkToPoint represents a target point for humanoid characters to walk towards, allowing developers and players to control their movement direction during gameplay.
Code Samples
HitboxType
Enum.HitboxType
HitboxType defines the type of hitbox used by the character. It can be configured via the Workspace, but runtime modification is not supported.
Code Samples
LookCameraDirection
bool
LookCameraDirection represent whether the camera should follow the direction the humanoid character faces during gameplay.
Code Samples
DefaultBlendSpace
BlendSpace
A BlendSpace plays a smoothly blended animation by interpolating between multiple animation assets based on character movement parameters such as speed and direction.
Code Samples
BlendSpace
BlendSpace
A BlendSpace plays a smoothly blended animation by interpolating between multiple animation assets based on character movement parameters such as speed and direction.
Code Samples
Methods
AddAccessory
The AddAccessory method adds accessory instance that came in as parameters.
Parameters
Instance InAccessory
Return
void
Code Samples
ApplyDescription
Change the appearance or animation by applying Humanoid Description to the current humanoid character.
Parameters
HumanoidDescription InDescription
Enum.AssetTypeVerification InAssetTypeVerification
Return
void
Code Samples
humanoid:ApplyDescription(humanoidDescription, Enum.AssetTypeVerification.Default)ApplyDescriptionReset
Resets the character's appearance to its default state. This method is useful when you want to revert the character's appearance back to its original state after making changes using ApplyDescription.
Parameters
HumanoidDescription InDescription
Enum.AssetTypeVerification InAssetTypeVerification
Return
void
Code Samples
EquipTool
EquipTool is equipped with a tool instance that has been entered.
Parameters
Instance InTool
Return
void
Code Samples
humanoid:EquipTool(Tool)GetAccessories
Returns the accessories currently equipped by the character.
Parameters
Return
Tuple
Code Samples
GetAppliedDescription
Returns the application applied to the current character to HumanoidDescription.
Parameters
Return
HumanoidDescription
Code Samples
UnequipTools
The UnquipTools method unequip the tool currently equipped with the humanoid character.
Parameters
Return
void
Code Samples
humanoid:UnequipTools(Tool)RemoveAccessories
How to remove accessories removes accessories from humanoid characters.
Parameters
Return
void
Code Samples
TakeDamage
TakeDamage reduces the health of the humanoid character by parameter value.
Parameters
number InDamage
Return
void
Code Samples
humanoid:TakeDamage(100)LoadAnimation
The LoadAnimation method is used to load an animation onto a humanoid character. It allows you to specify the animation you want to use and returns the corresponding AnimationTrack object that can be played, stopped, and manipulated as needed.
Parameters
Animation InAnimation
Return
AnimationTrack
Code Samples
local AnimationTrack = Animator:LoadAnimation(Animation)ChangeState
ChangeState method changes the status of the humanoid character with the status value entered.
Parameters
Value InLuaValue
Return
void
Code Samples
Humanoid:ChangeState(Enum.HumanoidStateType.Physics)SetStateEnabled
The SetStateEnabled method is used to enable or disable a specific humanoid state type for a character. By specifying the state type and a boolean value, the method controls whether the state is active or not.
Parameters
Enum.HumanoidStateType InHumanoidStateType
Value InEnabled
Return
void
Code Samples
humanoid:SetStateEnabled(Enum.HumanoidStateType.Climbing, false)GetState
Returns the status of the current humanoid.
Parameters
Return
Value
Code Samples
Events
ApplyDescriptionFinished
The ApplyDescriptionFinished event occurs when the application of a humanoid description to a character is completed.
Parameters
Code Samples
Climbing
The Climbing event is triggered when the humanoid character starts climbing. This event can be used to detect or handle behaviors specific to the climbing state.
Parameters
Code Samples
ClusterCompositionFinished
The ClusterCompositionFinished event is triggered when the humanoid's cluster composition process is completed. This event can be used to perform actions or logic after the humanoid's composition is finalized.
Parameters
Code Samples
Died
The Died event is triggered when the humanoid character's health reaches zero, indicating that the character has died. This event can be used to handle logic related to the character's death, such as respawning, recording statistics, or triggering animations.
Parameters
Code Samples
local function OnDied()
print("Die!")
end
humanoid.Died:Connect(OnDied)EmoteTriggered
The EmoteTriggered event is triggered when a humanoid character plays an emote animation. This event can be used to perform actions or trigger logic whenever a player activates an emote.
Parameters
Code Samples
FallingDown
The FallingDown event is triggered when the humanoid character falls down. This event can be used to handle logic or execute specific actions whenever the humanoid loses balance or falls to the ground.
Parameters
Code Samples
FreeFalling
The FreeFalling event is triggered when the humanoid character enters the FreeFalling state. This state typically occurs when the humanoid is in free fall, such as dropping from a height without any other active motion states. The event can be utilized to handle logic or actions associated with free falling, such as playing a free fall animation, enabling specific effects, or implementing mechanics related to falling.
Parameters
Code Samples
local function OnFreeFalling()
print("FreeFalling!")
end
humanoid.FreeFalling:Connect(OnFreeFalling)GettingUp
The GettingUp event is triggered when the humanoid character transitions into the "GettingUp" state. This state generally occurs after the humanoid has fallen or entered a similar state that requires recovery. This event can be used to execute logic or trigger actions, such as playing a "getting up" animation, resetting character properties, or modifying gameplay behaviors associated with recovery.
Parameters
Code Samples
HealthChanged
The HealthChanged event is triggered whenever there is a change in the humanoid character's health. This event can be used to perform actions or logic related to health modifications, such as updating health bars, triggering warnings, or applying specific game mechanics connected to health changes.
Parameters
Code Samples
local function OnHealthChanged()
print("HealthChanged!")
end
humanoid.HealthChanged:Connect(OnHealthChanged)Jumping
The Jumping event is triggered when the humanoid character starts jumping. This event can be used to handle actions or logic associated with the jumping action, such as triggering animations, modifying physics-related parameters, or implementing custom game mechanics.
Parameters
Code Samples
local function OnJumping()
print("Jumping!")
end
humanoid.Jumping:Connect(OnJumping)MoveToFinished
The MoveToFinished event in the humanoid object is triggered when the character completes a move action initiated by the MoveTo function or similar movement scripting commands. This event can help determine the success or interruption of a movement action, allowing you to handle post-move logic such as triggering animations, setting new movement targets, or logging movement results.
The MoveToFinished event is often used in scenarios where the game logic depends on whether a character reaches a specific location. For example:
Check if the character successfully navigated to a target destination.
Detect if the movement was interrupted or canceled.
Execute specific game mechanics upon completing the movement (e.g., dialogue triggers, animation changes).
Note: Always ensure the humanoid is properly configured and no unrelated constraints prevent the movement.
Parameters
Code Samples
PlatformStanding
The PlatformStanding event is triggered when a humanoid character transitions into the "PlatformStanding" state. This state generally occurs when the character is standing stationary on a moving platform. This event can be used to trigger logic or handle behaviors specific to standing on platforms, such as stabilizing animations or adjusting movement mechanics.
Parameters
Code Samples
Running
The Running event is triggered when the humanoid character begins or continues moving. This event can be used to handle actions or logic associated with the humanoid's movement. For instance, you can track their running speed or trigger animations when movement starts or stops.
Parameters
Code Samples
StateChanged
The StateChanged event is triggered when the humanoid character's state changes. This event can be used to monitor or handle behaviors associated with transitioning between different humanoid states, such as idle, running, or jumping.
Parameters
Code Samples
StateEnabledChanged
The StateEnabledChanged event is triggered when the enabled state of a humanoid's state type changes. This event can be used to monitor or respond to changes in the humanoid's state configuration.
Parameters
Code Samples
Swimming
The Swimming event is triggered when the humanoid character starts swimming. This event can be used to detect or handle behaviors specific to the swimming state.
Parameters
Code Samples
Touched
Touched is an event that is triggered when the character collides with a Part or MeshPart.
Parameters
Code Samples
Landed
The Landed event is triggered when a humanoid character lands on a surface after being in the air. This event can be used to execute logic or perform actions when the humanoid touches the ground, such as playing a landing animation, reducing health from fall damage, or resetting states.
Parameters
Code Samples
local function OnLanded()
print("Landed!")
end
humanoid.Landed:Connect(Landed)PlatformStandingMoving
The PlatformStandingMoving event is triggered when a humanoid character moves while standing on a platform. This event can be used to handle or trigger logic specific to the scenario where the character transitions between standing and moving states on a platform.
Parameters
Code Samples
Last updated