Players
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory category | Instances |
---|
Member index 63
Removed member index 19
History | Member | |
---|---|---|
258 | AddLeaderboardKey(key: string): void | |
284 | BlockUser(blockerUserId: int, blockeeUserId: int): string | |
310 | GetPlayerByID(userID: int): Instance | |
310 | GetPlayerById(userId: int): Instance | |
310 | GetUseCoreScriptHealthBar(): bool | |
310 | SetAbuseReportUrl(url: string): void | |
51 | SetBuildToolsUrl(url: string): void | |
310 | SetBuildUserPermissionsUrl(url: string): void | |
310 | SetChatFilterUrl(url: string): void | |
310 | SetLoadDataUrl(url: string): void | |
310 | SetSaveDataUrl(url: string): void | |
258 | SetSaveLeaderboardDataUrl(url: string): void | |
310 | SetSysStatsUrl(url: string): void | |
310 | SetSysStatsUrlId(urlId: string): void | |
284 | UnblockUser(exblockerUserId: int, exblockeeUserId: int): string | |
480 | getPlayerFromCharacter(character: Instance): Instance | |
310 | PlayerAddedEarly(player: Instance) | |
310 | PlayerRemovingLate(player: Instance) |
History 267
- 629 Remove
- 625 Add GetBanHistoryAsync
- 622 Add UnbanAsync
- 622 Add BanAsync
- 594 Change Security of UserSubscriptionStatusChanged from RobloxScriptSecurity to None
- 590 Add UserSubscriptionStatusChanged
- 578 Change Tags of UseStrafingAnimations from [NotReplicated, NotScriptable] to [NotScriptable]
- 573 Change ReturnType of WhisperChat from void to null
- 573 Change ReturnType of TeamChat from void to null
- 573 Change ReturnType of SetLocalPlayerInfo from void to null
- 573 Change ReturnType of SetChatStyle from void to null
- 573 Change ReturnType of ResetLocalPlayer from void to null
- 573 Change ReturnType of ReportAbuseV3 from void to null
- 573 Change ReturnType of ReportAbuse from void to null
- 573 Change ReturnType of Chat from void to null
- 567 Add
- 567 Change ThreadSafety of GetPlayerByUserId from Unsafe to Safe
- 565 Add ResetLocalPlayer
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Change PreferredDescriptor of players from to GetPlayers
- 553 Change PreferredDescriptor of playerFromCharacter from to GetPlayerFromCharacter
- 553 Change PreferredDescriptor of getPlayers from to GetPlayers
- 553 Change PreferredDescriptor of from to NumPlayers
- 553 Change Default of from to
- 553 Change PreferredDescriptor of from to LocalPlayer
- 553 Change Default of from to
- 553 Add UseStrafingAnimations
- 553 Add
- 553 Add
- 553 Change Default of RespawnTime from to
- 553 Change Default of from to
- 553 Change Default of PreferredPlayers from to
- 553 Change PreferredDescriptor of NumPlayers from to GetPlayers
- 553 Change Default of NumPlayers from to
- 553 Change Default of from to
- 553 Change Default of MaxPlayers from to
- 553 Change Default of LocalPlayer from to
- 553 Change Default of ClassicChat from to
- 553 Change Default of CharacterAutoLoads from to
- 553 Change Default of BubbleChat from to
- 540 Add ReportAbuseV3
- 533 Change ThreadSafety of GetPlayers from Unsafe to Safe
- 498 Change Parameters of PlayerRejoining from (player: Instance) to (player: Player)
- 498 Change Parameters of PlayerMembershipChanged from (player: Instance) to (player: Player)
- 498 Change Parameters of PlayerDisconnecting from (player: Instance) to (player: Player)
- 498 Change Parameters of PlayerConnecting from (player: Instance) to (player: Player)
- 498 Change Parameters of PlayerChatted from (chatType: PlayerChatType, player: Instance, message: string, targetPlayer: Instance) to (chatType: PlayerChatType, player: Player, message: string, targetPlayer: Player)
- 498 Change Parameters of ReportAbuse from (player: Instance, reason: string, optionalMessage: string) to (player: Player, reason: string, optionalMessage: string)
- 498 Change ReturnType of GetHumanoidDescriptionFromUserId from Instance to HumanoidDescription
- 498 Change ReturnType of GetHumanoidDescriptionFromOutfitId from Instance to HumanoidDescription
- 498 Change ReturnType of GetFriendsAsync from Instance to FriendPages
- 498 Change ReturnType of GetCharacterAppearanceAsync from Instance to Model
- 498 Change ReturnType of CreateLocalPlayer from Instance to Player
- 498 Change ReturnType of CreateHumanoidModelFromUserId from Instance to Model
- 498 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default) to (description: HumanoidDescription, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 498 Change ReturnType of CreateHumanoidModelFromDescription from Instance to Model
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of RespawnTime from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PreferredPlayers from ReadOnly to ReadSafe
- 486 Change ThreadSafety of NumPlayers from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MaxPlayers from ReadOnly to ReadSafe
- 486 Change ThreadSafety of LocalPlayer from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ClassicChat from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterAutoLoads from ReadOnly to ReadSafe
- 486 Change ThreadSafety of BubbleChat from ReadOnly to ReadSafe
- 483 Change Parameters of PlayerRemoving from (player: Instance) to (player: Player)
- 483 Change Parameters of PlayerAdded from (player: Instance) to (player: Player)
- 483 Change Parameters of FriendRequestEvent from (player: Instance, player: Instance, friendRequestEvent: FriendRequestEvent) to (player: Player, player: Player, friendRequestEvent: FriendRequestEvent)
- 483 Change Parameters of playerFromCharacter from (character: Instance) to (character: Model)
- 483 Change ReturnType of playerFromCharacter from Instance to Player
- 483 Change Parameters of GetPlayerFromCharacter from (character: Instance) to (character: Model)
- 483 Change ReturnType of GetPlayerFromCharacter from Instance to Player
- 483 Change ReturnType of GetPlayerByUserId from Instance to Player
- 481 Change Tags of GetCharacterAppearanceAsync from [Yields] to [Yields, Deprecated]
- 480 Remove getPlayerFromCharacter
- 469 Change Tags of from [] to [Hidden]
- 469 Change Tags of from [] to [Hidden]
- 462 Change ThreadSafety of PlayerRemoving from to Unsafe
- 462 Change ThreadSafety of PlayerRejoining from to Unsafe
- 462 Change ThreadSafety of PlayerMembershipChanged from to Unsafe
- 462 Change ThreadSafety of PlayerDisconnecting from to Unsafe
- 462 Change ThreadSafety of PlayerConnecting from to Unsafe
- 462 Change ThreadSafety of PlayerChatted from to Unsafe
- 462 Change ThreadSafety of PlayerAdded from to Unsafe
- 462 Change ThreadSafety of GameAnnounce from to Unsafe
- 462 Change ThreadSafety of FriendRequestEvent from to Unsafe
- 462 Change ThreadSafety of players from to Unsafe
- 462 Change ThreadSafety of playerFromCharacter from to Unsafe
- 462 Change ThreadSafety of getPlayers from to Unsafe
- 462 Change ThreadSafety of getPlayerFromCharacter from to Unsafe
- 462 Change ThreadSafety of WhisperChat from to Unsafe
- 462 Change ThreadSafety of TeamChat from to Unsafe
- 462 Change ThreadSafety of SetLocalPlayerInfo from to Unsafe
- 462 Change ThreadSafety of SetChatStyle from to Unsafe
- 462 Change ThreadSafety of ReportAbuse from to Unsafe
- 462 Change ThreadSafety of GetUserThumbnailAsync from to Unsafe
- 462 Change ThreadSafety of GetUserIdFromNameAsync from to Unsafe
- 462 Change ThreadSafety of GetPlayers from to Unsafe
- 462 Change ThreadSafety of GetPlayerFromCharacter from to Unsafe
- 462 Change ThreadSafety of GetPlayerByUserId from to Unsafe
- 462 Change ThreadSafety of GetNameFromUserIdAsync from to Unsafe
- 462 Change ThreadSafety of GetHumanoidDescriptionFromUserId from to Unsafe
- 462 Change ThreadSafety of GetHumanoidDescriptionFromOutfitId from to Unsafe
- 462 Change ThreadSafety of GetFriendsAsync from to Unsafe
- 462 Change ThreadSafety of GetCharacterAppearanceInfoAsync from to Unsafe
- 462 Change ThreadSafety of GetCharacterAppearanceAsync from to Unsafe
- 462 Change ThreadSafety of CreateLocalPlayer from to Unsafe
- 462 Change ThreadSafety of CreateHumanoidModelFromUserId from to Unsafe
- 462 Change ThreadSafety of CreateHumanoidModelFromDescription from to Unsafe
- 462 Change ThreadSafety of Chat from to Unsafe
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of RespawnTime from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of PreferredPlayers from to ReadOnly
- 462 Change ThreadSafety of NumPlayers from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of MaxPlayers from to ReadOnly
- 462 Change ThreadSafety of LocalPlayer from to ReadOnly
- 462 Change ThreadSafety of ClassicChat from to ReadOnly
- 462 Change ThreadSafety of CharacterAutoLoads from to ReadOnly
- 462 Change ThreadSafety of BubbleChat from to ReadOnly
- 454 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType) to (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 454 Change ValueType of from Instance to Player
- 454 Change ValueType of LocalPlayer from Instance to Player
- 452 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default) to (description: Instance, rigType: HumanoidRigType)
- 452 Change ValueType of from Player to Instance
- 452 Change ValueType of LocalPlayer from Player to Instance
- 453 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType) to (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 453 Change ValueType of from Instance to Player
- 453 Change ValueType of LocalPlayer from Instance to Player
- 443 Change Security of CreateHumanoidModelFromUserId from RobloxScriptSecurity to None
- 443 Change Security of CreateHumanoidModelFromDescription from RobloxScriptSecurity to None
- 442 Change Security of CreateHumanoidModelFromUserId from None to RobloxScriptSecurity
- 442 Change Security of CreateHumanoidModelFromDescription from None to RobloxScriptSecurity
- 443 Change Security of CreateHumanoidModelFromUserId from RobloxScriptSecurity to None
- 443 Change Security of CreateHumanoidModelFromDescription from RobloxScriptSecurity to None
- 427 Change Parameters of SetLocalPlayerInfo from (userId: int64, userName: string, membershipType: MembershipType, isUnder13: bool) to (userId: int64, userName: string, displayName: string, membershipType: MembershipType, isUnder13: bool)
- 416 Add PlayerMembershipChanged
- 377 Add CreateHumanoidModelFromUserId
- 377 Add CreateHumanoidModelFromDescription
- 374 Add SetLocalPlayerInfo
- 371 Add RespawnTime
- 369 Add GetHumanoidDescriptionFromUserId
- 369 Add GetHumanoidDescriptionFromOutfitId
- 329 Change ValueType of from Object to Instance
- 329 Change ValueType of LocalPlayer from Object to Instance
- 323 Change Parameters of GetUserThumbnailAsync from (userId: int, thumbnailType: ThumbnailType, thumbnailSize: ThumbnailSize) to (userId: int64, thumbnailType: ThumbnailType, thumbnailSize: ThumbnailSize)
- 323 Change ReturnType of GetUserIdFromNameAsync from int to int64
- 323 Change Parameters of GetNameFromUserIdAsync from (userId: int) to (userId: int64)
- 323 Change Parameters of GetFriendsAsync from (userId: int) to (userId: int64)
- 322 Change Parameters of GetCharacterAppearanceInfoAsync from (userId: int) to (userId: int64)
- 322 Change Parameters of GetCharacterAppearanceAsync from (userId: int) to (userId: int64)
- 319 Change Parameters of GetPlayerByUserId from (userId: int) to (userId: int64)
- 310 Remove PlayerRemovingLate
- 310 Remove PlayerAddedEarly
- 310 Remove SetSysStatsUrlId
- 310 Remove SetSysStatsUrl
- 310 Remove SetSaveDataUrl
- 310 Remove SetLoadDataUrl
- 310 Remove SetChatFilterUrl
- 310 Remove SetBuildUserPermissionsUrl
- 310 Remove SetAbuseReportUrl
- 310 Remove GetUseCoreScriptHealthBar
- 310 Remove GetPlayerById
- 310 Remove GetPlayerByID
- 310 Change Security of CreateLocalPlayer from PluginSecurity to LocalUserSecurity
- 310 Change Parameters of CreateLocalPlayer from (userId: int, isTeleport: bool = false) to ()
- 306 Add GetCharacterAppearanceInfoAsync
- 292 Change Tags of NumPlayers from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 287 Add GetUserThumbnailAsync
- 285 Remove GetUserThumbnailAsync
- 286 Add GetUserThumbnailAsync
- 285 Remove GetUserThumbnailAsync
- 286 Add GetUserThumbnailAsync
- 284 Remove UnblockUser
- 284 Remove BlockUser
- 272 Add PlayerRejoining
- 272 Add PlayerDisconnecting
- 272 Add PlayerConnecting
- 258 Remove SetSaveLeaderboardDataUrl
- 258 Remove AddLeaderboardKey
- 257 Add SetSaveLeaderboardDataUrl
- 257 Add AddLeaderboardKey
- 258 Remove SetSaveLeaderboardDataUrl
- 258 Remove AddLeaderboardKey
- 215 Change Parameters of CreateLocalPlayer from (userId: int) to (userId: int, isTeleport: bool = false)
- 212 Add GetCharacterAppearanceAsync
- 210 Add GetPlayerById
- 210 Change Tags of GetPlayerByID from [] to [Deprecated]
- 209 Add
- 209 Add PreferredPlayers
- 209 Add
- 209 Change WriteSecurity of MaxPlayers from RobloxSecurity to None
- 209 Change Tags of MaxPlayers from [NotReplicated] to [ReadOnly, NotReplicated]
- 209 Change ReadSecurity of MaxPlayers from RobloxSecurity to None
- 204 Add GetFriendsAsync
- 202 Add GetUserIdFromNameAsync
- 202 Add GetPlayerByUserId
- 202 Add GetNameFromUserIdAsync
- 200 Change Tags of LocalPlayer from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 181 Add UnblockUser
- 181 Add BlockUser
- 151 Change Security of TeamChat from LocalUserSecurity to PluginSecurity
- 151 Change Security of SetChatStyle from LocalUserSecurity to PluginSecurity
- 151 Change Security of CreateLocalPlayer from LocalUserSecurity to PluginSecurity
- 151 Change Security of Chat from LocalUserSecurity to PluginSecurity
- 142 Add GetUseCoreScriptHealthBar
- 83 Change Security of PlayerChatted from RobloxScriptSecurity to LocalUserSecurity
- 83 Change Security of WhisperChat from RobloxScriptSecurity to LocalUserSecurity
- 83 Change Security of TeamChat from RobloxScriptSecurity to LocalUserSecurity
- 83 Change Security of ReportAbuse from RobloxScriptSecurity to LocalUserSecurity
- 83 Change Security of Chat from RobloxScriptSecurity to LocalUserSecurity
- 71 Change Parameters of FriendRequestEvent from (player: Instance, player: Instance, FriendRequestEvent: FriendRequestEvent) to (player: Instance, player: Instance, friendRequestEvent: FriendRequestEvent)
- 61 Add
- 55 Add CharacterAutoLoads
- 51 Remove SetBuildToolsUrl
- 50 Add
- 49 Change Tags of playerFromCharacter from [] to [Deprecated]
- 49 Add getPlayers
- 49 Add getPlayerFromCharacter
- 47 Add PlayerRemovingLate
- 47 Add PlayerRemoving
- 47 Add PlayerChatted
- 47 Add PlayerAddedEarly
- 47 Add PlayerAdded
- 47 Add GameAnnounce
- 47 Add FriendRequestEvent
- 47 Add players
- 47 Add playerFromCharacter
- 47 Add WhisperChat
- 47 Add TeamChat
- 47 Add SetSysStatsUrlId
- 47 Add SetSysStatsUrl
- 47 Add SetSaveLeaderboardDataUrl
- 47 Add SetSaveDataUrl
- 47 Add SetLoadDataUrl
- 47 Add SetChatStyle
- 47 Add SetChatFilterUrl
- 47 Add SetBuildUserPermissionsUrl
- 47 Add SetBuildToolsUrl
- 47 Add SetAbuseReportUrl
- 47 Add ReportAbuse
- 47 Add GetPlayers
- 47 Add GetPlayerFromCharacter
- 47 Add GetPlayerByID
- 47 Add CreateLocalPlayer
- 47 Add Chat
- 47 Add AddLeaderboardKey
- 47 Add NumPlayers
- 47 Add MaxPlayers
- 47 Add LocalPlayer
- 47 Add ClassicChat
- 47 Add BubbleChat
- 47 Add Players
Members 63
BanAsync
Parameters (1) | ||
---|---|---|
config | Dictionary | |
Returns (1) | ||
null |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
BubbleChat
Type | Default | |
---|---|---|
bool |
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 4
- 553 Change Default of BubbleChat from to
- 486 Change ThreadSafety of BubbleChat from ReadOnly to ReadSafe
- 462 Change ThreadSafety of BubbleChat from to ReadOnly
- 47 Add BubbleChat
CharacterAutoLoads
Type | Default | |
---|---|---|
bool |
This property is not replicated. Its interface does not cross the network boundary.
Thread safety | ReadSafe |
---|---|
Category | Behavior |
Loaded/Saved | true |
History 4
- 553 Change Default of CharacterAutoLoads from to
- 486 Change ThreadSafety of CharacterAutoLoads from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterAutoLoads from to ReadOnly
- 55 Add CharacterAutoLoads
Chat
Parameters (1) | ||
---|---|---|
Returns (1) | ||
null |
Security | PluginSecurity |
---|---|
Thread safety | Unsafe |
ClassicChat
Type | Default | |
---|---|---|
bool |
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 4
- 553 Change Default of ClassicChat from to
- 486 Change ThreadSafety of ClassicChat from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ClassicChat from to ReadOnly
- 47 Add ClassicChat
CreateHumanoidModelFromDescription
Parameters (3) | Default | |
---|---|---|
description | HumanoidDescription | |
rigType | HumanoidRigType | |
assetTypeVerification | AssetTypeVerification | Default |
Returns (1) | ||
Model |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 10
- 498 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default) to (description: HumanoidDescription, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 498 Change ReturnType of CreateHumanoidModelFromDescription from Instance to Model
- 462 Change ThreadSafety of CreateHumanoidModelFromDescription from to Unsafe
- 454 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType) to (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 452 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default) to (description: Instance, rigType: HumanoidRigType)
- 453 Change Parameters of CreateHumanoidModelFromDescription from (description: Instance, rigType: HumanoidRigType) to (description: Instance, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default)
- 443 Change Security of CreateHumanoidModelFromDescription from RobloxScriptSecurity to None
- 442 Change Security of CreateHumanoidModelFromDescription from None to RobloxScriptSecurity
- 443 Change Security of CreateHumanoidModelFromDescription from RobloxScriptSecurity to None
- 377 Add CreateHumanoidModelFromDescription
CreateHumanoidModelFromUserId
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
Model |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 6
- 498 Change ReturnType of CreateHumanoidModelFromUserId from Instance to Model
- 462 Change ThreadSafety of CreateHumanoidModelFromUserId from to Unsafe
- 443 Change Security of CreateHumanoidModelFromUserId from RobloxScriptSecurity to None
- 442 Change Security of CreateHumanoidModelFromUserId from None to RobloxScriptSecurity
- 443 Change Security of CreateHumanoidModelFromUserId from RobloxScriptSecurity to None
- 377 Add CreateHumanoidModelFromUserId
CreateLocalPlayer
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Player |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 7
- 498 Change ReturnType of CreateLocalPlayer from Instance to Player
- 462 Change ThreadSafety of CreateLocalPlayer from to Unsafe
- 310 Change Security of CreateLocalPlayer from PluginSecurity to LocalUserSecurity
- 310 Change Parameters of CreateLocalPlayer from (userId: int, isTeleport: bool = false) to ()
- 215 Change Parameters of CreateLocalPlayer from (userId: int) to (userId: int, isTeleport: bool = false)
- 151 Change Security of CreateLocalPlayer from LocalUserSecurity to PluginSecurity
- 47 Add CreateLocalPlayer
FriendRequestEvent
Parameters (3) | |
---|---|
player | Player |
player | Player |
friendRequestEvent | FriendRequestEvent |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 4
- 483 Change Parameters of FriendRequestEvent from (player: Instance, player: Instance, friendRequestEvent: FriendRequestEvent) to (player: Player, player: Player, friendRequestEvent: FriendRequestEvent)
- 462 Change ThreadSafety of FriendRequestEvent from to Unsafe
- 71 Change Parameters of FriendRequestEvent from (player: Instance, player: Instance, FriendRequestEvent: FriendRequestEvent) to (player: Instance, player: Instance, friendRequestEvent: FriendRequestEvent)
- 47 Add FriendRequestEvent
GameAnnounce
Parameters (1) |
---|
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GameAnnounce from to Unsafe
- 47 Add GameAnnounce
GetBanHistoryAsync
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
BanHistoryPages |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 1
GetCharacterAppearanceAsync
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
Model |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 5
- 498 Change ReturnType of GetCharacterAppearanceAsync from Instance to Model
- 481 Change Tags of GetCharacterAppearanceAsync from [Yields] to [Yields, Deprecated]
- 462 Change ThreadSafety of GetCharacterAppearanceAsync from to Unsafe
- 322 Change Parameters of GetCharacterAppearanceAsync from (userId: int) to (userId: int64)
- 212 Add GetCharacterAppearanceAsync
GetCharacterAppearanceInfoAsync
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
Dictionary |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 462 Change ThreadSafety of GetCharacterAppearanceInfoAsync from to Unsafe
- 322 Change Parameters of GetCharacterAppearanceInfoAsync from (userId: int) to (userId: int64)
- 306 Add GetCharacterAppearanceInfoAsync
GetFriendsAsync
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
FriendPages |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 4
- 498 Change ReturnType of GetFriendsAsync from Instance to FriendPages
- 462 Change ThreadSafety of GetFriendsAsync from to Unsafe
- 323 Change Parameters of GetFriendsAsync from (userId: int) to (userId: int64)
- 204 Add GetFriendsAsync
GetHumanoidDescriptionFromOutfitId
Parameters (1) | ||
---|---|---|
outfitId | int64 | |
Returns (1) | ||
HumanoidDescription |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 498 Change ReturnType of GetHumanoidDescriptionFromOutfitId from Instance to HumanoidDescription
- 462 Change ThreadSafety of GetHumanoidDescriptionFromOutfitId from to Unsafe
- 369 Add GetHumanoidDescriptionFromOutfitId
GetHumanoidDescriptionFromUserId
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
HumanoidDescription |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 498 Change ReturnType of GetHumanoidDescriptionFromUserId from Instance to HumanoidDescription
- 462 Change ThreadSafety of GetHumanoidDescriptionFromUserId from to Unsafe
- 369 Add GetHumanoidDescriptionFromUserId
GetNameFromUserIdAsync
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
string |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 462 Change ThreadSafety of GetNameFromUserIdAsync from to Unsafe
- 323 Change Parameters of GetNameFromUserIdAsync from (userId: int) to (userId: int64)
- 202 Add GetNameFromUserIdAsync
GetPlayerByUserId
Parameters (1) | ||
---|---|---|
userId | int64 | |
Returns (1) | ||
Player |
Thread safety | Safe |
---|
History 5
- 567 Change ThreadSafety of GetPlayerByUserId from Unsafe to Safe
- 483 Change ReturnType of GetPlayerByUserId from Instance to Player
- 462 Change ThreadSafety of GetPlayerByUserId from to Unsafe
- 319 Change Parameters of GetPlayerByUserId from (userId: int) to (userId: int64)
- 202 Add GetPlayerByUserId
GetPlayerFromCharacter
Parameters (1) | ||
---|---|---|
character | Model | |
Returns (1) | ||
Player |
Thread safety | Unsafe |
---|
History 4
- 483 Change Parameters of GetPlayerFromCharacter from (character: Instance) to (character: Model)
- 483 Change ReturnType of GetPlayerFromCharacter from Instance to Player
- 462 Change ThreadSafety of GetPlayerFromCharacter from to Unsafe
- 47 Add GetPlayerFromCharacter
GetPlayers
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Objects |
Thread safety | Safe |
---|
History 3
- 533 Change ThreadSafety of GetPlayers from Unsafe to Safe
- 462 Change ThreadSafety of GetPlayers from to Unsafe
- 47 Add GetPlayers
GetUserIdFromNameAsync
Parameters (1) | ||
---|---|---|
userName | string | |
Returns (1) | ||
int64 |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 462 Change ThreadSafety of GetUserIdFromNameAsync from to Unsafe
- 323 Change ReturnType of GetUserIdFromNameAsync from int to int64
- 202 Add GetUserIdFromNameAsync
GetUserThumbnailAsync
Parameters (3) | ||
---|---|---|
userId | int64 | |
thumbnailType | ThumbnailType | |
thumbnailSize | ThumbnailSize | |
Returns (1) | ||
Tuple |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 7
- 462 Change ThreadSafety of GetUserThumbnailAsync from to Unsafe
- 323 Change Parameters of GetUserThumbnailAsync from (userId: int, thumbnailType: ThumbnailType, thumbnailSize: ThumbnailSize) to (userId: int64, thumbnailType: ThumbnailType, thumbnailSize: ThumbnailSize)
- 287 Add GetUserThumbnailAsync
- 285 Remove GetUserThumbnailAsync
- 286 Add GetUserThumbnailAsync
- 285 Remove GetUserThumbnailAsync
- 286 Add GetUserThumbnailAsync
LocalPlayer
Type | Default | |
---|---|---|
Player |
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 9
- 553 Change Default of LocalPlayer from to
- 486 Change ThreadSafety of LocalPlayer from ReadOnly to ReadSafe
- 462 Change ThreadSafety of LocalPlayer from to ReadOnly
- 454 Change ValueType of LocalPlayer from Instance to Player
- 452 Change ValueType of LocalPlayer from Player to Instance
- 453 Change ValueType of LocalPlayer from Instance to Player
- 329 Change ValueType of LocalPlayer from Object to Instance
- 200 Change Tags of LocalPlayer from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 47 Add LocalPlayer
MaxPlayers
Type | Default | |
---|---|---|
int |
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 7
- 553 Change Default of MaxPlayers from to
- 486 Change ThreadSafety of MaxPlayers from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MaxPlayers from to ReadOnly
- 209 Change WriteSecurity of MaxPlayers from RobloxSecurity to None
- 209 Change Tags of MaxPlayers from [NotReplicated] to [ReadOnly, NotReplicated]
- 209 Change ReadSecurity of MaxPlayers from RobloxSecurity to None
- 47 Add MaxPlayers
NumPlayers
Type | Default | |
---|---|---|
int |
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPlayers should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 6
- 553 Change PreferredDescriptor of NumPlayers from to GetPlayers
- 553 Change Default of NumPlayers from to
- 486 Change ThreadSafety of NumPlayers from ReadOnly to ReadSafe
- 462 Change ThreadSafety of NumPlayers from to ReadOnly
- 292 Change Tags of NumPlayers from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 47 Add NumPlayers
PlayerAdded
Parameters (1) | |
---|---|
player | Player |
Thread safety | Unsafe |
---|
History 3
- 483 Change Parameters of PlayerAdded from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerAdded from to Unsafe
- 47 Add PlayerAdded
PlayerChatted
Parameters (4) | |
---|---|
chatType | PlayerChatType |
player | Player |
targetPlayer | Player |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 4
- 498 Change Parameters of PlayerChatted from (chatType: PlayerChatType, player: Instance, message: string, targetPlayer: Instance) to (chatType: PlayerChatType, player: Player, message: string, targetPlayer: Player)
- 462 Change ThreadSafety of PlayerChatted from to Unsafe
- 83 Change Security of PlayerChatted from RobloxScriptSecurity to LocalUserSecurity
- 47 Add PlayerChatted
PlayerConnecting
Parameters (1) | |
---|---|
player | Player |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 498 Change Parameters of PlayerConnecting from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerConnecting from to Unsafe
- 272 Add PlayerConnecting
PlayerDisconnecting
Parameters (1) | |
---|---|
player | Player |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 498 Change Parameters of PlayerDisconnecting from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerDisconnecting from to Unsafe
- 272 Add PlayerDisconnecting
PlayerMembershipChanged
Parameters (1) | |
---|---|
player | Player |
Thread safety | Unsafe |
---|
History 3
- 498 Change Parameters of PlayerMembershipChanged from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerMembershipChanged from to Unsafe
- 416 Add PlayerMembershipChanged
PlayerRejoining
Parameters (1) | |
---|---|
player | Player |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 498 Change Parameters of PlayerRejoining from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerRejoining from to Unsafe
- 272 Add PlayerRejoining
PlayerRemoving
Parameters (1) | |
---|---|
player | Player |
Thread safety | Unsafe |
---|
History 3
- 483 Change Parameters of PlayerRemoving from (player: Instance) to (player: Player)
- 462 Change ThreadSafety of PlayerRemoving from to Unsafe
- 47 Add PlayerRemoving
PreferredPlayers
Type | Default | |
---|---|---|
int |
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 4
- 553 Change Default of PreferredPlayers from to
- 486 Change ThreadSafety of PreferredPlayers from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PreferredPlayers from to ReadOnly
- 209 Add PreferredPlayers
ReportAbuse
Parameters (3) | ||
---|---|---|
player | Player | |
reason | string | |
optionalMessage | string | |
Returns (1) | ||
null |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 5
- 573 Change ReturnType of ReportAbuse from void to null
- 498 Change Parameters of ReportAbuse from (player: Instance, reason: string, optionalMessage: string) to (player: Player, reason: string, optionalMessage: string)
- 462 Change ThreadSafety of ReportAbuse from to Unsafe
- 83 Change Security of ReportAbuse from RobloxScriptSecurity to LocalUserSecurity
- 47 Add ReportAbuse
ReportAbuseV3
Parameters (2) | ||
---|---|---|
player | Player | |
jsonTags | string | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of ReportAbuseV3 from void to null
- 540 Add ReportAbuseV3
ResetLocalPlayer
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
null |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of ResetLocalPlayer from void to null
- 565 Add ResetLocalPlayer
RespawnTime
Type | Default | |
---|---|---|
float |
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
History 4
- 553 Change Default of RespawnTime from to
- 486 Change ThreadSafety of RespawnTime from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RespawnTime from to ReadOnly
- 371 Add RespawnTime
SetChatStyle
Parameters (1) | Default | |
---|---|---|
style | ChatStyle | Classic |
Returns (1) | ||
null |
Security | PluginSecurity |
---|---|
Thread safety | Unsafe |
History 4
- 573 Change ReturnType of SetChatStyle from void to null
- 462 Change ThreadSafety of SetChatStyle from to Unsafe
- 151 Change Security of SetChatStyle from LocalUserSecurity to PluginSecurity
- 47 Add SetChatStyle
SetLocalPlayerInfo
Parameters (5) | ||
---|---|---|
userId | int64 | |
userName | string | |
displayName | string | |
membershipType | MembershipType | |
isUnder13 | bool | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 4
- 573 Change ReturnType of SetLocalPlayerInfo from void to null
- 462 Change ThreadSafety of SetLocalPlayerInfo from to Unsafe
- 427 Change Parameters of SetLocalPlayerInfo from (userId: int64, userName: string, membershipType: MembershipType, isUnder13: bool) to (userId: int64, userName: string, displayName: string, membershipType: MembershipType, isUnder13: bool)
- 374 Add SetLocalPlayerInfo
TeamChat
Parameters (1) | ||
---|---|---|
Returns (1) | ||
null |
Security | PluginSecurity |
---|---|
Thread safety | Unsafe |
UnbanAsync
Parameters (1) | ||
---|---|---|
config | Dictionary | |
Returns (1) | ||
null |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 1
- 622 Add UnbanAsync
UseStrafingAnimations
Type | Default | |
---|---|---|
bool |
This property is not scriptable. It cannot be accessed by script code.
Thread safety | ReadSafe |
---|---|
Category | Behavior |
Loaded/Saved | true |
History 2
- 578 Change Tags of UseStrafingAnimations from [NotReplicated, NotScriptable] to [NotScriptable]
- 553 Add UseStrafingAnimations
UserSubscriptionStatusChanged
Parameters (2) | |
---|---|
user | Player |
subscriptionId | string |
Thread safety | Unsafe |
---|
History 2
- 594 Change Security of UserSubscriptionStatusChanged from RobloxScriptSecurity to None
- 590 Add UserSubscriptionStatusChanged
WhisperChat
Parameters (2) | ||
---|---|---|
player | Instance | |
Returns (1) | ||
null |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 4
- 573 Change ReturnType of WhisperChat from void to null
- 462 Change ThreadSafety of WhisperChat from to Unsafe
- 83 Change Security of WhisperChat from RobloxScriptSecurity to LocalUserSecurity
- 47 Add WhisperChat
getPlayers
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Objects |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPlayers should be used instead.
Thread safety | Unsafe |
---|
History 3
- 553 Change PreferredDescriptor of getPlayers from to GetPlayers
- 462 Change ThreadSafety of getPlayers from to Unsafe
- 49 Add getPlayers
playerFromCharacter
Parameters (1) | ||
---|---|---|
character | Model | |
Returns (1) | ||
Player |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPlayerFromCharacter should be used instead.
Thread safety | Unsafe |
---|
History 6
- 553 Change PreferredDescriptor of playerFromCharacter from to GetPlayerFromCharacter
- 483 Change Parameters of playerFromCharacter from (character: Instance) to (character: Model)
- 483 Change ReturnType of playerFromCharacter from Instance to Player
- 462 Change ThreadSafety of playerFromCharacter from to Unsafe
- 49 Change Tags of playerFromCharacter from [] to [Deprecated]
- 47 Add playerFromCharacter
players
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Objects |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPlayers should be used instead.
Thread safety | Unsafe |
---|
Removed members 19
AddLeaderboardKey
Parameters (1) | ||
---|---|---|
key | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 4
- 258 Remove AddLeaderboardKey
- 257 Add AddLeaderboardKey
- 258 Remove AddLeaderboardKey
- 47 Add AddLeaderboardKey
BlockUser
Parameters (2) | ||
---|---|---|
blockerUserId | int | |
blockeeUserId | int | |
Returns (1) | ||
string |
This function yields. It will block the calling thread until completion.
Security | RobloxScriptSecurity |
---|
GetPlayerByID
Parameters (1) | ||
---|---|---|
userID | int | |
Returns (1) | ||
Instance |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Security | LocalUserSecurity |
---|
History 3
- 310 Remove GetPlayerByID
- 210 Change Tags of GetPlayerByID from [] to [Deprecated]
- 47 Add GetPlayerByID
GetPlayerById
Parameters (1) | ||
---|---|---|
userId | int | |
Returns (1) | ||
Instance |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove GetPlayerById
- 210 Add GetPlayerById
GetUseCoreScriptHealthBar
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
bool |
Security | RobloxScriptSecurity |
---|
History 2
PlayerAddedEarly
Parameters (1) | |
---|---|
player | Instance |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove PlayerAddedEarly
- 47 Add PlayerAddedEarly
PlayerRemovingLate
Parameters (1) | |
---|---|
player | Instance |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove PlayerRemovingLate
- 47 Add PlayerRemovingLate
SetAbuseReportUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | RobloxSecurity |
---|
History 2
- 310 Remove SetAbuseReportUrl
- 47 Add SetAbuseReportUrl
SetBuildToolsUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | RobloxSecurity |
---|
History 2
- 51 Remove SetBuildToolsUrl
- 47 Add SetBuildToolsUrl
SetBuildUserPermissionsUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | RobloxSecurity |
---|
History 2
SetChatFilterUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | RobloxSecurity |
---|
History 2
- 310 Remove SetChatFilterUrl
- 47 Add SetChatFilterUrl
SetLoadDataUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove SetLoadDataUrl
- 47 Add SetLoadDataUrl
SetSaveDataUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove SetSaveDataUrl
- 47 Add SetSaveDataUrl
SetSaveLeaderboardDataUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 4
SetSysStatsUrl
Parameters (1) | ||
---|---|---|
url | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove SetSysStatsUrl
- 47 Add SetSysStatsUrl
SetSysStatsUrlId
Parameters (1) | ||
---|---|---|
urlId | string | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 2
- 310 Remove SetSysStatsUrlId
- 47 Add SetSysStatsUrlId
UnblockUser
Parameters (2) | ||
---|---|---|
exblockerUserId | int | |
exblockeeUserId | int | |
Returns (1) | ||
string |
This function yields. It will block the calling thread until completion.
Security | RobloxScriptSecurity |
---|
History 2
- 284 Remove UnblockUser
- 181 Add UnblockUser
getPlayerFromCharacter
Parameters (1) | ||
---|---|---|
character | Instance | |
Returns (1) | ||
Instance |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safety | Unsafe |
---|
History 3
- 480 Remove getPlayerFromCharacter
- 462 Change ThreadSafety of getPlayerFromCharacter from to Unsafe
- 49 Add getPlayerFromCharacter