Properties
bool
[ReadOnly]
[NotReplicated]
|
Indicates whether or not bubble chat is enabled. It is set with the |
bool
[NotReplicated]
|
Indicates whether |
bool
[ReadOnly]
[NotReplicated]
|
Indicates whether or not classic chat is enabled; set by the |
Player
[ReadOnly]
[NotReplicated]
|
The |
int
[ReadOnly]
[NotReplicated]
|
The maximum amount of players that can be in this server. |
int
[Hidden]
|
|
int
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Returns the number of people in the server at the current time |
int
[ReadOnly]
[NotReplicated]
|
The preferred amount of players for this server. |
int
[Hidden]
|
|
float
|
Controls the amount of time taken for a players character to respawn |
Player
[Hidden]
[ReadOnly]
[NotReplicated]
[Deprecated]
|
int
[Hidden]
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Returns the number of people in the server at the current time |
bool
|
Determines if an |
string
[ReadOnly]
[NotReplicated]
|
A read-only string representing the class this |
int
[Hidden]
[ReadOnly]
[NotReplicated]
[Deprecated]
|
The cost of saving the instance using data persistence. |
string
|
A non-unique identifier of the |
Instance
[NotReplicated]
|
Determines the hierarchical parent of the |
bool
[Hidden]
|
A deprecated property that used to protect |
int64
[Hidden]
[NotReplicated]
|
bool
[Hidden]
[NotReplicated]
[Deprecated]
|
string
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Functions
void
|
Makes the local player chat the given message. |
Model
[Yields]
|
Model
[Yields]
|
Player
|
Manually trigger creating |
Model
[Yields]
[Deprecated]
|
Returns a |
Dictionary
[Yields]
|
Returns information about the character appearance of a given user |
FriendPages
[Yields]
|
Returns a |
HumanoidDescription
[Yields]
|
HumanoidDescription
[Yields]
|
string
[Yields]
|
Sends a query to the Roblox website for the username of an account with a given |
Player
|
Returns the |
Player
|
Returns the |
Objects
|
Returns a table of all presently connected |
int64
[Yields]
|
Sends a query to the Roblox website for the |
Tuple
[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
|
Attempts to report the given player for the given reason |
void
|
Sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and |
void
|
void
|
Makes the |
void
|
Delivers the given message to a recipient without anyone else seeing |
Objects
[Deprecated]
|
Player
[Deprecated]
|
. |
Objects
[Deprecated]
|
Returns a list of players in a game |
void
|
This function destroys all of an |
Instance
|
Create a copy of an object and all its descendants, ignoring objects that are not |
void
|
Sets the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first descendant found with the given |
Actor
|
Returns the Actor associated with the Instance, usually the first Actor ancestor |
Variant
|
Returns the attribute which has been assigned to the given name |
RBXScriptSignal
|
Returns an event that fires when the given attribute changes |
Dictionary
|
Returns a dictionary of string → variant pairs for each of the |
Objects
|
Returns an array containing all of the |
string
[NotBrowsable]
|
Returns a coded string of the |
Array
[CustomLuaState]
|
Returns an array containing all of the descendants of the instance |
string
|
Returns a string describing the |
RBXScriptSignal
|
Get an event that fires when a given property of an object changes. |
bool
[CustomLuaState]
|
Returns true if an |
bool
|
Returns true if an |
bool
|
Returns true if an |
void
[Deprecated]
|
Sets the object’s Parent to nil, and does the same for all its descendants. |
void
|
Sets the attribute with the given name to the given value |
Instance
[CustomLuaState]
[CanYield]
|
Returns the child of the |
Objects
[Deprecated]
|
Returns an array of the object’s children. |
Instance
[Deprecated]
|
void
[Deprecated]
|
Instance
[Deprecated]
|
Objects
[Deprecated]
|
bool
[Deprecated]
[CustomLuaState]
|
bool
[Deprecated]
|
void
[Deprecated]
|
Events
RBXScriptSignal
|
RBXScriptSignal
|
RBXScriptSignal
|
Fires when a player enters the game. |
RBXScriptSignal
|
Fired when a player chats. |
RBXScriptSignal
|
Fired when a player is connecting to the game. |
RBXScriptSignal
|
Fired when a player is disconnecting from the game. |
RBXScriptSignal
|
Fires when the game server recognizes that a player’s membership has changed |
RBXScriptSignal
|
Fired when a player rejoins a game session after having disconnected prior. |
RBXScriptSignal
|
Fires when a player is about to leave the game. |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires whenever an attribute is changed on the |
RBXScriptSignal
|
Fired immediately after a property of an object changes. |
RBXScriptSignal
|
Fires after an object is parented to this |
RBXScriptSignal
|
Fires after a child is removed from this |
RBXScriptSignal
|
Fires after a descendant is added to the |
RBXScriptSignal
|
Fires immediately before a descendant of the |
RBXScriptSignal
|
Fires immediately before the instance is destroyed via |
RBXScriptSignal
[Deprecated]
|
Code Samples
Give Sparkles to Everyone
This code sample listens for players spawning and gives them Sparkles in their head. It does this by defining two functions, onPlayerSpawned
and onPlayerAdded
. It calls these functions for players/characters already in the game, in case the script runs after players already arrive.