Players

Class fields

Field	XML type	Value
`Name`	string	Players
`ExplorerOrder`	string	2
`ExplorerImageIndex`	string	21

Properties

BubbleChat

bool

Field	XML type	Value
`Name`	string	BubbleChat

CharacterAutoLoads

bool

Field	XML type	Value
`Name`	string	CharacterAutoLoads
`Browsable`	bool	true
`summary`	string	Set to true, when a player joins a game, they get a character automatically, as well as when they die. When set to false, characters do not auto load and will only load in using Player:LoadCharacter().

ClassicChat

bool

Field	XML type	Value
`Name`	string	ClassicChat

LocalPlayer

Object

Field	XML type	Value
`Name`	string	LocalPlayer

MaxPlayers

int

Field	XML type	Value
`Name`	string	MaxPlayers

MaxPlayersInternal

int

Field	XML type	Value
`Name`	string	MaxPlayersInternal

NumPlayers

int

Field	XML type	Value
`Name`	string	NumPlayers

PreferredPlayers

int

Field	XML type	Value
`Name`	string	PreferredPlayers

PreferredPlayersInternal

int

Field	XML type	Value
`Name`	string	PreferredPlayersInternal

localPlayer

Object

Field	XML type	Value
`Name`	string	localPlayer

numPlayers

int

Field	XML type	Value
`Name`	string	numPlayers

Functions

AddLeaderboardKey

(key: string) → void

Field	XML type	Value
`Name`	string	AddLeaderboardKey

Chat

(message: string) → void

Field	XML type	Value
`Name`	string	Chat

CreateLocalPlayer

(userId: int, isTeleport: bool = …) → Instance

Field	XML type	Value
`Name`	string	CreateLocalPlayer

GetPlayerByID

(userID: int) → Instance

Field	XML type	Value
`Name`	string	GetPlayerByID

GetPlayerById

(userId: int) → Instance

Field	XML type	Value
`Name`	string	GetPlayerById

GetPlayerByUserId

(userId: int) → Instance

Field	XML type	Value
`Name`	string	GetPlayerByUserId

GetPlayerFromCharacter

(character: Instance) → Instance

Field	XML type	Value
`Name`	string	GetPlayerFromCharacter

GetPlayers

() → Objects

Field	XML type	Value
`Name`	string	GetPlayers

GetUseCoreScriptHealthBar

() → bool

Field	XML type	Value
`Name`	string	GetUseCoreScriptHealthBar

ReportAbuse

(player: Instance, reason: string, optionalMessage: string) → void

Field	XML type	Value
`Name`	string	ReportAbuse

SetAbuseReportUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetAbuseReportUrl

SetBuildUserPermissionsUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetBuildUserPermissionsUrl

SetChatFilterUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetChatFilterUrl

SetChatStyle

(style: ChatStyle = …) → void

Field	XML type	Value
`Name`	string	SetChatStyle

SetLoadDataUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetLoadDataUrl

SetSaveDataUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetSaveDataUrl

SetSaveLeaderboardDataUrl

(url: string) → void

Field	XML type	Value
`Name`	string	SetSaveLeaderboardDataUrl

TeamChat

(message: string) → void

Field	XML type	Value
`Name`	string	TeamChat

WhisperChat

(message: string, player: Instance) → void

Field	XML type	Value
`Name`	string	WhisperChat

getPlayerFromCharacter

(character: Instance) → Instance

Field	XML type	Value
`Name`	string	getPlayerFromCharacter

getPlayers

() → Objects

Field	XML type	Value
`Name`	string	getPlayers

playerFromCharacter

(character: Instance) → Instance

Field	XML type	Value
`Name`	string	playerFromCharacter

players

() → Objects

Field	XML type	Value
`Name`	string	players
`Deprecated`	bool	true
`summary`	string	Use GetPlayers() instead

Yield functions

BlockUser

(blockerUserId: int, blockeeUserId: int) → string

Field	XML type	Value
`Name`	string	BlockUser

GetCharacterAppearanceAsync

(userId: int) → Instance

Field	XML type	Value
`Name`	string	GetCharacterAppearanceAsync

GetFriendsAsync

(userId: int) → Instance

Field	XML type	Value
`Name`	string	GetFriendsAsync

GetNameFromUserIdAsync

(userId: int) → string

Field	XML type	Value
`Name`	string	GetNameFromUserIdAsync

GetUserIdFromNameAsync

(userName: string) → int

Field	XML type	Value
`Name`	string	GetUserIdFromNameAsync

UnblockUser

(exblockerUserId: int, exblockeeUserId: int) → string

Field	XML type	Value
`Name`	string	UnblockUser

Events

BlockUserSignal

(blockerUserId: int, blockeeUserId: int, blocking: bool) → void

Field	XML type	Value
`Name`	string	BlockUserSignal

BlockedRequestFinishedSignal

(blockerUserId: int, blockeeUserId: int, didDoRequest: string) → void

Field	XML type	Value
`Name`	string	BlockedRequestFinishedSignal

FriendRequestEvent

(player: Instance, player: Instance, friendRequestEvent: FriendRequestEvent) → void

Field	XML type	Value
`Name`	string	FriendRequestEvent

GameAnnounce

(message: string) → void

Field	XML type	Value
`Name`	string	GameAnnounce

PlayerAdded

(player: Instance) → void

Field	XML type	Value
`Name`	string	PlayerAdded

PlayerAddedEarly

(player: Instance) → void

Field	XML type	Value
`Name`	string	PlayerAddedEarly

PlayerChatted

(chatType: PlayerChatType, player: Instance, message: string, targetPlayer: Instance) → void

Field	XML type	Value
`Name`	string	PlayerChatted

PlayerRemoving

(player: Instance) → void

Field	XML type	Value
`Name`	string	PlayerRemoving

PlayerRemovingLate

(player: Instance) → void

Field	XML type	Value
`Name`	string	PlayerRemovingLate

RequestCloudEditKick

(playerId: int) → void

Field	XML type	Value
`Name`	string	RequestCloudEditKick

RequestCloudEditShutdown

() → void

Field	XML type	Value
`Name`	string	RequestCloudEditShutdown