This code sample demonstrates the creation of leaderboard stat values in
Roblox's default player list UI. It creates a "Score" leaderstat that starts
at 0.


This code sample demonstrates the usage of `Class.Players.PlayerAdded`,
`Class.Player.CharacterAdded` and `Class.Player.CharacterRemoving` in order to
detect the spawning and despawning of players' characters. You can use this as
a boilerplate script to make changes to players' characters as they spawn,
such as changing `Class.Humanoid.WalkSpeed`.


This code sample will cause players to respawn at the same place they died. It
does this by keeping track of where the player despawned using
`Class.Player.CharacterRemoving`. Note that the player's location is saved
on-despawn, not on-death. This can be problematic if the player falls off a
ledge and dies due to `Class.Workspace.FallenPartsDestroyHeight` - their
respawn position won't be saved in this case.

It's also important to note the need to "forget" the location of players who
leave the game. We use `Class.Instance.ChildRemoved` on `Players` instead of
`Class.Players.PlayerRemoving`. This is because PlayerRemoving fires before
CharacterRemoving - and we need to make sure we don't forget the player's
respawn location then immediately remember a new one (this is a memory leak;
potentially many players could visit, respawn and leave). So, we use
ChildRemoved on Players so the event fires after the character is removed.


This code sample automatically removes `Accessory` objects like hats from the
`Player`'s character when they respawn. Warning: this includes hair, so this
script may cause acute baldness.

When the `Class.Player.Character|Character()` is
`Class.Player.CharacterAdded|added`, we wait for `Class.RunService.Stepped` to
fire once (using the `wait` function of events). This is so the accessory
removal logic runs one frame after the character spawns. A warning can appear
if you delete accessories too quickly after the player spawns, so waiting one
frame will avoid that.


Player.CharacterAdded

character

This code sample will wait for accessories to fully load, print out
how many there are, and then destroy them all.


Player.CharacterAppearanceLoaded

This example prints the name of the character being removed, followed by "has
died".

For instance, if Shedletsky's character was to die in-game, "Shedletsky has
died." would be printed.


Player.CharacterRemoving

Setting chatted for all players. There is an easy way to make the Chatted
event registered on all players. Simply use the `Class.Players.PlayerAdded`
event in combination with this event.


This code sample, although lengthy, is quite simple: detect when a player
chats /play, then put them on the "Playing" team. When they die, move them
back to the "Spectating" team.


This code sample allows any player to chat "/jointeam <name>" where <name> is
the name of a team. It uses string manipulation using string.sub and
string.lower to make the command case-insensitive and allow for partial
matches. For example, "/jointeam red" will match the team "Red Robins".


Player.Chatted

message

recipient

This example will print how long a player, named Player, has been idle for.


Player.Idled

time

This example prints which stage of a teleport a player is at, as well as
printing if the teleport was a failure.


Player.OnTeleport

teleportState

placeId

spawnName

Player:ClearCharacterAppearance

This example demonstrates how to measure the distance between a player's
`Class.Player.Character` and another location.

This code will print the distance of each player's character from the origin
(0, 0, 0):


Player:DistanceFromCharacter

point

The following example tracks sources of traffic for analytics. By creating
URLs with unique launch data for each social platform, you can determine the
most popular traffic sources. The sample checks the source against a list of
possible samples and discards any invalid sources because users can modify the
launch data.


The following example generates a URL with the user's ID used as launch data.
It then displays the URL in a read-only text box that makes it easy for the
user to copy and share the link with their friends. When a user joins the game
using a referral link, you can use the launch data to reward the referrer.


The following example is a function that converts a table into a string you
can use as launch data. The provided data is JSON encoded, checked for valid
character length, and escaped with percent signs.


The following example attempts to decode launch data, using `pcall` to prevent
an error in case the data is corrupt.


The following code sample is an example of how teleport data can be retrieved
on the server using `Class.Player:GetJoinData()`. This code, when ran in a
`Script` in `ServerScriptService`, will listen for new `Player|Players`
joining the game. When they join it will retrieve their teleport data
(verifying it came from a valid place) to find their current level.


Player:GetJoinData

The below example will print:

> Button 1 is down

whenever the `Class.Players.LocalPlayer` left clicks.


Player:GetMouse

Player:GetNetworkPing

This example prints the result of `Class.Player:HasAppearanceLoaded()` after a
player joins the game until the player's appearance has loaded.


Player:HasAppearanceLoaded

The following example prints "true" if the player is verified.


Player:IsVerified

Player:Kick

Player:LoadBoolean

This script gives any Hat/Gear/Face/Body Part to a player once they chat the
URL of the asset.


Player:LoadCharacterAppearance

assetInstance

The below example would reparent the saved instance to Workspace.


Player:LoadInstance

The below would print the value of the player's TotalPlays.


Player:LoadNumber

The below example would print the value of the previously saved key
"TheirName".


Player:LoadString

The following example would cause the LocalPlayer to walk forward, towards
where their camera is pointing.


Player:Move

walkDirection

relativeToCamera

The below example would save a boolean to the player with a key of "HasPlayed"
and a value of true.


Player:SaveBoolean

value

The below code will save 'Model', a descendant of Workspace, to the player
each time they join the game. To access this instance again, we would need to
index it by it's key, 'Model', as defined in the first argument of this
method.


Player:SaveInstance

The below example would save a number to the player with a key of "TotalPlays"
and add one to the value each time.


Player:SaveNumber

The below example would save a string to the player with a key of "TheirName"
and a value of their current name. If you printed it, it would print their
name.


Player:SaveString

This example demonstrates how the `Class.Player:SetAccountAge()` function
would be used if it was accessible. It sets the local player's account age to
100 days.


This code sample adds a mark to players showing about how old their account
is. The mark uses a player's account age to determine if they are a New
Player, Veteran Player or Regular Player.


Player:SetAccountAge

accountAge

Player:SetSuperSafeChat

Player:loadBoolean

Player:loadInstance

Player:loadNumber

Player:loadString

Player:saveBoolean

Player:saveInstance

Player:saveNumber

Player:saveString

This example demonstrates how to get a dictionary of a player's online
friends. It returns the maximum number of friends specified by the argument,
or 200 if an argument is not provided.


Player:GetFriendsOnline

maxFriends

The code below will check if a player that has entered the game has a rank
equal to 255, in a group with an ID of 2. If they are, it will print "Player
is the owner of the group, 'LOL'!", otherwise "Player is NOT the owner of the
group, 'LOL'!" will be printed to the output.


Player:GetRankInGroup

groupId

The code below will print the name of the rank that the player is currently a
part of, in a specific group. In this instance we're checking what rank the
player is within a group which has a group ID of 2.


Player:GetRoleInGroup

Player:IsBestFriendsWith

userId

The below example would print whether or not a recently added player is
friends with Gordonrox24.


Player:IsFriendsWith

The below example will print "Player is in the Roblox Fan club!" if the newly
added player is in the group with a groupId of 7.


Player:IsInGroup

This script turns off auto-loading and simulates character respawning.


Player:LoadCharacter

To create a `HumanoidDescription` and then spawn a character with that
description applied, add a `Script` (not a `LocalScript`) to the workspace and
add this code to it.


Player:LoadCharacterWithHumanoidDescription

humanoidDescription

Player:RequestStreamAroundAsync

position

timeOut

Player:WaitForDataReady

Player:isFriendsWith

Player:waitForDataReady

Player

Player.AccountAge

This code sample is meant for a TextButton. It allows the player to toggle the
auto-jumping behavior while on a mobile device.


Player.AutoJumpEnabled

​The example demonstrates how to set a player's camera minimum and maximum
zoom distance.

In this example, we set the `Class.Player.CameraMinZoomDistance` and
`Class.Player.CameraMaxZoomDistance` to set the min and max distance in studs
a player's camera can be from their character.

Note that since the example attempts to set the CameraMinZoomDistance to be
greater than the CameraMaxZoomDistance, the CameraMinZoomDistance value will
be decreased and set to the value of the max zoom distance.

To change the default min and max zoom distance values for a player when they
first enter the game, you can change the
`StarterClass.Player.CameraMinZoomDistance` and
`StarterClass.Player.CameraMaxZoomDistance` properties.


Player.CameraMaxZoomDistance

Player.CameraMinZoomDistance

This example demonstrates how to change the character's CameraMode to first
person using the LockFirstPerson value of the `Enum.CameraMode` enum.


This example demonstrates how to change the character's CameraMode to third
person using the Classic value of the `Enum.CameraMode` enum.


Player.CameraMode

This example demonstrates how to disable loading a player's character
appearance. Instead, the player loads as a grey model without any hats,
shirts, pants, etc.

This is useful for games using custom clothing and accessories.

Note that if the character has already spawned, this change will not take affect
until the player respawns or the `Class.Player:LoadCharacter()` function is
called.


Player.CanLoadCharacterAppearance

Player.Character

Player.CharacterAppearance

This code sample allows players to chat "/disguise xyz", where xyz is a user
ID or username, and they will respawn appearing like that account's avatar.
Try typing "/disguise 261" or "/disguise Shedletsky"!


Player.CharacterAppearanceId

Player.DataComplexity

Player.DataReady

Player.DevCameraOcclusionMode

The example demonstrates how to set a player's camera movement mode for
players on a computer.

In this example, we set the camera movement mode to Classic via the
`Enum.DevComputerCameraMovementMode` enum. This means that the camera of
players on touch enabled devices will track the player but will not
automatically rotate if the player walks left or right.


Player.DevComputerCameraMode

The example demonstrates how to set the movement mode for players on
computers.

In this example, we set the movement mode to KeyboardMouse via the
`Enum.DevComputerMovementMode` enum. This means that players on computers can
control their characters using their keyboard and mouse.


Player.DevComputerMovementMode

This code sample demonstrates how to toggle whether mouse lock is available to
a player using a chat command. When a player types "mouselock", their ability
to toggle mouse lock is toggled. Note that this does **not** toggle the actual
state of mouse lock; rather, it changes whether a player is **able** to toggle
it themselves.

This code can be run by pasting it into a `Script` within
`ServerScriptService`.


Player.DevEnableMouseLock

The example demonstrates how to set a player's camera movement mode.

In this example, we set the camera movement mode to Classic via the
`Enum.DevTouchCameraMovementMode` enum. This means that the camera of players
on touch enabled devices will track the player but will not automatically
rotate if the player walks left or right.


Player.DevTouchCameraMode

The example demonstrates how to set the movement mode for players on touch
enabled devices.

In this example, we set the movement mode to Thumbstick via the
`Enum.DevTouchMovementMode` enum. This means that players on touch enabled
devices are able to move via a virtual thumbstick on their screen.


Player.DevTouchMovementMode

Player.DisplayName

This code sample alerts players if a new player follows the local player into
the game. It does so using a `Hint`. Place this in a `LocalScript` in
`StarterPlayerScripts`.


Player.FollowUserId

Player.GameplayPaused

Player.HasVerifiedBadge

This example demonstrates how to hide other `Humanoid`'s (`Player` and NPC)
health bars and names.

This is done by setting the player's `Class.Player.HealthDisplayDistance` and
`Class.Player.NameDisplayDistance` properties to 0.

If you would like to display health bars and names, you set the properties to
a value greater than 0. For instance, setting the properties to 100 means that
the player will see other player's health and names up to 100 studs away.

To modify the default values for players, you can change the values of the
`StarterClass.Player.HealthDisplayDistance` and
`StarterClass.Player.NameDisplayDistance` properties.


Player.HealthDisplayDistance

This example demonstrates how to check the locale of a local player using the
`Class.Player.LocaleId` property. It prints a string with the two letter
locale code for the locale of the local player.

For instance, if the player's local is within the US, the locale will be:

> en-us


Player.LocaleId

The following example checks whether a player has [Premium](https://www.roblox.com/premium/membership) membership.


Player.MembershipType

Player.NameDisplayDistance

This example checks if a player is neutral. If the player is neutral, the game
prints:

> Player is neutral!

If the player is neutral, the game prints:

> Player is not neutral!

_Note:_ Although this example prints the value of the local player's neutral
property, you can change the example to get the value for any player.


Player.Neutral

This example creates a new `BasePart` and sets the `Player`'s
`Class.Player.ReplicationFocus` to that part.

This demonstrates the functionality of the ReplicationFocus property. You can
easily change the part that the focus is set to to change the replication
focus.


Player.ReplicationFocus

This code sample will set the player to always respawn from the last
SpawnLocation they touched. New players will respawn from the SpawnLocation
named 'FirstSpawn' until they touch a different SpawnLocation.

This is an alternative to using the AllowTeamChangeOnTouch property to switch
SpawnLocations and does not require Teams.


Player.RespawnLocation

Player.Team

Player.TeamColor

The below example would print the UserId of every user who entered a game.


The following code sample gives an example of a 'met the creator' badge
system. This script will award a specified badge (BADGE_ID) to anyone who is
in a server at the same time as the user associated with OWNER_ID.


This code sample retrieves a player's saved gold from a data store and puts
the returned value onto the leaderboard. Note that this sample does not save
players' gold&nbsp;&mdash; it only loads it.


Player.UserId

Player.userId

The below example would print "Part is now a child of Model".


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

This code first references an existing object in the `original` variable.
Then, it makes a copy of the object, sets the parent to that of the original,
and finally moves the copy to (0, 50, 0).


Instance:Clone

Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".
