Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Player

Summary

Member index 138

HistoryMember
554AccountAge: int
554AutoJumpEnabled: bool
554CameraMaxZoomDistance: float
554CameraMinZoomDistance: float
554CameraMode: CameraMode
554CanLoadCharacterAppearance: bool
554Character: Model
554CharacterAppearance: string
554CharacterAppearanceId: int64
554DevCameraOcclusionMode: DevCameraOcclusionMode
554DevComputerCameraMode: DevComputerCameraMovementMode
554DevComputerMovementMode: DevComputerMovementMode
578DevEnableMouseLock: bool
554DevTouchCameraMode: DevTouchCameraMovementMode
554DevTouchMovementMode: DevTouchMovementMode
554DisplayName: string
554FollowUserId: int64
554GameplayPaused: bool
554HasVerifiedBadge: bool
554HealthDisplayDistance: float
554MembershipType: MembershipType
554NameDisplayDistance: float
554Neutral: bool
554ReplicationFocus: Instance
554RespawnLocation: SpawnLocation
554Team: Team
554TeamColor: BrickColor
554UserId: int64
554userId: int64
573AddToBlockList(userIds: Array): null
573ClearCharacterAppearance(): null
462DistanceFromCharacter(point: Vector3): float
483GetFriendStatus(player: Player): FriendStatus
462GetFriendsOnline(maxFriends: int = 200): Array
462GetGameSessionID(): string
624GetJoinData(): Dictionary
483GetMouse(): Mouse
562GetNetworkPing(): float
462GetRankInGroup(groupId: int64): int
462GetRoleInGroup(groupId: int64): string
462GetUnder13(): bool
462HasAppearanceLoaded(): bool
462IsBestFriendsWith(userId: int64): bool
462IsFriendsWith(userId: int64): bool
462IsInGroup(groupId: int64): bool
573IsVerified(): bool
573Kick(message: string = ): null
462LoadBoolean(key: string): bool
573LoadCharacter(): null
573LoadCharacterAppearance(assetInstance: Instance): null
573LoadCharacterBlocking(): null
573LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription): null
573LoadData(): null
462LoadInstance(key: string): Instance
462LoadNumber(key: string): double
462LoadString(key: string): string
573Move(walkDirection: Vector3, relativeToCamera: bool = false): null
573RemoveCharacter(): null
573RequestFriendship(player: Player): null
573RequestStreamAroundAsync(position: Vector3, timeOut: double = 0): null
573RevokeFriendship(player: Player): null
573SaveBoolean(key: string, value: bool): null
573SaveData(): null
573SaveInstance(key: string, value: Instance): null
573SaveNumber(key: string, value: double): null
573SaveString(key: string, value: string): null
573SetAccountAge(accountAge: int): null
593SetBlockListInitialized(): null
573SetCharacterAppearanceJson(jsonBlob: string): null
611SetChatTranslationSettingsLocaleId(locale: string): null
573SetExperienceSettingsLocaleId(locale: string): null
573SetMembershipType(membershipType: MembershipType): null
573SetModerationAccessKey(moderationAccessKey: string): null
573SetSuperSafeChat(value: bool): null
573SetUnder13(value: bool): null
573UpdatePlayerBlocked(userId: int64, blocked: bool): null
462WaitForDataReady(): bool
553isFriendsWith(userId: int64): bool
553loadBoolean(key: string): bool
553loadInstance(key: string): Instance
553loadNumber(key: string): double
553loadString(key: string): string
573saveBoolean(key: string, value: bool): null
573saveInstance(key: string, value: Instance): null
573saveNumber(key: string, value: double): null
573saveString(key: string, value: string): null
553waitForDataReady(): bool
483CharacterAdded(character: Model)
483CharacterAppearanceLoaded(character: Model)
483CharacterRemoving(character: Model)
483Chatted(message: string, recipient: Player)
483FriendStatusChanged(player: Player, friendStatus: FriendStatus)
462Idled(time: double)
462OnTeleport(teleportState: TeleportState, placeId: int64, spawnName: string)
462SimulationRadiusChanged(radius: float)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 19

HistoryMember
180ClanTag: string
273HasBuildTools: bool
273PersonalServerRank: int
335PlayerJoinData: PlayerJoinData
310BlockUser(player: Instance): string
273GetWebPersonalServerRank(): string
52HasBuildPermission(role: BuildPermission): bool
535IsUserAvailableForExperiment(): bool
338JumpCharacter(): void
338MoveCharacter(walkDirection: Vector2, maxWalkDelta: float): void
258SaveLeaderboardData(): void
180SetClanTag(newClanTag: string): void
273SetWebPersonalServerRank(rank: int): bool
310UnblockUser(player: Instance): string
90HoverOnPlayerChanged(playerHoveredOn: Instance)
90MouseDownOnPlayer(playerMouseDownOn: Instance)

History 574

Members 138

AccountAge

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

AddToBlockList

Parameters (1)
userIdsArray
Returns (1)
null

History 3

AutoJumpEnabled

TypeDefault
bool

History 5

CameraMaxZoomDistance

TypeDefault
float

History 5

CameraMinZoomDistance

TypeDefault
float

History 5

CameraMode

TypeDefault
CameraMode

History 5

CanLoadCharacterAppearance

TypeDefault
bool

History 5

Character

TypeDefault
Model

History 6

CharacterAdded

Parameters (1)
characterModel

History 3

CharacterAppearance

TypeDefault
string
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. CharacterAppearanceId should be used instead.
This property is not browsable. It is not visible in Studio's object browser.

History 6

Tags: [NotBrowsable, Deprecated]

CharacterAppearanceId

TypeDefault
int64

History 6

CharacterAppearanceLoaded

Parameters (1)
characterModel

History 3

CharacterRemoving

Parameters (1)
characterModel

History 3

Chatted

Parameters (2)
messagestring
recipientPlayer

History 3

ClearCharacterAppearance

Parameters (0)
No parameters.
Returns (1)
null

History 3

DevCameraOcclusionMode

TypeDefault
DevCameraOcclusionMode

History 7

DevComputerCameraMode

TypeDefault
DevComputerCameraMovementMode

History 7

DevComputerMovementMode

TypeDefault
DevComputerMovementMode

History 7

DevEnableMouseLock

TypeDefault
bool

History 9

DevTouchCameraMode

TypeDefault
DevTouchCameraMovementMode

History 7

DevTouchMovementMode

TypeDefault
DevTouchMovementMode

History 7

DisplayName

TypeDefault
string

History 6

DistanceFromCharacter

Parameters (1)
pointVector3
Returns (1)
float

History 2

FollowUserId

TypeDefault
int64
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 6

Tags: [ReadOnly, NotReplicated]

FriendStatusChanged

Parameters (2)
playerPlayer
friendStatusFriendStatus

History 3

GameplayPaused

TypeDefault
bool

History 8

GetFriendStatus

Parameters (1)
playerPlayer
Returns (1)
FriendStatus

History 3

GetFriendsOnline

Parameters (1)Default
maxFriendsint200
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

GetGameSessionID

Parameters (0)
No parameters.
Returns (1)
string

History 2

GetJoinData

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.

History 3

Tags: [CustomLuaState]

GetMouse

Parameters (0)
No parameters.
Returns (1)
Mouse

History 3

GetNetworkPing

Parameters (0)
No parameters.
Returns (1)
float

History 3

GetRankInGroup

Parameters (1)
groupIdint64
Returns (1)
int
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetRoleInGroup

Parameters (1)
groupIdint64
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetUnder13

Parameters (0)
No parameters.
Returns (1)
bool

History 2

HasAppearanceLoaded

Parameters (0)
No parameters.
Returns (1)
bool

History 2

HasVerifiedBadge

TypeDefault
bool

History 1

HealthDisplayDistance

TypeDefault
float

History 5

Idled

Parameters (1)
timedouble

History 2

IsBestFriendsWith

Parameters (1)
userIdint64
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields, Deprecated]

IsFriendsWith

Parameters (1)
userIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 3