Player

Hierarchy

Tags	Memory category
	Instances

Methods

Returns	Method	Tags	Security
`float`	`DistanceFromCharacter` (`point`: `Vector3`)

`string`	`GetClanTag` ()
			RobloxScriptSecurity
Enum.FriendStatus	`GetFriendStatus` (`player`: Player)
			RobloxScriptSecurity
Mouse	`GetMouse` ()

`int`	`GetRankInGroup` (`groupId`: `int`)

`bool`	`GetUnder13` ()

`string`	`GetWebPersonalServerRank` ()
		Yields	LocalUserSecurity
`bool`	`HasBuildPermission` (`role`: `BuildPermission`)

`bool`	`IsBestFriendsWith` (`userId`: `int`)
		Yields
`bool`	`IsFriendsWith` (`userId`: `int`)
		Yields
`bool`	`IsInGroup` (`groupId`: `int`)
		Yields
`bool`	`LoadBoolean` (`key`: `string`)

`void`	`LoadCharacter` ()
		Deprecated, Yields
`void`	`LoadCharacterBlocking` ()
		Yields	LocalUserSecurity
`void`	`LoadData` ()
		Unsupported *	LocalUserSecurity
Instance	`LoadInstance` (`key`: `string`)

`float`	`LoadNumber` (`key`: `string`)

`string`	`LoadString` (`key`: `string`)

`void`	`RemoveCharacter` ()
			LocalUserSecurity
`void`	`RequestFriendship` (`player`: Instance)
		Unsupported *	RobloxScriptSecurity
`void`	`RevokeFriendship` (`player`: Instance)
		Unsupported *	RobloxScriptSecurity
`void`	`SaveBoolean` (`key`: `string`, `value`: `bool`)

`void`	`SaveData` ()
		Unsupported *	LocalUserSecurity
`void`	`SaveInstance` (`key`: `string`, `value`: Instance)

`void`	`SaveLeaderboardData` ()
		Unsupported *	LocalUserSecurity
`void`	`SaveNumber` (`key`: `string`, `value`: `float`)

`void`	`SaveString` (`key`: `string`, `value`: `string`)

`void`	`SetAccountAge` (`accountAge`: `int`)
			LocalUserSecurity
`void`	`SetMembershipType` (`membershipType`: Enum.MembershipType)
			RobloxScriptSecurity
`void`	`SetSuperSafeChat` (`value`: `bool`)
			LocalUserSecurity
`void`	`SetUnder13` (`value`: `bool`)
		Deprecated	LocalUserSecurity
`bool`	`SetWebPersonalServerRank` (`Rank`: `int`)
		Yields	WritePlayerSecurity
`bool`	`WaitForDataReady` ()
		Yields

Properties

Property	Type	Tags	Read	Write
`AccountAge`	`int`	NotReplicated, ReadOnly
`AppearanceDidLoad`	`bool`	NotReplicated, ReadOnly	RobloxScriptSecurity	RobloxScriptSecurity
`Backpack`	`Object`	NotReplicated, ReadOnly
`CameraMaxZoomDistance`	`float`
`CameraMinZoomDistance`	`float`
`CameraMode`	Enum.CameraMode
`Character`	`Object`
`CharacterAppearance`	`string`	NotBrowsable
`ChatMode`	Enum.ChatMode	NotReplicated, ReadOnly	RobloxScriptSecurity	RobloxScriptSecurity
`DataComplexity`	`int`	NotReplicated, ReadOnly
`DataComplexityLimit`	`int`	NotReplicated	LocalUserSecurity	LocalUserSecurity
`DataReady`	`bool`	NotReplicated, ReadOnly
`DevComputerCameraMode`	Enum.DevComputerCameraMovementMode	NotReplicated
`DevComputerMovementMode`	Enum.DevComputerMovementMode	NotReplicated
`DevEnableMouseLock`	`bool`	NotReplicated
`DevTouchCameraMode`	Enum.DevTouchCameraMovementMode	NotReplicated
`DevTouchMovementMode`	Enum.DevTouchMovementMode	NotReplicated
`Guest`	`bool`	NotReplicated, ReadOnly	RobloxScriptSecurity	RobloxScriptSecurity
`HasBuildTools`	`bool`		RobloxScriptSecurity	RobloxScriptSecurity
`HealthDisplayDistance`	`float`
`Hostname`	`string`	ReadOnly
`MembershipType`	Enum.MembershipType	NotReplicated, ReadOnly
`Neutral`	`bool`
`PersonalServerRank`	`int`		RobloxScriptSecurity	RobloxScriptSecurity
`PlayerGui`	`Object`	NotReplicated, ReadOnly
`RespawnLocation`	`Object`
`Team`	`Object`	NotReplicated
`TeamColor`	`BrickColor`
`userId`	`int`

Events

Event	Arguments	Security
`CharacterAdded`	(`character`: Model)
`CharacterAppearanceLoaded`	(`character`: Model)
`CharacterRemoving`	(`character`: Model)
`Chatted`	(`message`: `string`, `recipient`: Instance)
`FriendStatusChanged`	(`player`: Instance, `friendStatus`: Enum.FriendStatus)	RobloxScriptSecurity
`HoverOnPlayerChanged`	(`playerHoveredOn`: Instance)	RobloxScriptSecurity
`Idled`	(`time`: `double`)
`MouseDownOnPlayer`	(`playerMouseDownOn`: Instance)	RobloxScriptSecurity
`OnTeleport`	()

Hierarchy

Methods

Properties

Events

Instance

Methods

Properties

Events