RBX.lua.Players (Object)

< Class Reference

This is a Game Service; it cannot be created with Instance.new - it must be obtained using the GetService method, or as a child of game.

Derived Classes

None

Players (extends Instance)

• Chat
• CreateLocalPlayer
• GetPlayerByID
• GetPlayerFromCharacter
• GetPlayers
• ReportAbuse
• SetAbuseReport
• SetBuildUserPermissionsUrl
• SetChatFilterUrl
• SetChatStyle
• SetSysStatsUrl
• SetLoadDataUrl
• SetSaveDataUrl
• AddLeaderboardKey
• TeamChat
• WhisperChat
• Clone
• FindFirstChild
• GetChildren
• GetDebugId
• GetFullName
• IsA
• IsAncestorOf
• IsDescendantOf
• Destroy
• ClearAllChildren

• BubbleChat
• ClassicChat
• LocalPlayer
• MaxPlayers
• NumPlayers
• Name
• Parent
• Archivable
• ClassName
• RobloxLocked
• DataCost

• PlayerAdded
• PlayerRemoving
• AncestryChanged
• Changed
• ChildAdded
• ChildRemoved
• DescendantAdded
• DescendantRemoving

The Players service is a container object that holds all of the Player objects in the game. You can use the events to watch for new players connected to the server or leaving the server, as well as keep an eye on the number of players.

There are two Chat methods:

Chat( Instance partOrCharacter, string message, ChatColor color = Blue )
Returns	nil
Description:	Makes partOrCharacter have a dialog-like billboard containing message in the color tone.
Member of:	Chat

Chat( string message )
Returns	nil
Description:	Makes the local player chat the message message.
Member of:	Players

CreateLocalPlayer( int userId )
Returns	Player
Description:	Used by the game to create the LocalPlayer.
Member of:	Players

GetPlayerByID( int userID )
Returns	Instance requestedPlayer
Description:	Returns the player with the given userId.
Member of:	Players

GetPlayerFromCharacter( Instance character )
Returns	Player object which is controlling the character
Description:	Gives you the player from that player's character. Useful for traps and where you only know which character is, not the player.
Member of:	Players

GetPlayers( )
Returns	table
Description:	Returns a table containing all the players in the server.
Member of:	Players

ReportAbuse( Player player, string reason, string optionalMessage )
Returns	nil
Description:	Used to report a player for inappropriate behavior.
Member of:	Players

SetAbuseReport( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetBuildUserPermissionsUrl( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetChatFilterUrl( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetChatStyle( ChatStyle ChatStyle )
Returns	nil
Description:	This sets BubbleChat and ClassicChat and tells TeamChat and Chat what to do.
Member of:	Players

SetSysStatsUrl( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetLoadDataUrl( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

SetSaveDataUrl( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

AddLeaderboardKey( )
Returns	Undocumented
Description:	Undocumented
Member of:	Undocumented

TeamChat( string message )
Returns	nil
Description:	When the Chat Bar picks up that you started your chat with a '%', it will call TeamChat rather than Chat.
Member of:	Players

WhisperChat( String message, Instance player )
Returns	nil
Description:	Whispers message to player without anyone else seeing.
Member of:	Players

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetDebugId( int scopeLength )
Returns	string
Description:	Returns a coded string of the object's DebugId used internally by Roblox.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Destroy( )
Returns	nil
Description:	Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of:	Instance

ClearAllChildren( )
Returns	nil
Description:	Removes all descendants of the Instance, but leaves the Instance itself.
Member of:	Instance

BubbleChat
Property	Boolean
Description	If Bubble Chat is enabled or not. It is set with SetChatStyle.
Member of	Players

ClassicChat
Property	Boolean
Description	If Classic Chat is enabled or not. It is set with SetChatStyle.
Member of	Players

LocalPlayer
Property	Player LocalPlayer
Description	The Player object for the client.
Member of	Players

MaxPlayers
Type	int
Description	The maximum amount of players allowed in a server.
Member of	Players

NumPlayers
Property	int NumPlayers
Description	The number of people in the server at the current time.
Member of	Players

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

RobloxLocked
Type	bool
Description	If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of	Instance

DataCost
Type	int
Description	How much saving this instance with SaveInstance will add to DataComplexity
Member of	Instance

PlayerAdded ( Player player )
Description	Fired after a player enters the game.
Member of:	Players

PlayerRemoving ( Player player )
Description	Fires when a player is leaving the game.
Member of:	Players

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance