Players

A service that contains presently connected Player objects.

Memory category: Instances
Own members: 70
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties39

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byPlayers16

Property categoryBehavior

Players.BanningEnabled: boolean
Enables or disables the three Players methods (BanAsync(), UnbanAsync(), and GetBanHistoryAsync()) that constitute the ban API. This property cannot be set through developer-facing Luau and must be set in Studio through the Players properties window.
- Not scriptable
- Read capabilities: Players
Players.CharacterAutoLoads: boolean
Indicates whether characters will respawn automatically.
- Not replicated
- Read capabilities: Players
Players.UseStrafingAnimations: boolean
Determines whether R15 character models play directional strafing and backpedaling animations instead of always turning to face their direction of movement.
- Not scriptable
- Read capabilities: Players

Property categoryData

Players.BubbleChat: boolean
Indicates whether or not bubble chat is enabled. It is set with the Players:SetChatStyle() method.
- Read only
- Read capabilities: Chat + Players
- Write capabilities: Chat
Players.ClassicChat: boolean
Indicates whether or not classic chat is enabled; set by the Players:SetChatStyle() method.
- Read only
- Read capabilities: Chat + Players
- Write capabilities: Chat
Players.LocalPlayer: Player
The Player that the LocalScript is running for.
- Read only
- Read capabilities: Players
Players.MaxPlayers: number
The maximum number of players that can be in a server.
- Read only
- Read capabilities: Players
Players.MaxPlayersInternal: number
- Hidden
- Local user security
- Read capabilities: Players
Players.PreferredPlayers: number
The preferred number of players for a server.
- Read only
- Read capabilities: Players
Players.PreferredPlayersInternal: number
- Hidden
- Local user security
- Read capabilities: Players
Players.RespawnTime: number
Controls the amount of time taken for a players character to respawn.
- Read capabilities: Players
Players.ServerGitHash: string
- Hidden
- Not scriptable
- Roblox engine security
- Read capabilities: Players
Players.ServerLogPrefix: string
- Hidden
- Not scriptable
- Roblox engine security
- Read capabilities: Players
Players.NumPlayers: number
Deprecated: This item is deprecated. Instead, of using this item, you should count the number of players returned by Players:GetPlayers().
Returns the number of people in the server at the current time.
- Deprecated
- Read only
- Read capabilities: Players
Use GetPlayers instead.
Players.localPlayer: Player
Deprecated: This property is a deprecated variant of Players.LocalPlayer which should be used instead.
- Deprecated
- Hidden
- Read only
- Read capabilities: Players
Use LocalPlayer instead.
Players.numPlayers: number
Deprecated: This property is a deprecated variant of Players.NumPlayers which has also been deprecated. Neither property should be used in new work. Instead, you should count the number of players returned by Players:GetPlayers().
Returns the number of people in the server at the current time.
- Deprecated
- Hidden
- Read only
- Read capabilities: Players
Use NumPlayers instead.

Methods78

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byPlayers36

Players:BanAsync(config: { [string]: any })

Bans users from your experience, with options to specify duration, reason, whether the ban applies to the entire universe or just the current place, and more. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.

Parameters
Parameter	Description
`config: { [string]: any }`	`UserIds` (required; array) — Array of `UserIds` of players to be banned. Max size is `50`. `ApplyToUniverse` (optional; boolean) — Whether ban propagates to all places within the experience universe. Default is `true`. `Duration` (required; integer) — Duration of the ban, in seconds. Permanent bans should have a value of `-1`. `0` and all other negative values are invalid. `DisplayReason` (required; string) — The message that will be displayed to users when they attempt to and fail to join an experience. Maximum string length is `400`. `PrivateReason` (required; string) — Internal messaging that will be returned when querying the user's ban history. Maximum string length is `1000`. `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban alternate accounts. Default is `false`. `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the experience for 24 hours after the ban is applied. Default is `false`. The block can be overridden by unbanning a user via a call to `Players:UnbanAsync()`. Note that unbanning a user through any other method will not lift the device block.

Players:Chat(message: string)
Makes the local player chat the given message.
- Plugin security
- Capabilities: Players
Parameters
Parameter Description
message: string
The message chatted.

Players:CreateHumanoidModelFromDescriptionAsync(description: HumanoidDescription,rigType: Enum.HumanoidRigType,assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default,): Model

Returns a character Model equipped with everything specified in the passed in HumanoidDescription. If UseAvatarSettings is set to true, Avatar Settings in the experience will be applied to the returned model.

Parameters
Parameter	Description
`description: HumanoidDescription`	Specifies the appearance of the returned character.
`rigType: Enum.HumanoidRigType`	Specifies whether the returned character will be R6 or R15.
`assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default`	The asset type verification mode.

Returns
Type	Description
`Model`	A `Humanoid` character `Model`.

Players:CreateHumanoidModelFromUserIdAsync(userId: User): Model
Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
- Yields
- Capabilities: Players
Parameters
Parameter Description
userId: User
The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
Returns
Type Description
Model
A Humanoid character Model.
Players:CreateLocalPlayer(): Player
- Local user security
- Capabilities: Players
Returns
Type
Player
Players:CreateThumbnailPlayer(): Player
- Roblox script security
- Capabilities: Players
Returns
Type
Player
Players:GetBanHistoryAsync(userId: User): BanHistoryPages
Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.
- Yields
- Capabilities: Consequences + Players
Parameters
Parameter Description
userId: User
The Player.UserId of the player whose ban history to retrieve.
Returns
Type Description
BanHistoryPages
See BanHistoryPages for return reference.
Players:GetCharacterAppearanceInfoAsync(userId: User): { [string]: any }
Returns information about the character appearance of a given user.
- Yields
- Capabilities: Players
Parameters
Parameter Description
userId: User
The *userId of the specified player.
Returns
Type Description
{ [string]: any }
A dictionary containing information about the character appearance of a given user.
Players:GetFriendsAsync(userId: User): FriendPages
Returns a FriendPages object which contains information for all of the given player's friends.
- Yields
- Capabilities: Players + Social
Parameters
Parameter Description
userId: User
The user ID of the player being specified.
Returns
Type Description
FriendPages
A FriendPages object containing information for all of the given user's friends.
Players:GetHumanoidDescriptionFromOutfitIdAsync(outfitId: number): HumanoidDescription
Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
- Yields
- Capabilities: AvatarAppearance + Players
Parameters
Parameter Description
outfitId: number
The ID of the outfit for which the HumanoidDescription is sought.
Returns
Type Description
HumanoidDescription
HumanoidDescription initialized with the specification for the passed in outfitId.
Players:GetHumanoidDescriptionFromUserIdAsync(userId: User): HumanoidDescription
Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
- Yields
- Capabilities: AvatarAppearance + Players
Parameters
Parameter Description
userId: User
The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
Returns
Type Description
HumanoidDescription
HumanoidDescription initialized with the passed in user's avatar specification.
Players:GetNameFromUserIdAsync(userId: User): string
Sends a query to the Roblox website for the username of an account with a given UserId.
- Yields
- Capabilities: Players
Parameters
Parameter Description
userId: User
The Player.UserId of the player being specified.
Returns
Type Description
string
The name of a user with the specified Player.UserId.
Players:GetPlayerByUserId(userId: User): Player
Returns the Player with the given UserId if they are in-experience.
- Thread safe
- Capabilities: Players
Parameters
Parameter Description
userId: User
The Player.UserId of the player being specified.
Returns
Type Description
Player
The Player with the given Player.UserId, or nil if no connected player has that UserId.
Players:GetPlayerFromCharacter(character: Model): Player
Returns the Player whose Player.Character matches the given instance, or nil if one cannot be found.
- Capabilities: Players
- Simulation access
Parameters
Parameter Description
character: Model
A character instance that you want to get the player from.
Returns
Type Description
Player
The Player whose Player.Character matches the given model, or nil if one cannot be found.
Players:GetPlayers(): { Instance }
Returns a table of all presently connected Player objects.
- Thread safe
- Capabilities: Players
Returns
Type Description
{ Instance }
A table containing all the players in the server.
Players:GetProfileConfigurationFromUserIdAsync(userId: User): { [string]: any }
Returns the profile configuration of a user as a dictionary.
- Yields
- Capabilities: AvatarAppearance + Players
Parameters
Parameter Description
userId: User
The Player.UserId of the user whose profile configuration to retrieve.
Returns
Type Description
{ [string]: any }
A dictionary containing the user's profile configuration, such as the background asset ID.
Players:GetUserIdFromNameAsync(userName: string): number
Sends a query to the Roblox website for the userId of an account with a given username.
- Yields
- Capabilities: Players
Parameters
Parameter Description
userName: string
The username of the player being specified.
Returns
Type Description
number
The Player.UserId of a user whose name is specified.

Players:GetUserThumbnailAsync(userId: User,thumbnailType: Enum.ThumbnailType,thumbnailSize: Enum.ThumbnailSize,): ...any

Returns the content URL of a player thumbnail given the size and type, as well as a boolean describing if the image is ready to use.

Parameters
Parameter	Description
`userId: User`	The `Player.UserId` of the player being specified.
`thumbnailType: Enum.ThumbnailType`	A `ThumbnailType` describing the type of thumbnail.
`thumbnailSize: Enum.ThumbnailSize`	A `ThumbnailSize` specifying the size of the thumbnail.

Returns
Type	Description
`...any`	A tuple containing the content URL of a user thumbnail based on the specified parameters, and a bool describing if the image is ready to be used or not.

Players:ReportAbuse(player: Player, reason: string, optionalMessage: string)
- Local user security
- Capabilities: Players
Parameters
Parameter
player: Player
reason: string
optionalMessage: string
Players:ReportAbuseV3(player: Player, jsonTags: string)
- Roblox script security
- Capabilities: Players
Parameters
Parameter
player: Player
jsonTags: string
Players:ReportAvatarAbuse(targetUserId: number, tags: { [string]: any })
- Roblox script security
- Capabilities: Players
Parameters
Parameter
targetUserId: number
tags: { [string]: any }
Players:ReportChatAbuse(eligibleChatLines: { any },targetChatLines: { any },tags: { [string]: any },)
- Roblox script security
- Capabilities: Players
Parameters
Parameter
eligibleChatLines: { any }
targetChatLines: { any }
tags: { [string]: any }
Players:ResetLocalPlayer()
- Local user security
- Capabilities: Players
Players:SetChatStyle(style: Enum.ChatStyle? = Enum.ChatStyle.Classic)
Sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and Chat what to do.
- Plugin security
- Capabilities: Players
Parameters
Parameter Description
style: Enum.ChatStyle? = Enum.ChatStyle.Classic
The specified chat style being set.

Players:SetLocalPlayerInfo(userId: number,userName: string,displayName: string,membershipType: Enum.MembershipType,isUnder13: boolean,hasRobloxSubscription: boolean? = false,ageCheckedStatus: Enum.AgeCheckStatus? = Enum.AgeCheckStatus.Unchecked,)

Parameters
Parameter
`userId: number`
`userName: string`
`displayName: string`
`membershipType: Enum.MembershipType`
`isUnder13: boolean`
`hasRobloxSubscription: boolean? = false`
`ageCheckedStatus: Enum.AgeCheckStatus? = Enum.AgeCheckStatus.Unchecked`

Players:TeamChat(message: string)
Makes the local player chat the given message, which will only be viewable by users on the same team.
- Plugin security
- Capabilities: Players
Parameters
Parameter Description
message: string
The message being chatted.

Players:UnbanAsync(config: { [string]: any })

Unbans players banned from Players:BanAsync() or the User Restrictions Open Cloud API. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.

Parameters
Parameter	Description
`config: { [string]: any }`	Name Type Description `UserIds` array UserIDs to be force allowed into the experience(s). Max size is `50`. `ApplyToUniverse` boolean Propagates the unban to all places within this universe.

Players:WhisperChat(message: string, player: Instance)
- Local user security
- Capabilities: Players
Parameters
Parameter
message: string
player: Instance

Players:CreateHumanoidModelFromDescription(description: HumanoidDescription,rigType: Enum.HumanoidRigType,assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default,): Model

Deprecated: This method has been superseded by CreateHumanoidModelFromDescriptionAsync().
Returns a character Model equipped with everything specified in the passed in HumanoidDescription.

Parameters
Parameter	Description
`description: HumanoidDescription`	Specifies the appearance of the returned character.
`rigType: Enum.HumanoidRigType`	Specifies whether the returned character will be R6 or R15.
`assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default`	The asset type verification mode.

Returns
Type	Description
`Model`	A `Humanoid` character `Model`.

Use CreateHumanoidModelFromDescriptionAsync instead.

Players:CreateHumanoidModelFromUserId(userId: User): Model
Deprecated: This method has been superseded by CreateHumanoidModelFromUserIdAsync().
Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
- Deprecated
- Yields
- Capabilities: Players
Parameters
Parameter Description
userId: User
The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
Returns
Type Description
Model
A Humanoid character Model.
Use CreateHumanoidModelFromUserIdAsync instead.
Players:GetCharacterAppearanceAsync(userId: User): Model
Deprecated: This method is deprecated. Do not use it for new work.
Returns a Model containing the assets which the player is wearing, excluding gear.
- Deprecated
- Yields
- Capabilities: Players
Parameters
Parameter Description
userId: User
The Player.UserId of the specified player.
Returns
Type Description
Model
A Model containing the assets the player is wearing, excluding gear.
Players:GetHumanoidDescriptionFromOutfitId(outfitId: number): HumanoidDescription
Deprecated: This method has been superseded by GetHumanoidDescriptionFromOutfitIdAsync().
Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
- Deprecated
- Yields
- Capabilities: AvatarAppearance + Players
Parameters
Parameter Description
outfitId: number
The ID of the outfit for which the HumanoidDescription is sought.
Returns
Type Description
HumanoidDescription
HumanoidDescription initialized with the specification for the passed in outfitId.
Use GetHumanoidDescriptionFromOutfitIdAsync instead.
Players:GetHumanoidDescriptionFromUserId(userId: User): HumanoidDescription
Deprecated: This method has been superseded by GetHumanoidDescriptionFromUserIdAsync().
Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
- Deprecated
- Yields
- Capabilities: AvatarAppearance + Players
Parameters
Parameter Description
userId: User
The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
Returns
Type Description
HumanoidDescription
HumanoidDescription initialized with the passed in user's avatar specification.
Use GetHumanoidDescriptionFromUserIdAsync instead.
Players:getPlayers(): { Instance }
Deprecated: This function is a deprecated variant of Players:GetPlayers() which should be used instead.
- Deprecated
- Capabilities: Players
Returns
Type
{ Instance }
Use GetPlayers instead.
Players:playerFromCharacter(character: Model): Player
Deprecated: This function is a deprecated variant of Players:GetPlayerFromCharacter() which should be used in new work.
- Deprecated
- Capabilities: Players
Parameters
Parameter
character: Model
Returns
Type
Player
Use GetPlayerFromCharacter instead.
Players:players(): { Instance }
Deprecated: This item has been superseded by Players:GetPlayers() which should be used in all new work.
Returns a list of players in an experience.
- Deprecated
- Capabilities: Players
Returns
Type
{ Instance }
Use GetPlayers instead.

Events28

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byPlayers18

Players.CloudEditApplyEditsMessage: RBXScriptSignal<(playerName: string,scriptName: string,)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
playerName: string
scriptName: string
Players.FriendRequestEvent: RBXScriptSignal<(player: Player,player: Player,friendRequestEvent: Enum.FriendRequestEvent,)>
- Roblox script security
- Capabilities: Players
Parameters
Parameter
player: Player
player: Player
friendRequestEvent: Enum.FriendRequestEvent
Players.PlayerAdded: RBXScriptSignal<(player: Player)>
Fires when a player enters the experience.
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PlayerChatted: RBXScriptSignal<(chatType: Enum.PlayerChatType,player: Player,message: string,targetPlayer: Player,)>
- Local user security
- Capabilities: Players
Parameters
Parameter
chatType: Enum.PlayerChatType
player: Player
message: string
targetPlayer: Player
Players.PlayerConnecting: RBXScriptSignal<(player: Player)>
- Local user security
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PlayerDisconnecting: RBXScriptSignal<(player: Player)>
- Local user security
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PlayerMembershipChanged: RBXScriptSignal<(player: Player)>
Fires when the experience server recognizes that a player's membership has changed.
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PlayerRejoining: RBXScriptSignal<(player: Player)>
- Local user security
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PlayerRemoving: RBXScriptSignal<(player: Player,reason: Enum.PlayerExitReason,)>
Fires when a player is about to leave the experience.
- Capabilities: Players
Parameters
Parameter
player: Player
reason: Enum.PlayerExitReason
Players.PromptAgeCheckRequested: RBXScriptSignal<(player: Player)>
- Roblox script security
- Capabilities: Players
Parameters
Parameter
player: Player
Players.PromptGameServerAvatarReportEnrichment: RBXScriptSignal<(reportId: string,targetUserId: number,)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
reportId: string
targetUserId: number
Players.PromptGameServerReportEnrichment: RBXScriptSignal<(reportId: string)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
reportId: string
Players.PromptGameServerTargetedChatReportEnrichment: RBXScriptSignal<(reportId: string,eligibleChatLines: { any },targetChatLines: { any },)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
reportId: string
eligibleChatLines: { any }
targetChatLines: { any }
Players.PromptReportServerEnrichmentAndScan: RBXScriptSignal<(v1comment: string,submitterId: number,abuserId: number,reportId: string,)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
v1comment: string
submitterId: number
abuserId: number
reportId: string
Players.RequestCloudEditKick: RBXScriptSignal<(playerId: number)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
playerId: number
Players.RequestCloudEditShutdown: RBXScriptSignal<()>
- Hidden
- Roblox engine security
- Capabilities: Players
Players.TeamCreateServerMessage: RBXScriptSignal<(messageType: Enum.MessageType,message: string,printToStatusBar: boolean,)>
- Hidden
- Roblox engine security
- Capabilities: Players
Parameters
Parameter
messageType: Enum.MessageType
message: string
printToStatusBar: boolean
Players.UserSubscriptionStatusChanged: RBXScriptSignal<(user: Player,subscriptionId: string,)>
Fires when the experience server recognizes that the user's status for a certain subscription has changed.
- Capabilities: Monetization + Players
Parameters
Parameter
user: Player
subscriptionId: string