Identifies, reads and sets the physics control state of a `Class.Humanoid`.
`Class.Humanoid:GetState()` and `Class.Humanoid:ChangeState()` methods, as
well as the `Class.Humanoid.StateChanged` event currently use this Enum.

Some states only allow manual setting, and allow a developer to make the
Humanoid relinquish control of its character.

When altering the Humanoid of a player, this should be done from a
`Class.LocalScript` ran by that player on their local client. Certain states
only work when set by the owner process (client or server). (Dead for example)


FallingDown

The Humanoid has been tripped, and will attempt to get up in a few
moments.


Running

Currently running while physics of parts in range are being calculated
(e.g. After a jump, close to other players, and others).


RunningNoPhysics

Currently running and not near other physical objects. (deprecated).


Climbing

The Humanoid is climbing (e.g. up a `Class.TrussPart` or ladder).


StrafingNoPhysics

Not currently used with default Humanoid. Cannot be set with
`Class.Humanoid:ChangeState()`.


Ragdoll

The Humanoid has been hit by a fast moving object (uncontrolled falling).
_The Humanoid can recover from this._


GettingUp

The Humanoid is getting back on their feet after Ragdoll.


Jumping

The Humanoid just jumped. (Check `Class.Humanoid.Jump`). This state lasts
only briefly. This state normally transitions into either Standing, if on
the ground, or Freefall, if still in the air.


Landed

The Humanoid touched the ground after a Freefall. This state lasts only
briefly.


Flying

When set, the Humanoid won't be animated, as with the
`Class.Humanoid.PlatformStand` property. This state lasts as long as the
player flies.


Freefall

The Humanoid is currently freefalling (jumped from a height).


Seated

The Humanoid is currently sitting in a Seat or VehicleSeat. Check the
`Class.Humanoid.Sit` property.


PlatformStanding

The Humanoid is platformstanding. Check the `Class.Humanoid.PlatformStand`
property.


Dead

The Humanoid died. Changing a Humanoid's state to this one will kill it.


Swimming

The Humanoid is currently swimming in `Class.Terrain` water.


Physics

The Humanoid doesn't apply any force on its own and will not automatically
transition to any other state. This state has to be set and unset manually
using `Class.Humanoid:ChangeState()`.


None

Unusable placeholder in case an unknown state gets triggered internally.


HumanoidStateType

Describes the physics control states within the Humanoid.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

HumanoidStateType

Items