Roblox API Reference

Players On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.

Tags: [NotCreatable, Service]

Inherits (1)

Member index (44)

Type Member History
bool BubbleChat
bool CharacterAutoLoads 55
bool ClassicChat
Player LocalPlayer 200 329 453 452 454
int MaxPlayers 209 209 209
int MaxPlayersInternal 209 469
int NumPlayers 292
int PreferredPlayers 209
int PreferredPlayersInternal 209 469
float RespawnTime 371
Player localPlayer 50 49 50 329 453 452 454
int numPlayers 61
void Chat (string message) 83 151
Model CreateHumanoidModelFromDescription (HumanoidDescription description, HumanoidRigType rigType, AssetTypeVerification assetTypeVerification = Default) 377 443 442 443 453 452 454 498 498
Model CreateHumanoidModelFromUserId (int64 userId) 377 443 442 443 498
Player CreateLocalPlayer () 151 215 310 310 498
Model GetCharacterAppearanceAsync (int64 userId) 212 322 481 498
Dictionary GetCharacterAppearanceInfoAsync (int64 userId) 306 322
FriendPages GetFriendsAsync (int64 userId) 204 323 498
HumanoidDescription GetHumanoidDescriptionFromOutfitId (int64 outfitId) 369 498
HumanoidDescription GetHumanoidDescriptionFromUserId (int64 userId) 369 498
string GetNameFromUserIdAsync (int64 userId) 202 323
Player GetPlayerByUserId (int64 userId) 202 319 483
Player GetPlayerFromCharacter (Model character) 483 483
Objects GetPlayers ()
int64 GetUserIdFromNameAsync (string userName) 202 323
Tuple GetUserThumbnailAsync (int64 userId, ThumbnailType thumbnailType, ThumbnailSize thumbnailSize) 286 285 286 285 287 323
void ReportAbuse (Player player, string reason, string optionalMessage) 83 498
void SetChatStyle (ChatStyle style = Classic) 151
void SetLocalPlayerInfo (int64 userId, string userName, string displayName, MembershipType membershipType, bool isUnder13) 374 427
void TeamChat (string message) 83 151
void WhisperChat (string message, Instance player) 83
Objects getPlayers () 49
Player playerFromCharacter (Model character) 49 483 483
Objects players ()
FriendRequestEvent (Player player, Player player, FriendRequestEvent friendRequestEvent) 71 483
GameAnnounce (string message)
PlayerAdded (Player player) 483
PlayerChatted (PlayerChatType chatType, Player player, string message, Player targetPlayer) 83 498
PlayerConnecting (Player player) 272 498
PlayerDisconnecting (Player player) 272 498
PlayerMembershipChanged (Player player) 416 498
PlayerRejoining (Player player) 272 498
PlayerRemoving (Player player) 483
51 members inherited from Instance

Removed member index (18)

Type Member History
void AddLeaderboardKey (string key) 258 257 258
string BlockUser (int blockerUserId, int blockeeUserId) 181 284
Instance GetPlayerByID (int userID) 210 310
Instance GetPlayerById (int userId) 210 310
bool GetUseCoreScriptHealthBar () 142 310
void SetAbuseReportUrl (string url) 310
void SetBuildToolsUrl (string url) 51
void SetBuildUserPermissionsUrl (string url) 310
void SetChatFilterUrl (string url) 310
void SetLoadDataUrl (string url) 310
void SetSaveDataUrl (string url) 310
void SetSaveLeaderboardDataUrl (string url) 258 257 258
void SetSysStatsUrl (string url) 310
void SetSysStatsUrlId (string urlId) 310
string UnblockUser (int exblockerUserId, int exblockeeUserId) 181 284
Instance getPlayerFromCharacter (Instance character) 49 480
PlayerAddedEarly (Instance player) 310
PlayerRemovingLate (Instance player) 310

History

Members

BubbleChat On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [ReadOnly, NotReplicated]

CharacterAutoLoads On DevHub

This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [NotReplicated]

Chat On DevHub

Name Type Default
message string none

History

  • 151 Change Security of Players.Chat from LocalUserSecurity to PluginSecurity
  • 83 Change Security of Players.Chat from RobloxScriptSecurity to LocalUserSecurity

ClassicChat On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

Tags: [ReadOnly, NotReplicated]

CreateHumanoidModelFromDescription On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
description HumanoidDescription none
rigType HumanoidRigType none
assetTypeVerification AssetTypeVerification Default

History

Tags: [Yields]

CreateHumanoidModelFromUserId On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

CreateLocalPlayer On DevHub

Name Type Default
No parameters.

History

FriendRequestEvent On DevHub

Name Type Default
player Player none
player Player none
friendRequestEvent FriendRequestEvent none

History

GameAnnounce On DevHub

Name Type Default
message string none

GetCharacterAppearanceAsync On DevHub

This function yields. It will block the calling thread until completion.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
userId int64 none

History

Tags: [Yields, Deprecated]

GetCharacterAppearanceInfoAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

GetFriendsAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

GetHumanoidDescriptionFromOutfitId On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
outfitId int64 none

History

Tags: [Yields]

GetHumanoidDescriptionFromUserId On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

GetNameFromUserIdAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

GetPlayerByUserId On DevHub

Name Type Default
userId int64 none

History

GetPlayerFromCharacter On DevHub

Name Type Default
character Model none

History

GetPlayers On DevHub

Name Type Default
No parameters.

GetUserIdFromNameAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userName string none

History

Tags: [Yields]

GetUserThumbnailAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none
thumbnailType ThumbnailType none
thumbnailSize ThumbnailSize none

History

Tags: [Yields]

LocalPlayer On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

MaxPlayers On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

MaxPlayersInternal On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

NumPlayers On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

  • 292 Change Tags of Players.NumPlayers from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]

Tags: [ReadOnly, NotReplicated, Deprecated]

PlayerAdded On DevHub

Name Type Default
player Player none

History

PlayerChatted On DevHub

Name Type Default
chatType PlayerChatType none
player Player none
message string none
targetPlayer Player none

History

PlayerConnecting On DevHub

Name Type Default
player Player none

History

PlayerDisconnecting On DevHub

Name Type Default
player Player none

History

PlayerMembershipChanged On DevHub

Name Type Default
player Player none

History

PlayerRejoining On DevHub

Name Type Default
player Player none

History

PlayerRemoving On DevHub

Name Type Default
player Player none

History

PreferredPlayers On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [ReadOnly, NotReplicated]

PreferredPlayersInternal On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

ReportAbuse On DevHub

Name Type Default
player Player none
reason string none
optionalMessage string none

History

RespawnTime On DevHub

History

SetChatStyle On DevHub

Name Type Default
style ChatStyle Classic

History

SetLocalPlayerInfo On DevHub

Name Type Default
userId int64 none
userName string none
displayName string none
membershipType MembershipType none
isUnder13 bool none

History

TeamChat On DevHub

Name Type Default
message string none

History

WhisperChat On DevHub

Name Type Default
message string none
player Instance none

History

getPlayers On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

History

Tags: [Deprecated]

localPlayer On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

numPlayers On DevHub

This property is read-only. Its value can be read, but it cannot be modified.
This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

playerFromCharacter On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
character Model none

History

Tags: [Deprecated]

players On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
No parameters.

Tags: [Deprecated]

Removed members

AddLeaderboardKey

Name Type Default
key string none

History

BlockUser

This function yields. It will block the calling thread until completion.
Name Type Default
blockerUserId int none
blockeeUserId int none

History

Tags: [Yields]

GetPlayerByID

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
userID int none

History

Tags: [Deprecated]

GetPlayerById

Name Type Default
userId int none

History

GetUseCoreScriptHealthBar

Name Type Default
No parameters.

History

PlayerAddedEarly

Name Type Default
player Instance none

History

PlayerRemovingLate

Name Type Default
player Instance none

History

SetAbuseReportUrl

Name Type Default
url string none

History

SetBuildToolsUrl

Name Type Default
url string none

History

SetBuildUserPermissionsUrl

Name Type Default
url string none

History

SetChatFilterUrl

Name Type Default
url string none

History

SetLoadDataUrl

Name Type Default
url string none

History

SetSaveDataUrl

Name Type Default
url string none

History

SetSaveLeaderboardDataUrl

Name Type Default
url string none

History

SetSysStatsUrl

Name Type Default
url string none

History

SetSysStatsUrlId

Name Type Default
urlId string none

History

UnblockUser

This function yields. It will block the calling thread until completion.
Name Type Default
exblockerUserId int none
exblockeeUserId int none

History

Tags: [Yields]

getPlayerFromCharacter

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
character Instance none

History

Tags: [Deprecated]

Relevant classes (5)

Relevant enums (8)