Player

The AccountAge is a Player property that describes how long ago a player's account was registered in days. It is set using the Player:SetAccountAge() function, which cannot be accessed by scripts.

This property is useful for conditionally showing new Roblox players content such as tutorials.

The AutoJumpEnabled property determines whether the Player.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 game, the StarterPlayer.AutoJumpEnabled value determines the initial state of this property. Then, this property determines the value of the Humanoid.AutoJumpEnabled property of the Player.Characters Humanoid on spawn. In other words, it is possible to set the auto-jump behavior on a per-character, per-player and per-game basis using these three properties.

The CameraMaxZoomDistance Player property sets the maximum distance in studs the camera can be from the character with the default cameras.

In other words, it controls the maximum distance the player's camera is allowed to zoom out.

The default value of this property is set by StarterPlayer.CameraMaxZoomDistance. If this value is set to a lower value than Player.CameraMinZoomDistance, it will be increased to CameraMinZoomDistance.

The CameraMinZoonDistance Player property sets the minimum distance in studs the camera can be from the character with the default cameras.

In other words, it controls the minimum distance the player's camera is allowed to zoom in.

The default value of this property is set by StarterPlayer.CameraMinZoomDistance. If this value is set to a higher value than Player.CameraMaxZoomDistance it will be decreased to CameraMaxZoomDistance.

The CameraMode Player property sets what mode that the player's camera is in. By default, the camera mode is set to third person.

The camera has two modes:

1. First person
2. Third person

The CameraMode Enum is used to set CameraMode in Player, and determines when first and third person cameras should be used.

First-person

In first-person mode, 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, the mouse will be locked and the user's camera will turn as the mouse moves.

Third-person

In third-person mode, the character can be seen in the camera. While in third-person mode on Roblox:

• You may right-click and drag to rotate your camera, or use the arrow keys at the bottom right-hand corner of the screen.
• When you move your mouse, your camera does not change (unless you move the mouse to the end of the screen).
• When you press any of the arrow keys, the user's character will face in the corresponding arrow key's direction.
• You can zoom in and out freely.

Third-person is the default camera setting.

.

Note

• This item should be used in a LocalScript to work as expected online.

The CanLoadCharacterAppearance Player 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 Player.CharacterAppearanceId.

If false, the player will spawn with a default appearance - a grey character model without any hats, shirts, pants, etc.

Attempting to set the property after the character has spawned will not change the character, you must call Player:LoadCharacter() to load the new appearance.

The Character property contains a reference to a Model containing a Humanoid, body parts, scripts and other objects required for simulating the player's avatar in-game. The model is parented to the Workspace, but may be moved. It is automatically loaded when Players.CharacterAutoLoads is true, but can be manually loaded otherwise using Player:LoadCharacter().

Initially, this property is nil then set when the player's character first spawns. Use the Player.CharacterAdded event to detect when a player's character properly loads, and the Player.CharacterRemoving event to detect when the character is about to despawn. Avoid using Instance:GetPropertyChangedSignal() on this property.

Note: LocalScripts that are cloned from StarterGui or StarterPack into a player's Backpack or PlayerGui are often run before the old Character model is deleted. Player.Character still refers to a model, but that model's parent is nil and it has been destroyed. Because of this, if the Character already exists, you should check to make sure that the Character's parent is not nil before using it.

So if you're writing a LocalScript under the StarterGui or StarterPack that requires access to the player's character, use this:

1local Players = game:GetService("Players")
2local player = Players.LocalPlayer
3local character = player.Character
4if not character or not character.Parent then
5    character = player.CharacterAdded:wait()
6end
7

This property determines the user ID of the account whose character appearance is used for a player's character. By default, this property is the Class.Player's Class.Player.UserId`, which uses the player's avatar as they have created it on the Roblox website.

Changing this property to the user ID of another account will cause the player to spawn with that account's appearance (hats, shirt, pants, etc).

Games can also toggle whether or not a player's character appearance is loaded in game by changing the StarterPlayer.LoadCharacterAppearance property.

The DevCameraOcclusionMode Player property sets how the default camera handles objects between the camera and the player. Set by default by StarterPlayer.DevCameraOcclusionMode.

The default value is Zoom (0): The camera will zoom in until there is nothing between the player and camera.

See DevCameraOcclusionMode for the different occlusion modes available. Sets how the default camera handles objects between the camera and the player.

The DevComputerCameraMode property determines the manner in which a player moves their camera when using a mouse-and-keyboard device device. See DevComputerCameraMovementMode for a description of each camera control mode available. 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.

Note

• The word "Computer" in this property name refers to non-TouchEnabled, non-GamepadEnabled devices.
• When set to UserChoice, a player can choose between any control mode (except Scriptable) in the Roblox game settings. In general, it is a good idea to allow players to choose their control mode to maximize accessibility.
• It is possible to create a custom control scheme by setting this property to Scriptable.
• This property does not affect players using a touch enabled device. See Player.DevTouchCameraMode instead.

The DevComputerMovementMode property determines the manner in which a player moves their character when using a mouse-and-keyboard device device. See DevComputerMovementMode for a description of each movement control mode available. 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.

Note

• The word "Computer" in this property name refers to non-TouchEnabled devices.
• When set to UserChoice, a player can choose between any control mode (except Scriptable) in the Roblox game settings. In general, it is a good idea to allow players to choose their control mode to maximize accessibility.
• It is possible to create a custom control scheme by setting this property to Scriptable.
• This property does not affect players using a touch enabled device. See Player.DevTouchMovementMode instead.

This property determines if a player is able to toggle mouse lock by pressing Shift. A player can disable the mouse lock switch in Roblox's game settings. By default, this property is set to the value of StarterPlayer.EnableMouseLockOption. This can be set server-side during run-time by using a Script. It can not be set client-side.

What is Mouse Lock?

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 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.

Below, the camera is moved left and right first by holding right-click. Then, mouse lock is enabled which changes the mouse to a target reticule, and offsets the camera. The camera is again moved left and right (without holding right click).

The DevTouchCameraMode property determines the manner in which a player moves their camera when using a TouchEnabled device. See DevTouchCameraMovementMode for a description of each camera control mode available. 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.

Note

• When set to UserChoice, a player can choose between any control mode (except Scriptable) in the Roblox game settings. In general, it is a good idea to allow players to choose their control mode to maximize accessibility.
• It is possible to create a custom control scheme by setting this property to Scriptable.
• This property does not affect players who are not using a touch enabled device. See Player.DevComputerCameraMovementMode instead.

The DevTouchMovementMode property determines the manner in which a player moves their character when using a TouchEnabled device. See DevTouchMovementMode for a description of each movement control mode available. 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.

Note

• When set to UserChoice, a player can choose between any control mode (except Scriptable) in the Roblox game settings. In general, it is a good idea to allow players to choose their control mode to maximize accessibility.
• It is possible to create a custom control scheme by setting this property to Scriptable.
• This property does not affect players who are not using a touch enabled device. See Player.DevComputerMovementMode instead.

The DisplayName is a Player property that contains the display name of the authenticated user associated with the Player object. Unlike usernames, display names are non-unique names a player displays to others. If the Roblox user has not chosen one, the property will read the same as the Name property.

Note:

• 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 Player.UserId (which is static) or Player.Name (which is the current Username) instead.
• Characters generated with LoadCharacter or by the Roblox engine will have their Humanoid's DisplayName property assigned to the Player's DisplayName property.
• Display names may have unicode characters in the string. See UTF-8 for more information on how to work with strings with unicode characters.

The FollowUserId is a Player property that contains the Player.UserId of the user that a player followed into the game. If the player did not follow anyone into the game, this property will be 0. This property is useful for alerting players who have been followed by another player into the game.

You can get the name of the player followed using this user ID and the Players:GetNameFromUserIdAsync() function.

The GameplayPaused property indicates if the player is currently in a pause state in a place with StreamingEnabled activated. It is set on the client but replicated to the server. To determine the pause status, you can utilize this property.

See also:

• Workspace.StreamingEnabled which controls whether content streaming is enabled
• Workspace.StreamingIntegrityMode and StreamingIntegrityMode for more details on when gameplay is paused.

The HealthDisplayDistance Player property sets the distance in studs at which this player will see other Humanoid's health bars. If set to 0, the health bars will not be displayed. This property is set to StarterPlayer.HealthDisplayDistance by default.

Note

If a Humanoid's health bar is visible, you can set the display type using Humanoid.DisplayDistanceType.

The LocaleId Player property shows the locale id that the local player has set for their Roblox account. It holds a string with the two letter code (for example, "en-us") for the locale.

This can be used to determine the geographic demographic of your game's player base.

This property allows access to the player's locale from the server. It is similar to LocalizationService's LocalizationService.RobloxLocaleId property.

The maximum value a Player's Player.SimulationRadius can grow to. Defaults to 1000 and is measured in studs.

What is the SimulationRadius?

Player.SimulationRadius determines the radius around the Player.Charater in which physically simulated objects, for whom network ownership is set to automatic, are physically simulated by the Player. In cases where a BasePart or assembly is within multiple player's SimulationRadiuses, the closest player is chosen.

Player.SimulationRadius, measured in studs, starts at 10 and grows at a rate of 5% per second until it reaches MaximumSimulationRadius.

Note:

• The Player.SimulationRadius can be visualized using PhysicsSettings.AreRegionsShown
• When this property is changed, the Player.SimulationRadiusChanged event fires
• For more information on network ownership, see Network Ownership

The MembershipType Player property can be used to determine the membership type of the player. It holds a MembershipType enum of the account's membership type.

This property can only be read from to determine membership (it cannot be set to another membership type). The property can only be changed via CoreScripts using Player:SetMembershipType() - which are not accessible.

The NameDisplayDistance StarterPlayer property sets the distance in studs at which this player will see other Humanoid's names. If the property is set to 0, names are hidden. This property is set to StarterPlayer.NameDisplayDistance by default.

Note

If a Humanoid's health bar is visible, you can set the display type using Humanoid.DisplayDistanceType.

The Neutral property determines whether the player is on a specific team.

• When true, the player is not on a specific team. This also means that the Player.Team property will be nil and the Player.TeamColor will be white.
• When false, the player is on a specific team. The Player.Team property will correspond to the Team that the player is on, as will the Player.TeamColor.

The ReplicationFocus Player property sets the part to focus replication around a Player. Different Roblox systems that communicate over the network (such as physics, streaming, etc) replicate at different rates depending on how close objects are to the replication focus.

When this property is nil, it reverts to its default behavior which is to treat the local player's character's PrimaryPart as the replication focus.

This property should only be set on the server with a Script, not a LocalScript. Note that this property does not change or update network ownership of parts.

If set, the player will respawn at the given SpawnLocation. This property can only be set through Lua and must contain a reference to a valid SpawnLocation, which must meet the following criteria:

• Descendant of Workspace
• SpawnLocation.TeamColor is set to the Player.TeamColor or SpawnLocation.Neutral is set to true

If RespawnLocation is not set to a valid SpawnLocation then the default spawning logic will apply. For more information on this see the page for SpawnLocation.

Alternatives to RespawnLocation

• A Player will spawn from SpawnLocations belonging to their team. In some cases it may be simpler to change the Player's Player.Team instead. This method also allows the Player to respawn from multiple SpawnLocations.
• Developers may wish to implement their own custom spawn logic, using Model:SetPrimaryPartCFrame() to move the Player.Character manually.

SimulationRadius determines the radius around the Player.Character in which physically simulated objects, for whom network ownership is set to automatic, are physically simulated by the Player. In cases where a BasePart or assembly is within multiple player's SimulationRadiuses, the closest player is chosen.

SimulationRadius, measured in studs, starts at 10 and grows at a rate of 5% per second until it reaches Player.MaximumSimulationRadius.

Note:

• The Player.SimulationRadius can be visualized using PhysicsSettings.AreRegionsShown
• When this property is changed, the Player.SimulationRadiusChanged event fires
• For more information on network ownership, see Network Ownership

The Team property is a reference to a Team object within the Teams service. It determines the team the player is on; if the Player isn't on a team or has an invalid Player.TeamColor, this property is nil. When this property is set, the player has joined the Team and the Team.PlayerAdded event fires on the associated team. Similarly, Team.PlayerRemoved fires when the property is unset from a certain Team.

The TeamColor property determines which team a Player is associated with according to that Team's Team.TeamColor. Changing this property will change Player.Team according to whichever team has the same BrickColor for their Team.TeamColor. If no Team object has the associated TeamColor, 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 teams across many scripts; this is something you want to avoid when adhering to the don't-repeat-yourself principle.

The UserId is a Player property that contains a read-only integer that uniquely and consistently identifies every user account on Roblox. Unlike the Instance.Name of a Player, which may change according the user's present username, this value will never change for the same account.

This property is essential when saving/loading player data using GlobalDataStores. Use a player's UserId as the data store key so that each player has a unique key.

The CharacterAdded event fires when a player's character spawns (or respawns). This event fires soon after setting Player.Character to a non-nil value or calling Player:LoadCharacter(), which is before the character is parented to the Workspace.

This can be used alongside the Player.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. If you want to detect when a player joins or leaves the game, use the Players.PlayerAdded and Players.PlayerRemoving events instead.

Note that the Humanoid and its default body parts (head, torso, and limbs) will exist when this event fires, but clothing items like Hats and Shirts, and Pants may take a few seconds to be added to the character. Connect Instance.ChildAdded on the added character to detect these, or wait for the Player.CharacterAppearanceLoaded event to be sure the character has everything equipped.

This event fires when the the full appearance of a Player's Player.Character has been inserted.

Player.Character's generally have a range of objects modifying their appearance including Accoutrements, Shirts, Pants and CharacterMeshes. This event will fire when all such objects have been inserted into the Player.Character.

One use for this event, is to remove and save aspects of a Characters appearance to be used later. See below for an example of this.

The CharacterRemoving event fires right before a player's character is removed, such as when the player is respawning.

This event can be used alongside the Player.CharacterAdded event, which fires when a player's character spawns or respawns. For instance, if you would like print a message every time a player spawns and dies:

1local Players = game:GetService("Players")
2
3local function onCharacterSpawned(player)
4	print(player.Name .. " is spawning")
5end
6
7local function onCharacterDespawned(player)
8	print(player.Name .. " is despawning")
9end
10
11local function onPlayerAdded(player)
12	player.CharacterAdded:Connect(function ()
13		onCharacterDespawned(player)
14	end)
15	player.CharacterRemoving:Connect(function ()
16		onCharacterDespawned(player)
17	end)
18end
19
20Players.PlayerAdded:Connect(onPlayerAdded)
21

This event is only concerned with the Character of a Player. If you instead need to track when a player joins/leaves the game, use the events Players.PlayerAdded and Players.PlayerRemoving.

The Chatted event fires when a Player types a message and presses enter in Roblox's provided chat bar. This is done using some Lua bindings by the default chat script. You can prevent players from chatting by using StarterGui:SetCoreGuiEnabled() and disabling the Chat CoreGuiType.

Chat Commands

Using this event and some string manipulation functions like string.sub() and string.lower(), it is possible to create chat commands, even with arguments like player names. Usually, commands are prefixed such as heal PlayerName. To check for a prefix in a string, use string.sub() on the message to check a substring of the message: string.sub(message, 1, 6) == "/heal " (note the inclusion of the space) . Then, extract the rest of the command using string.sub() again: string.sub(message, 7) will be equal to the player name. Check if that player exists, and if so, perform the command's action (in this example, healing them). Check the code samples for examples of chat commands.

Filtering

The message text fired with this event is unfiltered. If you are displaying player input like chat to other players in any form, it must be filtered using Chat:FilterStringAsync(). Keep this in mind when creating your own chat systems; if your game does not properly filter chat it may have moderation action taken against it.

This event is usually fired two minutes after the game engine classifies the player as idle. Time is the amount of seconds since this point.

This can be used to track when a player has been idled for approximately two minutes - which can be useful for implementing away from keyboard (AFK) features into a game.

When the game engine classifies a player as idle, this event is called after two minutes. After every check, if the player is still idled, the event will continue to fire until the check reveals the player is no longer idle.

This event is used by Roblox to automatically disconnect players that have been idle for at least 20 minutes. If you would like to track when this disconnect occurs, considering using Players.PlayerRemoving alongside this event.

Fired when the TeleportState of a player changes. This event is useful for detecting whether a teleportation was successful.

What is the TeleportState?

When a teleportation request is made using TeleportService, there are a series of stages before the Player is teleported. The current stage is represented by the TeleportState value which is given by OnTeleport. See below for a practical example of this.

Fired when the Player's Player.SimulationRadius is changed.

What is the SimulationRadius?

Player.SimulationRadius determines the radius around the Player.Character in which physically simulated objects, for whom network ownership is set to automatic, are physically simulated by the Player. In cases where a BasePart or assembly is within multiple player's SimulationRadiuses, the closest player is chosen.

Player.SimulationRadius, measured in studs, starts at 10 and grows at a rate of 5% per second until it reaches Player.MaximumSimulationRadius.

Note:

• The Player.SimulationRadius can be visualized using PhysicsSettings.AreRegionsShown
• For more information on network ownership, see Network Ownership

The ClearCharacterAppearance function removes all Accessory, Shirt, Pants, CharacterMesh, and BodyColors from the given player's Player.Character. In addition, it also removes the T-Shirt Decal on the player's torso. The character's body part colors and face will remain unchanged. This method does nothing if the player does not have a Character.

Note

It does not remove t-shirts, head meshes, or faces.

The DistanceFromCharacter Player function returns the distance between the character's head and the given Vector3 point. It returns 0 if the player has no Player.Character.

This is useful when determining the distance between a player and another object or location in game.

Note

If you would like to determine the distance between two non-player instances or positions, you can use the following:

1local distance = (position1 - position2).magnitude
2

Returns a dictionary containing information describing how the Player joins the experience. The dictionary contains any of the following fields:

GetJoinData and TeleportData

If a server initiates the Player's teleport, the dictionary that this method returns includes the player's teleport data. The Player:GetJoinData() method can only be used to fetch teleport data on the server. To fetch the data on the client, use TeleportService:GetLocalPlayerTeleportData().

Unlike TeleportService:GetLocalPlayerTeleportData(), Player:GetJoinData() only provides teleport data that meets the following security criteria:

• It's guaranteed to have been sent by a Roblox server in the past 48 hours.
• It's guaranteed to have been sent with this Player.
• The SourcePlaceId and SourceGameId are guaranteed to be the place and universe the data was sent from. This means you can verify the teleport data came from an approved place.

As this data is transmitted by the client, it can still potentially be abused by an exploiter. Sensitive data such as player currency should be transmitted via a secure solution like Memory Stores.

LaunchData

Contains the string embedded in the launchData URL parameter that the user clicked to join the experience. Only available on the first join. If the user teleports to another server, the data isn't included. If you need the data after a teleport, forward it manually as teleport data. You can only include LaunchData in direct join URLs, not URLs to the experience's page.

LaunchData is a URL parameter that you can create by adding &launchData=abcd to a URL, where abcd is the data. Special characters such as spaces must be URL encoded using HttpService:UrlEncode() and are automatically decoded when the user joins the game. The decoded launch data can't exceed 200 bytes. You can store more complex data as a JSON string and decode it with HttpService:JSONDecode() on the server.

This link joins the LaunchData sample place and starts the user in room 2: https://www.roblox.com/games/start?placeId=6900305353&launchData=%7B%22roomId%22%3A%202%7D

You can also make sure that this link works for users without roblox downloaded on their mobile devices by using the AppsFlyer version of the link. The above link would look like:

ro.blox.com/Ebh5?af_dp=https%3A%2F%2Fwww.roblox.com%2Fgames%2Fstart%3FplaceId%3D6900305353%26launchData%3D%257B%2522roomId%2522%253A%25202%257D&af_web_dp=https%3A%2F%2Fwww.roblox.com%2Fgames%2Fstart%3FplaceId%3D6900305353%26launchData%3D%257B%2522roomId%2522%253A%25202%257D

To build the AppsFlyer version of the link, you need to start the URL with ro.blox.com/Ebh5? and append the af_dp and af_web_dp parameters with the URL encoded version of Link 1.

Don't store confidential information in the LaunchData because it's fully visible in the URL. Furthermore, the data might not be authentic because a user can modify the URL.

The GetMouse Player function 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.

The UserInputService service provides additional functions and events to track user input - especially for devices that do not use a mouse.

Note:

• This item must be used in a LocalScript to work as expected online.
• Following an update in July 2014, the mouse's icon can now be set with this method.

GetNetworkPing returns the engine-calculated latency of the Player in seconds. "Ping" is a measurement of the time taken for data to be sent from the client to the server, then back again. For client-side LocalScripts, this function may only be called on the LocalPlayer. This function is useful in identifying and debugging issues that occur in high-latency scenarios. It can also be used in masking latency, such as adjusting the speed of throwing animations for projectiles.

The HasAppearanceLoaded Player function returns whether or not the appearance of the player's Player.Character has loaded.

A player's 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 game, which can be tracked using the Players.PlayerAdded event.

The Kick Player method allows an experience to gracefully disconnect a client from the game and optionally provide a message to the disconnected user. This is useful for moderating abusive users. In combination with a DataStore, you can create ban lists with expiration dates. You should only allow specific whitelisted users whom you trust to trigger this method on other users.

When using this method from a LocalScript, only the local player's client can be kicked.

When calling this method on a Player with no arguments, Roblox disconnects the player from the server and provides the following message: "You were kicked from this experience: Player service requests player disconnect."

Calling this method on a user and providing a string as the first argument replaces this message with the contents of the provided string.

The Move Player function 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).

The RemoveCharacter Player function removes the player's character. It also clears the player's Backpack and PlayerGui. This is useful when you would like to temporarily remove a player's character.

To reload a players character after using this function, simply use the Player:LoadCharacter() function.

Note

• This function does not remove a player from the game. It only removes their character. To remove a player from the game, you can use the Player:Kick() function.

The SetAccountAge function sets the Player.AccountAge of the player in days.

It is used to set the Player property that describes how long ago a player's account was registered in days.

This does not set the age of the player on the account, but the age of the account itself relative to when it was first created.

The SetSuperSafeChat Player function sets whether or not the player sees chat filtered by TextService's TextService:FilterStringAsync() rather than normal chats.

SuperSafeChat is a chat mode where player's cannot see unfiltered messages.

For example, entering the following command in the command prompt would enabled SuperSafeChat for the player named polarpanda16, as long as that player is in the game:

Note

Regardless of whether a player has SuperSafeChat enabled, all chat should be filtered by TextService when broadcasted 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.

This function returns a dictionary array of online friends, limited by the maxFriends value.

In the returned array, some fields are only present for certain location types. For example, PlaceId won't be present when LocationType is 0 (Mobile Website).