Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Humanoid

Member index 116

HistoryMember
553AutoJumpEnabled: bool
553AutoRotate: bool
553AutomaticScalingEnabled: bool
553BreakJointsOnDeath: bool
553CameraOffset: Vector3
553CollisionType: HumanoidCollisionType
553DisplayDistanceType: HumanoidDisplayDistanceType
486DisplayName: string
596EvaluateStateMachine: bool
553FloorMaterial: Material
553Health: float
553HealthDisplayDistance: float
553HealthDisplayType: HumanoidHealthDisplayType
553HipHeight: float
553Jump: bool
553JumpHeight: float
553JumpPower: float
553MaxHealth: float
553MaxSlopeAngle: float
553MoveDirection: Vector3
553NameDisplayDistance: float
553NameOcclusion: NameOcclusion
553PlatformStand: bool
553RequiresNeck: bool
553RigType: HumanoidRigType
553RootPart: BasePart
553SeatPart: BasePart
553Sit: bool
553TargetPoint: Vector3
553UseJumpPower: bool
553WalkSpeed: float
553WalkToPart: BasePart
553WalkToPoint: Vector3
553maxHealth: float
573AddAccessory(accessory: Instance): null
462AddCustomStatus(status: string): bool
462AddStatus(status: Status = Poison): bool
573ApplyDescription(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null
573ApplyDescriptionClientServer(humanoidDescription: HumanoidDescription): null
573ApplyDescriptionReset(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null
573BuildRigFromAttachments(): null
573CacheDefaults(): null
573ChangeState(state: HumanoidStateType = None): null
573EquipTool(tool: Instance): null
462GetAccessories(): Array
494GetAccessoryHandleScale(instance: Instance, partType: BodyPartR15): Vector3
486GetAppliedDescription(): HumanoidDescription
462GetBodyPartR15(part: Instance): BodyPartR15
462GetLimb(part: Instance): Limb
583GetMoveVelocity(): Vector3
553GetPlayingAnimationTracks(): Array
566GetState(): HumanoidStateType
566GetStateEnabled(state: HumanoidStateType): bool
462GetStatuses(): Array
462HasCustomStatus(status: string): bool
462HasStatus(status: Status = Poison): bool
553LoadAnimation(animation: Animation): AnimationTrack
573Move(moveDirection: Vector3, relativeToCamera: bool = false): null
573MoveTo(location: Vector3, part: Instance = Instance): null
462PlayEmote(emoteName: string): bool
462PlayEmoteAndGetAnimTrackById(emoteId: int64): Tuple
573RemoveAccessories(): null
462RemoveCustomStatus(status: string): bool
462RemoveStatus(status: Status = Poison): bool
486ReplaceBodyPartR15(bodyPart: BodyPartR15, part: BasePart): bool
573SetClickToWalkEnabled(enabled: bool): null
573SetStateEnabled(state: HumanoidStateType, enabled: bool): null
573TakeDamage(amount: float): null
573UnequipTools(): null
553loadAnimation(animation: Animation): AnimationTrack
573takeDamage(amount: float): null
553AnimationPlayed(animationTrack: AnimationTrack)
632ApplyDescriptionFinished(description: HumanoidDescription)
462Climbing(speed: float)
485ClusterCompositionFinished()
462CustomStatusAdded(status: string)
462CustomStatusRemoved(status: string)
462Died()
541EmoteTriggered(success: bool, animationTrack: AnimationTrack)
462FallingDown(active: bool)
462FreeFalling(active: bool)
462GettingUp(active: bool)
462HealthChanged(health: float)
462Jumping(active: bool)
462MoveToFinished(reached: bool)
462PlatformStanding(active: bool)
462Ragdoll(active: bool)
462Running(speed: float)
486Seated(active: bool, currentSeatPart: BasePart)
462StateChanged(old: HumanoidStateType, new: HumanoidStateType)
462StateEnabledChanged(state: HumanoidStateType, isEnabled: bool)
462StatusAdded(status: Status)
462StatusRemoved(status: Status)
462Strafing(active: bool)
462Swimming(speed: float)
486Touched(touchingPart: BasePart, humanoidPart: BasePart)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 3

HistoryMember
596ApplyDescriptionBlocking(humanoidDescription: HumanoidDescription): null
463PlayEmoteById(emoteName: string, emoteId: int64): bool

History 396

Members 116

AddAccessory

Parameters (1)
accessoryInstance
Returns (1)
null

History 5

AddCustomStatus

Parameters (1)
statusstring
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

AddStatus

Parameters (1)Default
statusStatusPoison
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

AnimationPlayed

Parameters (1)
animationTrackAnimationTrack
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 7

Tags: [Deprecated]

ApplyDescription

Parameters (2)Default
humanoidDescriptionHumanoidDescription
assetTypeVerificationAssetTypeVerificationDefault
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

ApplyDescriptionClientServer

Parameters (1)
humanoidDescriptionHumanoidDescription
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

ApplyDescriptionFinished

Parameters (1)
descriptionHumanoidDescription

History 1

ApplyDescriptionReset

Parameters (2)Default
humanoidDescriptionHumanoidDescription
assetTypeVerificationAssetTypeVerificationDefault
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

AutoJumpEnabled

TypeDefault
booltrue

History 5

AutoRotate

TypeDefault
booltrue

History 4

AutomaticScalingEnabled

TypeDefault
booltrue

History 4

BreakJointsOnDeath

TypeDefault
booltrue

History 4

BuildRigFromAttachments

Parameters (0)
No parameters.
Returns (1)
null

History 3

CacheDefaults

Parameters (0)
No parameters.
Returns (1)
null

History 3

CameraOffset

TypeDefault
Vector30, 0, 0

History 4

ChangeState

Parameters (1)Default
stateHumanoidStateTypeNone
Returns (1)
null

History 3

Climbing

Parameters (1)
speedfloat

History 2

ClusterCompositionFinished

Parameters (0)
No parameters.

History 1

CollisionType

TypeDefault
HumanoidCollisionTypeOuterBox
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

CustomStatusAdded

Parameters (1)
statusstring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

CustomStatusRemoved

Parameters (1)
statusstring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Died

Parameters (0)
No parameters.

History 2

DisplayDistanceType

TypeDefault
HumanoidDisplayDistanceTypeViewer

History 4

DisplayName

TypeDefault
string

History 3

EmoteTriggered

Parameters (2)
successbool
animationTrackAnimationTrack

History 2

EquipTool

Parameters (1)
toolInstance
Returns (1)
null

History 7

EvaluateStateMachine

TypeDefault
booltrue

History 3

FallingDown

Parameters (1)
activebool

History 2

FloorMaterial

TypeDefault
MaterialAir
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

FreeFalling

Parameters (1)
activebool

History 2

GetAccessories

Parameters (0)
No parameters.
Returns (1)
Array

History 4

GetAccessoryHandleScale

Parameters (2)
instanceInstance
partTypeBodyPartR15
Returns (1)
Vector3

History 1

GetAppliedDescription

Parameters (0)
No parameters.
Returns (1)
HumanoidDescription

History 3

GetBodyPartR15

Parameters (1)
partInstance
Returns (1)
BodyPartR15

History 2

GetLimb

Parameters (1)
partInstance
Returns (1)
Limb

History 4

GetMoveVelocity

Parameters (0)
No parameters.
Returns (1)
Vector3
This function is not browsable. It is not visible in Studio's object browser.

History 1

Tags: [NotBrowsable]

GetPlayingAnimationTracks

Parameters (0)
No parameters.
Returns (1)
Array
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

GetState

Parameters (0)
No parameters.
Returns (1)
HumanoidStateType

History 3

GetStateEnabled

Parameters (1)
stateHumanoidStateType
Returns (1)
bool

History 3

GetStatuses

Parameters (0)
No parameters.
Returns (1)
Array
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

GettingUp

Parameters (1)
activebool

History 2

HasCustomStatus

Parameters (1)
statusstring
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

HasStatus

Parameters (1)Default
statusStatusPoison
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Health

TypeDefault
float100
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

HealthChanged

Parameters (1)
healthfloat

History 2

HealthDisplayDistance

TypeDefault
float100

History 4

HealthDisplayType

TypeDefault
HumanoidHealthDisplayTypeDisplayWhenDamaged

History 4

HipHeight

TypeDefault
float0

History 4

Jump

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.

History 4

  • 553 Change Default of Jump from to false
  • 486 Change ThreadSafety of Jump from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Jump from to ReadOnly
  • 47 Add Jump
Tags: [NotReplicated]

JumpHeight

TypeDefault
float7.19999981

History 5

JumpPower

TypeDefault
float50

History 5

Jumping

Parameters (1)
activebool

History 2

LoadAnimation

Parameters (1)
animationAnimation
Returns (1)
AnimationTrack
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 8

Tags: [Deprecated]

MaxHealth

TypeDefault
float100

History 4

MaxSlopeAngle

TypeDefault
float89

History 4

Move

Parameters (2)Default
moveDirectionVector3
relativeToCameraboolfalse
Returns (1)
null

History 3

MoveDirection

TypeDefault
Vector30, 0, 0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

MoveTo

Parameters (2)Default
locationVector3
partInstanceInstance
Returns (1)
null

History 5

MoveToFinished

Parameters (1)
reachedbool

History 2

NameDisplayDistance

TypeDefault
float100

History 4

NameOcclusion

TypeDefault
NameOcclusionOccludeAll

History 8

PlatformStand

TypeDefault
boolfalse

History 4

PlatformStanding

Parameters (1)
activebool

History 2

PlayEmote

Parameters (1)
emoteNamestring
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

PlayEmoteAndGetAnimTrackById

Parameters (1)
emoteIdint64
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Ragdoll

Parameters (1)
activebool

History 2

RemoveAccessories

Parameters (0)
No parameters.
Returns (1)
null

History 5

RemoveCustomStatus

Parameters (1)
statusstring
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

RemoveStatus

Parameters (1)Default
statusStatusPoison
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

ReplaceBodyPartR15

Parameters (2)
bodyPartBodyPartR15
partBasePart
Returns (1)
bool

History 3

RequiresNeck

TypeDefault
booltrue

History 4

RigType

TypeDefault
HumanoidRigTypeR6

History 4

RootPart

TypeDefault
BasePart
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

Running

Parameters (1)
speedfloat

History 2

SeatPart

TypeDefault
BasePart
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

Seated

Parameters (2)
activebool
currentSeatPartBasePart

History 4

SetClickToWalkEnabled

Parameters (1)
enabledbool
Returns (1)
null

History 3

SetStateEnabled

Parameters (2)
stateHumanoidStateType
enabledbool
Returns (1)
null

History 3

Sit

TypeDefault
boolfalse

History 4

  • 553 Change Default of Sit from to false
  • 486 Change ThreadSafety of Sit from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Sit from to ReadOnly
  • 47 Add Sit

StateChanged

Parameters (2)
oldHumanoidStateType
newHumanoidStateType

History 2

StateEnabledChanged

Parameters (2)
stateHumanoidStateType
isEnabledbool

History 2

StatusAdded

Parameters (1)
statusStatus
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

StatusRemoved

Parameters (1)
statusStatus
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Strafing

Parameters (1)
activebool

History 2

Swimming

Parameters (1)
speedfloat

History 2

TakeDamage

Parameters (1)
amountfloat
Returns (1)
null

History 4

TargetPoint

TypeDefault
Vector30, 0, 0

History 4

Touched

Parameters (2)
touchingPartBasePart
humanoidPartBasePart

History 5

UnequipTools

Parameters (0)
No parameters.
Returns (1)
null

History 7

UseJumpPower

TypeDefault
booltrue

History 5

WalkSpeed

TypeDefault
float16

History 4

WalkToPart

TypeDefault
BasePart

History 5

WalkToPoint

TypeDefault
Vector30, 0, 0

History 4

loadAnimation

Parameters (1)
animationAnimation
Returns (1)
AnimationTrack
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. LoadAnimation should be used instead.

History 5

Tags: [Deprecated]

maxHealth

TypeDefault
float100
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. MaxHealth should be used instead.
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated, Deprecated]

takeDamage

Parameters (1)
amountfloat
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. TakeDamage should be used instead.

History 4

Tags: [Deprecated]

Removed members 3

ApplyDescriptionBlocking

Parameters (1)
humanoidDescriptionHumanoidDescription
Returns (1)
null

History 5

PlayEmoteById

Parameters (2)
emoteNamestring
emoteIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

Settings