Players

Hierarchy

Instance → Players

Tags	Memory category
NotCreatable, Service	Instances

Methods

Returns	Method	Tags	Security	Alias of
`void`	`AddLeaderboardKey` (`key`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`Chat` (`message`: `string`)
			RobloxScriptSecurity
Player	`CreateLocalPlayer` (`userId`: `int`)
			LocalUserSecurity
Player	`GetPlayerByID` (`userID`: `int`)
			LocalUserSecurity
Player	`GetPlayerFromCharacter` (`character`: Instance)

Player	`getPlayerFromCharacter` (`character`: Instance)
		Deprecated		GetPlayerFromCharacter
`Objects`	`GetPlayers` ()

`Objects`	`getPlayers` ()
		Deprecated		GetPlayers
`bool`	`GetUseCoreScriptHealthBar` ()

Player	`playerFromCharacter` (`character`: Instance)
		Deprecated		GetPlayerFromCharacter
`Objects`	`players` ()
		Deprecated		GetPlayers
`void`	`ReportAbuse` (`player`: Instance, `reason`: `string`, `optionalMessage`: `string`)
		Unsupported *	RobloxScriptSecurity
`void`	`SetAbuseReportUrl` (`url`: `string`)
		Unsupported *	RobloxSecurity
`void`	`SetBuildToolsUrl` (`url`: `string`)
		Unsupported *	RobloxSecurity
`void`	`SetBuildUserPermissionsUrl` (`url`: `string`)
		Unsupported *	RobloxSecurity
`void`	`SetChatFilterUrl` (`url`: `string`)
		Unsupported *	RobloxSecurity
`void`	`SetChatStyle` (`style`: Enum.ChatStyle = `Classic`)
			LocalUserSecurity
`void`	`SetLoadDataUrl` (`url`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`SetSaveDataUrl` (`url`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`SetSaveLeaderboardDataUrl` (`url`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`SetSysStatsUrl` (`url`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`SetSysStatsUrlId` (`urlId`: `string`)
		Unsupported *	LocalUserSecurity
`void`	`TeamChat` (`message`: `string`)
			RobloxScriptSecurity
`void`	`WhisperChat` (`message`: `string`, `player`: Instance)
		Unsupported *	RobloxScriptSecurity

Properties

Property	Type	Tags	Read	Write
`BubbleChat`	`bool`	NotReplicated, ReadOnly
`CharacterAutoLoads`	`bool`	NotReplicated
`ClassicChat`	`bool`	NotReplicated, ReadOnly
`LocalPlayer`	`Object`	Hidden, NotReplicated, ReadOnly
`MaxPlayers`	`int`	NotReplicated	RobloxSecurity	RobloxSecurity
`NumPlayers`	`int`	NotReplicated, ReadOnly
`RespawnTime`	`float`

Events

Event	Arguments	Security
`FriendRequestEvent`	(`player`: Instance, `player`: Instance, `FriendRequestEvent`: Enum.FriendRequestEvent)	RobloxScriptSecurity
`GameAnnounce`	(`message`: `string`)	RobloxScriptSecurity
`PlayerAdded`	(`player`: Instance)
`PlayerAddedEarly`	(`player`: Instance)	LocalUserSecurity
`PlayerChatted`	(`chatType`: Enum.PlayerChatType, `player`: Instance, `message`: `string`, `targetPlayer`: Instance)	RobloxScriptSecurity
`PlayerRemoving`	(`player`: Instance)
`PlayerRemovingLate`	(`player`: Instance)	LocalUserSecurity