Player On DevHub

Summary

Memory Category	Instances
ExplorerImageIndex	12 ()
ExplorerOrder	10
Insertable	false

Inherits (1)

Instance

Member index (109)

Type	Member	History
int	AccountAge
bool	AppearanceDidLoad	218 469
bool	AutoJumpEnabled	206
float	CameraMaxZoomDistance	147
float	CameraMinZoomDistance	147
CameraMode	CameraMode	50 49 50
bool	CanLoadCharacterAppearance	68
Model	Character	329
string	CharacterAppearance	292
int64	CharacterAppearanceId	250 323
ChatMode	ChatMode	469
int	DataComplexity	252 469
int	DataComplexityLimit	252 469 469
bool	DataReady	252 469
DevCameraOcclusionMode	DevCameraOcclusionMode	177 176 177
DevComputerCameraMovementMode	DevComputerCameraMode	177 176 177
DevComputerMovementMode	DevComputerMovementMode	177 176 177
bool	DevEnableMouseLock	177 176 177 576
DevTouchCameraMovementMode	DevTouchCameraMode	177 176 177
DevTouchMovementMode	DevTouchMovementMode	177 176 177
string	DisplayName	291 428 428
int64	FollowUserId	169 323
bool	GameplayPaused	384 386 386 386
bool	Guest	469
bool	HasVerifiedBadge	554
float	HealthDisplayDistance	147
string	LocaleId	338
float	MaximumSimulationRadius	125 469 469
MembershipType	MembershipType
float	NameDisplayDistance	147
bool	Neutral
string	OsPlatform	293 451 451 469 469
string	PlatformName	423 469
Instance	ReplicationFocus	313 329
SpawnLocation	RespawnLocation	182 329
float	SimulationRadius	61 469
Team	Team	250 329
BrickColor	TeamColor
bool	Teleported	205
bool	TeleportedIn	215 469
bool	UnfilteredChat	547
int64	UserId	210 323
string	VRDevice	235 469
bool	VREnabled	557
int64	userId	213 323
null	AddToBlockList (Array userIds)	344 573
null	ClearCharacterAppearance ()	68 573
float	DistanceFromCharacter (Vector3 point)
FriendStatus	GetFriendStatus (Player player)	483
Array	GetFriendsOnline (int maxFriends = 200)	119 204 204
string	GetGameSessionID ()	133
Dictionary	GetJoinData ()	333
Mouse	GetMouse ()	71 483
float	GetNetworkPing ()	481 488
int	GetRankInGroup (int64 groupId)	69 323
string	GetRoleInGroup (int64 groupId)	69 323
bool	GetUnder13 ()	83
bool	HasAppearanceLoaded ()	218
bool	IsBestFriendsWith (int64 userId)	206 323
bool	IsFriendsWith (int64 userId)	323
bool	IsInGroup (int64 groupId)	323
bool	IsVerified ()	573
null	Kick (string message = )	121 196 573
bool	LoadBoolean (string key)	252
null	LoadCharacter ()	55 250 290 573
null	LoadCharacterAppearance (Instance assetInstance)	68 373 573
null	LoadCharacterBlocking ()	288 573
null	LoadCharacterWithHumanoidDescription (HumanoidDescription humanoidDescription)	363 483 573
null	LoadData ()	252 573
Instance	LoadInstance (string key)	252
double	LoadNumber (string key)	60 252
string	LoadString (string key)	252
null	Move (Vector3 walkDirection, bool relativeToCamera = false)	163 573
null	RemoveCharacter ()	573
null	RequestFriendship (Player player)	483 573
null	RequestStreamAroundAsync (Vector3 position, double timeOut = 0)	429 428 429 573
null	RevokeFriendship (Player player)	483 573
null	SaveBoolean (string key, bool value)	252 573
null	SaveData ()	252 573
null	SaveInstance (string key, Instance value)	252 573
null	SaveNumber (string key, double value)	60 252 573
null	SaveString (string key, string value)	252 573
null	SetAccountAge (int accountAge)	151 573
null	SetCharacterAppearanceJson (string jsonBlob)	479 573
null	SetExperienceSettingsLocaleId (string locale)	546 573
null	SetMembershipType (MembershipType membershipType)	573
null	SetModerationAccessKey (string moderationAccessKey)	538 573
null	SetSuperSafeChat (bool value)	151 573
null	SetUnder13 (bool value)	83 573
null	UpdatePlayerBlocked (int64 userId, bool blocked)	344 573
bool	WaitForDataReady ()	252
bool	isFriendsWith (int64 userId)	61 323
bool	loadBoolean (string key)	61
Instance	loadInstance (string key)	61
double	loadNumber (string key)	50 49 50 60
string	loadString (string key)	61
null	saveBoolean (string key, bool value)	61 573
null	saveInstance (string key, Instance value)	61 573
null	saveNumber (string key, double value)	61 573
null	saveString (string key, string value)	61 573
bool	waitForDataReady ()	50 49 50
	CharacterAdded (Model character)	483
	CharacterAppearanceLoaded (Model character)	210 483
	CharacterRemoving (Model character)	483
	Chatted (string message, Player recipient)	483
	FriendStatusChanged (Player player, FriendStatus friendStatus)	483
	Idled (double time)
	OnTeleport (TeleportState teleportState, int64 placeId, string spawnName)	130 322
	SimulationRadiusChanged (float radius)	138
55 members inherited from Instance

Removed member index (17)

Type	Member	History
string	ClanTag	147 180
bool	HasBuildTools	273 272 273
float	MaxSimulationRadius	64 125
int	PersonalServerRank	273 272 273
PlayerJoinData	PlayerJoinData	331 335
string	BlockUser (Instance player)	270 295 310
string	GetWebPersonalServerRank ()	79 78 79 273 272 273
bool	HasBuildPermission (BuildPermission role)	52
bool	IsUserAvailableForExperiment ()	296 535
void	JumpCharacter ()	131 338
void	MoveCharacter (Vector2 walkDirection, float maxWalkDelta)	131 338
void	SaveLeaderboardData ()	252 258 257 258
void	SetClanTag (string newClanTag)	145 151 180
bool	SetWebPersonalServerRank (int rank)	71 273 272 273
string	UnblockUser (Instance player)	270 295 310
	HoverOnPlayerChanged (Instance playerHoveredOn)	90
	MouseDownOnPlayer (Instance playerMouseDownOn)	90

576 Change Tags of Player.DevEnableMouseLock from [] to [Deprecated]
573 Change ReturnType of Player.AddToBlockList from void to null
573 Change ReturnType of Player.ClearCharacterAppearance from void to null
573 Add Player.IsVerified
573 Change ReturnType of Player.Kick from void to null
573 Change ReturnType of Player.LoadCharacter from void to null
573 Change ReturnType of Player.LoadCharacterAppearance from void to null
573 Change ReturnType of Player.LoadCharacterBlocking from void to null
573 Change ReturnType of Player.LoadCharacterWithHumanoidDescription from void to null
573 Change ReturnType of Player.LoadData from void to null
573 Change ReturnType of Player.Move from void to null
573 Change ReturnType of Player.RemoveCharacter from void to null
573 Change ReturnType of Player.RequestFriendship from void to null
573 Change ReturnType of Player.RequestStreamAroundAsync from void to null
573 Change ReturnType of Player.RevokeFriendship from void to null
573 Change ReturnType of Player.SaveBoolean from void to null
573 Change ReturnType of Player.SaveData from void to null
573 Change ReturnType of Player.SaveInstance from void to null
573 Change ReturnType of Player.SaveNumber from void to null
573 Change ReturnType of Player.SaveString from void to null
573 Change ReturnType of Player.SetAccountAge from void to null
573 Change ReturnType of Player.SetCharacterAppearanceJson from void to null
573 Change ReturnType of Player.SetExperienceSettingsLocaleId from void to null
573 Change ReturnType of Player.SetMembershipType from void to null
573 Change ReturnType of Player.SetModerationAccessKey from void to null
573 Change ReturnType of Player.SetSuperSafeChat from void to null
573 Change ReturnType of Player.SetUnder13 from void to null
573 Change ReturnType of Player.UpdatePlayerBlocked from void to null
573 Change ReturnType of Player.saveBoolean from void to null
573 Change ReturnType of Player.saveInstance from void to null
573 Change ReturnType of Player.saveNumber from void to null
573 Change ReturnType of Player.saveString from void to null
557 Add Player.VREnabled
554 Add Player.HasVerifiedBadge
547 Add Player.UnfilteredChat
546 Add Player.SetExperienceSettingsLocaleId
538 Add Player.SetModerationAccessKey
535 Remove Player.IsUserAvailableForExperiment
488 Change ReturnType of Player.GetNetworkPing from int to float
483 Change Parameters of Player.GetFriendStatus from (Instance player) to (Player player)
483 Change ReturnType of Player.GetMouse from Instance to Mouse
483 Change Parameters of Player.LoadCharacterWithHumanoidDescription from (Instance humanoidDescription) to (HumanoidDescription humanoidDescription)
483 Change Parameters of Player.RequestFriendship from (Instance player) to (Player player)
483 Change Parameters of Player.RevokeFriendship from (Instance player) to (Player player)
483 Change Parameters of Player.CharacterAdded from (Instance character) to (Model character)
483 Change Parameters of Player.CharacterAppearanceLoaded from (Instance character) to (Model character)
483 Change Parameters of Player.CharacterRemoving from (Instance character) to (Model character)
483 Change Parameters of Player.Chatted from (string message, Instance recipient) to (string message, Player recipient)
483 Change Parameters of Player.FriendStatusChanged from (Instance player, FriendStatus friendStatus) to (Player player, FriendStatus friendStatus)
481 Add Player.GetNetworkPing
479 Add Player.SetCharacterAppearanceJson
469 Change Tags of Player.AppearanceDidLoad from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
469 Change Tags of Player.ChatMode from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of Player.DataComplexity from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
469 Change CanLoad of Player.DataComplexityLimit from true to false
469 Change Tags of Player.DataComplexityLimit from [NotReplicated, Deprecated] to [Hidden, NotReplicated, Deprecated]
469 Change Tags of Player.DataReady from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
469 Change Tags of Player.Guest from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change CanLoad of Player.MaximumSimulationRadius from true to false
469 Change Tags of Player.MaximumSimulationRadius from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of Player.OsPlatform from true to false
469 Change Tags of Player.OsPlatform from [NotReplicated] to [Hidden, NotReplicated]
469 Change Tags of Player.PlatformName from [] to [Hidden]
469 Change Tags of Player.SimulationRadius from [] to [Hidden]
469 Change Tags of Player.TeleportedIn from [] to [Hidden]
469 Change Tags of Player.VRDevice from [] to [Hidden]
451 Change CanLoad of Player.OsPlatform from false to true
451 Change Tags of Player.OsPlatform from [] to [NotReplicated]
429 Add Player.RequestStreamAroundAsync
428 Remove Player.RequestStreamAroundAsync
429 Add Player.RequestStreamAroundAsync
428 Change ReadSecurity of Player.DisplayName from RobloxScriptSecurity to None
428 Change WriteSecurity of Player.DisplayName from RobloxScriptSecurity to None
423 Add Player.PlatformName
386 Change WriteSecurity of Player.GameplayPaused from None to NotAccessibleSecurity
386 Change CanLoad of Player.GameplayPaused from false to true
386 Change Tags of Player.GameplayPaused from [ReadOnly, NotReplicated] to []
384 Add Player.GameplayPaused
373 Change Tags of Player.LoadCharacterAppearance from [] to [Deprecated]
363 Add Player.LoadCharacterWithHumanoidDescription
344 Add Player.AddToBlockList
344 Add Player.UpdatePlayerBlocked
338 Add Player.LocaleId
338 Remove Player.JumpCharacter
338 Remove Player.MoveCharacter
335 Remove Player.PlayerJoinData
333 Add Player.GetJoinData
331 Add Player.PlayerJoinData
329 Change ValueType of Player.Character from Object to Model
329 Change ValueType of Player.ReplicationFocus from Object to Instance
329 Change ValueType of Player.RespawnLocation from Object to SpawnLocation
329 Change ValueType of Player.Team from Object to Team
323 Change ValueType of Player.CharacterAppearanceId from int to int64
323 Change ValueType of Player.FollowUserId from int to int64
323 Change ValueType of Player.UserId from int to int64
323 Change ValueType of Player.userId from int to int64
323 Change Parameters of Player.GetRankInGroup from (int groupId) to (int64 groupId)
323 Change Parameters of Player.GetRoleInGroup from (int groupId) to (int64 groupId)
323 Change Parameters of Player.IsBestFriendsWith from (int userId) to (int64 userId)
323 Change Parameters of Player.IsFriendsWith from (int userId) to (int64 userId)
323 Change Parameters of Player.IsInGroup from (int groupId) to (int64 groupId)
323 Change Parameters of Player.isFriendsWith from (int userId) to (int64 userId)
322 Change Parameters of Player.OnTeleport from (TeleportState teleportState, int placeId, string spawnName) to (TeleportState teleportState, int64 placeId, string spawnName)
313 Add Player.ReplicationFocus
310 Remove Player.BlockUser
310 Remove Player.UnblockUser
296 Add Player.IsUserAvailableForExperiment
295 Change Tags of Player.BlockUser from [Yields] to [Yields, Deprecated]
295 Change Tags of Player.UnblockUser from [Yields] to [Yields, Deprecated]
293 Add Player.OsPlatform
292 Change Tags of Player.CharacterAppearance from [NotBrowsable] to [NotBrowsable, Deprecated]
291 Add Player.DisplayName
290 Change Parameters of Player.LoadCharacter from (bool inGame = true) to ()
288 Add Player.LoadCharacterBlocking
273 Remove Player.HasBuildTools
273 Remove Player.PersonalServerRank
273 Remove Player.GetWebPersonalServerRank
273 Remove Player.SetWebPersonalServerRank
272 Add Player.HasBuildTools
272 Add Player.PersonalServerRank
272 Add Player.GetWebPersonalServerRank
272 Add Player.SetWebPersonalServerRank
273 Remove Player.HasBuildTools
273 Remove Player.PersonalServerRank
273 Remove Player.GetWebPersonalServerRank
273 Remove Player.SetWebPersonalServerRank
270 Add Player.BlockUser
270 Add Player.UnblockUser
258 Remove Player.SaveLeaderboardData
257 Add Player.SaveLeaderboardData
258 Remove Player.SaveLeaderboardData
252 Change Tags of Player.DataComplexity from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
252 Change Tags of Player.DataComplexityLimit from [NotReplicated] to [NotReplicated, Deprecated]
252 Change Tags of Player.DataReady from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
252 Change Tags of Player.LoadBoolean from [] to [Deprecated]
252 Change Tags of Player.LoadData from [] to [Deprecated]
252 Change Tags of Player.LoadInstance from [] to [Deprecated]
252 Change Tags of Player.LoadNumber from [] to [Deprecated]
252 Change Tags of Player.LoadString from [] to [Deprecated]
252 Change Tags of Player.SaveBoolean from [] to [Deprecated]
252 Change Tags of Player.SaveData from [] to [Deprecated]
252 Change Tags of Player.SaveInstance from [] to [Deprecated]
252 Change Tags of Player.SaveLeaderboardData from [] to [Deprecated]
252 Change Tags of Player.SaveNumber from [] to [Deprecated]
252 Change Tags of Player.SaveString from [] to [Deprecated]
252 Change Tags of Player.WaitForDataReady from [Yields] to [Yields, Deprecated]
250 Add Player.CharacterAppearanceId
250 Add Player.Team
250 Change Tags of Player.LoadCharacter from [] to [Yields]
235 Add Player.VRDevice
218 Change Tags of Player.AppearanceDidLoad from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
218 Add Player.HasAppearanceLoaded
215 Add Player.TeleportedIn
213 Change Tags of Player.userId from [] to [Deprecated]
210 Add Player.UserId
210 Add Player.CharacterAppearanceLoaded
206 Add Player.AutoJumpEnabled
206 Change Tags of Player.IsBestFriendsWith from [Yields] to [Yields, Deprecated]
205 Add Player.Teleported
204 Change Parameters of Player.GetFriendsOnline from (int maxFriends = 50) to (int maxFriends = 200)
204 Change ReturnType of Player.GetFriendsOnline from Dictionary to Array
196 Change Parameters of Player.Kick from () to (string message = )
182 Add Player.RespawnLocation
180 Remove Player.ClanTag
180 Remove Player.SetClanTag
177 Add Player.DevCameraOcclusionMode
177 Add Player.DevComputerCameraMode
177 Add Player.DevComputerMovementMode
177 Add Player.DevEnableMouseLock
177 Add Player.DevTouchCameraMode
177 Add Player.DevTouchMovementMode
176 Remove Player.DevCameraOcclusionMode
176 Remove Player.DevComputerCameraMode
176 Remove Player.DevComputerMovementMode
176 Remove Player.DevEnableMouseLock
176 Remove Player.DevTouchCameraMode
176 Remove Player.DevTouchMovementMode
177 Add Player.DevCameraOcclusionMode
177 Add Player.DevComputerCameraMode
177 Add Player.DevComputerMovementMode
177 Add Player.DevEnableMouseLock
177 Add Player.DevTouchCameraMode
177 Add Player.DevTouchMovementMode
169 Add Player.FollowUserId
163 Add Player.Move
151 Change Security of Player.SetAccountAge from LocalUserSecurity to PluginSecurity
151 Change Security of Player.SetClanTag from LocalUserSecurity to PluginSecurity
151 Change Security of Player.SetSuperSafeChat from LocalUserSecurity to PluginSecurity
147 Add Player.CameraMaxZoomDistance
147 Add Player.CameraMinZoomDistance
147 Add Player.ClanTag
147 Add Player.HealthDisplayDistance
147 Add Player.NameDisplayDistance
145 Add Player.SetClanTag
138 Add Player.SimulationRadiusChanged
133 Add Player.GetGameSessionID
131 Add Player.JumpCharacter
131 Add Player.MoveCharacter
130 Add Player.OnTeleport
125 Remove Player.MaxSimulationRadius
125 Add Player.MaximumSimulationRadius
121 Add Player.Kick
119 Add Player.GetFriendsOnline
90 Remove Player.HoverOnPlayerChanged
90 Remove Player.MouseDownOnPlayer
83 Add Player.GetUnder13
83 Change Security of Player.SetUnder13 from LocalUserSecurity to RobloxSecurity
79 Change Tags of Player.GetWebPersonalServerRank from [Yields] to [backend, Yields]
78 Change Tags of Player.GetWebPersonalServerRank from [backend, Yields] to [Yields]
79 Change Tags of Player.GetWebPersonalServerRank from [Yields] to [backend, Yields]
71 Add Player.GetMouse
71 Change Parameters of Player.SetWebPersonalServerRank from (int Rank) to (int rank)
69 Add Player.GetRankInGroup
69 Add Player.GetRoleInGroup
68 Add Player.CanLoadCharacterAppearance
68 Add Player.ClearCharacterAppearance
68 Add Player.LoadCharacterAppearance
64 Add Player.MaxSimulationRadius
61 Add Player.SimulationRadius
61 Add Player.isFriendsWith
61 Add Player.loadBoolean
61 Add Player.loadInstance
61 Add Player.loadString
61 Add Player.saveBoolean
61 Add Player.saveInstance
61 Add Player.saveNumber
61 Add Player.saveString
60 Change ReturnType of Player.LoadNumber from float to double
60 Change Parameters of Player.SaveNumber from (string key, float value) to (string key, double value)
60 Change ReturnType of Player.loadNumber from float to double
55 Change Security of Player.LoadCharacter from LocalUserSecurity to None
52 Remove Player.HasBuildPermission
50 Add Player.CameraMode
50 Add Player.loadNumber
50 Add Player.waitForDataReady
49 Remove Player.CameraMode
49 Remove Player.loadNumber
49 Remove Player.waitForDataReady
50 Add Player.CameraMode
50 Add Player.loadNumber
50 Add Player.waitForDataReady

Members

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

Value Type	int
Category	Data
Can Load	false
Can Save	false

Tags: [ReadOnly, NotReplicated]

AddToBlockList On DevHub

Parameters	1

Name	Type	Default
userIds	Array	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.AddToBlockList from void to null
344 Add Player.AddToBlockList

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

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.AppearanceDidLoad from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
218 Change Tags of Player.AppearanceDidLoad from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

AutoJumpEnabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

206 Add Player.AutoJumpEnabled

CameraMaxZoomDistance On DevHub

Value Type	float
Category	Camera
Can Load	true
Can Save	true

History

147 Add Player.CameraMaxZoomDistance

CameraMinZoomDistance On DevHub

Value Type	float
Category	Camera
Can Load	true
Can Save	true

History

147 Add Player.CameraMinZoomDistance

CameraMode On DevHub

Value Type	CameraMode
Category	Camera
Can Load	true
Can Save	true

History

CanLoadCharacterAppearance On DevHub

Value Type	bool
Category	Behavior
Can Load	false
Can Save	false

History

68 Add Player.CanLoadCharacterAppearance

Character On DevHub

Value Type	Model
Category	Data
Can Load	true
Can Save	true

History

329 Change ValueType of Player.Character from Object to Model

CharacterAdded On DevHub

Parameters	1

Name	Type	Default
character	Model	none

History

483 Change Parameters of Player.CharacterAdded from (Instance character) to (Model character)

CharacterAppearance On DevHub

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

This item is not browsable. It is not visible in Studio's object browser.

Value Type	string
Category	Data
Can Load	true
Can Save	true
PreferredParent	Model

History

292 Change Tags of Player.CharacterAppearance from [NotBrowsable] to [NotBrowsable, Deprecated]

Tags: [NotBrowsable, Deprecated]

CharacterAppearanceId On DevHub

Value Type	int64
Category	Data
Can Load	true
Can Save	true

History

323 Change ValueType of Player.CharacterAppearanceId from int to int64
250 Add Player.CharacterAppearanceId

CharacterAppearanceLoaded On DevHub

Parameters	1

Name	Type	Default
character	Model	none

History

483 Change Parameters of Player.CharacterAppearanceLoaded from (Instance character) to (Model character)
210 Add Player.CharacterAppearanceLoaded

CharacterRemoving On DevHub

Parameters	1

Name	Type	Default
character	Model	none

History

483 Change Parameters of Player.CharacterRemoving from (Instance character) to (Model character)

ChatMode 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 not replicated. Its interface does not cross the network boundary.

Value Type	ChatMode
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.ChatMode from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]

Tags: [Hidden, ReadOnly, NotReplicated]

Chatted On DevHub

Parameters	2

Name	Type	Default
message	string	none
recipient	Player	none

History

483 Change Parameters of Player.Chatted from (string message, Instance recipient) to (string message, Player recipient)

ClearCharacterAppearance On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Player.ClearCharacterAppearance from void to null
68 Add Player.ClearCharacterAppearance

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

Value Type	int
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.DataComplexity from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
252 Change Tags of Player.DataComplexity from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

DataComplexityLimit On DevHub

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.

Value Type	int
Security	LocalUserSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of Player.DataComplexityLimit from true to false
469 Change Tags of Player.DataComplexityLimit from [NotReplicated, Deprecated] to [Hidden, NotReplicated, Deprecated]
252 Change Tags of Player.DataComplexityLimit from [NotReplicated] to [NotReplicated, Deprecated]

Tags: [Hidden, NotReplicated, Deprecated]

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

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.DataReady from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
252 Change Tags of Player.DataReady from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

DevCameraOcclusionMode On DevHub

Value Type	DevCameraOcclusionMode
Category	Camera
Can Load	true
Can Save	true

History

177 Add Player.DevCameraOcclusionMode
176 Remove Player.DevCameraOcclusionMode
177 Add Player.DevCameraOcclusionMode

DevComputerCameraMode On DevHub

Value Type	DevComputerCameraMovementMode
Category	Camera
Can Load	true
Can Save	true

History

DevComputerMovementMode On DevHub

Value Type	DevComputerMovementMode
Category	Control
Can Load	true
Can Save	true

History

177 Add Player.DevComputerMovementMode
176 Remove Player.DevComputerMovementMode
177 Add Player.DevComputerMovementMode

DevEnableMouseLock On DevHub

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

Value Type	bool
Category	Camera
Can Load	true
Can Save	true

History

576 Change Tags of Player.DevEnableMouseLock from [] to [Deprecated]
177 Add Player.DevEnableMouseLock
176 Remove Player.DevEnableMouseLock
177 Add Player.DevEnableMouseLock

Tags: [Deprecated]

DevTouchCameraMode On DevHub

Value Type	DevTouchCameraMovementMode
Category	Camera
Can Load	true
Can Save	true

History

DevTouchMovementMode On DevHub

Value Type	DevTouchMovementMode
Category	Control
Can Load	true
Can Save	true

History

DisplayName On DevHub

Value Type	string
Category	Data
Can Load	false
Can Save	false

History

428 Change ReadSecurity of Player.DisplayName from RobloxScriptSecurity to None
428 Change WriteSecurity of Player.DisplayName from RobloxScriptSecurity to None
291 Add Player.DisplayName

DistanceFromCharacter On DevHub

Parameters	1

Name	Type	Default
point	Vector3	none

Return Type	float

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

Value Type	int64
Category	Data
Can Load	false
Can Save	true

History

323 Change ValueType of Player.FollowUserId from int to int64
169 Add Player.FollowUserId

Tags: [ReadOnly, NotReplicated]

FriendStatusChanged On DevHub

Parameters	2

Name	Type	Default
player	Player	none
friendStatus	FriendStatus	none

Security	RobloxScriptSecurity

History

483 Change Parameters of Player.FriendStatusChanged from (Instance player, FriendStatus friendStatus) to (Player player, FriendStatus friendStatus)

GameplayPaused On DevHub

Value Type	bool
Write Security	NotAccessibleSecurity
Category	Behavior
Can Load	true
Can Save	true

History

386 Change WriteSecurity of Player.GameplayPaused from None to NotAccessibleSecurity
386 Change CanLoad of Player.GameplayPaused from false to true
386 Change Tags of Player.GameplayPaused from [ReadOnly, NotReplicated] to []
384 Add Player.GameplayPaused

GetFriendStatus On DevHub

Parameters	1

Name	Type	Default
player	Player	none

Return Type	FriendStatus
Security	RobloxScriptSecurity

History

483 Change Parameters of Player.GetFriendStatus from (Instance player) to (Player player)

GetFriendsOnline On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
maxFriends	int	200

Return Type	Array

History

204 Change Parameters of Player.GetFriendsOnline from (int maxFriends = 50) to (int maxFriends = 200)
204 Change ReturnType of Player.GetFriendsOnline from Dictionary to Array
119 Add Player.GetFriendsOnline

Tags: [Yields]

GetGameSessionID On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxSecurity

History

133 Add Player.GetGameSessionID

GetJoinData On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary

History

333 Add Player.GetJoinData

GetMouse On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Mouse

History

483 Change ReturnType of Player.GetMouse from Instance to Mouse
71 Add Player.GetMouse

GetNetworkPing On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	float

History

488 Change ReturnType of Player.GetNetworkPing from int to float
481 Add Player.GetNetworkPing

GetRankInGroup On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
groupId	int64	none

Return Type	int

History

323 Change Parameters of Player.GetRankInGroup from (int groupId) to (int64 groupId)
69 Add Player.GetRankInGroup

Tags: [Yields]

GetRoleInGroup On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
groupId	int64	none

Return Type	string

History

323 Change Parameters of Player.GetRoleInGroup from (int groupId) to (int64 groupId)
69 Add Player.GetRoleInGroup

Tags: [Yields]

GetUnder13 On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

83 Add Player.GetUnder13

Guest 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 not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.Guest from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]

Tags: [Hidden, ReadOnly, NotReplicated]

HasAppearanceLoaded On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

218 Add Player.HasAppearanceLoaded

HasVerifiedBadge On DevHub

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

554 Add Player.HasVerifiedBadge

HealthDisplayDistance On DevHub

Value Type	float
Category	Camera
Can Load	true
Can Save	true

History

147 Add Player.HealthDisplayDistance

Idled On DevHub

Parameters	1

Name	Type	Default
time	double	none

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

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool

History

323 Change Parameters of Player.IsBestFriendsWith from (int userId) to (int64 userId)
206 Change Tags of Player.IsBestFriendsWith from [Yields] to [Yields, Deprecated]

Tags: [Yields, Deprecated]

IsFriendsWith On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool

History

323 Change Parameters of Player.IsFriendsWith from (int userId) to (int64 userId)

Tags: [Yields]

IsInGroup On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
groupId	int64	none

Return Type	bool

History

323 Change Parameters of Player.IsInGroup from (int groupId) to (int64 groupId)

Tags: [Yields]

IsVerified On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

573 Add Player.IsVerified

Kick On DevHub

Parameters	1

Name	Type	Default
message	string

Return Type	null

History

573 Change ReturnType of Player.Kick from void to null
196 Change Parameters of Player.Kick from () to (string message = )
121 Add Player.Kick

LoadBoolean On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	bool

History

252 Change Tags of Player.LoadBoolean from [] to [Deprecated]

Tags: [Deprecated]

LoadCharacter On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Player.LoadCharacter from void to null
290 Change Parameters of Player.LoadCharacter from (bool inGame = true) to ()
250 Change Tags of Player.LoadCharacter from [] to [Yields]
55 Change Security of Player.LoadCharacter from LocalUserSecurity to None

Tags: [Yields]

LoadCharacterAppearance On DevHub

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

Parameters	1

Name	Type	Default
assetInstance	Instance	none

Return Type	null

History

573 Change ReturnType of Player.LoadCharacterAppearance from void to null
373 Change Tags of Player.LoadCharacterAppearance from [] to [Deprecated]
68 Add Player.LoadCharacterAppearance

Tags: [Deprecated]

LoadCharacterBlocking On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	LocalUserSecurity

History

573 Change ReturnType of Player.LoadCharacterBlocking from void to null
288 Add Player.LoadCharacterBlocking

Tags: [Yields]

LoadCharacterWithHumanoidDescription On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
humanoidDescription	HumanoidDescription	none

Return Type	null

History

573 Change ReturnType of Player.LoadCharacterWithHumanoidDescription from void to null
483 Change Parameters of Player.LoadCharacterWithHumanoidDescription from (Instance humanoidDescription) to (HumanoidDescription humanoidDescription)
363 Add Player.LoadCharacterWithHumanoidDescription

Tags: [Yields]

LoadData On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	LocalUserSecurity

History

573 Change ReturnType of Player.LoadData from void to null
252 Change Tags of Player.LoadData from [] to [Deprecated]

Tags: [Deprecated]

LoadInstance On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	Instance

History

252 Change Tags of Player.LoadInstance from [] to [Deprecated]

Tags: [Deprecated]

LoadNumber On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	double

History

252 Change Tags of Player.LoadNumber from [] to [Deprecated]
60 Change ReturnType of Player.LoadNumber from float to double

Tags: [Deprecated]

LoadString On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	string

History

252 Change Tags of Player.LoadString from [] to [Deprecated]

Tags: [Deprecated]

LocaleId 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 not replicated. Its interface does not cross the network boundary.

Value Type	string
Category	Data
Can Load	false
Can Save	false

History

338 Add Player.LocaleId

Tags: [Hidden, ReadOnly, NotReplicated]

MaximumSimulationRadius On DevHub

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

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

Value Type	float
Security	LocalUserSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of Player.MaximumSimulationRadius from true to false
469 Change Tags of Player.MaximumSimulationRadius from [NotReplicated] to [Hidden, NotReplicated]
125 Add Player.MaximumSimulationRadius

Tags: [Hidden, NotReplicated]

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

Value Type	MembershipType
Category	Data
Can Load	false
Can Save	false

Tags: [ReadOnly, NotReplicated]

Move On DevHub

Parameters	2

Name	Type	Default
walkDirection	Vector3	none
relativeToCamera	bool	false

Return Type	null

History

573 Change ReturnType of Player.Move from void to null
163 Add Player.Move

NameDisplayDistance On DevHub

Value Type	float
Category	Camera
Can Load	true
Can Save	true

History

147 Add Player.NameDisplayDistance

Neutral On DevHub

Value Type	bool
Category	Team
Can Load	true
Can Save	true

OnTeleport On DevHub

Parameters	3

Name	Type	Default
teleportState	TeleportState	none
placeId	int64	none
spawnName	string	none

History

322 Change Parameters of Player.OnTeleport from (TeleportState teleportState, int placeId, string spawnName) to (TeleportState teleportState, int64 placeId, string spawnName)
130 Add Player.OnTeleport

OsPlatform On DevHub

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

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

Value Type	string
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of Player.OsPlatform from true to false
469 Change Tags of Player.OsPlatform from [NotReplicated] to [Hidden, NotReplicated]
451 Change CanLoad of Player.OsPlatform from false to true
451 Change Tags of Player.OsPlatform from [] to [NotReplicated]
293 Add Player.OsPlatform

Tags: [Hidden, NotReplicated]

PlatformName On DevHub

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

Value Type	string
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.PlatformName from [] to [Hidden]
423 Add Player.PlatformName

Tags: [Hidden]

RemoveCharacter On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	LocalUserSecurity

History

573 Change ReturnType of Player.RemoveCharacter from void to null

ReplicationFocus On DevHub

Value Type	Instance
Category	Data
Can Load	true
Can Save	true

History

329 Change ValueType of Player.ReplicationFocus from Object to Instance
313 Add Player.ReplicationFocus

RequestFriendship On DevHub

Parameters	1

Name	Type	Default
player	Player	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.RequestFriendship from void to null
483 Change Parameters of Player.RequestFriendship from (Instance player) to (Player player)

RequestStreamAroundAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
position	Vector3	none
timeOut	double	0

Return Type	null

History

573 Change ReturnType of Player.RequestStreamAroundAsync from void to null
429 Add Player.RequestStreamAroundAsync
428 Remove Player.RequestStreamAroundAsync
429 Add Player.RequestStreamAroundAsync

Tags: [Yields]

RespawnLocation On DevHub

Value Type	SpawnLocation
Category	Data
Can Load	true
Can Save	true

History

329 Change ValueType of Player.RespawnLocation from Object to SpawnLocation
182 Add Player.RespawnLocation

RevokeFriendship On DevHub

Parameters	1

Name	Type	Default
player	Player	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.RevokeFriendship from void to null
483 Change Parameters of Player.RevokeFriendship from (Instance player) to (Player player)

SaveBoolean On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	bool	none

Return Type	null

History

573 Change ReturnType of Player.SaveBoolean from void to null
252 Change Tags of Player.SaveBoolean from [] to [Deprecated]

Tags: [Deprecated]

SaveData On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	LocalUserSecurity

History

573 Change ReturnType of Player.SaveData from void to null
252 Change Tags of Player.SaveData from [] to [Deprecated]

Tags: [Deprecated]

SaveInstance On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	Instance	none

Return Type	null

History

573 Change ReturnType of Player.SaveInstance from void to null
252 Change Tags of Player.SaveInstance from [] to [Deprecated]

Tags: [Deprecated]

SaveNumber On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	double	none

Return Type	null

History

573 Change ReturnType of Player.SaveNumber from void to null
252 Change Tags of Player.SaveNumber from [] to [Deprecated]
60 Change Parameters of Player.SaveNumber from (string key, float value) to (string key, double value)

Tags: [Deprecated]

SaveString On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	string	none

Return Type	null

History

573 Change ReturnType of Player.SaveString from void to null
252 Change Tags of Player.SaveString from [] to [Deprecated]

Tags: [Deprecated]

SetAccountAge On DevHub

Parameters	1

Name	Type	Default
accountAge	int	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Player.SetAccountAge from void to null
151 Change Security of Player.SetAccountAge from LocalUserSecurity to PluginSecurity

SetCharacterAppearanceJson On DevHub

Parameters	1

Name	Type	Default
jsonBlob	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.SetCharacterAppearanceJson from void to null
479 Add Player.SetCharacterAppearanceJson

SetExperienceSettingsLocaleId On DevHub

Parameters	1

Name	Type	Default
locale	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.SetExperienceSettingsLocaleId from void to null
546 Add Player.SetExperienceSettingsLocaleId

SetMembershipType On DevHub

Parameters	1

Name	Type	Default
membershipType	MembershipType	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.SetMembershipType from void to null

SetModerationAccessKey On DevHub

Parameters	1

Name	Type	Default
moderationAccessKey	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.SetModerationAccessKey from void to null
538 Add Player.SetModerationAccessKey

SetSuperSafeChat On DevHub

Parameters	1

Name	Type	Default
value	bool	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Player.SetSuperSafeChat from void to null
151 Change Security of Player.SetSuperSafeChat from LocalUserSecurity to PluginSecurity

SetUnder13 On DevHub

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

Parameters	1

Name	Type	Default
value	bool	none

Return Type	null
Security	RobloxSecurity

History

573 Change ReturnType of Player.SetUnder13 from void to null
83 Change Security of Player.SetUnder13 from LocalUserSecurity to RobloxSecurity

Tags: [Deprecated]

SimulationRadius On DevHub

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

Value Type	float
Security	LocalUserSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.SimulationRadius from [] to [Hidden]
61 Add Player.SimulationRadius

Tags: [Hidden]

SimulationRadiusChanged On DevHub

Parameters	1

Name	Type	Default
radius	float	none

Security	LocalUserSecurity

History

138 Add Player.SimulationRadiusChanged

Team On DevHub

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

Value Type	Team
Category	Team
Can Load	true
Can Save	true

History

329 Change ValueType of Player.Team from Object to Team
250 Add Player.Team

Tags: [NotReplicated]

TeamColor On DevHub

Value Type	BrickColor
Category	Team
Can Load	true
Can Save	true

Teleported 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 not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

205 Add Player.Teleported

Tags: [Hidden, ReadOnly, NotReplicated]

TeleportedIn On DevHub

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

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	true
Can Save	true

History

469 Change Tags of Player.TeleportedIn from [] to [Hidden]
215 Add Player.TeleportedIn

Tags: [Hidden]

UnfilteredChat 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 not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

547 Add Player.UnfilteredChat

Tags: [Hidden, ReadOnly, NotReplicated]

UpdatePlayerBlocked On DevHub

Parameters	2

Name	Type	Default
userId	int64	none
blocked	bool	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Player.UpdatePlayerBlocked from void to null
344 Add Player.UpdatePlayerBlocked

UserId On DevHub

Value Type	int64
Category	Data
Can Load	false
Can Save	false

History

323 Change ValueType of Player.UserId from int to int64
210 Add Player.UserId

VRDevice On DevHub

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

Value Type	string
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Player.VRDevice from [] to [Hidden]
235 Add Player.VRDevice

Tags: [Hidden]

VREnabled On DevHub

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

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

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

557 Add Player.VREnabled

Tags: [Hidden, NotReplicated]

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

252 Change Tags of Player.WaitForDataReady from [Yields] to [Yields, Deprecated]

Tags: [Yields, Deprecated]

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

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool

History

323 Change Parameters of Player.isFriendsWith from (int userId) to (int64 userId)
61 Add Player.isFriendsWith

Tags: [Yields, Deprecated]

loadBoolean On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	bool

History

61 Add Player.loadBoolean

Tags: [Deprecated]

loadInstance On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	Instance

History

61 Add Player.loadInstance

Tags: [Deprecated]

loadNumber On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	double

History

60 Change ReturnType of Player.loadNumber from float to double
50 Add Player.loadNumber
49 Remove Player.loadNumber
50 Add Player.loadNumber

Tags: [Deprecated]

loadString On DevHub

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

Parameters	1

Name	Type	Default
key	string	none

Return Type	string

History

61 Add Player.loadString

Tags: [Deprecated]

saveBoolean On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	bool	none

Return Type	null

History

573 Change ReturnType of Player.saveBoolean from void to null
61 Add Player.saveBoolean

Tags: [Deprecated]

saveInstance On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	Instance	none

Return Type	null

History

573 Change ReturnType of Player.saveInstance from void to null
61 Add Player.saveInstance

Tags: [Deprecated]

saveNumber On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	double	none

Return Type	null

History

573 Change ReturnType of Player.saveNumber from void to null
61 Add Player.saveNumber

Tags: [Deprecated]

saveString On DevHub

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

Parameters	2

Name	Type	Default
key	string	none
value	string	none

Return Type	null

History

573 Change ReturnType of Player.saveString from void to null
61 Add Player.saveString

Tags: [Deprecated]

userId On DevHub

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

Value Type	int64
Category	Data
Can Load	false
Can Save	false

History

323 Change ValueType of Player.userId from int to int64
213 Change Tags of Player.userId from [] to [Deprecated]

Tags: [Deprecated]

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

Tags: [Yields, Deprecated]

Removed members

BlockUser

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.

Parameters	1

Name	Type	Default
player	Instance	none

Return Type	string
Security	RobloxScriptSecurity

History

310 Remove Player.BlockUser
295 Change Tags of Player.BlockUser from [Yields] to [Yields, Deprecated]
270 Add Player.BlockUser

Tags: [Yields, Deprecated]

ClanTag

Value Type	string
Category
Can Load	false
Can Save	false

History

180 Remove Player.ClanTag
147 Add Player.ClanTag

GetWebPersonalServerRank

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	LocalUserSecurity

History

273 Remove Player.GetWebPersonalServerRank
272 Add Player.GetWebPersonalServerRank
273 Remove Player.GetWebPersonalServerRank
79 Change Tags of Player.GetWebPersonalServerRank from [Yields] to [backend, Yields]
78 Change Tags of Player.GetWebPersonalServerRank from [backend, Yields] to [Yields]
79 Change Tags of Player.GetWebPersonalServerRank from [Yields] to [backend, Yields]

Tags: [backend, Yields]

HasBuildPermission

Parameters	1

Name	Type	Default
role	BuildPermission	none

Return Type	bool

History

52 Remove Player.HasBuildPermission

HasBuildTools

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

HoverOnPlayerChanged

Parameters	1

Name	Type	Default
playerHoveredOn	Instance	none

Security	RobloxScriptSecurity

History

90 Remove Player.HoverOnPlayerChanged

IsUserAvailableForExperiment

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

535 Remove Player.IsUserAvailableForExperiment
296 Add Player.IsUserAvailableForExperiment

Tags: [Deprecated]

JumpCharacter

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

338 Remove Player.JumpCharacter
131 Add Player.JumpCharacter

MaxSimulationRadius

Value Type	float
Security	LocalUserSecurity
Category
Can Load	false
Can Save	false

History

125 Remove Player.MaxSimulationRadius
64 Add Player.MaxSimulationRadius

MouseDownOnPlayer

Parameters	1

Name	Type	Default
playerMouseDownOn	Instance	none

Security	RobloxScriptSecurity

History

90 Remove Player.MouseDownOnPlayer

MoveCharacter

Parameters	2

Name	Type	Default
walkDirection	Vector2	none
maxWalkDelta	float	none

Return Type	void
Security	RobloxScriptSecurity

History

338 Remove Player.MoveCharacter
131 Add Player.MoveCharacter

PersonalServerRank

Value Type	int
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

PlayerJoinData

This property is read-only. Its value can be read, but it cannot be modified.

Value Type	PlayerJoinData
Category
Can Load	false
Can Save	false

History

335 Remove Player.PlayerJoinData
331 Add Player.PlayerJoinData

Tags: [ReadOnly]

SaveLeaderboardData

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	LocalUserSecurity

History

258 Remove Player.SaveLeaderboardData
257 Add Player.SaveLeaderboardData
258 Remove Player.SaveLeaderboardData
252 Change Tags of Player.SaveLeaderboardData from [] to [Deprecated]

Tags: [Deprecated]

SetClanTag

Parameters	1

Name	Type	Default
newClanTag	string	none

Return Type	void
Security	PluginSecurity

History

180 Remove Player.SetClanTag
151 Change Security of Player.SetClanTag from LocalUserSecurity to PluginSecurity
145 Add Player.SetClanTag

SetWebPersonalServerRank

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
rank	int	none

Return Type	bool
Security	WritePlayerSecurity

History

273 Remove Player.SetWebPersonalServerRank
272 Add Player.SetWebPersonalServerRank
273 Remove Player.SetWebPersonalServerRank
71 Change Parameters of Player.SetWebPersonalServerRank from (int Rank) to (int rank)

Tags: [Yields]

UnblockUser

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.

Parameters	1

Name	Type	Default
player	Instance	none

Return Type	string
Security	RobloxScriptSecurity

History

310 Remove Player.UnblockUser
295 Change Tags of Player.UnblockUser from [Yields] to [Yields, Deprecated]
270 Add Player.UnblockUser

Tags: [Yields, Deprecated]

Relevant classes (7)

Relevant enums (10)

Relevant members (54)

Animator.LoadStreamAnimationForSelfieView_deprecated (player)
AssetService.PromptPublishAssetAsync (player)
BasePart.SetNetworkOwner (playerInstance)
Chat.FilterStringAsync (playerFrom)
Chat.FilterStringForBroadcast (playerFrom)
Chat.FilterStringForPlayerAsync (playerToFilterFor)
ClickDetector.MouseClick (playerWhoClicked)
ClickDetector.MouseHoverEnter (playerWhoHovered)
ClickDetector.MouseHoverLeave (playerWhoHovered)
ClickDetector.RightMouseClick (playerWhoClicked)
ClickDetector.mouseClick (playerWhoClicked)
DragDetector.DragContinue (playerWhoDragged)
DragDetector.DragEnd (playerWhoDragged)
DragDetector.DragStart (playerWhoDragged)
GamePassService.PlayerHasPass (player)
MarketplaceService.PlayerOwnsBundle (player)
Model.AddPersistentPlayer (playerInstance)
Model.RemovePersistentPlayer (playerInstance)
Player.Chatted (recipient)
Player.FriendStatusChanged (player)
Player.GetFriendStatus (player)
Player.RequestFriendship (player)
Player.RevokeFriendship (player)
Players.CreateLocalPlayer
Players.FriendRequestEvent (player)
Players.GetPlayerByUserId
Players.GetPlayerFromCharacter
Players.LocalPlayer
Players.PlayerAdded (player)
Players.PlayerChatted (player)
Players.PlayerConnecting (player)
Players.PlayerDisconnecting (player)
Players.PlayerMembershipChanged (player)
Players.PlayerRejoining (player)
Players.PlayerRemoving (player)
Players.ReportAbuse (player)
Players.ReportAbuseV3 (player)
Players.localPlayer
Players.playerFromCharacter
ProximityPrompt.PromptButtonHoldBegan (playerWhoTriggered)
ProximityPrompt.PromptButtonHoldEnded (playerWhoTriggered)
ProximityPrompt.TriggerEnded (playerWhoTriggered)
ProximityPrompt.Triggered (playerWhoTriggered)
ProximityPromptService.PromptButtonHoldBegan (playerWhoTriggered)
ProximityPromptService.PromptButtonHoldEnded (playerWhoTriggered)
ProximityPromptService.PromptTriggerEnded (playerWhoTriggered)
ProximityPromptService.PromptTriggered (playerWhoTriggered)
RemoteEvent.FireClient (player)
RemoteEvent.OnServerEvent (player)
RemoteFunction.InvokeClient (player)
RemoteFunction.OnServerInvoke (player)
Team.PlayerAdded (player)
Team.PlayerRemoved (player)
Workspace.PersistentLoaded (player)