PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Players

Show deprecated

Players

Show deprecated

The Players game service contains only Player objects for presently connected clients to a Roblox game server. It also contains information about a place’s configuration (such as bubble chat or classic chat). It can fetch information about players not connected to the server, such as character appearances, friends and avatar thumbnail.

Properties

bool

BubbleChat

[ReadOnly] [NotReplicated]

Indicates whether or not bubble chat is enabled. It is set with the Players/SetChatStyle method.

bool

CharacterAutoLoads

[NotReplicated]

Indicates whether Characters will respawn automatically.

bool

ClassicChat

[ReadOnly] [NotReplicated]

Indicates whether or not classic chat is enabled. This property is set by the Players/SetChatStyle method.

Instance

LocalPlayer

[ReadOnly] [NotReplicated]

The Player that the LocalScript is running for.

int

MaxPlayers

[ReadOnly] [NotReplicated]

The maximum amount of players that can be in this server.

int

MaxPlayersInternal

Players/MaxPlayers for internal use.

int

PreferredPlayers

[ReadOnly] [NotReplicated]

The preferred amount of players for this server.

int

PreferredPlayersInternal

Players/PreferredPlayers for internal use.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

void

Chat ( string message )

Makes the local player chat the given message.

Instance

CreateLocalPlayer ( )

Used by the game to create the LocalPlayer.

Instance

GetCharacterAppearanceAsync ( int64 userId )

[Yields]

Returns a Model containing the assets which the player is wearing, excluding gear.

Dictionary

GetCharacterAppearanceInfoAsync ( int64 userId )

[Yields]

Returns information about the character appearance of a given user.

Instance

GetFriendsAsync ( int64 userId )

[Yields]

Returns a FriendPages object which contains information for all of the given player’s friends.

string

GetNameFromUserIdAsync ( int64 userId )

[Yields]

Sends a query to the Roblox website for the username of an account with a given Player/UserId|user ID.

Instance

GetPlayerByUserId ( int64 userId )

Returns the Player with the given Player/UserId|UserId if they are in-game.

Instance

GetPlayerFromCharacter ( Instance character )

Returns the Player whose Player/Character|Character matches the given instance, or nil if one cannot be found.

Objects

GetPlayers ( )

Returns a table of all presently connected Player objects.

int64

GetUserIdFromNameAsync ( string userName )

[Yields]

Sends a query to the Roblox website for the Player/UserId|user ID of an account with a given username.

Tuple

GetUserThumbnailAsync ( int64 userId , ThumbnailType thumbnailType , ThumbnailSize thumbnailSize )

[Yields]

Returns the content URL of a player thumbnail given the size and type (avatar, bust, headshot), and a bool describing if the image is ready to be used.

void

ReportAbuse ( Instance player , string reason , string optionalMessage )

Attempts to report the given player for the given reason.

void

SetChatStyle ( ChatStyle style )

Sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and Chat what to do.

void

TeamChat ( string message )

Makes the LocalPlayer chat the given message, which will only be viewable by users on the same team.

void

WhisperChat ( string message , Instance player )

Delivers the given message to a recipient without anyone else seeing.

Inherited from Instance: Show Hide

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

RBXScriptSignal

PlayerAdded ( Instance player )

Fires when a player enters the game.

RBXScriptSignal

PlayerChatted ( PlayerChatType chatType , Instance player , string message , Instance targetPlayer )

Fired when a player chats.

If the chat type is a Whisper Chat, the targetPlayer is the player being whispered to.

RBXScriptSignal

PlayerConnecting ( Instance player )

Fired when a player is connecting to the game.

RBXScriptSignal

PlayerDisconnecting ( Instance player )

Fired when a player is disconnecting from the game.

RBXScriptSignal

PlayerRejoining ( Instance player )

Fired when a player rejoins a game session after having disconnected prior.

RBXScriptSignal

PlayerRemoving ( Instance player )

Fires when a player is about to leave the game.

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.