Player

Inherits: Instance

No description available.

Properties
AccountAge: int

No description available.

AppearanceDidLoad: bool

No description available.

AutoJumpEnabled: bool

No description available.

CameraMaxZoomDistance: float

No description available.

CameraMinZoomDistance: float

No description available.

CameraMode: CameraMode

An enum that describes how a Player's camera is allowed to behave. More info.

CanLoadCharacterAppearance: bool

No description available.

Character: Model

No description available.

CharacterAppearance: string

No description available.

CharacterAppearanceId: int64

No description available.

ChatMode: ChatMode

No description available.

DataComplexity: int

No description available.

DataComplexityLimit: int

No description available.

DataReady: bool

Read-only. If true, this Player's persistent data can be loaded, false otherwise. Info on Data Persistence.

DevCameraOcclusionMode: DevCameraOcclusionMode

No description available.

DevComputerCameraMode: DevComputerCameraMovementMode

No description available.

DevComputerMovementMode: DevComputerMovementMode

No description available.

DevEnableMouseLock: bool

No description available.

DevTouchCameraMode: DevTouchCameraMovementMode

No description available.

DevTouchMovementMode: DevTouchMovementMode

No description available.

DisplayName: string

No description available.

FollowUserId: int64

No description available.

GameplayPaused: bool

No description available.

Guest: bool

No description available.

HealthDisplayDistance: float

No description available.

LocaleId: string

No description available.

MaximumSimulationRadius: float

No description available.

MembershipType: MembershipType

No description available.

NameDisplayDistance: float

No description available.

Neutral: bool

No description available.

OsPlatform: string

No description available.

ReplicationFocus: Instance

No description available.

RespawnLocation: SpawnLocation

No description available.

SimulationRadius: float

No description available.

Team: Team

No description available.

TeamColor: BrickColor

No description available.

Teleported: bool

No description available.

TeleportedIn: bool

No description available.

UserId: int64

No description available.

VRDevice: string

No description available.

userId: int64

userId is deprecated. Use UserId instead.

Functions
AddToBlockList(
userIds: Array
) => void

No description available.

ClearCharacterAppearance() => void

No description available.

DistanceFromCharacter(
point: Vector3
) => float

No description available.

GetFriendStatus(
player: Instance
) => FriendStatus

No description available.

GetGameSessionID() => string

No description available.

GetJoinData() => Dictionary

No description available.

GetMouse() => Instance

No description available.

GetUnder13() => bool

No description available.

HasAppearanceLoaded() => bool

No description available.

IsUserAvailableForExperiment() => bool

No description available.

Kick(
message: string
) => void

No description available.

LoadBoolean(
key: string
) => bool

No description available.

LoadCharacterAppearance(
assetInstance: Instance
) => void

No description available.

LoadData() => void

No description available.

LoadInstance(
key: string
) => Instance

No description available.

LoadNumber(
key: string
) => double

No description available.

LoadString(
key: string
) => string

No description available.

Move(
walkDirection: Vector3,
relativeToCamera: bool
) => void

No description available.

RemoveCharacter() => void

No description available.

RequestFriendship(
player: Instance
) => void

No description available.

RevokeFriendship(
player: Instance
) => void

No description available.

SaveBoolean(
key: string,
value: bool
) => void

No description available.

SaveData() => void

No description available.

SaveInstance(
key: string,
value: Instance
) => void

No description available.

SaveNumber(
key: string,
value: double
) => void

No description available.

SaveString(
key: string,
value: string
) => void

No description available.

SetAccountAge(
accountAge: int
) => void

No description available.

SetMembershipType(
membershipType: MembershipType
) => void

No description available.

SetSuperSafeChat(
value: bool
) => void

No description available.

SetUnder13(
value: bool
) => void

No description available.

UpdatePlayerBlocked(
userId: int64,
blocked: bool
) => void

No description available.

loadBoolean(
key: string
) => bool

loadBoolean is deprecated. Use LoadBoolean instead.

loadInstance(
key: string
) => Instance

loadInstance is deprecated. Use LoadInstance instead.

loadNumber(
key: string
) => double

loadNumber is deprecated. Use LoadNumber instead.

loadString(
key: string
) => string

loadString is deprecated. Use LoadString instead.

saveBoolean(
key: string,
value: bool
) => void

saveBoolean is deprecated. Use SaveBoolean instead.

saveInstance(
key: string,
value: Instance
) => void

saveInstance is deprecated. Use SaveInstance instead.

saveNumber(
key: string,
value: double
) => void

saveNumber is deprecated. Use SaveNumber instead.

saveString(
key: string,
value: string
) => void

saveString is deprecated. Use SaveString instead.

GetFriendsOnline(
maxFriends: int
) => Array

No description available.

GetRankInGroup(
groupId: int64
) => int

No description available.

GetRoleInGroup(
groupId: int64
) => string

No description available.

IsBestFriendsWith(
userId: int64
) => bool

No description available.

IsFriendsWith(
userId: int64
) => bool

No description available.

IsInGroup(
groupId: int64
) => bool

No description available.

LoadCharacter() => void

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

LoadCharacterBlocking() => void

No description available.

LoadCharacterWithHumanoidDescription(
humanoidDescription: Instance
) => void

No description available.

WaitForDataReady() => bool

Yields until the persistent data for this Player is ready to be loaded. Info on Data Persistence.

isFriendsWith(
userId: int64
) => bool

isFriendsWith is deprecated. Use IsFriendsWith instead.

waitForDataReady() => bool

waitForDataReady is deprecated. Use WaitForDataReady instead.

Events
CharacterAdded: RBXScriptSignal(
character: Instance
)

No description available.

CharacterAppearanceLoaded: RBXScriptSignal(
character: Instance
)

No description available.

CharacterRemoving: RBXScriptSignal(
character: Instance
)

No description available.

Chatted: RBXScriptSignal(
message: string,
recipient: Instance
)

No description available.

FriendStatusChanged: RBXScriptSignal(
player: Instance,
friendStatus: FriendStatus
)

No description available.

Idled: RBXScriptSignal(
time: double
)

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.

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

No description available.

SimulationRadiusChanged: RBXScriptSignal(
radius: float
)

No description available.