FANDOM


The Humanoid class inherits from Instance.

Properties

Pubfield bool AutoJumpEnabled

If set to true, this humanoid's character will automatically jump when hitting an object on a mobile device.

Category: Jump Settings.

Serialization: can save and load.

Pubfield bool AutoRotate

Category: Control.

Serialization: can save and load.

Pubfield bool AutomaticScalingEnabled

Category: Game.

Serialization: can save and load.

Pubfield bool BreakJointsOnDeath

Category: Behavior.

Serialization: can save and load.

Pubfield Vector3 CameraOffset

Category: Data.

Serialization: cannot load or save.

Protfield HumanoidCollisionType CollisionType

Category: Behavior.

Write security: PluginSecurity.

Serialization: can save and load.

Pubfield HumanoidDisplayDistanceType DisplayDistanceType

Category: Data.

Serialization: can save and load.

Pubfield Material FloorMaterial

Category: Control.

Serialization: cannot load or save.

Tags: ReadOnly, NotReplicated.

Pubfield float Health

The amount of health this character currently has. If set to 0, the character will automatically die.

Category: Game.

Serialization: can load only.

Tags: NotReplicated.

Pubfield float HealthDisplayDistance

How far away this character's health bar can be seen. Set to 0 and this character will have no health bar.

Category: Data.

Serialization: can save and load.

Pubfield HumanoidHealthDisplayType HealthDisplayType

Category: Data.

Serialization: can save and load.

Pubfield float HipHeight

Category: Game.

Serialization: can save and load.

Pubfield bool Jump

If set to true, it will instantly be set to false, and the character will jump.

Category: Control.

Serialization: can load only.

Tags: NotReplicated.

Pubfield float JumpHeight

Category: Jump Settings.

Serialization: can save and load.

Pubfield float JumpPower

Category: Jump Settings.

Serialization: can save and load.

Pubfield BasePart LeftLeg

Category: Data.

Serialization: can load only.

Tags: Hidden, NotReplicated, Deprecated.

Pubfield float MaxHealth

The maximum amount of health this character can have at one point in time.

Category: Game.

Serialization: can save and load.

Pubfield float MaxSlopeAngle

Category: Game.

Serialization: can save and load.

Pubfield Vector3 MoveDirection

The direction in which this character is walking.

Category: Control.

Serialization: cannot load or save.

Tags: ReadOnly, NotReplicated.

Pubfield float NameDisplayDistance

The distance that this player's nametag can be seen. Set to 0 for no nametag.

Category: Data.

Serialization: can save and load.

Pubfield NameOcclusion NameOcclusion

Sets how to display other humanoid names to this humanoid's player.

Category: Data.

Serialization: can save and load.

Pubfield bool PlatformStand

If set to true, this will turn the character into a ragdoll, preventing it to move. False will undo this action.

Category: Control.

Serialization: cannot load or save.

Pubfield HumanoidRigType RigType

The rig type of this character.

Category: Data.

Serialization: can save and load.

Pubfield BasePart RightLeg

Category: Data.

Serialization: can load only.

Tags: Hidden, NotReplicated, Deprecated.

Pubfield BasePart RootPart

Category: Data.

Serialization: can save only.

Tags: ReadOnly, NotReplicated.

Pubfield BasePart SeatPart

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

Category: Control.

Serialization: cannot load or save.

Tags: ReadOnly, NotReplicated.

Pubfield bool Sit

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.

Pubfield Vector3 TargetPoint

Category: Control.

Serialization: cannot load or save.

Pubfield BasePart Torso

Category: Data.

Serialization: can load only.

Tags: Hidden, NotReplicated, Deprecated.

Pubfield bool UseJumpPower

Category: Jump Settings.

Serialization: can save and load.

Pubfield float WalkSpeed

The speed at which this character can move.

Category: Game.

Serialization: can save and load.

Pubfield BasePart WalkToPart

Changing this property attempts to make this character walk to the given BasePart.

Category: Control.

Serialization: cannot load or save.

Pubfield Vector3 WalkToPoint

Changing this property attempts to make this character walk to the given location.

Category: Control.

Serialization: cannot load or save.

Pubfield float maxHealth

Category: Game.

Serialization: can load only.

Tags: NotReplicated, Deprecated.

Functions

Pubmethod void AddAccessory(Instance accessory)

Pubmethod bool AddCustomStatus(string status)

Tags: Deprecated.

Pubmethod bool AddStatus(Status status = Poison)

Tags: Deprecated.

Pubmethod void ApplyDescription(Instance humanoidDescription)

Tags: Yields.

Protmethod void ApplyDescriptionClientServer(Instance humanoidDescription)

Security: RobloxScriptSecurity.

Tags: Yields.

Pubmethod void BuildRigFromAttachments()

Protmethod void CacheDefaults()

Security: RobloxScriptSecurity.

Pubmethod void ChangeState(HumanoidStateType state = None)

Pubmethod void EquipTool(Instance tool)

Takes a specified tool and equips it to the Humanoid's Character. Tool argument should be of type 'Tool'.

Pubmethod Array GetAccessories()

Pubmethod Instance GetAppliedDescription()

Pubmethod BodyPartR15 GetBodyPartR15(Instance part)

Returns a Enum.BodyPartR15 given a body part in the Humanoid's Character.

Pubmethod Limb GetLimb(Instance part)

Pubmethod Array GetPlayingAnimationTracks()

Pubmethod HumanoidStateType GetState()

Pubmethod bool GetStateEnabled(HumanoidStateType state)

Pubmethod Array GetStatuses()

Tags: Deprecated.

Pubmethod bool HasCustomStatus(string status)

Tags: Deprecated.

Pubmethod bool HasStatus(Status status = Poison)

Tags: Deprecated.

Pubmethod Instance LoadAnimation(Instance animation)

Pubmethod void Move(Vector3 moveDirection, bool relativeToCamera = false)

Pubmethod void MoveTo(Vector3 location, Instance part = nil)

Attempts to move the Humanoid and it's associated character to 'part'. 'location' is used as an offset from part's origin.

Pubmethod bool PlayEmote(string emoteName)

Tags: Yields.

Pubmethod void RemoveAccessories()

Pubmethod bool RemoveCustomStatus(string status)

Tags: Deprecated.

Pubmethod bool RemoveStatus(Status status = Poison)

Tags: Deprecated.

Pubmethod bool ReplaceBodyPartR15(BodyPartR15 bodyPart, Instance part)

Replaces the desired bodypart on the Humanoid's Character using a specified Enum.BodyPartR15 and BasePart. Returns a success boolean.

Protmethod void SetClickToWalkEnabled(bool enabled)

Security: RobloxScriptSecurity.

Pubmethod void SetStateEnabled(HumanoidStateType state, bool enabled)

Pubmethod void TakeDamage(float amount)

Decreases health by the amount. Use this instead of changing health directly to make sure weapons are filtered for things such as ForceField(s).

Pubmethod void UnequipTools()

Takes any active gear/tools that the Humanoid is using and puts them into the backpack. This function only works on Humanoids with a corresponding Player.

Pubmethod Instance loadAnimation(Instance animation)

Tags: Deprecated.

Pubmethod void takeDamage(float amount)

Tags: Deprecated.

Events

Pubevent AnimationPlayed(Instance animationTrack)

Pubevent Climbing(float speed)

Pubevent CustomStatusAdded(string status)

Tags: Deprecated.

Pubevent CustomStatusRemoved(string status)

Tags: Deprecated.

Pubevent Died()

Pubevent FallingDown(bool active)

Pubevent FreeFalling(bool active)

Pubevent GettingUp(bool active)

Pubevent HealthChanged(float health)

Pubevent Jumping(bool active)

Pubevent MoveToFinished(bool reached)

Pubevent PlatformStanding(bool active)

Pubevent Ragdoll(bool active)

Pubevent Running(float speed)

Pubevent Seated(bool active, Instance currentSeatPart)

Pubevent StateChanged(HumanoidStateType old, HumanoidStateType new)

Pubevent StateEnabledChanged(HumanoidStateType state, bool isEnabled)

Pubevent StatusAdded(Status status)

Tags: Deprecated.

Pubevent StatusRemoved(Status status)

Tags: Deprecated.

Pubevent Strafing(bool active)

Pubevent Swimming(float speed)

Pubevent Touched(Instance touchingPart, Instance humanoidPart)

External links

Community content is available under CC-BY-SA unless otherwise noted.