This site is inactive!

This site is no longer kept up to date. It has been superseded by the Roblox API Reference. Please update your bookmarks.

Members

Properties

Property Type History
AccountAge int
AutoJumpEnabled bool (+0.206)
CameraMaxZoomDistance float (+0.147)
CameraMinZoomDistance float (+0.147)
CameraMode CameraMode (+0.50)
CanLoadCharacterAppearance bool (+0.68)
Character Class:Model
CharacterAppearanceId int64 (+0.250)
ChatMode ChatMode
ClanTag string (+0.147, −0.180)
DevCameraOcclusionMode DevCameraOcclusionMode (+0.177)
DevComputerCameraMode DevComputerCameraMovementMode (+0.177)
DevComputerMovementMode DevComputerMovementMode (+0.177)
DevEnableMouseLock bool (+0.177)
DevTouchCameraMode DevTouchCameraMovementMode (+0.177)
DevTouchMovementMode DevTouchMovementMode (+0.177)
DisplayName string (+0.291)
FollowUserId int64 (+0.169)
Guest bool
HasBuildTools bool (−0.273)
HealthDisplayDistance float (+0.147)
LocaleId string (+0.338)
MaxSimulationRadius float (+0.64, −0.125)
MaximumSimulationRadius float (+0.125)
MembershipType MembershipType
NameDisplayDistance float (+0.147)
Neutral bool
OsPlatform string (+0.293)
PersonalServerRank int (−0.273)
PlayerJoinData Class:PlayerJoinData (+0.331, −0.335)
ReplicationFocus Class:Instance (+0.313)
RespawnLocation Class:SpawnLocation (+0.182)
SimulationRadius float (+0.61)
Team Class:Team (+0.250)
TeamColor BrickColor
Teleported bool (+0.205)
TeleportedIn bool (+0.215)
UserId int64 (+0.210)
VRDevice string (+0.235)
AppearanceDidLoad bool
CharacterAppearance string
DataComplexity int
DataComplexityLimit int
DataReady bool
userId int64

Functions

Returns Function History
void AddToBlockList ( Array userIds ) (+0.344)
void ClearCharacterAppearance ( ) (+0.68)
float DistanceFromCharacter ( Vector3 point )
FriendStatus GetFriendStatus ( Instance player )
string GetGameSessionID ( ) (+0.133)
Dictionary GetJoinData ( ) (+0.333)
Instance GetMouse ( ) (+0.71)
bool GetUnder13 ( ) (+0.83)
bool HasAppearanceLoaded ( ) (+0.218)
bool HasBuildPermission ( BuildPermission role ) (−0.52)
void JumpCharacter ( ) (+0.131, −0.338)
void Kick ( string message = ) (+0.121)
void LoadCharacter ( bool inGame = true ) (−0.250)
void LoadCharacterAppearance ( Instance assetInstance ) (+0.68)
void Move ( Vector3 walkDirection, bool relativeToCamera = false ) (+0.163)
void MoveCharacter ( Vector2 walkDirection, float maxWalkDelta ) (+0.131, −0.338)
void RemoveCharacter ( )
void RequestFriendship ( Instance player )
void RevokeFriendship ( Instance player )
void SetAccountAge ( int accountAge )
void SetClanTag ( string newClanTag ) (+0.145, −0.180)
void SetMembershipType ( MembershipType membershipType )
void SetSuperSafeChat ( bool value )
void UpdatePlayerBlocked ( int64 userId, bool blocked ) (+0.344)
bool IsUserAvailableForExperiment ( ) (+0.296)
bool LoadBoolean ( string key )
void LoadData ( )
Instance LoadInstance ( string key )
double LoadNumber ( string key )
string LoadString ( string key )
void SaveBoolean ( string key, bool value )
void SaveData ( )
void SaveInstance ( string key, Instance value )
void SaveLeaderboardData ( ) (−0.258)
void SaveNumber ( string key, double value )
void SaveString ( string key, string value )
void SetUnder13 ( bool value )
bool loadBoolean ( string key ) (+0.61)
Instance loadInstance ( string key ) (+0.61)
double loadNumber ( string key ) (+0.50)
string loadString ( string key ) (+0.61)
void saveBoolean ( string key, bool value ) (+0.61)
void saveInstance ( string key, Instance value ) (+0.61)
void saveNumber ( string key, double value ) (+0.61)
void saveString ( string key, string value ) (+0.61)

YieldFunctions

Returns YieldFunction History
Array GetFriendsOnline ( int maxFriends = 200 ) (+0.119)
int GetRankInGroup ( int64 groupId ) (+0.69)
string GetRoleInGroup ( int64 groupId ) (+0.69)
string GetWebPersonalServerRank ( ) (−0.273)
bool IsFriendsWith ( int64 userId )
bool IsInGroup ( int64 groupId )
void LoadCharacter ( ) (+0.250)
void LoadCharacterBlocking ( ) (+0.288)
bool SetWebPersonalServerRank ( int rank ) (−0.273)
string BlockUser ( Instance player ) (+0.270, −0.310)
bool IsBestFriendsWith ( int64 userId )
string UnblockUser ( Instance player ) (+0.270, −0.310)
bool WaitForDataReady ( )
bool isFriendsWith ( int64 userId ) (+0.61)
bool waitForDataReady ( ) (+0.50)
  • 1 yieldfunction inherited from Instance

Events

Event History
CharacterAdded ( Instance character )
CharacterAppearanceLoaded ( Instance character ) (+0.210)
CharacterRemoving ( Instance character )
Chatted ( string message, Instance recipient )
FriendStatusChanged ( Instance player, FriendStatus friendStatus )
HoverOnPlayerChanged ( Instance playerHoveredOn ) (−0.90)
Idled ( double time )
MouseDownOnPlayer ( Instance playerMouseDownOn ) (−0.90)
OnTeleport ( TeleportState teleportState, int64 placeId, string spawnName ) (+0.130)
SimulationRadiusChanged ( float radius ) (+0.138)

Property Descriptions

int Player.AccountAge

Tags: readonly

bool Player.AutoJumpEnabled

Version History:(+0.206)

float Player.CameraMaxZoomDistance

Version History:(+0.147)

float Player.CameraMinZoomDistance

Version History:(+0.147)

CameraMode Player.CameraMode

Version History:(+0.50)

bool Player.CanLoadCharacterAppearance

Version History:(+0.68)

Class:Model Player.Character

int64 Player.CharacterAppearanceId

Version History:(+0.250)

ChatMode Player.ChatMode

Tags: RobloxScriptSecurity, readonly

string Player.ClanTag

Version History:(+0.147, −0.180)

DevCameraOcclusionMode Player.DevCameraOcclusionMode

Version History:(+0.177)

DevComputerCameraMovementMode Player.DevComputerCameraMode

Version History:(+0.177)

DevComputerMovementMode Player.DevComputerMovementMode

Version History:(+0.177)

bool Player.DevEnableMouseLock

Version History:(+0.177)

DevTouchCameraMovementMode Player.DevTouchCameraMode

Version History:(+0.177)

DevTouchMovementMode Player.DevTouchMovementMode

Version History:(+0.177)

string Player.DisplayName

Version History:(+0.291)

Tags: RobloxScriptSecurity

int64 Player.FollowUserId

Version History:(+0.169)

Tags: readonly

bool Player.Guest

Tags: RobloxScriptSecurity, readonly

bool Player.HasBuildTools

Version History:(−0.273)

Tags: RobloxScriptSecurity

float Player.HealthDisplayDistance

Version History:(+0.147)

string Player.LocaleId

Version History:(+0.338)

Tags: hidden, readonly

float Player.MaxSimulationRadius

Version History:(+0.64, −0.125)

Tags: LocalUserSecurity

float Player.MaximumSimulationRadius

Version History:(+0.125)

Tags: LocalUserSecurity

MembershipType Player.MembershipType

Tags: readonly

float Player.NameDisplayDistance

Version History:(+0.147)

bool Player.Neutral

string Player.OsPlatform

Version History:(+0.293)

Tags: RobloxScriptSecurity

int Player.PersonalServerRank

Version History:(−0.273)

Tags: RobloxScriptSecurity

Class:PlayerJoinData Player.PlayerJoinData

Version History:(+0.331, −0.335)

Tags: readonly

Class:Instance Player.ReplicationFocus

Version History:(+0.313)

Class:SpawnLocation Player.RespawnLocation

Version History:(+0.182)

float Player.SimulationRadius

Version History:(+0.61)

Tags: LocalUserSecurity

Class:Team Player.Team

Version History:(+0.250)

BrickColor Player.TeamColor

bool Player.Teleported

Version History:(+0.205)

Tags: RobloxScriptSecurity, hidden, readonly

bool Player.TeleportedIn

Version History:(+0.215)

Tags: RobloxScriptSecurity

int64 Player.UserId

Version History:(+0.210)

string Player.VRDevice

Version History:(+0.235)

Tags: RobloxScriptSecurity

bool Player.AppearanceDidLoad

Deprecated: This member is deprecated.

Tags: RobloxScriptSecurity, readonly

string Player.CharacterAppearance

Deprecated: This member is deprecated.

Tags: notbrowsable

int Player.DataComplexity

Deprecated: This member is deprecated.

Tags: readonly

int Player.DataComplexityLimit

Deprecated: This member is deprecated.

Tags: LocalUserSecurity

bool Player.DataReady

Deprecated: This member is deprecated.

Tags: readonly

int64 Player.userId

Deprecated: This member is deprecated.

Function Descriptions

voidPlayer.AddToBlockList ( Array userIds )

Version History:(+0.344)

Tags: RobloxScriptSecurity

voidPlayer.ClearCharacterAppearance ( )

Version History:(+0.68)

floatPlayer.DistanceFromCharacter ( Vector3 point )

FriendStatusPlayer.GetFriendStatus ( Instance player )

Tags: RobloxScriptSecurity

stringPlayer.GetGameSessionID ( )

Version History:(+0.133)

Tags: RobloxSecurity

DictionaryPlayer.GetJoinData ( )

Version History:(+0.333)

InstancePlayer.GetMouse ( )

Version History:(+0.71)

boolPlayer.GetUnder13 ( )

Version History:(+0.83)

Tags: RobloxScriptSecurity

boolPlayer.HasAppearanceLoaded ( )

Version History:(+0.218)

boolPlayer.HasBuildPermission ( BuildPermission role )

Version History:(−0.52)

voidPlayer.JumpCharacter ( )

Version History:(+0.131, −0.338)

Tags: RobloxScriptSecurity

voidPlayer.Kick ( string message = )

Version History:(+0.121)

voidPlayer.LoadCharacter ( bool inGame = true )

Version History:(−0.250)

voidPlayer.LoadCharacterAppearance ( Instance assetInstance )

Version History:(+0.68)

voidPlayer.Move ( Vector3 walkDirection, bool relativeToCamera = false )

Version History:(+0.163)

voidPlayer.MoveCharacter ( Vector2 walkDirection, float maxWalkDelta )

Version History:(+0.131, −0.338)

Tags: RobloxScriptSecurity

voidPlayer.RemoveCharacter ( )

Tags: LocalUserSecurity

voidPlayer.RequestFriendship ( Instance player )

Tags: RobloxScriptSecurity

voidPlayer.RevokeFriendship ( Instance player )

Tags: RobloxScriptSecurity

voidPlayer.SetAccountAge ( int accountAge )

Tags: PluginSecurity

voidPlayer.SetClanTag ( string newClanTag )

Version History:(+0.145, −0.180)

Tags: PluginSecurity

voidPlayer.SetMembershipType ( MembershipType membershipType )

Tags: RobloxScriptSecurity

voidPlayer.SetSuperSafeChat ( bool value )

Tags: PluginSecurity

voidPlayer.UpdatePlayerBlocked ( int64 userId, bool blocked )

Version History:(+0.344)

Tags: RobloxScriptSecurity

boolPlayer.IsUserAvailableForExperiment ( )

Version History:(+0.296)

Deprecated: This member is deprecated.

boolPlayer.LoadBoolean ( string key )

Deprecated: This member is deprecated.

voidPlayer.LoadData ( )

Deprecated: This member is deprecated.

Tags: LocalUserSecurity

InstancePlayer.LoadInstance ( string key )

Deprecated: This member is deprecated.

doublePlayer.LoadNumber ( string key )

Deprecated: This member is deprecated.

stringPlayer.LoadString ( string key )

Deprecated: This member is deprecated.

voidPlayer.SaveBoolean ( string key, bool value )

Deprecated: This member is deprecated.

voidPlayer.SaveData ( )

Deprecated: This member is deprecated.

Tags: LocalUserSecurity

voidPlayer.SaveInstance ( string key, Instance value )

Deprecated: This member is deprecated.

voidPlayer.SaveLeaderboardData ( )

Version History:(−0.258)

Deprecated: This member is deprecated.

Tags: LocalUserSecurity

voidPlayer.SaveNumber ( string key, double value )

Deprecated: This member is deprecated.

voidPlayer.SaveString ( string key, string value )

Deprecated: This member is deprecated.

voidPlayer.SetUnder13 ( bool value )

Deprecated: This member is deprecated.

Tags: RobloxSecurity

boolPlayer.loadBoolean ( string key )

Version History:(+0.61)

Deprecated: This member is deprecated.

InstancePlayer.loadInstance ( string key )

Version History:(+0.61)

Deprecated: This member is deprecated.

doublePlayer.loadNumber ( string key )

Version History:(+0.50)

Deprecated: This member is deprecated.

stringPlayer.loadString ( string key )

Version History:(+0.61)

Deprecated: This member is deprecated.

voidPlayer.saveBoolean ( string key, bool value )

Version History:(+0.61)

Deprecated: This member is deprecated.

voidPlayer.saveInstance ( string key, Instance value )

Version History:(+0.61)

Deprecated: This member is deprecated.

voidPlayer.saveNumber ( string key, double value )

Version History:(+0.61)

Deprecated: This member is deprecated.

voidPlayer.saveString ( string key, string value )

Version History:(+0.61)

Deprecated: This member is deprecated.

YieldFunction Descriptions

ArrayPlayer.GetFriendsOnline ( int maxFriends = 200 )

Version History:(+0.119)

intPlayer.GetRankInGroup ( int64 groupId )

Version History:(+0.69)

stringPlayer.GetRoleInGroup ( int64 groupId )

Version History:(+0.69)

stringPlayer.GetWebPersonalServerRank ( )

Version History:(−0.273)

Tags: LocalUserSecurity, backend

boolPlayer.IsFriendsWith ( int64 userId )

boolPlayer.IsInGroup ( int64 groupId )

voidPlayer.LoadCharacter ( )

Version History:(+0.250)

voidPlayer.LoadCharacterBlocking ( )

Version History:(+0.288)

Tags: LocalUserSecurity

boolPlayer.SetWebPersonalServerRank ( int rank )

Version History:(−0.273)

Tags: WritePlayerSecurity

stringPlayer.BlockUser ( Instance player )

Version History:(+0.270, −0.310)

Deprecated: This member is deprecated.

Tags: RobloxScriptSecurity

boolPlayer.IsBestFriendsWith ( int64 userId )

Deprecated: This member is deprecated.

stringPlayer.UnblockUser ( Instance player )

Version History:(+0.270, −0.310)

Deprecated: This member is deprecated.

Tags: RobloxScriptSecurity

boolPlayer.WaitForDataReady ( )

Deprecated: This member is deprecated.

boolPlayer.isFriendsWith ( int64 userId )

Version History:(+0.61)

Deprecated: This member is deprecated.

boolPlayer.waitForDataReady ( )

Version History:(+0.50)

Deprecated: This member is deprecated.

Event Descriptions

Player.CharacterAdded ( Instance character )

Player.CharacterAppearanceLoaded ( Instance character )

Version History:(+0.210)

Player.CharacterRemoving ( Instance character )

Player.Chatted ( string message, Instance recipient )

Player.FriendStatusChanged ( Instance player, FriendStatus friendStatus )

Tags: RobloxScriptSecurity

Player.HoverOnPlayerChanged ( Instance playerHoveredOn )

Version History:(−0.90)

Tags: RobloxScriptSecurity

Player.Idled ( double time )

Player.MouseDownOnPlayer ( Instance playerMouseDownOn )

Version History:(−0.90)

Tags: RobloxScriptSecurity

Player.OnTeleport ( TeleportState teleportState, int64 placeId, string spawnName )

Version History:(+0.130)

Player.SimulationRadiusChanged ( float radius )

Version History:(+0.138)

Tags: LocalUserSecurity

Inherits: