Properties
bool
|
Sets whether the character will automatically jump when they hit an obstacle as a player on a mobile device. |
bool
|
AutoRotate sets whether or not the Humanoid will automatically rotate to face in the direction they are moving in. |
bool
|
bool
|
Determines whether a |
Vector3
|
An offset applied to the Camera’s subject position when its CameraSubject is set to this Humanoid. |
HumanoidCollisionType
[Deprecated]
|
Selects the |
HumanoidDisplayDistanceType
|
Controls the distance behavior of the Humanoid’s name and health display. |
string
|
Sets the text of a Humanoid, displayed above their head. |
Material
[ReadOnly]
[NotReplicated]
|
Describes the |
float
[NotReplicated]
|
Describes the current health of the Humanoid on the range [0, |
float
|
Used in conjunction with the |
HumanoidHealthDisplayType
|
Controls when the |
float
|
Determines the distance off the ground the |
bool
[NotReplicated]
|
Whether the |
float
|
Provides control over the force with which a |
float
|
Determines how much upwards force is applied to the |
BasePart
[Hidden]
[NotReplicated]
[Deprecated]
|
A reference to the humanoid’s Left Leg part. |
float
|
The maximum value of a |
float
|
The maximum slope angle that a humanoid can walk on without slipping |
Vector3
[ReadOnly]
[NotReplicated]
|
Describes the direction that the Humanoid is walking in, as a unit vector along the X/Z axis. |
float
|
Used in conjunction with the Humanoid’s DisplayDistanceType property to either determine how far a player controlling this Humanoid can see another humanoid’s name, or how far this Humanoid’s name displays to other viewing players. |
NameOcclusion
|
Controls whether a |
bool
|
Determines whether the |
bool
|
Allows developers to disable the behavior where a player |
HumanoidRigType
|
Describes whether this |
BasePart
[Hidden]
[NotReplicated]
[Deprecated]
|
A reference to the humanoid’s Right Leg part. |
BasePart
[ReadOnly]
[NotReplicated]
|
A reference to the |
BasePart
[ReadOnly]
[NotReplicated]
|
A reference to the seat that a |
bool
|
Describes whether the |
Vector3
|
Describes the 3D position where the |
BasePart
[Hidden]
[NotReplicated]
[Deprecated]
|
A reference to a humanoid’s root driving part. |
bool
|
Determines whether the |
float
|
Describes the |
BasePart
|
A reference to a part whose position is trying to be reached by a humanoid. |
Vector3
|
The position that a humanoid is trying to reach, after a call to |
float
[NotReplicated]
[Deprecated]
|
bool
|
Determines if an |
string
[ReadOnly]
[NotReplicated]
|
A read-only string representing the class this |
int
[Hidden]
[ReadOnly]
[NotReplicated]
[Deprecated]
|
The cost of saving the instance using data persistence. |
string
|
A non-unique identifier of the |
Instance
[NotReplicated]
|
Determines the hierarchical parent of the |
bool
[Hidden]
|
A deprecated property that used to protect |
int64
[Hidden]
[NotReplicated]
|
bool
[Hidden]
[NotReplicated]
[Deprecated]
|
string
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Functions
void
|
Attaches the specified |
bool
[Deprecated]
|
Adds a custom status to the Humanoid. |
bool
[Deprecated]
|
Adds a BoolValue to the Humanoid’s Status object. |
void
[Yields]
|
Makes the |
void
|
void
[Yields]
|
void
|
Assembles a tree of |
void
|
void
|
Set the |
void
|
Makes the |
Array
|
Returns an array of |
Vector3
|
HumanoidDescription
|
Returns back a copy of the |
BodyPartR15
|
Limb
|
Returns the |
Array
[Deprecated]
|
Returns an array of all |
HumanoidStateType
|
Returns the |
bool
|
Returns whether a |
Array
[Deprecated]
|
Returns a table of the Humanoid’s statuses, and custom statuses. |
bool
[Deprecated]
|
Returns boolean based on if custom statuses exist. |
bool
[Deprecated]
|
Returns a boolean based on if a status exists. |
AnimationTrack
[Deprecated]
|
Loads an |
void
|
Causes the |
void
|
Causes the |
bool
[Yields]
|
Plays emotes and returns if was successfully ran. |
Tuple
[Yields]
|
void
|
Removes all |
bool
[Deprecated]
|
Removes the defined custom status from the Status model in the Humanoid… |
bool
[Deprecated]
|
.Removes the defined status from the Status model in the Humanoid. |
bool
|
Dynamically replaces a Humanoid body part with a different part. |
void
|
void
|
Sets whether a given |
void
|
Lowers the |
void
|
Unequips any |
AnimationTrack
[Deprecated]
|
void
[Deprecated]
|
void
|
This function destroys all of an |
Instance
|
Create a copy of an object and all its descendants, ignoring objects that are not |
void
|
Sets the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first descendant found with the given |
Actor
|
Returns the Actor associated with the Instance, usually the first Actor ancestor |
Variant
|
Returns the attribute which has been assigned to the given name |
RBXScriptSignal
|
Returns an event that fires when the given attribute changes |
Dictionary
|
Returns a dictionary of string → variant pairs for each of the |
Objects
|
Returns an array containing all of the |
string
[NotBrowsable]
|
Returns a coded string of the |
Array
[CustomLuaState]
|
Returns an array containing all of the descendants of the instance |
string
|
Returns a string describing the |
RBXScriptSignal
|
Get an event that fires when a given property of an object changes. |
bool
[CustomLuaState]
|
Returns true if an |
bool
|
Returns true if an |
bool
|
Returns true if an |
void
[Deprecated]
|
Sets the object’s Parent to nil, and does the same for all its descendants. |
void
|
Sets the attribute with the given name to the given value |
Instance
[CustomLuaState]
[CanYield]
|
Returns the child of the |
Objects
[Deprecated]
|
Returns an array of the object’s children. |
Instance
[Deprecated]
|
void
[Deprecated]
|
Instance
[Deprecated]
|
Objects
[Deprecated]
|
bool
[Deprecated]
[CustomLuaState]
|
bool
[Deprecated]
|
void
[Deprecated]
|
Events
RBXScriptSignal
[Deprecated]
|
Fires when an |
RBXScriptSignal
|
Fires when the speed at which a |
RBXScriptSignal
|
RBXScriptSignal
[Deprecated]
|
Fired when a status is added to the Humanoid. |
RBXScriptSignal
[Deprecated]
|
Fired when a status is removed from the Humanoid. |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the speed at which a |
RBXScriptSignal
|
Fired when a |
RBXScriptSignal
|
Fired when the state of the |
RBXScriptSignal
|
Fires when |
RBXScriptSignal
[Deprecated]
|
Fired when a status is added to the Humanoid. |
RBXScriptSignal
[Deprecated]
|
Fired when a status is removed from the Humanoid. |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires when the speed at which a |
RBXScriptSignal
|
Fires when one of the |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires whenever an attribute is changed on the |
RBXScriptSignal
|
Fired immediately after a property of an object changes. |
RBXScriptSignal
|
Fires after an object is parented to this |
RBXScriptSignal
|
Fires after a child is removed from this |
RBXScriptSignal
|
Fires after a descendant is added to the |
RBXScriptSignal
|
Fires immediately before a descendant of the |
RBXScriptSignal
|
Fires immediately before the instance is destroyed via |
RBXScriptSignal
[Deprecated]
|
Code Samples
Walking Camera Bobble Effect
This LocalScript makes the camera bobble as the player’s character walks around, utilizing both the Humanoid’s CameraOffset and MoveDirection.
It should be parented inside of the StarterCharacterScripts so that it is distributed into a player’s character as expected.