# Players

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/Players/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Players

A service that contains presently connected [`Player`](https://rapi.sleaze.dev/classes/Player.md) objects.

## Properties

### BanningEnabled

```luau
Players.BanningEnabled: boolean
```

- Tags: Not scriptable, Read capabilities: Players

Enables or disables the three [`Players`](https://rapi.sleaze.dev/classes/Players.md) methods ([`BanAsync()`](https://rapi.sleaze.dev/classes/Players.md), [`UnbanAsync()`](https://rapi.sleaze.dev/classes/Players.md), and [`GetBanHistoryAsync()`](https://rapi.sleaze.dev/classes/Players.md)) 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.

### CharacterAutoLoads

```luau
Players.CharacterAutoLoads: boolean
```

- Tags: Not replicated, Read capabilities: Players

Indicates whether `characters` will respawn automatically.

### UseStrafingAnimations

```luau
Players.UseStrafingAnimations: boolean
```

- Tags: Not scriptable, Read capabilities: Players

Determines whether R15 character models play directional strafing and backpedaling animations instead of always turning to face their direction of movement.

### BubbleChat

```luau
Players.BubbleChat: boolean
```

- Tags: Read only, Read capabilities: Chat + Players, Write capabilities: Chat

Indicates whether or not bubble chat is enabled. It is set with the [`Players:SetChatStyle()`](https://rapi.sleaze.dev/classes/Players.md) method.

### ClassicChat

```luau
Players.ClassicChat: boolean
```

- Tags: Read only, Read capabilities: Chat + Players, Write capabilities: Chat

Indicates whether or not classic chat is enabled; set by the [`Players:SetChatStyle()`](https://rapi.sleaze.dev/classes/Players.md) method.

### LocalPlayer

```luau
Players.LocalPlayer: Player
```

- Tags: Read only, Read capabilities: Players

The [`Player`](https://rapi.sleaze.dev/classes/Player.md) that the [`LocalScript`](https://rapi.sleaze.dev/classes/LocalScript.md) is running for.

### MaxPlayers

```luau
Players.MaxPlayers: number
```

- Tags: Read only, Read capabilities: Players

The maximum number of players that can be in a server.

### MaxPlayersInternal

```luau
Players.MaxPlayersInternal: number
```

- Tags: Hidden, Local user security, Read capabilities: Players

### PreferredPlayers

```luau
Players.PreferredPlayers: number
```

- Tags: Read only, Read capabilities: Players

The preferred number of players for a server.

### PreferredPlayersInternal

```luau
Players.PreferredPlayersInternal: number
```

- Tags: Hidden, Local user security, Read capabilities: Players

### RespawnTime

```luau
Players.RespawnTime: number
```

- Tags: Read capabilities: Players

Controls the amount of time taken for a players character to respawn.

### ServerGitHash

```luau
Players.ServerGitHash: string
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players

### ServerLogPrefix

```luau
Players.ServerLogPrefix: string
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players

### NumPlayers

```luau
Players.NumPlayers: number
```

- Tags: Deprecated, Read only, Read capabilities: Players
- Use instead: [`Players.GetPlayers`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This item is deprecated. Instead, of using this item, you should count the number of players returned by [`Players:GetPlayers()`](https://rapi.sleaze.dev/classes/Players.md).

Returns the number of people in the server at the current time.

### localPlayer

```luau
Players.localPlayer: Player
```

- Tags: Deprecated, Hidden, Read only, Read capabilities: Players
- Use instead: [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This property is a deprecated variant of [`Players.LocalPlayer`](https://rapi.sleaze.dev/classes/Players.md) which should be used instead.

### numPlayers

```luau
Players.numPlayers: number
```

- Tags: Deprecated, Hidden, Read only, Read capabilities: Players
- Use instead: [`Players.NumPlayers`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This property is a deprecated variant of [`Players.NumPlayers`](https://rapi.sleaze.dev/classes/Players.md) 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()`](https://rapi.sleaze.dev/classes/Players.md).

Returns the number of people in the server at the current time.

## Methods

### BanAsync

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

- Tags: Yields, Capabilities: Consequences + Players

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`](https://rapi.sleaze.dev/classes/Players.md) property, which you can toggle in Studio.

Parameters:

- `config`: - `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()`](https://rapi.sleaze.dev/classes/Players.md). Note that unbanning a user through any other method will not lift the device block.

### Chat

```luau
Players:Chat(message: string)
```

- Tags: Plugin security, Capabilities: Players

Makes the local player chat the given message.

Parameters:

- `message`: The message chatted.

### CreateHumanoidModelFromDescriptionAsync

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

- Tags: Yields, Capabilities: AvatarAppearance + Players

Returns a character [`Model`](https://rapi.sleaze.dev/classes/Model.md) equipped with everything specified in the passed in [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md). If `UseAvatarSettings` is set to true, Avatar Settings in the experience will be applied to the returned model.

Parameters:

- `description`: Specifies the appearance of the returned character.
- `rigType`: Specifies whether the returned character will be R6 or R15.
- `assetTypeVerification`: The asset type verification mode.

Returns: A [`Humanoid`](https://rapi.sleaze.dev/classes/Humanoid.md) character [`Model`](https://rapi.sleaze.dev/classes/Model.md).

### CreateHumanoidModelFromUserIdAsync

```luau
Players:CreateHumanoidModelFromUserIdAsync(userId: User): Model
```

- Tags: Yields, Capabilities: Players

Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.

Parameters:

- `userId`: 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: A Humanoid character Model.

### CreateLocalPlayer

```luau
Players:CreateLocalPlayer(): Player
```

- Tags: Local user security, Capabilities: Players

### CreateThumbnailPlayer

```luau
Players:CreateThumbnailPlayer(): Player
```

- Tags: Roblox script security, Capabilities: Players

### GetBanHistoryAsync

```luau
Players:GetBanHistoryAsync(userId: User): BanHistoryPages
```

- Tags: Yields, Capabilities: Consequences + Players

Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the [`Players.BanningEnabled`](https://rapi.sleaze.dev/classes/Players.md) property, which you can toggle in Studio.

Parameters:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the player whose ban history to retrieve.

Returns: See [`BanHistoryPages`](https://rapi.sleaze.dev/classes/BanHistoryPages.md) for return reference.

### GetCharacterAppearanceInfoAsync

```luau
Players:GetCharacterAppearanceInfoAsync(userId: User): { [string]: any }
```

- Tags: Yields, Capabilities: Players

Returns information about the character appearance of a given user.

Parameters:

- `userId`: The **userId* of the specified player.

Returns: A dictionary containing information about the character appearance of a given user.

### GetFriendsAsync

```luau
Players:GetFriendsAsync(userId: User): FriendPages
```

- Tags: Yields, Capabilities: Players + Social

Returns a [`FriendPages`](https://rapi.sleaze.dev/classes/FriendPages.md) object which contains information for all of the given player's friends.

Parameters:

- `userId`: The user ID of the player being specified.

Returns: A [`FriendPages`](https://rapi.sleaze.dev/classes/FriendPages.md) object containing information for all of the given user's friends.

### GetHumanoidDescriptionFromOutfitIdAsync

```luau
Players:GetHumanoidDescriptionFromOutfitIdAsync(outfitId: number): HumanoidDescription
```

- Tags: Yields, Capabilities: AvatarAppearance + Players

Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.

Parameters:

- `outfitId`: The ID of the outfit for which the HumanoidDescription is sought.

Returns: HumanoidDescription initialized with the specification for the passed in outfitId.

### GetHumanoidDescriptionFromUserIdAsync

```luau
Players:GetHumanoidDescriptionFromUserIdAsync(userId: User): HumanoidDescription
```

- Tags: Yields, Capabilities: AvatarAppearance + Players

Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.

Parameters:

- `userId`: 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: HumanoidDescription initialized with the passed in user's avatar specification.

### GetNameFromUserIdAsync

```luau
Players:GetNameFromUserIdAsync(userId: User): string
```

- Tags: Yields, Capabilities: Players

Sends a query to the Roblox website for the username of an account with a given `UserId`.

Parameters:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the player being specified.

Returns: The name of a user with the specified [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md).

### GetPlayerByUserId

```luau
Players:GetPlayerByUserId(userId: User): Player
```

- Tags: Thread safe, Capabilities: Players

Returns the [`Player`](https://rapi.sleaze.dev/classes/Player.md) with the given `UserId` if they are in-experience.

Parameters:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the player being specified.

Returns: The [`Player`](https://rapi.sleaze.dev/classes/Player.md) with the given [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md), or `nil` if no connected player has that UserId.

### GetPlayerFromCharacter

```luau
Players:GetPlayerFromCharacter(character: Model): Player
```

- Tags: Capabilities: Players, Simulation access

Returns the [`Player`](https://rapi.sleaze.dev/classes/Player.md) whose [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md) matches the given instance, or `nil` if one cannot be found.

Parameters:

- `character`: A character instance that you want to get the player from.

Returns: The [`Player`](https://rapi.sleaze.dev/classes/Player.md) whose [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md) matches the given model, or `nil` if one cannot be found.

### GetPlayers

```luau
Players:GetPlayers(): { Instance }
```

- Tags: Thread safe, Capabilities: Players

Returns a table of all presently connected [`Player`](https://rapi.sleaze.dev/classes/Player.md) objects.

Returns: A table containing all the players in the server.

### GetProfileConfigurationFromUserIdAsync

```luau
Players:GetProfileConfigurationFromUserIdAsync(userId: User): { [string]: any }
```

- Tags: Yields, Capabilities: AvatarAppearance + Players

Returns the profile configuration of a user as a dictionary.

Parameters:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the user whose profile configuration to retrieve.

Returns: A dictionary containing the user's profile configuration, such as the background asset ID.

### GetUserIdFromNameAsync

```luau
Players:GetUserIdFromNameAsync(userName: string): number
```

- Tags: Yields, Capabilities: Players

Sends a query to the Roblox website for the `userId` of an account with a given username.

Parameters:

- `userName`: The username of the player being specified.

Returns: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of a user whose name is specified.

### GetUserThumbnailAsync

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

- Tags: Yields, Capabilities: Players

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:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the player being specified.
- `thumbnailType`: A `ThumbnailType` describing the type of thumbnail.
- `thumbnailSize`: A `ThumbnailSize` specifying the size of the thumbnail.

Returns: 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.

### ReportAbuse

```luau
Players:ReportAbuse(player: Player, reason: string, optionalMessage: string)
```

- Tags: Local user security, Capabilities: Players

### ReportAbuseV3

```luau
Players:ReportAbuseV3(player: Player, jsonTags: string)
```

- Tags: Roblox script security, Capabilities: Players

### ReportAvatarAbuse

```luau
Players:ReportAvatarAbuse(targetUserId: number, tags: { [string]: any })
```

- Tags: Roblox script security, Capabilities: Players

### ReportChatAbuse

```luau
Players:ReportChatAbuse(eligibleChatLines: { any }, targetChatLines: { any }, tags: { [string]: any })
```

- Tags: Roblox script security, Capabilities: Players

### ResetLocalPlayer

```luau
Players:ResetLocalPlayer()
```

- Tags: Local user security, Capabilities: Players

### SetChatStyle

```luau
Players:SetChatStyle(style: Enum.ChatStyle? = Enum.ChatStyle.Classic)
```

- Tags: Plugin security, Capabilities: Players

Sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and [`Chat`](https://rapi.sleaze.dev/classes/Chat.md) what to do.

Parameters:

- `style`: The specified chat style being set.

### SetLocalPlayerInfo

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

- Tags: Roblox script security, Capabilities: Players

### TeamChat

```luau
Players:TeamChat(message: string)
```

- Tags: Plugin security, Capabilities: Players

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

Parameters:

- `message`: The message being chatted.

### UnbanAsync

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

- Tags: Yields, Capabilities: Consequences + Players

Unbans players banned from [`Players:BanAsync()`](https://rapi.sleaze.dev/classes/Players.md) or the User Restrictions Open Cloud API. This method is enabled and disabled by the [`Players.BanningEnabled`](https://rapi.sleaze.dev/classes/Players.md) property, which you can toggle in Studio.

Parameters:

- `config`: 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.

### WhisperChat

```luau
Players:WhisperChat(message: string, player: Instance)
```

- Tags: Local user security, Capabilities: Players

### CreateHumanoidModelFromDescription

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

- Tags: Deprecated, Yields, Capabilities: AvatarAppearance + Players
- Use instead: [`Players.CreateHumanoidModelFromDescriptionAsync`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This method has been superseded by [`CreateHumanoidModelFromDescriptionAsync()`](https://rapi.sleaze.dev/classes/Players.md).

Returns a character [`Model`](https://rapi.sleaze.dev/classes/Model.md) equipped with everything specified in the passed in [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md).

Parameters:

- `description`: Specifies the appearance of the returned character.
- `rigType`: Specifies whether the returned character will be R6 or R15.
- `assetTypeVerification`: The asset type verification mode.

Returns: A [`Humanoid`](https://rapi.sleaze.dev/classes/Humanoid.md) character [`Model`](https://rapi.sleaze.dev/classes/Model.md).

### CreateHumanoidModelFromUserId

```luau
Players:CreateHumanoidModelFromUserId(userId: User): Model
```

- Tags: Deprecated, Yields, Capabilities: Players
- Use instead: [`Players.CreateHumanoidModelFromUserIdAsync`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This method has been superseded by [`CreateHumanoidModelFromUserIdAsync()`](https://rapi.sleaze.dev/classes/Players.md).

Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.

Parameters:

- `userId`: 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: A Humanoid character Model.

### GetCharacterAppearanceAsync

```luau
Players:GetCharacterAppearanceAsync(userId: User): Model
```

- Tags: Deprecated, Yields, Capabilities: Players

**Deprecated:** This method is deprecated. Do not use it for new work.

Returns a [`Model`](https://rapi.sleaze.dev/classes/Model.md) containing the assets which the player is wearing, excluding gear.

Parameters:

- `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the specified player.

Returns: A [`Model`](https://rapi.sleaze.dev/classes/Model.md) containing the assets the player is wearing, excluding gear.

### GetHumanoidDescriptionFromOutfitId

```luau
Players:GetHumanoidDescriptionFromOutfitId(outfitId: number): HumanoidDescription
```

- Tags: Deprecated, Yields, Capabilities: AvatarAppearance + Players
- Use instead: [`Players.GetHumanoidDescriptionFromOutfitIdAsync`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This method has been superseded by [`GetHumanoidDescriptionFromOutfitIdAsync()`](https://rapi.sleaze.dev/classes/Players.md).

Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.

Parameters:

- `outfitId`: The ID of the outfit for which the HumanoidDescription is sought.

Returns: HumanoidDescription initialized with the specification for the passed in outfitId.

### GetHumanoidDescriptionFromUserId

```luau
Players:GetHumanoidDescriptionFromUserId(userId: User): HumanoidDescription
```

- Tags: Deprecated, Yields, Capabilities: AvatarAppearance + Players
- Use instead: [`Players.GetHumanoidDescriptionFromUserIdAsync`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This method has been superseded by [`GetHumanoidDescriptionFromUserIdAsync()`](https://rapi.sleaze.dev/classes/Players.md).

Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.

Parameters:

- `userId`: 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: HumanoidDescription initialized with the passed in user's avatar specification.

### getPlayers

```luau
Players:getPlayers(): { Instance }
```

- Tags: Deprecated, Capabilities: Players
- Use instead: [`Players.GetPlayers`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This function is a deprecated variant of [`Players:GetPlayers()`](https://rapi.sleaze.dev/classes/Players.md) which should be used instead.

### playerFromCharacter

```luau
Players:playerFromCharacter(character: Model): Player
```

- Tags: Deprecated, Capabilities: Players
- Use instead: [`Players.GetPlayerFromCharacter`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This function is a deprecated variant of [`Players:GetPlayerFromCharacter()`](https://rapi.sleaze.dev/classes/Players.md) which should be used in new work.

### players

```luau
Players:players(): { Instance }
```

- Tags: Deprecated, Capabilities: Players
- Use instead: [`Players.GetPlayers`](https://rapi.sleaze.dev/classes/Players.md)

**Deprecated:** This item has been superseded by [`Players:GetPlayers()`](https://rapi.sleaze.dev/classes/Players.md) which should be used in all new work.

Returns a list of players in an experience.

## Events

### CloudEditApplyEditsMessage

```luau
Players.CloudEditApplyEditsMessage: RBXScriptSignal<(playerName: string, scriptName: string)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### FriendRequestEvent

```luau
Players.FriendRequestEvent: RBXScriptSignal<(player: Player, player: Player, friendRequestEvent: Enum.FriendRequestEvent)>
```

- Tags: Roblox script security, Capabilities: Players

### PlayerAdded

```luau
Players.PlayerAdded: RBXScriptSignal<(player: Player)>
```

- Tags: Capabilities: Players

Fires when a player enters the experience.

### PlayerChatted

```luau
Players.PlayerChatted: RBXScriptSignal<(chatType: Enum.PlayerChatType, player: Player, message: string, targetPlayer: Player)>
```

- Tags: Local user security, Capabilities: Players

### PlayerConnecting

```luau
Players.PlayerConnecting: RBXScriptSignal<(player: Player)>
```

- Tags: Local user security, Capabilities: Players

### PlayerDisconnecting

```luau
Players.PlayerDisconnecting: RBXScriptSignal<(player: Player)>
```

- Tags: Local user security, Capabilities: Players

### PlayerMembershipChanged

```luau
Players.PlayerMembershipChanged: RBXScriptSignal<(player: Player)>
```

- Tags: Capabilities: Players

Fires when the experience server recognizes that a player's membership has changed.

### PlayerRejoining

```luau
Players.PlayerRejoining: RBXScriptSignal<(player: Player)>
```

- Tags: Local user security, Capabilities: Players

### PlayerRemoving

```luau
Players.PlayerRemoving: RBXScriptSignal<(player: Player, reason: Enum.PlayerExitReason)>
```

- Tags: Capabilities: Players

Fires when a player is about to leave the experience.

### PromptAgeCheckRequested

```luau
Players.PromptAgeCheckRequested: RBXScriptSignal<(player: Player)>
```

- Tags: Roblox script security, Capabilities: Players

### PromptGameServerAvatarReportEnrichment

```luau
Players.PromptGameServerAvatarReportEnrichment: RBXScriptSignal<(reportId: string, targetUserId: number)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### PromptGameServerReportEnrichment

```luau
Players.PromptGameServerReportEnrichment: RBXScriptSignal<(reportId: string)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### PromptGameServerTargetedChatReportEnrichment

```luau
Players.PromptGameServerTargetedChatReportEnrichment: RBXScriptSignal<(reportId: string, eligibleChatLines: { any }, targetChatLines: { any })>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### PromptReportServerEnrichmentAndScan

```luau
Players.PromptReportServerEnrichmentAndScan: RBXScriptSignal<(v1comment: string, submitterId: number, abuserId: number, reportId: string)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### RequestCloudEditKick

```luau
Players.RequestCloudEditKick: RBXScriptSignal<(playerId: number)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### RequestCloudEditShutdown

```luau
Players.RequestCloudEditShutdown: RBXScriptSignal<()>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### TeamCreateServerMessage

```luau
Players.TeamCreateServerMessage: RBXScriptSignal<(messageType: Enum.MessageType, message: string, printToStatusBar: boolean)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Players

### UserSubscriptionStatusChanged

```luau
Players.UserSubscriptionStatusChanged: RBXScriptSignal<(user: Player, subscriptionId: string)>
```

- Tags: Capabilities: Monetization + Players

Fires when the experience server recognizes that the user's status for a certain subscription has changed.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`
