Player¶
An object that represents a presently connected client to the experience.
Description¶
A Player object is a client that is currently connected. These objects are
added to the Players service when a new player connects, then removed
when they eventually disconnect from the server.
The Instance.Name property reflects the player's username. When saving information about a player, you should use their UserId since it is possible that a player can change their username.
There are several similar methods in the Players service for working with Player objects. Use these over their respective Instance methods:
- You can get a table of current
Playerobjects using Players.GetPlayers(); again, use this instead of Instance.GetChildren(). - To detect the addition of
Playerobjects, it is recommended to use the Players.PlayerAdded event (instead of Instance.ChildAdded on the Players service). - Similarly, you can detect the removal of
Playerobjects using Players.PlayerRemoving, which fires just before thePlayeris removed (instead of Instance.ChildRemoved which fires after). This is important if you are saving information about the player that might be removed or cleaned up on removal.
Inheritance¶
Nova inheritance: Instance → Player
Properties¶
AccountAge Supported Property Describes the player's account age in days.
Describes the player's account age in days.
This property describes how long ago a player's account was registered in days. It is set using the SetAccountAge() method, which cannot be accessed by scripts.
AppearanceDidLoad Supported Property Deprecated
No description available.
RobloxScriptSecurityAutoJumpEnabled Supported Property Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.
Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.
This property determines whether the Character of a Player using a mobile device will automatically jump when they hit an obstacle. This can make levels more navigable while on a mobile device.
When the player joins the experience, the StarterPlayer.AutoJumpEnabled value determines the initial state of this property. Then, this property determines the value of the Humanoid.AutoJumpEnabled property of the Character on spawn. In other words, it is possible to set the auto-jump behavior on a per-character, per-player, and per-experience basis using these three properties.
CameraMaxZoomDistance Supported Property The maximum distance the player's camera is allowed to zoom out.
The maximum distance the player's camera is allowed to zoom out.
This property sets the maximum distance the player's camera is allowed to zoom out, in studs.
The default value of this property is set by StarterPlayer.CameraMaxZoomDistance. If this value is set to a lower value than CameraMinZoomDistance, it will be increased to CameraMinZoomDistance.
CameraMinZoomDistance Supported Property The minimum distance the player's camera is allowed to zoom in.
The minimum distance the player's camera is allowed to zoom in.
This property sets the minimum distance the player's camera is allowed to zoom in, in studs.
The default value of this property is set by StarterPlayer.CameraMinZoomDistance. If this value is set to a higher value than CameraMaxZoomDistance, it will be decreased to CameraMaxZoomDistance.
CameraMode Supported Property Changes the camera's mode to either first or third person.
Changes the camera's mode to either first or third person.
This property sets the player's camera mode, defaulting to third person.
Third Person¶
In the default third person mode (CameraMode.Classic), the character can be seen in the camera. While in this mode, the default behavior is:
- Players can right-click and drag (mouse), tap and drag (mobile), use the secondary thumbstick (gamepad), or press the left/right arrows (keyboard) to rotate the camera around their character.
- When a player moves their character, it faces in the corresponding movement direction.
- Players can zoom in and out freely, even to first person on full zoom in.
First Person¶
In first person mode (CameraMode.LockFirstPerson), the player's
camera is zoomed all the way in. Unless there is a visible GUI present
with the GuiButton.Modal property set to true, moving the mouse,
tap-dragging on mobile, or using the secondary thumbstick on a gamepad
will rotate the camera around the character.
CanLoadCharacterAppearance Supported Property Determines whether the character's appearance will be loaded when the player spawns. If false, the player will spawn with a default appearance.
This property determines whether the character's appearance will be loaded when the player spawns. The default value of this property is set by StarterPlayer.LoadPlayerAppearance.
-
If
true, the character will load the appearance of the player corresponding to the player's CharacterAppearanceId. -
If
false, the player will spawn with a default appearance.
Attempting to set the property after the character has spawned will not change the character; you must call LoadCharacterAsync() to load the new appearance.
Character Supported Property A Model controlled by the player that contains a Humanoid, body parts, scripts, and other objects.
A Model controlled by the player that contains a Humanoid, body parts, scripts, and other objects.
This property contains a reference to a Model containing a
Humanoid, body parts, scripts, and other objects required for
simulating the player's avatar in-experience. The model is parented to the
Workspace but it may be moved. It is automatically loaded when
Players.CharacterAutoLoads is true and it can be manually loaded
otherwise using LoadCharacterAsync().
Initially this property is nil and it is set when the player's character
first spawns. Use the CharacterAdded event
to detect when a player's character properly loads, and the
CharacterRemoving event to detect when
the character is about to despawn. Avoid using
Object.GetPropertyChangedSignal() on this property.
Note that LocalScripts that are cloned from
StarterGui or StarterPack into a player's
PlayerGui or Backpack respectively are often run before
the old character model is replaced, so Player.Character may refer
to the old model whose Parent property is nil.
Therefore, in a LocalScript under StarterGui or
StarterPack, it is advisable to make sure the parent of
Character is not nil before using it, for example:
CharacterAppearance Supported Property Deprecated The URL of the asset containing the character's appearance, clothing, and gear.
This property indicates the URL of the asset containing the character's appearance, clothing, and gear. It is automatically set by Roblox to load your avatar's appearance when you join an experience.
Attempting to set the property after the character has spawned will not change the character, you must call LoadCharacterAsync() to load the new appearance.
ChatMode Supported Property
DataComplexity Supported Property Deprecated The total amount of data currently being stored in the player's cache on the current place.
This property was once used by an ancient data persistence method to indicate the total amount of data currently being stored in the player's cache on the current place.
Notes¶
- Booleans and numbers cost 1 data complexity unit.
- Strings cost their length divided by 100 in data complexity units.
- Instances cost their DataCost in data complexity units.
- Saving the default value (0 for numbers, false for booleans, "" for
strings and
nilfor Instances) removes the key from the DataComplexity count. - If, when using the SaveBoolean, SaveString, SaveNumber or SaveInstance functions, the DataComplexity for the player goes over the limit (currently 45000 units, defined by DataComplexityLimit), the function throws an error, the value is not saved, and any previous value of the key that was being saved to is deleted.
DataComplexityLimit Supported Property
DataReady Supported Property Deprecated Indicates when the player's data is available to load.
Indicates when the player's data is available to load.
This property was once used by an ancient data persistence method to indicate when the player's data is available to load. Becomes true when data is available.
DevCameraOcclusionMode Supported Property Sets how the default camera handles objects between the camera and the player.
Sets how the default camera handles objects between the camera and the player.
Defines how the default camera scripts handle objects between the camera and the camera subject. Set by StarterPlayer.DevCameraOcclusionMode and can't be changed for individual players.
The default value is Zoom. See DevCameraOcclusionMode for a list of available modes.
DevComputerCameraMode Supported Property Determines player's camera movement mode when using a device with a mouse and keyboard.
Determines player's camera movement mode when using a device with a mouse and keyboard.
This property determines the manner in which a player moves their camera when using a device with a mouse and keyboard. This property cannot be set using a LocalScript (it must be set on the server using a Script).
The default value of this property is determined by StarterPlayer.DevComputerCameraMovementMode.
This property doesn't affect players using a TouchEnabled device. See DevTouchCameraMode instead.
DevComputerMovementMode Supported Property Determines player's character movement mode when using a device with a mouse and keyboard.
Determines player's character movement mode when using a device with a mouse and keyboard.
This property determines the manner in which a player moves their character when using a device with a mouse and keyboard. This property cannot be set using a LocalScript (it must be set on the server using a Script).
The default value of this property is determined by StarterPlayer.DevComputerMovementMode.
This property doesn't affect players using a TouchEnabled device. See DevTouchMovementMode instead.
DevEnableMouseLock Supported Property Determines if the player can toggle mouse lock.
Determines if the player can toggle mouse lock.
This property determines if a player is able to toggle mouse lock by pressing Shift. A player can disable the mouse lock switch in the experience's settings during play. By default, this property is set to the value of StarterPlayer.EnableMouseLockOption. This can be set server-side during runtime by using a Script. It can not be set client-side.
When mouse lock is enabled, the player's cursor is locked to the center of the screen. Moving the mouse will orbit the camera around the player's Character, and the character will face the same direction as the Camera. It also offsets the camera view just over the right shoulder of the player's character.
DevTouchCameraMode Supported Property Determines player's camera movement mode when using a touch-enabled device.
Determines player's camera movement mode when using a touch-enabled device.
This property determines the manner in which a player moves their camera when using a TouchEnabled device. This property cannot be set using a LocalScript (it must be set on the server using a Script).
The default value of this property is determined by StarterPlayer.DevTouchCameraMovementMode.
This property doesn't affect players who aren't using a TouchEnabled device. See DevComputerCameraMode instead.
DevTouchMovementMode Supported Property Determines player's character movement mode when using a touch-enabled device.
Determines player's character movement mode when using a touch-enabled device.
This property determines the manner in which a player moves their character when using a TouchEnabled device. This property cannot be set using a LocalScript (it must be set on the server using a Script).
The default value of this property is determined by StarterPlayer.DevTouchMovementMode.
This property doesn't affect players who aren't using a TouchEnabled device. See DevComputerMovementMode instead.
DisplayName Supported Property The display name of the authenticated user associated with the Player.
This property contains the display name of the authenticated user associated with the Player object. Unlike UserId, display names are non-unique names a player displays to others.
Usage Notes¶
-
Since display names are non-unique, it's possible for two players in a single instance to have identical names. If you need a globally unique identifier for a player, use UserId instead.
-
Characters generated with LoadCharacterAsync() or by the Roblox engine will have their Humanoid.DisplayName property assigned to the Player.DisplayName property.
-
Display names may have unicode characters in the string. See
Library.utf8|UTF-8for more information on how to work with strings with unicode characters.
FollowUserId Supported Property Describes the user ID of the player who was followed into an experience by a player.
Describes the user ID of the player who was followed into an experience by a player.
This property contains the UserId of the user that a
player followed into the experience, or 0 if the player did not follow
anyone in. This property is useful for alerting players who have been
followed by another player into the experience.
You can get the name of the player followed using this user ID and the Players.GetNameFromUserIdAsync() method.
Guest Supported Property
HasBuildTools Supported Property
HealthDisplayDistance Supported Property Sets the distance at which this player will see other players' health bars.
Sets the distance at which this player will see other players' health bars.
This property sets the distance in studs at which this player will see
other Humanoid health bars. If set to 0, the health bars will
not be displayed. This property is set to
StarterPlayer.HealthDisplayDistance by default.
If a humanoid's health bar is visible, you can set the display type using Humanoid.DisplayDistanceType.
MaximumSimulationRadius Supported Property
No description available.
LocalUserSecurityMembershipType Supported Property Deprecated Describes the account's membership type.
Describes the account's membership type.
This property can only be read from to determine membership (it cannot be set to another membership type). It holds a MembershipType enum of the account's membership type.
NameDisplayDistance Supported Property Sets the distance at which this player will see other players' names.
Sets the distance at which this player will see other players' names.
This property sets the distance in studs at which this player will see
other Humanoid names. If the property is set to 0, names are
hidden. This property is set to StarterPlayer.NameDisplayDistance
by default.
If a humanoid's name is visible, you can set the display type using Humanoid.DisplayDistanceType.
Neutral Supported Property Determines whether the player is on a specific team.
This property determines whether the player is on a specific team.
PersonalServerRank Supported Property
No description available.
RobloxScriptSecurityRespawnLocation Supported Property If set, the player will respawn at the given SpawnLocation.
If set, the player will respawn at the given SpawnLocation.
If set, the player will respawn at the given SpawnLocation which must meet the following criteria:
-
Descendant of Workspace.
-
The SpawnLocation.TeamColor property is set to the player's TeamColor or the SpawnLocation.Neutral property is set to
true.
Alternatives¶
- A Player will spawn from SpawnLocations belonging to their team. In some cases it may be simpler to change the player's Team instead.
- Implement your own custom spawn logic using PVInstance.PivotTo() to manually move the Character.
SimulationRadius Supported Property
TeamColor Supported Property Determines the Team with which the player is associated with according to that team's Team.TeamColor.
Determines the Team with which the player is associated with according to that team's Team.TeamColor.
This property determines which Team a player is associated with according to that team's Team.TeamColor. If no Team object has the associated BrickColor, the player will not be associated with a team.
It's often a better idea to set Player.Team to the respective Team instead of using this property. Setting this property often leads to repetition of the same BrickColor value for a certain team across many scripts.
Teleported Supported Property
TeleportedIn Supported Property
UserId Supported Property A unique identifying integer assigned to all user accounts.
A unique identifying integer assigned to all user accounts.
This property contains a read-only integer that uniquely and consistently identifies the user's account on Roblox. Unlike the player's DisplayName which may change, this value will never change for the same account.
This property is essential when saving/loading player data using GlobalDataStores.
userId Supported Property Deprecated
No description available.
VRDevice Supported Property
Methods¶
ClearCharacterAppearance Supported Function Removes appearance children from the player's current character.
Removes appearance children from the player's current character.
Nova still removes Accessory, Shirt, Pants, CharacterMesh, and
BodyColors children from the character. It does nothing if the player
has no character.
DistanceFromCharacter Supported Function Returns the distance between the character's head and the given Vector3, or 0 if the player has no character.
This method returns the distance between the character's head and the
given Vector3 point, or 0 if the player has no
Character.
This is useful when determining the distance between a player and another object or location in experience.
If you would like to determine the distance between two non-player instances or positions, you can use the following:
GetFriendsOnline Supported Function Deprecated Returns a dictionary of online friends.
Returns a dictionary of online friends.
This method returns an array describing the
LocalPlayer's currently online friends, up to
a maximum of maxFriends entries. It can only be called on the
Players.LocalPlayer; calling it on any other Player raises
an error. No more than 200 friends are ever returned, and requesting more
logs a warning.
This method has been superseded by GetFriendsOnlineAsync(), which shares the same behavior and return format. See that method for the full description of the returned dictionary array.
GetFriendStatus Supported Function
No description available.
RobloxScriptSecurityGetGameSessionID Supported Function
No description available.
RobloxSecurityGetMouse Supported Function Returns the mouse being used by the client.
Returns the mouse being used by the client.
This method returns the Mouse being used by the client. The player's mouse instance can be used to track user mouse input including left and right mouse button clicks and movement and location.
Note that UserInputService provides additional methods, properties, and events to track user input, especially for devices that do not use a mouse.
GetRankInGroup Supported Function Deprecated Returns the player's rank in the group as an integer.
Returns the player's rank in the group as an integer.
Only public roles are considered.
GetRoleInGroup Supported Function Deprecated Returns the player's role in the group as a string, or Guest if the player isn't part of the group.
Returns the player's role in the group as a string, or Guest if the
player isn't part of the group.
Only public roles are considered.
GetUnder13 Supported Function
No description available.
RobloxScriptSecurityGetWebPersonalServerRank Supported Function
No description available.
LocalUserSecurityHasAppearanceLoaded Supported Function Returns whether or not the appearance of the player's character has loaded.
Returns whether or not the appearance of the player's character has loaded.
This method returns whether or not the appearance of the player's Character has loaded. Appearance includes items such as the player's Shirt, Pants, and Accessories.
This is useful when determining whether a player's appearance has loaded after they first join the experience, which can be tracked using the Players.PlayerAdded event.
IsBestFriendsWith Supported Function Deprecated Returns whether two players are friends. Nova has no separate best-friend concept.
Returns whether two players are friends. Nova has no separate best-friend concept.
Modern Roblox removed the best-friend feature and describes this as
non-functional. Nova does not have best friends either, but the engine
maps this call to the ordinary friends check, so it can still return
true for friends.
IsFriendsWith Supported Function Deprecated Checks whether a player is a friend of the user with the given
Checks whether a player is a friend of the user with the given
This method sends a request to Roblox asking whether the player is a
friend of the user with the given UserId. Results
are cached, so multiple calls on the same player with the same userId
may not reflect the most up-to-date friendship status.
This method has been superseded by IsFriendsWithAsync(), which shares the same behavior and should be used for new work.
isFriendsWith Supported Function Deprecated
No description available.
IsInGroup Supported Function Deprecated Checks whether a player is a member of a group with the given ID.
Checks whether a player is a member of a group with the given ID.
This method sends a request to Roblox asking whether the player is a member of the group with the given ID.
This method has been superseded by IsInGroupAsync(), which shares the same behavior (including its per-peer result caching) and should be used for new work.
JumpCharacter Supported Function
No description available.
RobloxScriptSecurityKick Supported Function Forcibly disconnect a player from the experience, optionally providing a message.
Forcibly disconnect a player from the experience, optionally providing a message.
This method allows an experience to gracefully disconnect a client and optionally provide a message to the disconnected user. This is useful for moderating abusive users. You should only allow specific users whom you trust to trigger this method on other users.
Calling this method on a Player with no arguments disconnects the user from the server and provides a default notice message. Calling this method on a Player along with a string as the first argument replaces the default message with the provided string.
When you call this method from the server, the custom message can be at most 500 bytes long. If the message is longer, it's discarded and the user sees the default notice message instead. The limit is measured in bytes, not characters, so messages that contain multibyte characters such as emoji or non-Latin text reach the limit sooner.
When using this method from a LocalScript, only the local user's client can be kicked.
LoadBoolean Supported Function Deprecated Returns a boolean value that was previously saved to the player with Player.SaveBoolean() with the same key.
This function returns a boolean value that was previously saved to the
player with Player.SaveBoolean() with the same key. Returns false
if the key doesn't exist, not nil.
loadBoolean Supported Function Deprecated
No description available.
LoadCharacter Supported Function Deprecated Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.
Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.
This method creates a new Character for the player, removing the old one, and also clears the player's Backpack and PlayerGui. It can only be called on the server.
This method has been superseded by LoadCharacterAsync(), which shares the same character-loading behavior and should be used for new work.
LoadCharacterAppearance Supported Function Deprecated Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
The LoadCharacterAppearance Player function places the given instance either in the player's Player.Character, head, or StarterGear based on the instance's class.
This is useful when giving a player's character an asset from the Roblox catalog, such as a hat or piece of gear.
It is similar to Player.LoadCharacterAsync(), except it does not reload the entire character instance, StarterGear, or PlayerGui.
Note:
- Accessory, Shirt, ShirtGraphic, CharacterMesh, BodyColors, and Accoutrement are parented to the player's character.
- Decal, FileMesh, SpecialMesh, BlockMesh, CylinderMesh, and Texture are parented to the character's head.
- Tool is parented to the player's StarterGear.
- All other classes are ignored.
LoadData Supported Function
No description available.
LocalUserSecurityLoadInstance Supported Function Deprecated Returns an instance that was previously saved to the player with Player.SaveInstance() with the same key.
This function returns an instance that was previously saved to the player
with Player.SaveInstance() with the same key. Returns nil if the
key doesn't exist.
loadInstance Supported Function Deprecated
No description available.
LoadNumber Supported Function Deprecated Returns a number value that was previously saved to the player.
Returns a number value that was previously saved to the player.
This function was once used by an ancient data persistence method to
return a number value that was previously saved to the player with
Player.SaveNumber() with the same key. Returns 0 if the key
doesn't exist, not nil.
loadNumber Supported Function Deprecated
No description available.
LoadString Supported Function Deprecated Returns a string value that was previously saved to the player.
Returns a string value that was previously saved to the player.
This function returns a string value that was previously saved to the
player with Player.SaveString() with the same key. Returns an
empty string ("") if the key doesn't exist, not nil.
loadString Supported Function Deprecated
No description available.
Move Supported Function Causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls).
This method causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls).
This is useful when scripting NPC Humanoids that move around a map but are not controlled by an actual player's input.
Note that the function's second argument indicates whether the provided
Vector3 should move the player relative to world coordinates
(false) or the player's Camera (true).
Roblox reference signature
MoveCharacter Supported Function
No description available.
RobloxScriptSecurityRemoveCharacter Supported Function
No description available.
LocalUserSecurityRequestFriendship Supported Function
No description available.
RobloxScriptSecurityRevokeFriendship Supported Function
No description available.
RobloxScriptSecuritySaveBoolean Supported Function Deprecated Used to save a boolean value that can be loaded again at a later time using Player.LoadBoolean().
This function is used to save a boolean value that can be loaded again at a later time using Player.LoadBoolean().
saveBoolean Supported Function Deprecated
No description available.
SaveData Supported Function
No description available.
LocalUserSecuritySaveInstance Supported Function Deprecated Saves an instance which can be loaded again at a later time.
Saves an instance which can be loaded again at a later time.
This function was once used by an ancient data persistence method to save an instance which can be loaded again at a later time using Player.LoadInstance()..
saveInstance Supported Function Deprecated
No description available.
SaveLeaderboardData Supported Function
No description available.
LocalUserSecuritySaveNumber Supported Function Deprecated Saves a number value that can be loaded again at a later time using.
Saves a number value that can be loaded again at a later time using.
This function was once used by an ancient data persistence method to save a number value that can be loaded again at a later time using Player.LoadNumber().
saveNumber Supported Function Deprecated
No description available.
SaveString Supported Function Deprecated Saves a string value that can be loaded again at a later time.
Saves a string value that can be loaded again at a later time.
This function was once used by an ancient data persistence method to save a string value that can be loaded again at a later time using Player.LoadString().
saveString Supported Function Deprecated
No description available.
SetAccountAge Supported Function Sets the AccountAge of the player.
Sets the AccountAge of the player.
This method sets the AccountAge of the player in days, meaning the age of the account itself relative to when it was first created.
PluginSecuritySetMembershipType Supported Function
No description available.
RobloxScriptSecuritySetSuperSafeChat Supported Function Sets whether or not the player sees filtered chats, rather than normal chats.
Sets whether or not the player sees filtered chats, rather than normal chats.
This method sets whether or not the player sees chat filtered by TextService.FilterStringAsync() rather than normal chats.
local Players = game:GetService("Players")
local player = Players.LocalPlayer
player:SetSuperSafeChat(true)
Regardless of whether a player has filtered chat enabled, all chat should be filtered by TextService when broadcast to other players or on the player's own screen. TextService.FilterStringAsync() returns a TextFilterResult object that can be filtered differently according to the message's intended use.
PluginSecuritySetUnder13 Supported Function Deprecated
No description available.
RobloxSecuritySetWebPersonalServerRank Supported Function
WaitForDataReady Supported Function Deprecated Used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the playe…
This function is used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the player's data
waitForDataReady Supported Function Deprecated
No description available.
Events¶
CharacterAdded Supported Event Fires when a player's character spawns or respawns.
This event fires when a player's character spawns or respawns. It fires
soon after setting Character to a non-nil value
or calling LoadCharacterAsync(), which
is before the character is parented to the Workspace.
This can be used alongside the CharacterRemoving event which fires right before a player's character is about to be removed, typically after death. As such, both of these events can potentially fire many times as players die then respawn in a place.
Note that the Humanoid and its default body parts (head, torso, and limbs) will exist on the server when this event fires, but clothing items like Hats, Shirts, and Pants might take a few seconds to be added to the character. The parts will also take time to replicate to clients. Connect Instance.ChildAdded on the added character to detect these, or wait for the CharacterAppearanceLoaded event to be sure the character has everything equipped.
If you instead need to track when a player joins/leaves the experience, use the events Players.PlayerAdded and Players.PlayerRemoving.
CharacterAppearanceLoaded Supported Event Fires when the full appearance of a Character has been inserted.
This event fires when the full appearance of a Character has been inserted. It only fires on the server.
A Character generally has a range of objects modifying its appearance, including Accoutrements, Shirts, Pants and CharacterMeshes. This event will fire when all such objects have been inserted into the character.
For custom character implementations, such as using a character model
named StarterCharacter inside StarterPlayer, use
CharacterAdded and handle your own
accessories.
One use for this event is to ensure all accessories have loaded before destroying them. See below for an example of this.
CharacterRemoving Supported Event Fires right before a player's character is removed.
Fires right before a player's character is removed.
This event fires right before a player's Character is removed, such as when the player is respawning. This can be used alongside the CharacterAdded event which fires when a player's character spawns or respawns.
If you instead need to track when a player joins/leaves the experience, use the events Players.PlayerAdded and Players.PlayerRemoving.
Chatted Supported Event Fires when a player chats in experience using Roblox's provided chat bar.
Fires when a player chats in experience using Roblox's provided chat bar.
This event fires when a Player types a message and presses
Enter in Roblox's provided chat bar. This is done using some
Luau bindings by the default chat script. You can prevent players from
chatting by using StarterGui.SetCoreGuiEnabled() and setting
CoreGuiType.Chat to false.
FriendStatusChanged Supported Event
No description available.
RobloxScriptSecurityIdled Supported Event This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that…
This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point. The event continues to fire every 30 seconds for as long as the player remains idle.
Once the player becomes active again, Idled stops firing and the elapsed
idle time resets. There is no separate event for the transition back to
activity. If the player goes idle again later, Idled waits the same ~2
minutes before firing again.
This event only fires in client scripts, not server scripts; use a RemoteEvent to notify the server of idle players.
Roblox automatically disconnects players that have been idle for at least 20 minutes, so this event is useful for warning players that they will be disconnected soon, disconnecting players prior to those 20 minutes, or other away from keyboard (AFK) features.
To track how often automatic disconnects occur, try correlating this event with occurrences of Players.PlayerRemoving.
OnTeleport Supported Event Fires when the teleport state of a player changes.
Fires when the teleport state of a player changes.
This event fires when the TeleportState of a player changes. This event is useful for detecting whether a teleportation was successful.
Roblox reference signature
SimulationRadiusChanged Supported Event
No description available.
LocalUserSecurityInherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
62 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's Player class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AgeChecked |
AgeChecked: AgeCheckStatus |
Not yet | Indicates whether the player has completed an age verification check. | read None / write RobloxSecurity |
CharacterAppearanceId |
CharacterAppearanceId: int64 |
Not yet | Determines the user ID of the account whose character appearance is used for a player's Character. | — |
FrustumStreaming |
FrustumStreaming: FrustumStreamingMode |
Not yet | Controls the engine's instance streaming behavior for the player's camera view. | — |
HasRobloxSubscription |
HasRobloxSubscription: bool |
Not yet | Indicates whether the player has an active Roblox subscription. | read None / write RobloxSecurity |
HasVerifiedBadge |
HasVerifiedBadge: bool |
Not yet | Indicates if a player has a Verified badge. | — |
InputLatency |
InputLatency: int |
Not yet | Latency used by the Server Authority netcode system. | RobloxSecurity |
ReplicationFocus |
ReplicationFocus: Instance |
Not yet | Sets the part to focus replication around. | — |
StepIdOffset |
StepIdOffset: int |
Not yet | — | RobloxSecurity |
Team |
Team: Team |
Not yet | Determines the Team with which the player is associated. | NotReplicated |
ThirdPartyTextChatRestrictionStatus |
ThirdPartyTextChatRestrictionStatus: ChatRestrictionStatus |
Not yet | A read-only value reflecting the player's text-chat restriction status as reported by a third-party platform. | ReadOnly, NotReplicated, RobloxScriptSecurity |
User |
User: User |
Not yet | The User representing this player's domain-scoped identity within the current experience. | read None / write RobloxSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AddReplicationFocus |
Player:AddReplicationFocus(part: BasePart): null |
Not yet | Adds an additional replication focus for the player. | — |
AddReplicationFocusPosition |
Player:AddReplicationFocusPosition(center: Vector3, radius: int): null |
Not yet | — | RobloxSecurity |
AddToBlockList |
Player:AddToBlockList(userIds: Array): null |
Not yet | — | RobloxScriptSecurity |
ClearCachedAvatarAppearance |
Player:ClearCachedAvatarAppearance(): null |
Not yet | Clears the cached avatar appearance for the player, forcing a fresh fetch from the backend on the next respawn. | — |
GetBlockListInitialized |
Player:GetBlockListInitialized(): bool |
Not yet | — | RobloxScriptSecurity |
GetCameraState |
Player:GetCameraState(): Dictionary |
Not yet | Returns a dictionary containing the player's current camera state. | CustomLuaState |
GetCanManageAsync |
Player:GetCanManageAsync(): bool |
Not yet | — | Yields, RobloxScriptSecurity |
GetData |
Player:GetData(): PlayerData |
Not yet | — | — |
GetFriendsInUniverseAsync |
Player:GetFriendsInUniverseAsync(): Array |
Not yet | — | Yields |
GetFriendsOnlineAsync |
Player:GetFriendsOnlineAsync(maxFriends: int = 200): Array |
Not yet | Returns a dictionary of online friends. | Yields |
GetFriendsWhoPlayedAsync |
Player:GetFriendsWhoPlayedAsync(): Array |
Not yet | Returns the user IDs of friends who have previously joined this experience. | Yields |
GetGlobalUserId |
Player:GetGlobalUserId(): int64 |
Not yet | — | RobloxScriptSecurity |
GetJoinData |
Player:GetJoinData(): Dictionary |
Not yet | Returns a dictionary containing information describing how the player joins the experience. | CustomLuaState |
GetNetworkPing |
Player:GetNetworkPing(): float |
Not yet | Returns the round-trip, isolated network latency in seconds. | — |
GetRankInGroupAsync |
Player:GetRankInGroupAsync(groupId: int64): int |
Not yet | Returns the player's rank in the group as an integer. | Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
GetRoleInGroupAsync |
Player:GetRoleInGroupAsync(groupId: int64): string |
Not yet | Returns the player's role in the group as a string, or Guest if the player isn't part of the group. |
Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
GetSeatRequested |
Player:GetSeatRequested(): Instance |
Not yet | — | RobloxScriptSecurity |
GetToolRequested |
Player:GetToolRequested(): Instance |
Not yet | — | RobloxScriptSecurity |
HasBlockedPlayer |
Player:HasBlockedPlayer(fromPlayer: int64): bool |
Not yet | — | RobloxScriptSecurity |
IsFriendsWithAsync |
Player:IsFriendsWithAsync(userId: User): bool |
Not yet | Checks whether a player is a friend of the user with the given Player.UserId. | Yields |
IsInGroupAsync |
Player:IsInGroupAsync(groupId: int64): bool |
Not yet | Checks whether a player is a member of a group with the given ID. | Yields |
IsVerified |
Player:IsVerified(level: VerifiedLevel = Low): bool |
Not yet | Returns whether the player meets the specified verification level. | — |
LoadCharacterAsync |
Player:LoadCharacterAsync(): null |
Not yet | Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui. | Yields |
LoadCharacterBlocking |
Player:LoadCharacterBlocking(): null |
Not yet | — | Yields, LocalUserSecurity |
LoadCharacterWithAvatarRules |
Player:LoadCharacterWithAvatarRules(avatarRules: AvatarRules): null |
Not yet | — | Yields, RobloxScriptSecurity |
LoadCharacterWithHumanoidDescription |
Player:LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null |
Not yet | Spawns a player character with everything equipped in the passed in HumanoidDescription. | Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
LoadCharacterWithHumanoidDescriptionAsync |
Player:LoadCharacterWithHumanoidDescriptionAsync(humanoidDescription: HumanoidDescription, assetTypeVerification: AssetTypeVerification = Default): null |
Not yet | Spawns a player character with everything equipped in the passed in HumanoidDescription. | Yields |
NotifyAgeCheckPassed |
Player:NotifyAgeCheckPassed(): null |
Not yet | — | RobloxScriptSecurity |
OverrideStreamingRadii |
Player:OverrideStreamingRadii(minRadius: int, targetRadius: int): null |
Not yet | — | RobloxSecurity |
PinStreamingForInstance |
Player:PinStreamingForInstance(instance: Instance, depth: int): null |
Not yet | — | RobloxScriptSecurity |
PinStreamingForInstanceByUniqueId |
Player:PinStreamingForInstanceByUniqueId(uniqueIdString: string, depth: int): null |
Not yet | — | RobloxScriptSecurity |
PromptAgeCheck |
Player:PromptAgeCheck(): null |
Not yet | Prompts the player to complete age verification. | — |
PromptSecurityChallengeAsync |
Player:PromptSecurityChallengeAsync(): bool |
Not yet | — | Yields, RobloxSecurity |
RemoveReplicationFocus |
Player:RemoveReplicationFocus(part: BasePart): null |
Not yet | Removes a previously added replication focus. | — |
RemoveReplicationFocusPosition |
Player:RemoveReplicationFocusPosition(center: Vector3, radius: int): null |
Not yet | — | RobloxSecurity |
RequestSeat |
Player:RequestSeat(instance: Instance): null |
Not yet | — | RobloxScriptSecurity |
RequestStreamAroundAsync |
Player:RequestStreamAroundAsync(position: Vector3, timeOut: double = 0): null |
Not yet | Requests that the server stream to the player around the specified location. | Yields |
RequestTool |
Player:RequestTool(instance: Instance): null |
Not yet | — | RobloxScriptSecurity |
SetBlockListInitialized |
Player:SetBlockListInitialized(): null |
Not yet | — | RobloxScriptSecurity |
SetCharacterAppearanceJson |
Player:SetCharacterAppearanceJson(jsonBlob: string): null |
Not yet | — | RobloxScriptSecurity |
SetChatTranslationSettingsLocaleId |
Player:SetChatTranslationSettingsLocaleId(locale: string): null |
Not yet | — | RobloxScriptSecurity |
SetExperienceSettingsLocaleId |
Player:SetExperienceSettingsLocaleId(locale: string): null |
Not yet | — | RobloxScriptSecurity |
SetHasRobloxSubscription |
Player:SetHasRobloxSubscription(hasRobloxSubscription: bool): null |
Not yet | — | RobloxScriptSecurity |
SetModerationAccessKey |
Player:SetModerationAccessKey(moderationAccessKey: string): null |
Not yet | — | RobloxScriptSecurity |
UnpinStreamingForInstance |
Player:UnpinStreamingForInstance(instance: Instance, depth: int): null |
Not yet | — | RobloxScriptSecurity |
UpdatePlayerBlocked |
Player:UpdatePlayerBlocked(userId: int64, blocked: bool): null |
Not yet | — | RobloxScriptSecurity |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
BlockListChanged |
BlockListChanged() |
Not yet | — | RobloxScriptSecurity |
CloudEditSelectionChanged |
CloudEditSelectionChanged(newSelection: Array) |
Not yet | — | RobloxScriptSecurity |
InstancePinned |
InstancePinned(uniqueIdString: string, depth: int) |
Not yet | — | RobloxScriptSecurity |
InstanceUnpinned |
InstanceUnpinned(uniqueIdString: string, depth: int) |
Not yet | — | RobloxScriptSecurity |
StreamingPinComplete |
StreamingPinComplete(instance: Instance) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: Player
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.