Player

Player
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Memory category	Instances
Inheritance
Object Instance Player

The Player class inherits from Instance. This class is used as a reference for all the players in the place.

Properties

AccountAge: int

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Indicates the age of the player's account, in days.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

AppearanceDidLoad: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/AppearanceDidLoad.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

AutoJumpEnabled: bool

Determines whether or not players on a mobile device will automatically jump when coming into contact with a BasePart that can be scaled by jumping.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

CameraMaxZoomDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/CameraMaxZoomDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CameraMinZoomDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/CameraMinZoomDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CameraMode: CameraMode

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/CameraMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CanLoadCharacterAppearance: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/CanLoadCharacterAppearance.

• Category: Behavior.
• Serialization: cannot load or save.
• Thread safety: read safe

Character: Model

Contains a reference to the Model that houses the player's avatar. This model also contains a Humanoid, which allows for movement and other player functions.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

CharacterAppearance: string

• Not browsableThis member is not visible in documentation for end-users.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/CharacterAppearance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

CharacterAppearanceId: int64

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/CharacterAppearanceId.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ChatMode: ChatMode

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/ChatMode.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

DataComplexity: int

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/DataComplexity.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

DataComplexityLimit: int

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/DataComplexityLimit.

• Category: Data.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

DataReady: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/DataReady.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

DevCameraOcclusionMode: DevCameraOcclusionMode

This class member is missing documentation. Create or add to its subpage at Class:Player/DevCameraOcclusionMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevComputerCameraMode: DevComputerCameraMovementMode

This class member is missing documentation. Create or add to its subpage at Class:Player/DevComputerCameraMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevComputerMovementMode: DevComputerMovementMode

This class member is missing documentation. Create or add to its subpage at Class:Player/DevComputerMovementMode.

• Category: Control.
• Serialization: can save and load.
• Thread safety: read safe

DevEnableMouseLock: bool

This class member is missing documentation. Create or add to its subpage at Class:Player/DevEnableMouseLock.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevTouchCameraMode: DevTouchCameraMovementMode

This class member is missing documentation. Create or add to its subpage at Class:Player/DevTouchCameraMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevTouchMovementMode: DevTouchMovementMode

This class member is missing documentation. Create or add to its subpage at Class:Player/DevTouchMovementMode.

• Category: Control.
• Serialization: can save and load.
• Thread safety: read safe

DisplayName: string

This class member is missing documentation. Create or add to its subpage at Class:Player/DisplayName.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

FollowUserId: int64

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/FollowUserId.

• Category: Data.
• Serialization: can save only.
• Thread safety: read safe

GameplayPaused: bool

This class member is missing documentation. Create or add to its subpage at Class:Player/GameplayPaused.

• Category: Behavior.
• Write security: NotAccessibleSecurity.
• Serialization: can save and load.
• Thread safety: read safe

Guest: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Whether or not a Player is a Guest. Because the Guest feature has been removed, this property will always be false.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

HasVerifiedBadge: bool

Determines whether or not this player has the Verified Badge.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

HealthDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/HealthDisplayDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

LocaleId: string

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/LocaleId.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

MaximumSimulationRadius: float

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/MaximumSimulationRadius.

• Category: Data.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

MembershipType: MembershipType

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

Indicates the type of Roblox membership this player has. Will always be either 'None' or 'Premium'.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

NameDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/NameDisplayDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

Neutral: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/Neutral.

• Category: Team.
• Serialization: can save and load.
• Thread safety: read safe

OsPlatform: string

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/OsPlatform.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

PlatformName: string

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Player/PlatformName.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

ReplicationFocus: Instance

This class member is missing documentation. Create or add to its subpage at Class:Player/ReplicationFocus.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

RespawnLocation: SpawnLocation

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/RespawnLocation.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

SimulationRadius: float

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Player/SimulationRadius.

• Category: Data.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

Team: Team

• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/Team.

• Category: Team.
• Serialization: can save and load.
• Thread safety: read safe

TeamColor: BrickColor

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/TeamColor.

• Category: Team.
• Serialization: can save and load.
• Thread safety: read safe

Teleported: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/Teleported.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

TeleportedIn: bool

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Player/TeleportedIn.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

UnfilteredChat: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/UnfilteredChat.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

UserId: int64

Determines the unique identifier of this player. This is the best way to distinguish players, as each player has a unique ID (no two players share the same ID). It is also the best way to store long-term data, as players cannot change their User ID.

Despite having no write-security, attempting to modify the User ID will always result in an error.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

VRDevice: string

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Player/VRDevice.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

VREnabled: bool

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Player/VREnabled.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

userId: int64

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use UserId instead.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

Methods

AddToBlockList(userIds: Array): null

Parameters

Name	Type
userIds	Array

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ClearCharacterAppearance(): null

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/ClearCharacterAppearance.

• Thread safety: unsafe

DistanceFromCharacter(point: Vector3): float

Parameters

Name	Type
point	Vector3

• Thread safety: unsafe

GetFriendStatus(player: Player): FriendStatus

Parameters

Name	Type
player	Player

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetFriendsOnline(maxFriends: int = 200): Array

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
maxFriends	int	200

• Thread safety: unsafe

GetGameSessionID(): string

This class member is missing documentation. Create or add to its subpage at Class:Player/GetGameSessionID.

• Security: RobloxSecurity.
• Thread safety: unsafe

GetJoinData(): Dictionary

• Custom Lua stateThis member uses the Lua C API directly.

This class member is missing documentation. Create or add to its subpage at Class:Player/GetJoinData.

• Thread safety: unsafe

GetMouse(): Mouse

Returns the Mouse object for a player. This should only be used on the client with the Players.LocalPlayer.

• Thread safety: unsafe

GetNetworkPing(): float

This class member is missing documentation. Create or add to its subpage at Class:Player/GetNetworkPing.

• Thread safety: safe

GetRankInGroup(groupId: int64): int

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
groupId	int64

Returns a player's group rank ID for the group with the provided ID.

• Thread safety: unsafe

GetRoleInGroup(groupId: int64): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
groupId	int64

Returns a player's group rank name for the group with the provided ID.

• Thread safety: unsafe

GetUnder13(): bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/GetUnder13.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

HasAppearanceLoaded(): bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/HasAppearanceLoaded.

• Thread safety: unsafe

IsBestFriendsWith(userId: int64): bool

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
userId	int64

• Thread safety: unsafe

IsFriendsWith(userId: int64): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
userId	int64

• Thread safety: unsafe

IsInGroup(groupId: int64): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
groupId	int64

Returns whether or not a player is a member of the group with the provided ID.

• Thread safety: unsafe

IsVerified(): bool

Returns true if the player is ID or phone-verified. Returns false otherwise.

• Thread safety: unsafe

Kick(message: string = ): null

Parameters

Name	Type	Default
message	string

Disconnects a player from the server with an optional message that is displayed to the kicked user.

• Thread safety: unsafe

LoadBoolean(key: string): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

LoadCharacter(): null

• YieldsThis function can yield the script it is used in.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Player/LoadCharacter.

• Thread safety: unsafe

LoadCharacterAppearance(assetInstance: Instance): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
assetInstance	Instance

• Thread safety: unsafe

LoadCharacterBlocking(): null

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:Player/LoadCharacterBlocking.

• Security: LocalUserSecurity.
• Thread safety: unsafe

LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
humanoidDescription	HumanoidDescription

• Thread safety: unsafe

LoadData(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/LoadData.

• Security: LocalUserSecurity.
• Thread safety: unsafe

LoadInstance(key: string): Instance

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

LoadNumber(key: string): double

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

LoadString(key: string): string

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

Move(walkDirection: Vector3, relativeToCamera: bool = false): null

Parameters

Name	Type	Default
walkDirection	Vector3
relativeToCamera	bool	false

• Thread safety: unsafe

RemoveCharacter(): null

This class member is missing documentation. Create or add to its subpage at Class:Player/RemoveCharacter.

• Security: LocalUserSecurity.
• Thread safety: unsafe

RequestFriendship(player: Player): null

Parameters

Name	Type
player	Player

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

RequestStreamAroundAsync(position: Vector3, timeOut: double = 0): null

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
position	Vector3
timeOut	double	0

• Thread safety: unsafe

RevokeFriendship(player: Player): null

Parameters

Name	Type
player	Player

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SaveBoolean(key: string, value: bool): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	bool

• Thread safety: unsafe

SaveData(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Player/SaveData.

• Security: LocalUserSecurity.
• Thread safety: unsafe

SaveInstance(key: string, value: Instance): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	Instance

• Thread safety: unsafe

SaveNumber(key: string, value: double): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	double

• Thread safety: unsafe

SaveString(key: string, value: string): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	string

• Thread safety: unsafe

SetAccountAge(accountAge: int): null

Parameters

Name	Type
accountAge	int

• Security: PluginSecurity.
• Thread safety: unsafe

SetBlockListInitialized(): null

This class member is missing documentation. Create or add to its subpage at Class:Player/SetBlockListInitialized.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetCharacterAppearanceJson(jsonBlob: string): null

Parameters

Name	Type
jsonBlob	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetChatTranslationSettingsLocaleId(locale: string): null

This class member is missing documentation. Create or add to its subpage at Class:Player/SetChatTranslationSettingsLocaleId.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetExperienceSettingsLocaleId(locale: string): null

Parameters

Name	Type
locale	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetMembershipType(membershipType: MembershipType): null

Parameters

Name	Type
membershipType	MembershipType

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetModerationAccessKey(moderationAccessKey: string): null

Parameters

Name	Type
moderationAccessKey	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetSuperSafeChat(value: bool): null

Parameters

Name	Type
value	bool

• Security: PluginSecurity.
• Thread safety: unsafe

SetUnder13(value: bool): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
value	bool

• Security: RobloxSecurity.
• Thread safety: unsafe

UpdatePlayerBlocked(userId: int64, blocked: bool): null

Parameters

Name	Type
userId	int64
blocked	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

WaitForDataReady(): bool

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This method was used with data persistence but no longer does anything. DataStoreService should be used for saving and loading data instead.

• Thread safety: unsafe

isFriendsWith(userId: int64): bool

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
userId	int64

Use IsFriendsWith instead.

• Thread safety: unsafe

loadBoolean(key: string): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

loadInstance(key: string): Instance

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

loadNumber(key: string): double

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

loadString(key: string): string

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string

• Thread safety: unsafe

saveBoolean(key: string, value: bool): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	bool

• Thread safety: unsafe

saveInstance(key: string, value: Instance): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	Instance

• Thread safety: unsafe

saveNumber(key: string, value: double): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	double

• Thread safety: unsafe

saveString(key: string, value: string): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
key	string
value	string

• Thread safety: unsafe

waitForDataReady(): bool

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This method was used with data persistence but no longer does anything. DataStoreService should be used for saving and loading data instead.

• Thread safety: unsafe

Events

CharacterAdded(character: Model)

Parameters

Name	Type
character	Model

• Thread safety: unsafe

CharacterAppearanceLoaded(character: Model)

Parameters

Name	Type
character	Model

• Thread safety: unsafe

CharacterRemoving(character: Model)

Parameters

Name	Type
character	Model

• Thread safety: unsafe

Chatted(message: string, recipient: Player)

Parameters

Name	Type
message	string
recipient	Player

• Thread safety: unsafe

FriendStatusChanged(player: Player, friendStatus: FriendStatus)

Parameters

Name	Type
player	Player
friendStatus	FriendStatus

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Idled(time: double)

Parameters

Name	Type
time	double

• Thread safety: unsafe

OnTeleport(teleportState: TeleportState, placeId: int64, spawnName: string)

Parameters

Name	Type
teleportState	TeleportState
placeId	int64
spawnName	string

• Thread safety: unsafe

SimulationRadiusChanged(radius: float)

Parameters

Name	Type
radius	float

• Security: LocalUserSecurity.
• Thread safety: unsafe

Removed members

Methods

• BlockUser
• GetWebPersonalServerRank
• HasBuildPermission
• IsUserAvailableForExperiment
• JumpCharacter
• MoveCharacter
• SaveLeaderboardData
• SetClanTag
• SetWebPersonalServerRank
• UnblockUser

Properties

• ClanTag
• HasBuildTools
• MaxSimulationRadius
• PersonalServerRank
• PlayerJoinData

Events

• HoverOnPlayerChanged
• MouseDownOnPlayer

External links

• Player in the Roblox Creator Documentation
• Player in the Roblox API Reference