Reference API Roblox

Engine API

Website

Related

Reference API Roblox

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.
Tags: [NotCreatable, Service]

Member index 63

HistoryMember
553BubbleChat: bool
553CharacterAutoLoads: bool
553ClassicChat: bool
553LocalPlayer: Player
553MaxPlayers: int
553NumPlayers: int
553PreferredPlayers: int
553RespawnTime: float
578UseStrafingAnimations: bool
622BanAsync(config: Dictionary): null
573Chat(message: string): null
498CreateHumanoidModelFromDescription(description: HumanoidDescription, rigType: HumanoidRigType, assetTypeVerification: AssetTypeVerification = Default): Model
498CreateHumanoidModelFromUserId(userId: int64): Model
498CreateLocalPlayer(): Player
625GetBanHistoryAsync(userId: int64): BanHistoryPages
498GetCharacterAppearanceAsync(userId: int64): Model
462GetCharacterAppearanceInfoAsync(userId: int64): Dictionary
498GetFriendsAsync(userId: int64): FriendPages
498GetHumanoidDescriptionFromOutfitId(outfitId: int64): HumanoidDescription
498GetHumanoidDescriptionFromUserId(userId: int64): HumanoidDescription
462GetNameFromUserIdAsync(userId: int64): string
567GetPlayerByUserId(userId: int64): Player
483GetPlayerFromCharacter(character: Model): Player
533GetPlayers(): Objects
462GetUserIdFromNameAsync(userName: string): int64
462GetUserThumbnailAsync(userId: int64, thumbnailType: ThumbnailType, thumbnailSize: ThumbnailSize): Tuple
573ReportAbuse(player: Player, reason: string, optionalMessage: string): null
573ReportAbuseV3(player: Player, jsonTags: string): null
573ResetLocalPlayer(): null
573SetChatStyle(style: ChatStyle = Classic): null
573SetLocalPlayerInfo(userId: int64, userName: string, displayName: string, membershipType: MembershipType, isUnder13: bool): null
573TeamChat(message: string): null
622UnbanAsync(config: Dictionary): null
573WhisperChat(message: string, player: Instance): null
553getPlayers(): Objects
553playerFromCharacter(character: Model): Player
553players(): Objects
483FriendRequestEvent(player: Player, player: Player, friendRequestEvent: FriendRequestEvent)
462GameAnnounce(message: string)
483PlayerAdded(player: Player)
498PlayerChatted(chatType: PlayerChatType, player: Player, message: string, targetPlayer: Player)
498PlayerConnecting(player: Player)
498PlayerDisconnecting(player: Player)
498PlayerMembershipChanged(player: Player)
498PlayerRejoining(player: Player)
483PlayerRemoving(player: Player)
594UserSubscriptionStatusChanged(user: Player, subscriptionId: string)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 19

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

History 267

Members 63

BanAsync

Parameters (1)
configDictionary
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

BubbleChat

TypeDefault
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.

History 4

Tags: [ReadOnly, NotReplicated]

CharacterAutoLoads

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

Chat

Parameters (1)
messagestring
Returns (1)
null

History 5

  • 573 Change ReturnType of Chat from void to null
  • 462 Change ThreadSafety of Chat from to Unsafe
  • 151 Change Security of Chat from LocalUserSecurity to PluginSecurity
  • 83 Change Security of Chat from RobloxScriptSecurity to LocalUserSecurity
  • 47 Add Chat

ClassicChat

TypeDefault
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.

History 4

Tags: [ReadOnly, NotReplicated]

CreateHumanoidModelFromDescription

Parameters (3)Default
descriptionHumanoidDescription
rigTypeHumanoidRigType
assetTypeVerificationAssetTypeVerificationDefault
Returns (1)
Model
This function yields. It will block the calling thread until completion.

History 10

Tags: [Yields]

CreateHumanoidModelFromUserId

Parameters (1)
userIdint64
Returns (1)
Model
This function yields. It will block the calling thread until completion.

History 6

Tags: [Yields]

CreateLocalPlayer

Parameters (0)
No parameters.
Returns (1)
Player

History 7

FriendRequestEvent

Parameters (3)
playerPlayer
playerPlayer
friendRequestEventFriendRequestEvent

History 4

GameAnnounce

Parameters (1)
messagestring

History 2

GetBanHistoryAsync

Parameters (1)
userIdint64
Returns (1)
BanHistoryPages
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetCharacterAppearanceAsync

Parameters (1)
userIdint64
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.

History 5

Tags: [Yields, Deprecated]

GetCharacterAppearanceInfoAsync

Parameters (1)
userIdint64
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetFriendsAsync

Parameters (1)
userIdint64
Returns (1)
FriendPages
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

GetHumanoidDescriptionFromOutfitId

Parameters (1)
outfitIdint64
Returns (1)
HumanoidDescription
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetHumanoidDescriptionFromUserId

Parameters (1)
userIdint64
Returns (1)
HumanoidDescription
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetNameFromUserIdAsync

Parameters (1)
userIdint64
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetPlayerByUserId

Parameters (1)
userIdint64
Returns (1)
Player

History 5

GetPlayerFromCharacter

Parameters (1)
characterModel
Returns (1)
Player

History 4

GetPlayers

Parameters (0)
No parameters.
Returns (1)
Objects

History 3

GetUserIdFromNameAsync

Parameters (1)
userNamestring
Returns (1)
int64
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetUserThumbnailAsync

Parameters (3)
userIdint64
thumbnailTypeThumbnailType
thumbnailSizeThumbnailSize
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 7

Tags: [Yields]

LocalPlayer

TypeDefault
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.

History 9

Tags: [ReadOnly, NotReplicated]

MaxPlayers

TypeDefault
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.

History 7

Tags: [ReadOnly, NotReplicated]

NumPlayers

TypeDefault
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.

History 6

Tags: [ReadOnly, NotReplicated, Deprecated]

PlayerAdded

Parameters (1)
playerPlayer

History 3

PlayerChatted

Parameters (4)
chatTypePlayerChatType
playerPlayer
messagestring
targetPlayerPlayer

History 4

PlayerConnecting

Parameters (1)
playerPlayer

History 3

PlayerDisconnecting

Parameters (1)
playerPlayer

History 3

PlayerMembershipChanged

Parameters (1)
playerPlayer

History 3

PlayerRejoining

Parameters (1)
playerPlayer

History 3

PlayerRemoving

Parameters (1)
playerPlayer

History 3

PreferredPlayers

TypeDefault
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.

History 4

Tags: [ReadOnly, NotReplicated]

ReportAbuse

Parameters (3)
playerPlayer
reasonstring
optionalMessagestring
Returns (1)
null

History 5

ReportAbuseV3

Parameters (2)
playerPlayer
jsonTagsstring
Returns (1)
null

History 2

ResetLocalPlayer

Parameters (0)
No parameters.
Returns (1)
null

History 2

RespawnTime

TypeDefault
float

History 4

SetChatStyle

Parameters (1)Default
styleChatStyleClassic
Returns (1)
null

History 4

SetLocalPlayerInfo

Parameters (5)
userIdint64
userNamestring
displayNamestring
membershipTypeMembershipType
isUnder13bool
Returns (1)
null

History 4

TeamChat

Parameters (1)
messagestring
Returns (1)
null

History 5

UnbanAsync

Parameters (1)
configDictionary
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

UseStrafingAnimations

TypeDefault
bool
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

UserSubscriptionStatusChanged

Parameters (2)
userPlayer
subscriptionIdstring

History 2

WhisperChat

Parameters (2)
messagestring
playerInstance
Returns (1)
null

History 4

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.

History 3

Tags: [Deprecated]

playerFromCharacter

Parameters (1)
characterModel
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.

History 6

Tags: [Deprecated]

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.

History 3

Tags: [Deprecated]

Removed members 19

AddLeaderboardKey

Parameters (1)
keystring
Returns (1)
void

History 4

BlockUser

Parameters (2)
blockerUserIdint
blockeeUserIdint
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetPlayerByID

Parameters (1)
userIDint
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

GetPlayerById

Parameters (1)
userIdint
Returns (1)
Instance

History 2

GetUseCoreScriptHealthBar

Parameters (0)
No parameters.
Returns (1)
bool

History 2

PlayerAddedEarly

Parameters (1)
playerInstance

History 2

PlayerRemovingLate

Parameters (1)
playerInstance

History 2

SetAbuseReportUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetBuildToolsUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetBuildUserPermissionsUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetChatFilterUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetLoadDataUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetSaveDataUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetSaveLeaderboardDataUrl

Parameters (1)
urlstring
Returns (1)
void

History 4

SetSysStatsUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetSysStatsUrlId

Parameters (1)
urlIdstring
Returns (1)
void

History 2

UnblockUser

Parameters (2)
exblockerUserIdint
exblockeeUserIdint
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

getPlayerFromCharacter

Parameters (1)
characterInstance
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Settings