Roblox API Reference

Player On DevHub

Summary

Inherits (1)

Member index (104)

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
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
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
int64 UserId 210 323
string VRDevice 235 469
int64 userId 213 323
void AddToBlockList (Array userIds) 344
void ClearCharacterAppearance () 68
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 IsUserAvailableForExperiment () 296
void Kick (string message = ) 121 196
bool LoadBoolean (string key) 252
void LoadCharacter () 55 250 290
void LoadCharacterAppearance (Instance assetInstance) 68 373
void LoadCharacterBlocking () 288
void LoadCharacterWithHumanoidDescription (HumanoidDescription humanoidDescription) 363 483
void LoadData () 252
Instance LoadInstance (string key) 252
double LoadNumber (string key) 60 252
string LoadString (string key) 252
void Move (Vector3 walkDirection, bool relativeToCamera = false) 163
void RemoveCharacter ()
void RequestFriendship (Player player) 483
void RequestStreamAroundAsync (Vector3 position, double timeOut = 0) 429 428 429
void RevokeFriendship (Player player) 483
void SaveBoolean (string key, bool value) 252
void SaveData () 252
void SaveInstance (string key, Instance value) 252
void SaveNumber (string key, double value) 60 252
void SaveString (string key, string value) 252
void SetAccountAge (int accountAge) 151
void SetCharacterAppearanceJson (string jsonBlob) 479
void SetMembershipType (MembershipType membershipType)
void SetSuperSafeChat (bool value) 151
void SetUnder13 (bool value) 83
void UpdatePlayerBlocked (int64 userId, bool blocked) 344
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
void saveBoolean (string key, bool value) 61
void saveInstance (string key, Instance value) 61
void saveNumber (string key, double value) 61
void saveString (string key, string value) 61
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
51 members inherited from Instance

Removed member index (16)

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

History

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.

Tags: [ReadOnly, NotReplicated]

AddToBlockList On DevHub

Name Type Default
userIds Array none

History

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.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

AutoJumpEnabled On DevHub

History

CameraMaxZoomDistance On DevHub

History

CameraMinZoomDistance On DevHub

History

CameraMode On DevHub

History

CanLoadCharacterAppearance On DevHub

History

Character On DevHub

History

CharacterAdded On DevHub

Name Type Default
character Model none

History

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.

History

Tags: [NotBrowsable, Deprecated]

CharacterAppearanceId On DevHub

History

CharacterAppearanceLoaded On DevHub

Name Type Default
character Model none

History

CharacterRemoving On DevHub

Name Type Default
character Model none

History

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.

History

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

Tags: [Hidden, ReadOnly, NotReplicated]

Chatted On DevHub

Name Type Default
message string none
recipient Player none

History

ClearCharacterAppearance On DevHub

Name Type Default
No parameters.

History

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.

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.

History

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.

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

History

DevComputerCameraMode On DevHub

History

DevComputerMovementMode On DevHub

History

DevEnableMouseLock On DevHub

History

DevTouchCameraMode On DevHub

History

DevTouchMovementMode On DevHub

History

DisplayName On DevHub

History

DistanceFromCharacter On DevHub

Name Type Default
point Vector3 none

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.

History

Tags: [ReadOnly, NotReplicated]

FriendStatusChanged On DevHub

Name Type Default
player Player none
friendStatus FriendStatus none

History

GameplayPaused On DevHub

History

GetFriendStatus On DevHub

Name Type Default
player Player none

History

GetFriendsOnline On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
maxFriends int 200

History

Tags: [Yields]

GetGameSessionID On DevHub

Name Type Default
No parameters.

History

GetJoinData On DevHub

Name Type Default
No parameters.

History

GetMouse On DevHub

Name Type Default
No parameters.

History

GetNetworkPing On DevHub

Name Type Default
No parameters.

History

GetRankInGroup On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
groupId int64 none

History

Tags: [Yields]

GetRoleInGroup On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
groupId int64 none

History

Tags: [Yields]

GetUnder13 On DevHub

Name Type Default
No parameters.

History

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.

History

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

Tags: [Hidden, ReadOnly, NotReplicated]

HasAppearanceLoaded On DevHub

Name Type Default
No parameters.

History

HealthDisplayDistance On DevHub

History

Idled On DevHub

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.
Name Type Default
userId int64 none

History

Tags: [Yields, Deprecated]

IsFriendsWith On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

IsInGroup On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
groupId int64 none

History

Tags: [Yields]

IsUserAvailableForExperiment On DevHub

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

History

Tags: [Deprecated]

Kick On DevHub

Name Type Default
message string

History

LoadBoolean On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

LoadCharacter On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [Yields]

LoadCharacterAppearance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
assetInstance Instance none

History

Tags: [Deprecated]

LoadCharacterBlocking On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [Yields]

LoadCharacterWithHumanoidDescription On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
humanoidDescription HumanoidDescription none

History

Tags: [Yields]

LoadData On DevHub

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

History

Tags: [Deprecated]

LoadInstance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

LoadNumber On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

LoadString On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

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.

History

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.

History

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.

Tags: [ReadOnly, NotReplicated]

Move On DevHub

Name Type Default
walkDirection Vector3 none
relativeToCamera bool false

History

NameDisplayDistance On DevHub

History

Neutral On DevHub

OnTeleport On DevHub

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

History

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.

History

Tags: [Hidden, NotReplicated]

PlatformName On DevHub

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

History

Tags: [Hidden]

RemoveCharacter On DevHub

Name Type Default
No parameters.

ReplicationFocus On DevHub

History

RequestFriendship On DevHub

Name Type Default
player Player none

History

RequestStreamAroundAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
position Vector3 none
timeOut double 0

History

Tags: [Yields]

RespawnLocation On DevHub

History

RevokeFriendship On DevHub

Name Type Default
player Player none

History

SaveBoolean On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value bool none

History

Tags: [Deprecated]

SaveData On DevHub

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

History

Tags: [Deprecated]

SaveInstance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value Instance none

History

Tags: [Deprecated]

SaveNumber On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value double none

History

Tags: [Deprecated]

SaveString On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value string none

History

Tags: [Deprecated]

SetAccountAge On DevHub

Name Type Default
accountAge int none

History

SetCharacterAppearanceJson On DevHub

Name Type Default
jsonBlob string none

History

SetMembershipType On DevHub

Name Type Default
membershipType MembershipType none

SetSuperSafeChat On DevHub

Name Type Default
value bool none

History

SetUnder13 On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
value bool none

History

Tags: [Deprecated]

SimulationRadius On DevHub

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

History

Tags: [Hidden]

SimulationRadiusChanged On DevHub

Name Type Default
radius float none

History

Team On DevHub

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

History

Tags: [NotReplicated]

TeamColor On DevHub

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.

History

Tags: [Hidden, ReadOnly, NotReplicated]

TeleportedIn On DevHub

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

History

Tags: [Hidden]

UpdatePlayerBlocked On DevHub

Name Type Default
userId int64 none
blocked bool none

History

UserId On DevHub

History

VRDevice On DevHub

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

History

Tags: [Hidden]

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.
Name Type Default
No parameters.

History

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.
Name Type Default
userId int64 none

History

Tags: [Yields, Deprecated]

loadBoolean On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

loadInstance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

loadNumber On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

loadString On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none

History

Tags: [Deprecated]

saveBoolean On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value bool none

History

Tags: [Deprecated]

saveInstance On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value Instance none

History

Tags: [Deprecated]

saveNumber On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value double none

History

Tags: [Deprecated]

saveString On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
key string none
value string none

History

Tags: [Deprecated]

userId On DevHub

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

History

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.
Name Type Default
No parameters.

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.
Name Type Default
player Instance none

History

Tags: [Yields, Deprecated]

ClanTag

History

GetWebPersonalServerRank

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [backend, Yields]

HasBuildPermission

Name Type Default
role BuildPermission none

History

HasBuildTools

History

HoverOnPlayerChanged

Name Type Default
playerHoveredOn Instance none

History

JumpCharacter

Name Type Default
No parameters.

History

MaxSimulationRadius

History

MouseDownOnPlayer

Name Type Default
playerMouseDownOn Instance none

History

MoveCharacter

Name Type Default
walkDirection Vector2 none
maxWalkDelta float none

History

PersonalServerRank

History

PlayerJoinData

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

History

Tags: [ReadOnly]

SaveLeaderboardData

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

History

Tags: [Deprecated]

SetClanTag

Name Type Default
newClanTag string none

History

SetWebPersonalServerRank

This function yields. It will block the calling thread until completion.
Name Type Default
rank int none

History

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.
Name Type Default
player Instance none

History

Tags: [Yields, Deprecated]

Relevant classes (7)

Relevant enums (10)

Relevant members (43)