Player

Class fields

Field	XML type	Value
`Name`	string	Player
`ExplorerOrder`	string	1
`ExplorerImageIndex`	string	12

Properties

AccountAge

int

Field	XML type	Value
`Name`	string	AccountAge

AccountAgeReplicate

int

Field	XML type	Value
`Name`	string	AccountAgeReplicate

AppearanceDidLoad

bool

Field	XML type	Value
`Name`	string	AppearanceDidLoad

AutoJumpEnabled

bool

Field	XML type	Value
`Name`	string	AutoJumpEnabled

CameraMaxZoomDistance

float

Field	XML type	Value
`Name`	string	CameraMaxZoomDistance

CameraMinZoomDistance

float

Field	XML type	Value
`Name`	string	CameraMinZoomDistance

CameraMode

CameraMode

Field	XML type	Value
`Name`	string	CameraMode
`summary`	string	An enum that describes how a Player's camera is allowed to behave. <a href="http://wiki.roblox.com/index.php/CameraMode" target="_blank">More info</a>.

CanLoadCharacterAppearance

bool

Field	XML type	Value
`Name`	string	CanLoadCharacterAppearance

Character

Object

Field	XML type	Value
`Name`	string	Character

CharacterAppearance

string

Field	XML type	Value
`Name`	string	CharacterAppearance
`Browsable`	bool	false

ChatMode

ChatMode

Field	XML type	Value
`Name`	string	ChatMode

CloudEditCameraCoordinateFrame

CoordinateFrame

Field	XML type	Value
`Name`	string	CloudEditCameraCoordinateFrame

DataComplexity

int

Field	XML type	Value
`Name`	string	DataComplexity

DataComplexityLimit

int

Field	XML type	Value
`Name`	string	DataComplexityLimit

DataReady

bool

Field	XML type	Value
`Name`	string	DataReady
`summary`	string	Read-only. If true, this Player's persistent data can be loaded, false otherwise. <a href="http://wiki.roblox.com/index.php/ROBLOX_Scripting_How_To:_Data_Persistence" target="_blank">Info on Data Persistence</a>.

DevCameraOcclusionMode

DevCameraOcclusionMode

Field	XML type	Value
`Name`	string	DevCameraOcclusionMode

DevComputerCameraMode

DevComputerCameraMovementMode

Field	XML type	Value
`Name`	string	DevComputerCameraMode

DevComputerMovementMode

DevComputerMovementMode

Field	XML type	Value
`Name`	string	DevComputerMovementMode

DevEnableMouseLock

bool

Field	XML type	Value
`Name`	string	DevEnableMouseLock

DevTouchCameraMode

DevTouchCameraMovementMode

Field	XML type	Value
`Name`	string	DevTouchCameraMode

DevTouchMovementMode

DevTouchMovementMode

Field	XML type	Value
`Name`	string	DevTouchMovementMode

DisplayName

string

Field	XML type	Value
`Name`	string	DisplayName
`summary`	string	The non-unique display name of the authenticated user associated with this Player.

FollowUserId

int64

Field	XML type	Value
`Name`	string	FollowUserId

FollowUserIdReplicated

int64

Field	XML type	Value
`Name`	string	FollowUserIdReplicated

Guest

bool

Field	XML type	Value
`Name`	string	Guest

HasBuildTools

bool

Field	XML type	Value
`Name`	string	HasBuildTools

HealthDisplayDistance

float

Field	XML type	Value
`Name`	string	HealthDisplayDistance

MaxSimulationRadius

float

Field	XML type	Value
`Name`	string	MaxSimulationRadius

MaximumSimulationRadius

float

Field	XML type	Value
`Name`	string	MaximumSimulationRadius

MembershipType

MembershipType

Field	XML type	Value
`Name`	string	MembershipType

MembershipTypeReplicate

MembershipType

Field	XML type	Value
`Name`	string	MembershipTypeReplicate

NameDisplayDistance

float

Field	XML type	Value
`Name`	string	NameDisplayDistance

Neutral

bool

Field	XML type	Value
`Name`	string	Neutral

OsPlatform

string

Field	XML type	Value
`Name`	string	OsPlatform

PersonalServerRank

int

Field	XML type	Value
`Name`	string	PersonalServerRank

RespawnLocation

Object

Field	XML type	Value
`Name`	string	RespawnLocation

SimulationRadius

float

Field	XML type	Value
`Name`	string	SimulationRadius

TeamColor

BrickColor

Field	XML type	Value
`Name`	string	TeamColor

Teleported

bool

Field	XML type	Value
`Name`	string	Teleported

TeleportedIn

bool

Field	XML type	Value
`Name`	string	TeleportedIn

UserId

int64

Field	XML type	Value
`Name`	string	UserId

VRDevice

string

Field	XML type	Value
`Name`	string	VRDevice

userId

int64

Field	XML type	Value
`Name`	string	userId

Functions

ClearCharacterAppearance

() → void

Field	XML type	Value
`Name`	string	ClearCharacterAppearance

DistanceFromCharacter

(point: Vector3) → float

Field	XML type	Value
`Name`	string	DistanceFromCharacter

GetFriendStatus

(player: Instance) → FriendStatus

Field	XML type	Value
`Name`	string	GetFriendStatus

GetGameSessionID

() → string

Field	XML type	Value
`Name`	string	GetGameSessionID

GetMouse

() → Instance

Field	XML type	Value
`Name`	string	GetMouse

GetUnder13

() → bool

Field	XML type	Value
`Name`	string	GetUnder13

HasAppearanceLoaded

() → bool

Field	XML type	Value
`Name`	string	HasAppearanceLoaded

JumpCharacter

() → void

Field	XML type	Value
`Name`	string	JumpCharacter

Kick

(message: string = …) → void

Field	XML type	Value
`Name`	string	Kick

LoadBoolean

(key: string) → bool

Field	XML type	Value
`Name`	string	LoadBoolean

LoadCharacter

(inGame: bool = …) → void

Field	XML type	Value
`Name`	string	LoadCharacter
`Browsable`	bool	true
`Deprecated`	bool	true
`summary`	string	Loads in a new character for this player. This will replace the player's current character, if they have one. This should be used in conjunction with Players.CharacterAutoLoads to control spawning of characters. This function only works from a server-side script (NOT a LocalScript).

LoadCharacterAppearance

(assetInstance: Instance) → void

Field	XML type	Value
`Name`	string	LoadCharacterAppearance

LoadCharacterBlocking

() → void

Field	XML type	Value
`Name`	string	LoadCharacterBlocking
`Browsable`	bool	true
`summary`	string	Loads this player's character and blocks until loading finishes.

LoadData

() → void

Field	XML type	Value
`Name`	string	LoadData

LoadInstance

(key: string) → Instance

Field	XML type	Value
`Name`	string	LoadInstance

LoadNumber

(key: string) → double

Field	XML type	Value
`Name`	string	LoadNumber

LoadString

(key: string) → string

Field	XML type	Value
`Name`	string	LoadString

Move

(walkDirection: Vector3, relativeToCamera: bool = …) → void

Field	XML type	Value
`Name`	string	Move

MoveCharacter

(walkDirection: Vector2, maxWalkDelta: float) → void

Field	XML type	Value
`Name`	string	MoveCharacter

RemoveCharacter

() → void

Field	XML type	Value
`Name`	string	RemoveCharacter

RequestFriendship

(player: Instance) → void

Field	XML type	Value
`Name`	string	RequestFriendship

RevokeFriendship

(player: Instance) → void

Field	XML type	Value
`Name`	string	RevokeFriendship

SaveBoolean

(key: string, value: bool) → void

Field	XML type	Value
`Name`	string	SaveBoolean

SaveData

() → void

Field	XML type	Value
`Name`	string	SaveData

SaveInstance

(key: string, value: Instance) → void

Field	XML type	Value
`Name`	string	SaveInstance

SaveLeaderboardData

() → void

Field	XML type	Value
`Name`	string	SaveLeaderboardData

SaveNumber

(key: string, value: double) → void

Field	XML type	Value
`Name`	string	SaveNumber

SaveString

(key: string, value: string) → void

Field	XML type	Value
`Name`	string	SaveString

SetAccountAge

(accountAge: int) → void

Field	XML type	Value
`Name`	string	SetAccountAge

SetMembershipType

(membershipType: MembershipType) → void

Field	XML type	Value
`Name`	string	SetMembershipType

loadBoolean

(key: string) → bool

Field	XML type	Value
`Name`	string	loadBoolean

loadInstance

(key: string) → Instance

Field	XML type	Value
`Name`	string	loadInstance

loadNumber

(key: string) → double

Field	XML type	Value
`Name`	string	loadNumber

loadString

(key: string) → string

Field	XML type	Value
`Name`	string	loadString

saveBoolean

(key: string, value: bool) → void

Field	XML type	Value
`Name`	string	saveBoolean

saveInstance

(key: string, value: Instance) → void

Field	XML type	Value
`Name`	string	saveInstance

saveNumber

(key: string, value: double) → void

Field	XML type	Value
`Name`	string	saveNumber

saveString

(key: string, value: string) → void

Field	XML type	Value
`Name`	string	saveString

Yield functions

GetFriendsOnline

(maxFriends: int = …) → Array

Field	XML type	Value
`Name`	string	GetFriendsOnline

GetRankInGroup

(groupId: int) → int

Field	XML type	Value
`Name`	string	GetRankInGroup

GetRoleInGroup

(groupId: int) → string

Field	XML type	Value
`Name`	string	GetRoleInGroup

GetWebPersonalServerRank

() → string

Field	XML type	Value
`Name`	string	GetWebPersonalServerRank
`IsBackend`	bool	true

IsBestFriendsWith

(userId: int) → bool

Field	XML type	Value
`Name`	string	IsBestFriendsWith

IsFriendsWith

(userId: int) → bool

Field	XML type	Value
`Name`	string	IsFriendsWith

IsInGroup

(groupId: int) → bool

Field	XML type	Value
`Name`	string	IsInGroup

LoadCharacterAsync

() → void

Field	XML type	Value
`Name`	string	LoadCharacterAsync
`Browsable`	bool	true
`summary`	string	Yields while asynchronously loading this player's character.

SetWebPersonalServerRank

(rank: int) → bool

Field	XML type	Value
`Name`	string	SetWebPersonalServerRank

WaitForDataReady

() → bool

Field	XML type	Value
`Name`	string	WaitForDataReady
`Browsable`	bool	true
`summary`	string	Yields until the persistent data for this Player is ready to be loaded. <a href="http://wiki.roblox.com/index.php/ROBLOX_Scripting_How_To:_Data_Persistence" target="_blank">Info on Data Persistence</a>.

isFriendsWith

(userId: int) → bool

Field	XML type	Value
`Name`	string	isFriendsWith

waitForDataReady

() → bool

Field	XML type	Value
`Name`	string	waitForDataReady

Events

CharacterAdded

(character: Instance) → void

Field	XML type	Value
`Name`	string	CharacterAdded

CharacterAppearanceLoaded

(character: Instance) → void

Field	XML type	Value
`Name`	string	CharacterAppearanceLoaded

CharacterRemoving

(character: Instance) → void

Field	XML type	Value
`Name`	string	CharacterRemoving

Chatted

(message: string, recipient: Instance) → void

Field	XML type	Value
`Name`	string	Chatted

CloudEditSelectionChanged

(newSelection: Array) → void

Field	XML type	Value
`Name`	string	CloudEditSelectionChanged

ConnectDiedSignalBackend

() → void

Field	XML type	Value
`Name`	string	ConnectDiedSignalBackend

FriendStatusChanged

(player: Instance, friendStatus: FriendStatus) → void

Field	XML type	Value
`Name`	string	FriendStatusChanged

Idled

(time: double) → void

Field	XML type	Value
`Name`	string	Idled
`summary`	string	Fired periodically after the user has been AFK for a while. Currently this event is only fired for the local Player. "time" is the time in seconds that the user has been idle.

Kill

() → void

Field	XML type	Value
`Name`	string	Kill

OnTeleport

(teleportState: TeleportState, placeId: int, spawnName: string) → void

Field	XML type	Value
`Name`	string	OnTeleport

OnTeleportInternal

(teleportState: TeleportState, teleportInfo: Dictionary, customLoadingScreen: Instance) → void

Field	XML type	Value
`Name`	string	OnTeleportInternal

RemoteFriendServiceSignal

(makeFriends: bool, userId: int) → void

Field	XML type	Value
`Name`	string	RemoteFriendServiceSignal

RemoteInsert

(url: string, position: Vector3) → void

Field	XML type	Value
`Name`	string	RemoteInsert

ScriptSecurityError

(hash: string, error: string, stack: string) → void

Field	XML type	Value
`Name`	string	ScriptSecurityError

SetShutdownMessage

(message: string) → void

Field	XML type	Value
`Name`	string	SetShutdownMessage

SimulationRadiusChanged

(radius: float) → void

Field	XML type	Value
`Name`	string	SimulationRadiusChanged

StatsAvailable

(info: string) → void

Field	XML type	Value
`Name`	string	StatsAvailable