Player
CreatorHub

An object that represents a presently connected client to the experience.

Memory category	Instances

Member index 155

History		Member
554		AccountAge: int
554		AccountAgeReplicate: int
554		AppearanceDidLoad: bool
554		AutoJumpEnabled: bool
554		CameraMaxZoomDistance: float
554		CameraMinZoomDistance: float
554		CameraMode: CameraMode
554		CanLoadCharacterAppearance: bool
554		Character: Model
554		CharacterAppearance: string
554		CharacterAppearanceId: int64
554		ChararacterRegionId: Vector3
554		ChatMode: ChatMode
554		ChatPrivacyMode: ChatPrivacyMode
554		CloudEditCameraCoordinateFrame: CFrame
554		CloudEditPlayerActive: bool
554		CountryRegionCodeReplicate: string
554		DataComplexity: int
554		DataComplexityLimit: int
554		DataReady: bool
554		DevCameraOcclusionMode: DevCameraOcclusionMode
554		DevComputerCameraMode: DevComputerCameraMovementMode
554		DevComputerMovementMode: DevComputerMovementMode
578		DevEnableMouseLock: bool
554		DevTouchCameraMode: DevTouchCameraMovementMode
554		DevTouchMovementMode: DevTouchMovementMode
554		DisplayName: string
554		FollowUserId: int64
554		FollowUserIdReplicated: int64
554		GameplayPaused: bool
554		Guest: bool
554		HasVerifiedBadge: bool
554		HealthDisplayDistance: float
554		InternalCharacterAppearanceLoaded: bool
554		LocaleId: string
554		MaxSimulationRadius: float
554		MaximumSimulationRadius: float
554		MembershipType: MembershipType
554		MembershipTypeReplicate: MembershipType
554		NameDisplayDistance: float
554		Neutral: bool
554		OsPlatform: string
669		PartyId: string
554		PlatformName: string
554		RawJoinData: BinaryString
554		ReplicationFocus: Instance
554		RespawnLocation: SpawnLocation
554		SimulationRadius: float
663		StepIdOffset: int
554		SuperSafeChatReplicate: bool
554		Team: Team
554		TeamColor: BrickColor
554		Teleported: bool
554		TeleportedIn: bool
663		ThirdPartyTextChatRestrictionStatus: ChatRestrictionStatus
554		UnfilteredChat: bool
554		UserId: int64
554		VRDevice: string
557		VREnabled: bool
554		userId: int64
660		AddReplicationFocus(part: BasePart): null
662		AddReplicationFocusPosition(center: Vector3, radius: int): null
573		AddToBlockList(userIds: Array): null
573		ClearCharacterAppearance(): null
462		DistanceFromCharacter(point: Vector3): float
664		GetData(): PlayerData
483		GetFriendStatus(player: Player): FriendStatus
462		GetFriendsOnline(maxFriends: int = 200): Array
462		GetGameSessionID(): string
624		GetJoinData(): Dictionary
483		GetMouse(): Mouse
562		GetNetworkPing(): float
462		GetRankInGroup(groupId: int64): int
462		GetRoleInGroup(groupId: int64): string
462		GetUnder13(): bool
462		HasAppearanceLoaded(): bool
462		IsBestFriendsWith(userId: int64): bool
462		IsFriendsWith(userId: int64): bool
462		IsInGroup(groupId: int64): bool
573		IsVerified(): bool
573		Kick(message: string = ): null
462		LoadBoolean(key: string): bool
573		LoadCharacter(): null
573		LoadCharacterAppearance(assetInstance: Instance): null
573		LoadCharacterBlocking(): null
672		LoadCharacterWithAvatarRules(avatarRules: AvatarRules): null
573		LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription): null
573		LoadData(): null
462		LoadInstance(key: string): Instance
462		LoadNumber(key: string): double
462		LoadString(key: string): string
573		Move(walkDirection: Vector3, relativeToCamera: bool = false): null
666		OverrideStreamingRadii(minRadius: int, targetRadius: int): null
675		PinStreamingForInstance(instance: Instance, depth: int): null
573		RemoveCharacter(): null
660		RemoveReplicationFocus(part: BasePart): null
662		RemoveReplicationFocusPosition(center: Vector3, radius: int): null
573		RequestFriendship(player: Player): null
573		RequestStreamAroundAsync(position: Vector3, timeOut: double = 0): null
573		RevokeFriendship(player: Player): null
573		SaveBoolean(key: string, value: bool): null
573		SaveData(): null
573		SaveInstance(key: string, value: Instance): null
573		SaveNumber(key: string, value: double): null
573		SaveString(key: string, value: string): null
573		SetAccountAge(accountAge: int): null
593		SetBlockListInitialized(): null
573		SetCharacterAppearanceJson(jsonBlob: string): null
611		SetChatTranslationSettingsLocaleId(locale: string): null
573		SetExperienceSettingsLocaleId(locale: string): null
573		SetMembershipType(membershipType: MembershipType): null
573		SetModerationAccessKey(moderationAccessKey: string): null
573		SetSuperSafeChat(value: bool): null
573		SetUnder13(value: bool): null
675		UnpinStreamingForInstance(instance: Instance, depth: int): null
573		UpdatePlayerBlocked(userId: int64, blocked: bool): null
462		WaitForDataReady(): bool
553		isFriendsWith(userId: int64): bool
553		loadBoolean(key: string): bool
553		loadInstance(key: string): Instance
553		loadNumber(key: string): double
553		loadString(key: string): string
573		saveBoolean(key: string, value: bool): null
573		saveInstance(key: string, value: Instance): null
573		saveNumber(key: string, value: double): null
573		saveString(key: string, value: string): null
553		waitForDataReady(): bool
483		CharacterAdded(character: Model)
483		CharacterAppearanceLoaded(character: Model)
483		CharacterRemoving(character: Model)
483		Chatted(message: string, recipient: Player)
678		CloudEditSelectionChanged(newSelection: Array)
553		ConnectDiedSignalBackend()
483		FriendStatusChanged(player: Player, friendStatus: FriendStatus)
462		Idled(time: double)
553		Kill()
462		OnTeleport(teleportState: TeleportState, placeId: int64, spawnName: string)
553		OnTeleportInternal(teleportState: TeleportState, teleportInfo: Dictionary, customLoadingScreen: Instance)
666		OverrideStreamRadii(minRadius: int, targetRadius: int)
675		PinStreamingStart(instance: Instance, depth: int)
622		PlayerCharacterLoaded(metrics: Dictionary)
611		PlayerChatTranslationSettingsLocaleSetFromLua(newLocaleId: string)
553		PlayerExperienceSettingsLocaleSetFromLua(newLocaleId: string)
553		RemoteFriendRequestSignal(otherUserId: int64, eventType: FriendRequestEvent)
553		RemoteInsert(url: string, position: Vector3)
675		RequestStreamingPin(instance: Instance, depth: int)
553		ScopeCheckInitiated(guid: string, serializedScopes: Array, metadata: Dictionary)
553		ScriptSecurityError(hash: string, error: string, stack: string)
553		ServerToClientUnfilteredChatReplicate(value: bool)
597		ServerUpdatedHead(assetType: AssetType, assetId: int64)
553		SetShutdownMessage(message: string)
462		SimulationRadiusChanged(radius: float)
553		StatsAvailable(info: string)
675		StreamingPinComplete(instance: Instance)
675		UnpinStreaming(instance: Instance, depth: int)
65 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Removed member index 19

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

Description

A Player object is a client that is currently connected. These objects are added to the Players service when a new player connects, then removed when they eventually disconnect from the server.

The Instance.Name property reflects the player's username. When saving information about a player, you should use their UserId since it is possible that a player can change their username.

There are several similar methods in the Players service for working with Player objects. Use these over their respective Instance methods:

You can get a table of current Player objects using Players:GetPlayers(); again, use this instead of Instance:GetChildren().
To detect the addition of Player objects, it is recommended to use the Players.PlayerAdded event (instead of Instance.ChildAdded on the Players service).
Similarly, you can detect the removal of Player objects using Players.PlayerRemoving, which fires just before the Player is removed (instead of Instance.ChildRemoved which fires after). This is important if you are saving information about the player that might be removed or cleaned up on removal.

History 594
Hide member changes

678 Change Tags of CloudEditSelectionChanged from [Hidden] to []
678 Change Security of CloudEditSelectionChanged from RobloxSecurity to RobloxScriptSecurity
675 Add UnpinStreaming
675 Add StreamingPinComplete
675 Add RequestStreamingPin
675 Add PinStreamingStart
675 Add UnpinStreamingForInstance
675 Add PinStreamingForInstance
672 Add LoadCharacterWithAvatarRules
669 Change WriteSecurity of PartyId from WritePlayerSecurity to RobloxSecurity
666 Add OverrideStreamRadii
666 Add OverrideStreamingRadii
664 Add GetData
664 Add PartyId
663 Add ThirdPartyTextChatRestrictionStatus
663 Add StepIdOffset
662 Add RemoveReplicationFocusPosition
662 Add AddReplicationFocusPosition
660 Add RemoveReplicationFocus
660 Add AddReplicationFocus
624 Change Tags of GetJoinData from [] to [CustomLuaState]
623 Remove ReceivedJoinTelemetry
622 Add PlayerCharacterLoaded
611 Add PlayerChatTranslationSettingsLocaleSetFromLua
611 Add SetChatTranslationSettingsLocaleId
597 Add ServerUpdatedHead
593 Add SetBlockListInitialized
578 Change Tags of DevEnableMouseLock from [Deprecated] to []
576 Change Tags of DevEnableMouseLock from [] to [Deprecated]
574 Remove ReplicatedLocaleIdInternal
574 Remove ReplicatedLocaleId
573 Change ReturnType of saveString from void to null
573 Change ReturnType of saveNumber from void to null
573 Change ReturnType of saveInstance from void to null
573 Change ReturnType of saveBoolean from void to null
573 Change ReturnType of UpdatePlayerBlocked from void to null
573 Change ReturnType of SetUnder13 from void to null
573 Change ReturnType of SetSuperSafeChat from void to null
573 Change ReturnType of SetModerationAccessKey from void to null
573 Change ReturnType of SetMembershipType from void to null
573 Change ReturnType of SetExperienceSettingsLocaleId from void to null
573 Change ReturnType of SetCharacterAppearanceJson from void to null
573 Change ReturnType of SetAccountAge from void to null
573 Change ReturnType of SaveString from void to null
573 Change ReturnType of SaveNumber from void to null
573 Change ReturnType of SaveInstance from void to null
573 Change ReturnType of SaveData from void to null
573 Change ReturnType of SaveBoolean from void to null
573 Change ReturnType of RevokeFriendship from void to null
573 Change ReturnType of RequestStreamAroundAsync from void to null
573 Change ReturnType of RequestFriendship from void to null
573 Change ReturnType of RemoveCharacter from void to null
573 Change ReturnType of Move from void to null
573 Change ReturnType of LoadData from void to null
573 Change ReturnType of LoadCharacterWithHumanoidDescription from void to null
573 Change ReturnType of LoadCharacterBlocking from void to null
573 Change ReturnType of LoadCharacterAppearance from void to null
573 Change ReturnType of LoadCharacter from void to null
573 Change ReturnType of Kick from void to null
573 Add IsVerified
573 Change ReturnType of ClearCharacterAppearance from void to null
573 Change ReturnType of AddToBlockList from void to null
562 Change ThreadSafety of GetNetworkPing from Unsafe to Safe
557 Add VREnabled
554 Change Default of userId from 0 to
554 Change Default of VRDevice from to
554 Change Default of UserId from 0 to
554 Change Default of UnfilteredChat from false to
554 Change Default of TeleportedIn from false to
554 Change Default of Teleported from false to
554 Change Default of TeamColor from to
554 Change Default of Team from to
554 Change Default of SuperSafeChatReplicate from false to
554 Change Default of SimulationRadius from 10 to
554 Change Default of RespawnLocation from to
554 Change Default of ReplicationFocus from to
554 Change Default of ReplicatedLocaleIdInternal from to
554 Change Default of ReplicatedLocaleId from to
554 Change Default of RawJoinData from to
554 Change Default of PlatformName from to
554 Change Default of OsPlatform from to
554 Change Default of Neutral from true to
554 Change Default of NameDisplayDistance from 100 to
554 Change Default of MembershipTypeReplicate from None to
554 Change Default of MembershipType from None to
554 Change Default of MaximumSimulationRadius from 1000 to
554 Change Default of MaxSimulationRadius from 0 to
554 Change Default of LocaleId from to
554 Change Default of InternalCharacterAppearanceLoaded from false to
554 Change Default of HealthDisplayDistance from 100 to
554 Add HasVerifiedBadge
554 Change Default of Guest from false to
554 Change Default of GameplayPaused from false to
554 Change Default of FollowUserIdReplicated from 0 to
554 Change Default of FollowUserId from 0 to
554 Change Default of DisplayName from to
554 Change Default of DevTouchMovementMode from UserChoice to
554 Change Default of DevTouchCameraMode from UserChoice to
554 Change Default of DevEnableMouseLock from true to
554 Change Default of DevComputerMovementMode from UserChoice to
554 Change Default of DevComputerCameraMode from UserChoice to
554 Change Default of DevCameraOcclusionMode from Zoom to
554 Change Default of DataReady from false to
554 Change Default of DataComplexityLimit from 45000 to
554 Change Default of DataComplexity from 0 to
554 Change Default of CountryRegionCodeReplicate from to
554 Change Default of CloudEditPlayerActive from true to
554 Change Default of CloudEditCameraCoordinateFrame from to
554 Change Default of ChatPrivacyMode from NoOne to
554 Change Default of ChatMode from TextAndMenu to
554 Change Default of ChararacterRegionId from Vector3(NAN, NAN, NAN) to
554 Change Default of CharacterAppearanceId from 0 to
554 Change Default of CharacterAppearance from to
554 Change Default of Character from to
554 Change Default of CanLoadCharacterAppearance from true to
554 Change Default of CameraMode from Classic to
554 Change Default of CameraMinZoomDistance from 0.5 to
554 Change Default of CameraMaxZoomDistance from 400 to
554 Change Default of AutoJumpEnabled from true to
554 Change Default of AppearanceDidLoad from false to
554 Change Default of AccountAgeReplicate from 0 to
554 Change Default of AccountAge from 0 to
553 Add StatsAvailable
553 Add SetShutdownMessage
553 Add ServerToClientUnfilteredChatReplicate
553 Add ScriptSecurityError
553 Add ScopeCheckInitiated
553 Add RemoteInsert
553 Add RemoteFriendRequestSignal
553 Add ReceivedJoinTelemetry
553 Add PlayerExperienceSettingsLocaleSetFromLua
553 Add OnTeleportInternal
553 Add Kill
553 Add ConnectDiedSignalBackend
553 Add CloudEditSelectionChanged
553 Change PreferredDescriptor of waitForDataReady from to WaitForDataReady
553 Change PreferredDescriptor of saveString from to SaveString
553 Change PreferredDescriptor of saveNumber from to SaveNumber
553 Change PreferredDescriptor of saveInstance from to SaveInstance
553 Change PreferredDescriptor of saveBoolean from to SaveBoolean
553 Change PreferredDescriptor of loadString from to LoadString
553 Change PreferredDescriptor of loadNumber from to LoadNumber
553 Change PreferredDescriptor of loadInstance from to LoadInstance
553 Change PreferredDescriptor of loadBoolean from to LoadBoolean
553 Change PreferredDescriptor of isFriendsWith from to IsFriendsWith
553 Change Default of userId from to 0
553 Change PreferredDescriptor of userId from to UserId
553 Change Default of UserId from to 0
553 Change Default of UnfilteredChat from to false
553 Change Default of TeleportedIn from to false
553 Change Default of Teleported from to false
553 Change Default of TeamColor from to
553 Change Default of Team from to
553 Add SuperSafeChatReplicate
553 Change Default of SimulationRadius from to 10
553 Change Default of RespawnLocation from to
553 Change Default of ReplicationFocus from to
553 Add ReplicatedLocaleIdInternal
553 Add ReplicatedLocaleId
553 Add RawJoinData
553 Change Default of Neutral from to true
553 Change Default of NameDisplayDistance from to 100
553 Add MembershipTypeReplicate
553 Change Default of MembershipType from to None
553 Change Default of MaximumSimulationRadius from to 1000
553 Add MaxSimulationRadius
553 Add InternalCharacterAppearanceLoaded
553 Change Default of HealthDisplayDistance from to 100
553 Change Default of Guest from to false
553 Change Default of GameplayPaused from to false
553 Add FollowUserIdReplicated
553 Change Default of FollowUserId from to 0
553 Change Default of DevTouchMovementMode from to UserChoice
553 Change Default of DevTouchCameraMode from to UserChoice
553 Change Default of DevEnableMouseLock from to true
553 Change Default of DevComputerMovementMode from to UserChoice
553 Change Default of DevComputerCameraMode from to UserChoice
553 Change Default of DevCameraOcclusionMode from to Zoom
553 Change Default of DataReady from to false
553 Change Default of DataComplexityLimit from to 45000
553 Change Default of DataComplexity from to 0
553 Add CountryRegionCodeReplicate
553 Add CloudEditPlayerActive
553 Add CloudEditCameraCoordinateFrame
553 Add ChatPrivacyMode
553 Change Default of ChatMode from to TextAndMenu
553 Add ChararacterRegionId
553 Change Default of CharacterAppearanceId from to 0
553 Change PreferredDescriptor of CharacterAppearance from to CharacterAppearanceId
553 Change Default of Character from to
553 Change Default of CanLoadCharacterAppearance from to true
553 Change Default of CameraMode from to Classic
553 Change Default of CameraMinZoomDistance from to 0.5
553 Change Default of CameraMaxZoomDistance from to 400
553 Change Default of AutoJumpEnabled from to true
553 Change Default of AppearanceDidLoad from to false
553 Add AccountAgeReplicate
553 Change Default of AccountAge from to 0
547 Add UnfilteredChat
546 Add SetExperienceSettingsLocaleId
538 Add SetModerationAccessKey
535 Remove IsUserAvailableForExperiment
488 Change ReturnType of GetNetworkPing from int to float
486 Change ThreadSafety of userId from ReadOnly to ReadSafe
486 Change ThreadSafety of VRDevice from ReadOnly to ReadSafe
486 Change ThreadSafety of UserId from ReadOnly to ReadSafe
486 Change ThreadSafety of TeleportedIn from ReadOnly to ReadSafe
486 Change ThreadSafety of Teleported from ReadOnly to ReadSafe
486 Change ThreadSafety of TeamColor from ReadOnly to ReadSafe
486 Change ThreadSafety of Team from ReadOnly to ReadSafe
486 Change ThreadSafety of SimulationRadius from ReadOnly to ReadSafe
486 Change ThreadSafety of RespawnLocation from ReadOnly to ReadSafe
486 Change ThreadSafety of ReplicationFocus from ReadOnly to ReadSafe
486 Change ThreadSafety of PlatformName from ReadOnly to ReadSafe
486 Change ThreadSafety of OsPlatform from ReadOnly to ReadSafe
486 Change ThreadSafety of Neutral from ReadOnly to ReadSafe
486 Change ThreadSafety of NameDisplayDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of MembershipType from ReadOnly to ReadSafe
486 Change ThreadSafety of MaximumSimulationRadius from ReadOnly to ReadSafe
486 Change ThreadSafety of LocaleId from ReadOnly to ReadSafe
486 Change ThreadSafety of HealthDisplayDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of Guest from ReadOnly to ReadSafe
486 Change ThreadSafety of GameplayPaused from ReadOnly to ReadSafe
486 Change ThreadSafety of FollowUserId from ReadOnly to ReadSafe
486 Change ThreadSafety of DisplayName from ReadOnly to ReadSafe
486 Change ThreadSafety of DevTouchMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of DevTouchCameraMode from ReadOnly to ReadSafe
486 Change ThreadSafety of DevEnableMouseLock from ReadOnly to ReadSafe
486 Change ThreadSafety of DevComputerMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of DevComputerCameraMode from ReadOnly to ReadSafe
486 Change ThreadSafety of DevCameraOcclusionMode from ReadOnly to ReadSafe
486 Change ThreadSafety of DataReady from ReadOnly to ReadSafe
486 Change ThreadSafety of DataComplexityLimit from ReadOnly to ReadSafe
486 Change ThreadSafety of DataComplexity from ReadOnly to ReadSafe
486 Change ThreadSafety of ChatMode from ReadOnly to ReadSafe
486 Change ThreadSafety of CharacterAppearanceId from ReadOnly to ReadSafe
486 Change ThreadSafety of CharacterAppearance from ReadOnly to ReadSafe
486 Change ThreadSafety of Character from ReadOnly to ReadSafe
486 Change ThreadSafety of CanLoadCharacterAppearance from ReadOnly to ReadSafe
486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
486 Change ThreadSafety of CameraMinZoomDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of CameraMaxZoomDistance from ReadOnly to ReadSafe
486 Change ThreadSafety of AutoJumpEnabled from ReadOnly to ReadSafe
486 Change ThreadSafety of AppearanceDidLoad from ReadOnly to ReadSafe
486 Change ThreadSafety of AccountAge from ReadOnly to ReadSafe
483 Change Parameters of FriendStatusChanged from (player: Instance, friendStatus: FriendStatus) to (player: Player, friendStatus: FriendStatus)
483 Change Parameters of Chatted from (message: string, recipient: Instance) to (message: string, recipient: Player)
483 Change Parameters of CharacterRemoving from (character: Instance) to (character: Model)
483 Change Parameters of CharacterAppearanceLoaded from (character: Instance) to (character: Model)
483 Change Parameters of CharacterAdded from (character: Instance) to (character: Model)
483 Change Parameters of RevokeFriendship from (player: Instance) to (player: Player)
483 Change Parameters of RequestFriendship from (player: Instance) to (player: Player)
483 Change Parameters of LoadCharacterWithHumanoidDescription from (humanoidDescription: Instance) to (humanoidDescription: HumanoidDescription)
483 Change ReturnType of GetMouse from Instance to Mouse
483 Change Parameters of GetFriendStatus from (player: Instance) to (player: Player)
481 Add GetNetworkPing
479 Add SetCharacterAppearanceJson
469 Change Tags of VRDevice from [] to [Hidden]
469 Change Tags of TeleportedIn from [] to [Hidden]
469 Change Tags of SimulationRadius from [] to [Hidden]
469 Change Tags of PlatformName from [] to [Hidden]
469 Change Tags of OsPlatform from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of OsPlatform from true to false
469 Change Tags of MaximumSimulationRadius from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of MaximumSimulationRadius from true to false
469 Change Tags of Guest from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of DataReady from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
469 Change Tags of DataComplexityLimit from [NotReplicated, Deprecated] to [Hidden, NotReplicated, Deprecated]
469 Change CanLoad of DataComplexityLimit from true to false
469 Change Tags of DataComplexity from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
469 Change Tags of ChatMode from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of AppearanceDidLoad from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
462 Change ThreadSafety of SimulationRadiusChanged from to Unsafe
462 Change ThreadSafety of OnTeleport from to Unsafe
462 Change ThreadSafety of Idled from to Unsafe
462 Change ThreadSafety of FriendStatusChanged from to Unsafe
462 Change ThreadSafety of Chatted from to Unsafe
462 Change ThreadSafety of CharacterRemoving from to Unsafe
462 Change ThreadSafety of CharacterAppearanceLoaded from to Unsafe
462 Change ThreadSafety of CharacterAdded from to Unsafe
462 Change ThreadSafety of waitForDataReady from to Unsafe
462 Change ThreadSafety of saveString from to Unsafe
462 Change ThreadSafety of saveNumber from to Unsafe
462 Change ThreadSafety of saveInstance from to Unsafe
462 Change ThreadSafety of saveBoolean from to Unsafe
462 Change ThreadSafety of loadString from to Unsafe
462 Change ThreadSafety of loadNumber from to Unsafe
462 Change ThreadSafety of loadInstance from to Unsafe
462 Change ThreadSafety of loadBoolean from to Unsafe
462 Change ThreadSafety of isFriendsWith from to Unsafe
462 Change ThreadSafety of WaitForDataReady from to Unsafe
462 Change ThreadSafety of UpdatePlayerBlocked from to Unsafe
462 Change ThreadSafety of SetUnder13 from to Unsafe
462 Change ThreadSafety of SetSuperSafeChat from to Unsafe
462 Change ThreadSafety of SetMembershipType from to Unsafe
462 Change ThreadSafety of SetAccountAge from to Unsafe
462 Change ThreadSafety of SaveString from to Unsafe
462 Change ThreadSafety of SaveNumber from to Unsafe
462 Change ThreadSafety of SaveInstance from to Unsafe
462 Change ThreadSafety of SaveData from to Unsafe
462 Change ThreadSafety of SaveBoolean from to Unsafe
462 Change ThreadSafety of RevokeFriendship from to Unsafe
462 Change ThreadSafety of RequestStreamAroundAsync from to Unsafe
462 Change ThreadSafety of RequestFriendship from to Unsafe
462 Change ThreadSafety of RemoveCharacter from to Unsafe
462 Change ThreadSafety of Move from to Unsafe
462 Change ThreadSafety of LoadString from to Unsafe
462 Change ThreadSafety of LoadNumber from to Unsafe
462 Change ThreadSafety of LoadInstance from to Unsafe
462 Change ThreadSafety of LoadData from to Unsafe
462 Change ThreadSafety of LoadCharacterWithHumanoidDescription from to Unsafe
462 Change ThreadSafety of LoadCharacterBlocking from to Unsafe
462 Change ThreadSafety of LoadCharacterAppearance from to Unsafe
462 Change ThreadSafety of LoadCharacter from to Unsafe
462 Change ThreadSafety of LoadBoolean from to Unsafe
462 Change ThreadSafety of Kick from to Unsafe
462 Change ThreadSafety of IsUserAvailableForExperiment from to Unsafe
462 Change ThreadSafety of IsInGroup from to Unsafe
462 Change ThreadSafety of IsFriendsWith from to Unsafe
462 Change ThreadSafety of IsBestFriendsWith from to Unsafe
462 Change ThreadSafety of HasAppearanceLoaded from to Unsafe
462 Change ThreadSafety of GetUnder13 from to Unsafe
462 Change ThreadSafety of GetRoleInGroup from to Unsafe
462 Change ThreadSafety of GetRankInGroup from to Unsafe
462 Change ThreadSafety of GetMouse from to Unsafe
462 Change ThreadSafety of GetJoinData from to Unsafe
462 Change ThreadSafety of GetGameSessionID from to Unsafe
462 Change ThreadSafety of GetFriendsOnline from to Unsafe
462 Change ThreadSafety of GetFriendStatus from to Unsafe
462 Change ThreadSafety of DistanceFromCharacter from to Unsafe
462 Change ThreadSafety of ClearCharacterAppearance from to Unsafe
462 Change ThreadSafety of AddToBlockList from to Unsafe
462 Change ThreadSafety of userId from to ReadOnly
462 Change ThreadSafety of VRDevice from to ReadOnly
462 Change ThreadSafety of UserId from to ReadOnly
462 Change ThreadSafety of TeleportedIn from to ReadOnly
462 Change ThreadSafety of Teleported from to ReadOnly
462 Change ThreadSafety of TeamColor from to ReadOnly
462 Change ThreadSafety of Team from to ReadOnly
462 Change ThreadSafety of SimulationRadius from to ReadOnly
462 Change ThreadSafety of RespawnLocation from to ReadOnly
462 Change ThreadSafety of ReplicationFocus from to ReadOnly
462 Change ThreadSafety of PlatformName from to ReadOnly
462 Change ThreadSafety of OsPlatform from to ReadOnly
462 Change ThreadSafety of Neutral from to ReadOnly
462 Change ThreadSafety of NameDisplayDistance from to ReadOnly
462 Change ThreadSafety of MembershipType from to ReadOnly
462 Change ThreadSafety of MaximumSimulationRadius from to ReadOnly
462 Change ThreadSafety of LocaleId from to ReadOnly
462 Change ThreadSafety of HealthDisplayDistance from to ReadOnly
462 Change ThreadSafety of Guest from to ReadOnly
462 Change ThreadSafety of GameplayPaused from to ReadOnly
462 Change ThreadSafety of FollowUserId from to ReadOnly
462 Change ThreadSafety of DisplayName from to ReadOnly
462 Change ThreadSafety of DevTouchMovementMode from to ReadOnly
462 Change ThreadSafety of DevTouchCameraMode from to ReadOnly
462 Change ThreadSafety of DevEnableMouseLock from to ReadOnly
462 Change ThreadSafety of DevComputerMovementMode from to ReadOnly
462 Change ThreadSafety of DevComputerCameraMode from to ReadOnly
462 Change ThreadSafety of DevCameraOcclusionMode from to ReadOnly
462 Change ThreadSafety of DataReady from to ReadOnly
462 Change ThreadSafety of DataComplexityLimit from to ReadOnly
462 Change ThreadSafety of DataComplexity from to ReadOnly
462 Change ThreadSafety of ChatMode from to ReadOnly
462 Change ThreadSafety of CharacterAppearanceId from to ReadOnly
462 Change ThreadSafety of CharacterAppearance from to ReadOnly
462 Change ThreadSafety of Character from to ReadOnly
462 Change ThreadSafety of CanLoadCharacterAppearance from to ReadOnly
462 Change ThreadSafety of CameraMode from to ReadOnly
462 Change ThreadSafety of CameraMinZoomDistance from to ReadOnly
462 Change ThreadSafety of CameraMaxZoomDistance from to ReadOnly
462 Change ThreadSafety of AutoJumpEnabled from to ReadOnly
462 Change ThreadSafety of AppearanceDidLoad from to ReadOnly
462 Change ThreadSafety of AccountAge from to ReadOnly
451 Change CanLoad of OsPlatform from false to true
451 Change Tags of OsPlatform from [] to [NotReplicated]
429 Add RequestStreamAroundAsync
428 Remove RequestStreamAroundAsync
429 Add RequestStreamAroundAsync
428 Change WriteSecurity of DisplayName from RobloxScriptSecurity to None
428 Change ReadSecurity of DisplayName from RobloxScriptSecurity to None
423 Add PlatformName
386 Change WriteSecurity of GameplayPaused from None to NotAccessibleSecurity
386 Change Tags of GameplayPaused from [ReadOnly, NotReplicated] to []
386 Change CanLoad of GameplayPaused from false to true
384 Add GameplayPaused
373 Change Tags of LoadCharacterAppearance from [] to [Deprecated]
363 Add LoadCharacterWithHumanoidDescription
344 Add UpdatePlayerBlocked
344 Add AddToBlockList
338 Remove MoveCharacter
338 Remove JumpCharacter
338 Add LocaleId
335 Remove PlayerJoinData
333 Add GetJoinData
331 Add PlayerJoinData
329 Change ValueType of Team from Object to Team
329 Change ValueType of RespawnLocation from Object to SpawnLocation
329 Change ValueType of ReplicationFocus from Object to Instance
329 Change ValueType of Character from Object to Model
323 Change Parameters of isFriendsWith from (userId: int) to (userId: int64)
323 Change Parameters of IsInGroup from (groupId: int) to (groupId: int64)
323 Change Parameters of IsFriendsWith from (userId: int) to (userId: int64)
323 Change Parameters of IsBestFriendsWith from (userId: int) to (userId: int64)
323 Change Parameters of GetRoleInGroup from (groupId: int) to (groupId: int64)
323 Change Parameters of GetRankInGroup from (groupId: int) to (groupId: int64)
323 Change ValueType of userId from int to int64
323 Change ValueType of UserId from int to int64
323 Change ValueType of FollowUserId from int to int64
323 Change ValueType of CharacterAppearanceId from int to int64
322 Change Parameters of OnTeleport from (teleportState: TeleportState, placeId: int, spawnName: string) to (teleportState: TeleportState, placeId: int64, spawnName: string)
313 Add ReplicationFocus
310 Remove UnblockUser
310 Remove BlockUser
296 Add IsUserAvailableForExperiment
295 Change Tags of UnblockUser from [Yields] to [Yields, Deprecated]
295 Change Tags of BlockUser from [Yields] to [Yields, Deprecated]
293 Add OsPlatform
292 Change Tags of CharacterAppearance from [NotBrowsable] to [NotBrowsable, Deprecated]
291 Add DisplayName
290 Change Parameters of LoadCharacter from (inGame: bool = true) to ()
288 Add LoadCharacterBlocking
273 Remove SetWebPersonalServerRank
273 Remove GetWebPersonalServerRank
273 Remove PersonalServerRank
273 Remove HasBuildTools
272 Add SetWebPersonalServerRank
272 Add GetWebPersonalServerRank
272 Add PersonalServerRank
272 Add HasBuildTools
273 Remove SetWebPersonalServerRank
273 Remove GetWebPersonalServerRank
273 Remove PersonalServerRank
273 Remove HasBuildTools
270 Add UnblockUser
270 Add BlockUser
258 Remove SaveLeaderboardData
257 Add SaveLeaderboardData
258 Remove SaveLeaderboardData
252 Change Tags of WaitForDataReady from [Yields] to [Yields, Deprecated]
252 Change Tags of SaveString from [] to [Deprecated]
252 Change Tags of SaveNumber from [] to [Deprecated]
252 Change Tags of SaveLeaderboardData from [] to [Deprecated]
252 Change Tags of SaveInstance from [] to [Deprecated]
252 Change Tags of SaveData from [] to [Deprecated]
252 Change Tags of SaveBoolean from [] to [Deprecated]
252 Change Tags of LoadString from [] to [Deprecated]
252 Change Tags of LoadNumber from [] to [Deprecated]
252 Change Tags of LoadInstance from [] to [Deprecated]
252 Change Tags of LoadData from [] to [Deprecated]
252 Change Tags of LoadBoolean from [] to [Deprecated]
252 Change Tags of DataReady from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
252 Change Tags of DataComplexityLimit from [NotReplicated] to [NotReplicated, Deprecated]
252 Change Tags of DataComplexity from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
250 Change Tags of LoadCharacter from [] to [Yields]
250 Add Team
250 Add CharacterAppearanceId
235 Add VRDevice
218 Add HasAppearanceLoaded
218 Change Tags of AppearanceDidLoad from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
215 Add TeleportedIn
213 Change Tags of userId from [] to [Deprecated]
210 Add CharacterAppearanceLoaded
210 Add UserId
206 Change Tags of IsBestFriendsWith from [Yields] to [Yields, Deprecated]
206 Add AutoJumpEnabled
205 Add Teleported
204 Change ReturnType of GetFriendsOnline from Dictionary to Array
204 Change Parameters of GetFriendsOnline from (maxFriends: int = 50) to (maxFriends: int = 200)
196 Change Parameters of Kick from () to (message: string = )
182 Add RespawnLocation
180 Remove SetClanTag
180 Remove ClanTag
177 Add DevTouchMovementMode
177 Add DevTouchCameraMode
177 Add DevEnableMouseLock
177 Add DevComputerMovementMode
177 Add DevComputerCameraMode
177 Add DevCameraOcclusionMode
176 Remove DevTouchMovementMode
176 Remove DevTouchCameraMode
176 Remove DevEnableMouseLock
176 Remove DevComputerMovementMode
176 Remove DevComputerCameraMode
176 Remove DevCameraOcclusionMode
177 Add DevTouchMovementMode
177 Add DevTouchCameraMode
177 Add DevEnableMouseLock
177 Add DevComputerMovementMode
177 Add DevComputerCameraMode
177 Add DevCameraOcclusionMode
169 Add FollowUserId
163 Add Move
151 Change Security of SetSuperSafeChat from LocalUserSecurity to PluginSecurity
151 Change Security of SetClanTag from LocalUserSecurity to PluginSecurity
151 Change Security of SetAccountAge from LocalUserSecurity to PluginSecurity
147 Add NameDisplayDistance
147 Add HealthDisplayDistance
147 Add ClanTag
147 Add CameraMinZoomDistance
147 Add CameraMaxZoomDistance
145 Add SetClanTag
138 Add SimulationRadiusChanged
133 Add GetGameSessionID
131 Add MoveCharacter
131 Add JumpCharacter
130 Add OnTeleport
125 Add MaximumSimulationRadius
125 Remove MaxSimulationRadius
121 Add Kick
119 Add GetFriendsOnline
90 Remove MouseDownOnPlayer
90 Remove HoverOnPlayerChanged
83 Change Security of SetUnder13 from LocalUserSecurity to RobloxSecurity
83 Add GetUnder13
79 Change Tags of GetWebPersonalServerRank from [Yields] to [backend, Yields]
78 Change Tags of GetWebPersonalServerRank from [backend, Yields] to [Yields]
79 Change Tags of GetWebPersonalServerRank from [Yields] to [backend, Yields]
71 Change Parameters of SetWebPersonalServerRank from (Rank: int) to (rank: int)
71 Add GetMouse
69 Add GetRoleInGroup
69 Add GetRankInGroup
68 Add LoadCharacterAppearance
68 Add ClearCharacterAppearance
68 Add CanLoadCharacterAppearance
64 Add MaxSimulationRadius
61 Add saveString
61 Add saveNumber
61 Add saveInstance
61 Add saveBoolean
61 Add loadString
61 Add loadInstance
61 Add loadBoolean
61 Add isFriendsWith
61 Add SimulationRadius
60 Change ReturnType of loadNumber from float to double
60 Change Parameters of SaveNumber from (key: string, value: float) to (key: string, value: double)
60 Change ReturnType of LoadNumber from float to double
55 Change Security of LoadCharacter from LocalUserSecurity to None
52 Remove HasBuildPermission
50 Add waitForDataReady
50 Add loadNumber
50 Add CameraMode
47 Add MouseDownOnPlayer
47 Add Idled
47 Add HoverOnPlayerChanged
47 Add FriendStatusChanged
47 Add Chatted
47 Add CharacterRemoving
47 Add CharacterAdded
47 Add WaitForDataReady
47 Add SetWebPersonalServerRank
47 Add SetUnder13
47 Add SetSuperSafeChat
47 Add SetMembershipType
47 Add SetAccountAge
47 Add SaveString
47 Add SaveNumber
47 Add SaveLeaderboardData
47 Add SaveInstance
47 Add SaveData
47 Add SaveBoolean
47 Add RevokeFriendship
47 Add RequestFriendship
47 Add RemoveCharacter
47 Add LoadString
47 Add LoadNumber
47 Add LoadInstance
47 Add LoadData
47 Add LoadCharacter
47 Add LoadBoolean
47 Add IsInGroup
47 Add IsFriendsWith
47 Add IsBestFriendsWith
47 Add HasBuildPermission
47 Add GetWebPersonalServerRank
47 Add GetFriendStatus
47 Add DistanceFromCharacter
47 Add userId
47 Add TeamColor
47 Add PersonalServerRank
47 Add Neutral
47 Add MembershipType
47 Add HasBuildTools
47 Add Guest
47 Add DataReady
47 Add DataComplexityLimit
47 Add DataComplexity
47 Add ChatMode
47 Add CharacterAppearance
47 Add Character
47 Add AppearanceDidLoad
47 Add AccountAge
47 Add Player

Members 155

AccountAge
CreatorHub

Type		Default
int

This property describes how long ago a player's account was registered in days. It is set using the SetAccountAge() method, which cannot be accessed by scripts.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

554 Change Default of AccountAge from 0 to
553 Change Default of AccountAge from to 0
486 Change ThreadSafety of AccountAge from ReadOnly to ReadSafe
462 Change ThreadSafety of AccountAge from to ReadOnly
47 Add AccountAge

Tags: [ReadOnly, NotReplicated]

AccountAgeReplicate
CreatorHub

Type		Default
int

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of AccountAgeReplicate from 0 to
553 Add AccountAgeReplicate

Tags: [Hidden, NotScriptable]

AddReplicationFocus
CreatorHub

Parameters (1)
part	BasePart
Returns (1)
null

Thread safety	Unsafe

History 1

660 Add AddReplicationFocus

AddReplicationFocusPosition
CreatorHub

Parameters (2)
center	Vector3
radius	int
Returns (1)
null

Security	RobloxSecurity
Thread safety	Unsafe

History 1

662 Add AddReplicationFocusPosition

AddToBlockList
CreatorHub

Parameters (1)
userIds	Array
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of AddToBlockList from void to null
462 Change ThreadSafety of AddToBlockList from to Unsafe
344 Add AddToBlockList

AppearanceDidLoad
CreatorHub

Type		Default
bool

It exists only for backward compatibility, and should not be used for new work.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 7

554 Change Default of AppearanceDidLoad from false to
553 Change Default of AppearanceDidLoad from to false
486 Change ThreadSafety of AppearanceDidLoad from ReadOnly to ReadSafe
469 Change Tags of AppearanceDidLoad from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
462 Change ThreadSafety of AppearanceDidLoad from to ReadOnly
218 Change Tags of AppearanceDidLoad from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
47 Add AppearanceDidLoad

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

AutoJumpEnabled
CreatorHub

Type		Default
bool

This property determines whether the Character of a Player using a mobile device will automatically jump when they hit an obstacle. This can make levels more navigable while on a mobile device.

When the player joins the experience, the StarterPlayer.AutoJumpEnabled value determines the initial state of this property. Then, this property determines the value of the Humanoid.AutoJumpEnabled property of the Character on spawn. In other words, it is possible to set the auto-jump behavior on a per-character, per-player, and per-experience basis using these three properties.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

554 Change Default of AutoJumpEnabled from true to
553 Change Default of AutoJumpEnabled from to true
486 Change ThreadSafety of AutoJumpEnabled from ReadOnly to ReadSafe
462 Change ThreadSafety of AutoJumpEnabled from to ReadOnly
206 Add AutoJumpEnabled

CameraMaxZoomDistance
CreatorHub

Type		Default
float

This property sets the maximum distance the player's camera is allowed to zoom out, in studs.

The default value of this property is set by StarterPlayer.CameraMaxZoomDistance. If this value is set to a lower value than CameraMinZoomDistance, it will be increased to CameraMinZoomDistance.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 5

554 Change Default of CameraMaxZoomDistance from 400 to
553 Change Default of CameraMaxZoomDistance from to 400
486 Change ThreadSafety of CameraMaxZoomDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of CameraMaxZoomDistance from to ReadOnly
147 Add CameraMaxZoomDistance

CameraMinZoomDistance
CreatorHub

Type		Default
float

This property sets the minimum distance the player's camera is allowed to zoom in, in studs.

The default value of this property is set by StarterPlayer.CameraMinZoomDistance. If this value is set to a higher value than CameraMaxZoomDistance, it will be decreased to CameraMaxZoomDistance.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 5

554 Change Default of CameraMinZoomDistance from 0.5 to
553 Change Default of CameraMinZoomDistance from to 0.5
486 Change ThreadSafety of CameraMinZoomDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of CameraMinZoomDistance from to ReadOnly
147 Add CameraMinZoomDistance

CameraMode
CreatorHub

Type		Default
CameraMode

This property sets the player's camera mode, defaulting to third person.

Third Person

In the default third person mode (CameraMode.Classic), the character can be seen in the camera. While in this mode, the default behavior is:

Players can right-click and drag (mouse), tap and drag (mobile), use the secondary thumbstick (gamepad), or press the left/right arrows (keyboard) to rotate the camera around their character.
When a player moves their character, it faces in the corresponding movement direction.
Players can zoom in and out freely, even to first person on full zoom in.

First Person

In first person mode (CameraMode.LockFirstPerson), the player's camera is zoomed all the way in. Unless there is a visible GUI present with the GuiButton.Modal property set to true, moving the mouse, tap-dragging on mobile, or using the secondary thumbstick on a gamepad will rotate the camera around the character.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 5

554 Change Default of CameraMode from Classic to
553 Change Default of CameraMode from to Classic
486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
462 Change ThreadSafety of CameraMode from to ReadOnly
50 Add CameraMode

CanLoadCharacterAppearance
CreatorHub

Type		Default
bool

This property determines whether the character's appearance will be loaded when the player spawns. The default value of this property is set by StarterPlayer.LoadPlayerAppearance.

If true, the character will load the appearance of the player corresponding to the player's CharacterAppearanceId.
If false, the player will spawn with a default appearance.

Attempting to set the property after the character has spawned will not change the character; you must call LoadCharacter() to load the new appearance.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	false

History 5

554 Change Default of CanLoadCharacterAppearance from true to
553 Change Default of CanLoadCharacterAppearance from to true
486 Change ThreadSafety of CanLoadCharacterAppearance from ReadOnly to ReadSafe
462 Change ThreadSafety of CanLoadCharacterAppearance from to ReadOnly
68 Add CanLoadCharacterAppearance

Character
CreatorHub

Type		Default
Model

This property contains a reference to a Model containing a Humanoid, body parts, scripts, and other objects required for simulating the player's avatar in-experience. The model is parented to the Workspace but it may be moved. It is automatically loaded when Players.CharacterAutoLoads is true and it can be manually loaded otherwise using LoadCharacter().

Initially this property is nil and it is set when the player's character first spawns. Use the CharacterAdded event to detect when a player's character properly loads, and the CharacterRemoving event to detect when the character is about to despawn. Avoid using Object:GetPropertyChangedSignal() on this property.

Note that LocalScripts that are cloned from StarterGui or StarterPack into a player's PlayerGui or Backpack respectively are often run before the old character model is replaced, so Player.Character may refer to the old model whose Parent property is nil. Therefore, in a LocalScript under StarterGui or StarterPack, it is advisable to make sure the parent of Character is not nil before using it, for example:

local Players = game:GetService("Players")
local player = Players.LocalPlayer

local character = player.Character
if not character or character.Parent == nil then
	character = player.CharacterAdded:Wait()
end

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of Character from to
553 Change Default of Character from to
486 Change ThreadSafety of Character from ReadOnly to ReadSafe
462 Change ThreadSafety of Character from to ReadOnly
329 Change ValueType of Character from Object to Model
47 Add Character

CharacterAdded
CreatorHub

Parameters (1)
character	Model

This event fires when a player's character spawns or respawns. It fires soon after setting Character to a non-nil value or calling LoadCharacter(), which is before the character is parented to the Workspace.

This can be used alongside the CharacterRemoving event which fires right before a player's character is about to be removed, typically after death. As such, both of these events can potentially fire many times as players die then respawn in a place.

Note that the Humanoid and its default body parts (head, torso, and limbs) will exist when this event fires, but clothing items like Hats, Shirts, and Pants may take a few seconds to be added to the character. Connect Instance.ChildAdded on the added character to detect these, or wait for the CharacterAppearanceLoaded event to be sure the character has everything equipped.

If you instead need to track when a player joins/leaves the experience, use the events Players.PlayerAdded and Players.PlayerRemoving.

Thread safety	Unsafe

History 3

483 Change Parameters of CharacterAdded from (character: Instance) to (character: Model)
462 Change ThreadSafety of CharacterAdded from to Unsafe
47 Add CharacterAdded

CharacterAppearance
CreatorHub

Type		Default
string

This property indicates the URL of the asset containing the character's appearance, clothing, and gear. It is automatically set by Roblox to load your avatar's appearance when you join an experience.

Attempting to set the property after the character has spawned will not change the character, you must call LoadCharacter() to load the new appearance.

It exists only for backward compatibility, and should not be used for new work. CharacterAppearanceId should be used instead.

It is not visible in Studio's object browser.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of CharacterAppearance from to
553 Change PreferredDescriptor of CharacterAppearance from to CharacterAppearanceId
486 Change ThreadSafety of CharacterAppearance from ReadOnly to ReadSafe
462 Change ThreadSafety of CharacterAppearance from to ReadOnly
292 Change Tags of CharacterAppearance from [NotBrowsable] to [NotBrowsable, Deprecated]
47 Add CharacterAppearance

Tags: [NotBrowsable, Deprecated]

CharacterAppearanceId
CreatorHub

Type		Default
int64

This property determines the user ID of the account whose character appearance is used for a player's Character. By default, this property is the UserId, which uses the player's avatar as they have created it on Roblox.

Changing this property to the user ID of another account will cause the player to spawn with that account's appearance.

You can also toggle whether or not a player's character appearance is loaded in experience by changing the StarterPlayer.LoadCharacterAppearance property.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of CharacterAppearanceId from 0 to
553 Change Default of CharacterAppearanceId from to 0
486 Change ThreadSafety of CharacterAppearanceId from ReadOnly to ReadSafe
462 Change ThreadSafety of CharacterAppearanceId from to ReadOnly
323 Change ValueType of CharacterAppearanceId from int to int64
250 Add CharacterAppearanceId

CharacterAppearanceLoaded
CreatorHub

Parameters (1)
character	Model

This event fires when the full appearance of a Character has been inserted. It only fires on the server.

A Character generally has a range of objects modifying its appearance, including Accoutrements, Shirts, Pants and CharacterMeshes. This event will fire when all such objects have been inserted into the character.

For custom character implementations, such as using a character model named StarterCharacter inside StarterPlayer, use CharacterAdded and handle your own accessories.

One use for this event is to ensure all accessories have loaded before destroying them. See below for an example of this.

Thread safety	Unsafe

History 3

483 Change Parameters of CharacterAppearanceLoaded from (character: Instance) to (character: Model)
462 Change ThreadSafety of CharacterAppearanceLoaded from to Unsafe
210 Add CharacterAppearanceLoaded

CharacterRemoving
CreatorHub

Parameters (1)
character	Model

This event fires right before a player's Character is removed, such as when the player is respawning. This can be used alongside the CharacterAdded event which fires when a player's character spawns or respawns.

If you instead need to track when a player joins/leaves the experience, use the events Players.PlayerAdded and Players.PlayerRemoving.

Thread safety	Unsafe

History 3

483 Change Parameters of CharacterRemoving from (character: Instance) to (character: Model)
462 Change ThreadSafety of CharacterRemoving from to Unsafe
47 Add CharacterRemoving

ChararacterRegionId
CreatorHub

Type		Default
Vector3

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of ChararacterRegionId from Vector3(NAN, NAN, NAN) to
553 Add ChararacterRegionId

Tags: [Hidden, NotScriptable]

ChatMode
CreatorHub

Type		Default
ChatMode

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

554 Change Default of ChatMode from TextAndMenu to
553 Change Default of ChatMode from to TextAndMenu
486 Change ThreadSafety of ChatMode from ReadOnly to ReadSafe
469 Change Tags of ChatMode from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
462 Change ThreadSafety of ChatMode from to ReadOnly
47 Add ChatMode

Tags: [Hidden, ReadOnly, NotReplicated]

ChatPrivacyMode
CreatorHub

Type		Default
ChatPrivacyMode

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of ChatPrivacyMode from NoOne to
553 Add ChatPrivacyMode

Tags: [Hidden, NotScriptable]

Chatted
CreatorHub

Parameters (2)
message	string
recipient	Player

This event fires when a Player types a message and presses Enter in Roblox's provided chat bar. This is done using some Luau bindings by the default chat script. You can prevent players from chatting by using StarterGui:SetCoreGuiEnabled() and setting CoreGuiType.Chat to false.

Thread safety	Unsafe

History 3

483 Change Parameters of Chatted from (message: string, recipient: Instance) to (message: string, recipient: Player)
462 Change ThreadSafety of Chatted from to Unsafe
47 Add Chatted

ClearCharacterAppearance
CreatorHub

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

This method removes all Accessory, Shirt, Pants, CharacterMesh, and BodyColors from the given player's Character. In addition, it also removes the T-Shirt Decal on the player's torso. The character's body part colors and face will remain unchanged. This method does nothing if the player does not have a Character.

Thread safety	Unsafe

History 3

573 Change ReturnType of ClearCharacterAppearance from void to null
462 Change ThreadSafety of ClearCharacterAppearance from to Unsafe
68 Add ClearCharacterAppearance

CloudEditCameraCoordinateFrame
CreatorHub

Type		Default
CFrame

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of CloudEditCameraCoordinateFrame from to
553 Add CloudEditCameraCoordinateFrame

Tags: [Hidden, NotScriptable]

CloudEditPlayerActive
CreatorHub

Type		Default
bool

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of CloudEditPlayerActive from true to
553 Add CloudEditPlayerActive

Tags: [Hidden, NotScriptable]

CloudEditSelectionChanged
CreatorHub

Parameters (1)
newSelection	Array

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

678 Change Tags of CloudEditSelectionChanged from [Hidden] to []
678 Change Security of CloudEditSelectionChanged from RobloxSecurity to RobloxScriptSecurity
553 Add CloudEditSelectionChanged

ConnectDiedSignalBackend
CreatorHub

Parameters (0)
No parameters.

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add ConnectDiedSignalBackend

Tags: [Hidden]

CountryRegionCodeReplicate
CreatorHub

Type		Default
string

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of CountryRegionCodeReplicate from to
553 Add CountryRegionCodeReplicate

Tags: [Hidden, NotScriptable]

DataComplexity
CreatorHub

Type		Default
int

This property was once used by an ancient data persistence method to indicate the total amount of data currently being stored in the player's cache on the current place.

Notes

Booleans and numbers cost 1 data complexity unit.
Strings cost their length divided by 100 in data complexity units.
Instances cost their DataCost in data complexity units.
Saving the default value (0 for numbers, false for booleans, "" for strings and nil for Instances) removes the key from the DataComplexity count.
If, when using the SaveBoolean, SaveString, SaveNumber or SaveInstance functions, the DataComplexity for the player goes over the limit (currently 45000 units, defined by DataComplexityLimit), the function throws an error, the value is not saved, and any previous value of the key that was being saved to is deleted.

It exists only for backward compatibility, and should not be used for new work.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 7

554 Change Default of DataComplexity from 0 to
553 Change Default of DataComplexity from to 0
486 Change ThreadSafety of DataComplexity from ReadOnly to ReadSafe
469 Change Tags of DataComplexity from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
462 Change ThreadSafety of DataComplexity from to ReadOnly
252 Change Tags of DataComplexity from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
47 Add DataComplexity

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

DataComplexityLimit
CreatorHub

Type		Default
int

It exists only for backward compatibility, and should not be used for new work.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 8

554 Change Default of DataComplexityLimit from 45000 to
553 Change Default of DataComplexityLimit from to 45000
486 Change ThreadSafety of DataComplexityLimit from ReadOnly to ReadSafe
469 Change Tags of DataComplexityLimit from [NotReplicated, Deprecated] to [Hidden, NotReplicated, Deprecated]
469 Change CanLoad of DataComplexityLimit from true to false
462 Change ThreadSafety of DataComplexityLimit from to ReadOnly
252 Change Tags of DataComplexityLimit from [NotReplicated] to [NotReplicated, Deprecated]
47 Add DataComplexityLimit

Tags: [Hidden, NotReplicated, Deprecated]

DataReady
CreatorHub

Type		Default
bool

This property was once used by an ancient data persistence method to indicate when the player's data is available to load. Becomes true when data is available.

It exists only for backward compatibility, and should not be used for new work.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 7

554 Change Default of DataReady from false to
553 Change Default of DataReady from to false
486 Change ThreadSafety of DataReady from ReadOnly to ReadSafe
469 Change Tags of DataReady from [ReadOnly, NotReplicated, Deprecated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
462 Change ThreadSafety of DataReady from to ReadOnly
252 Change Tags of DataReady from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
47 Add DataReady

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

DevCameraOcclusionMode
CreatorHub

Type		Default
DevCameraOcclusionMode

Defines how the default camera scripts handle objects between the camera and the camera subject. Set by StarterPlayer.DevCameraOcclusionMode and can't be changed for individual players.

The default value is Zoom. See DevCameraOcclusionMode for a list of available modes.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 7

554 Change Default of DevCameraOcclusionMode from Zoom to
553 Change Default of DevCameraOcclusionMode from to Zoom
486 Change ThreadSafety of DevCameraOcclusionMode from ReadOnly to ReadSafe
462 Change ThreadSafety of DevCameraOcclusionMode from to ReadOnly
177 Add DevCameraOcclusionMode
176 Remove DevCameraOcclusionMode
177 Add DevCameraOcclusionMode

DevComputerCameraMode
CreatorHub

Type		Default
DevComputerCameraMovementMode

This property determines the manner in which a player moves their camera when using a device with a mouse and keyboard. This property cannot be set using a LocalScript (it must be set on the server using a Script).

The default value of this property is determined by StarterPlayer.DevComputerCameraMovementMode.

This property doesn't affect players using a TouchEnabled device. See DevTouchCameraMode instead.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 7

554 Change Default of DevComputerCameraMode from UserChoice to
553 Change Default of DevComputerCameraMode from to UserChoice
486 Change ThreadSafety of DevComputerCameraMode from ReadOnly to ReadSafe
462 Change ThreadSafety of DevComputerCameraMode from to ReadOnly
177 Add DevComputerCameraMode
176 Remove DevComputerCameraMode
177 Add DevComputerCameraMode

DevComputerMovementMode
CreatorHub

Type		Default
DevComputerMovementMode

This property determines the manner in which a player moves their character when using a device with a mouse and keyboard. This property cannot be set using a LocalScript (it must be set on the server using a Script).

The default value of this property is determined by StarterPlayer.DevComputerMovementMode.

This property doesn't affect players using a TouchEnabled device. See DevTouchMovementMode instead.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 7

554 Change Default of DevComputerMovementMode from UserChoice to
553 Change Default of DevComputerMovementMode from to UserChoice
486 Change ThreadSafety of DevComputerMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of DevComputerMovementMode from to ReadOnly
177 Add DevComputerMovementMode
176 Remove DevComputerMovementMode
177 Add DevComputerMovementMode

DevEnableMouseLock
CreatorHub

Type		Default
bool

This property determines if a player is able to toggle mouse lock by pressing Shift. A player can disable the mouse lock switch in the experience's settings during play. By default, this property is set to the value of StarterPlayer.EnableMouseLockOption. This can be set server-side during runtime by using a Script. It can not be set client-side.

When mouse lock is enabled, the player's cursor is locked to the center of the screen. Moving the mouse will orbit the camera around the player's Character, and the character will face the same direction as the Camera. It also offsets the camera view just over the right shoulder of the player's character.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 9

578 Change Tags of DevEnableMouseLock from [Deprecated] to []
576 Change Tags of DevEnableMouseLock from [] to [Deprecated]
554 Change Default of DevEnableMouseLock from true to
553 Change Default of DevEnableMouseLock from to true
486 Change ThreadSafety of DevEnableMouseLock from ReadOnly to ReadSafe
462 Change ThreadSafety of DevEnableMouseLock from to ReadOnly
177 Add DevEnableMouseLock
176 Remove DevEnableMouseLock
177 Add DevEnableMouseLock

DevTouchCameraMode
CreatorHub

Type		Default
DevTouchCameraMovementMode

This property determines the manner in which a player moves their camera when using a TouchEnabled device. This property cannot be set using a LocalScript (it must be set on the server using a Script).

The default value of this property is determined by StarterPlayer.DevTouchCameraMovementMode.

This property doesn't affect players who aren't using a TouchEnabled device. See DevComputerCameraMode instead.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 7

554 Change Default of DevTouchCameraMode from UserChoice to
553 Change Default of DevTouchCameraMode from to UserChoice
486 Change ThreadSafety of DevTouchCameraMode from ReadOnly to ReadSafe
462 Change ThreadSafety of DevTouchCameraMode from to ReadOnly
177 Add DevTouchCameraMode
176 Remove DevTouchCameraMode
177 Add DevTouchCameraMode

DevTouchMovementMode
CreatorHub

Type		Default
DevTouchMovementMode

This property determines the manner in which a player moves their character when using a TouchEnabled device. This property cannot be set using a LocalScript (it must be set on the server using a Script).

The default value of this property is determined by StarterPlayer.DevTouchMovementMode.

This property doesn't affect players who aren't using a TouchEnabled device. See DevComputerMovementMode instead.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 7

554 Change Default of DevTouchMovementMode from UserChoice to
553 Change Default of DevTouchMovementMode from to UserChoice
486 Change ThreadSafety of DevTouchMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of DevTouchMovementMode from to ReadOnly
177 Add DevTouchMovementMode
176 Remove DevTouchMovementMode
177 Add DevTouchMovementMode

DisplayName
CreatorHub

Type		Default
string

This property contains the display name of the authenticated user associated with the Player object. Unlike UserId, display names are non-unique names a player displays to others.

Usage Notes

Since display names are non-unique, it's possible for two players in a single instance to have identical names. If you need a globally unique identifier for a player, use UserId instead.
Characters generated with LoadCharacter() or by the Roblox engine will have their Humanoid.DisplayName property assigned to the Player.DisplayName property.
Display names may have unicode characters in the string. See UTF-8 for more information on how to work with strings with unicode characters.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

554 Change Default of DisplayName from to
486 Change ThreadSafety of DisplayName from ReadOnly to ReadSafe
462 Change ThreadSafety of DisplayName from to ReadOnly
428 Change WriteSecurity of DisplayName from RobloxScriptSecurity to None
428 Change ReadSecurity of DisplayName from RobloxScriptSecurity to None
291 Add DisplayName

DistanceFromCharacter
CreatorHub

Parameters (1)
point	Vector3
Returns (1)
float

This method returns the distance between the character's head and the given Vector3 point, or 0 if the player has no Character.

This is useful when determining the distance between a player and another object or location in experience.

If you would like to determine the distance between two non-player instances or positions, you can use the following:

1	`local distance = (position1 - position2).Magnitude`

Thread safety	Unsafe

History 2

462 Change ThreadSafety of DistanceFromCharacter from to Unsafe
47 Add DistanceFromCharacter

FollowUserId
CreatorHub

Type		Default
int64

This property contains the UserId of the user that a player followed into the experience, or 0 if the player did not follow anyone in. This property is useful for alerting players who have been followed by another player into the experience.

You can get the name of the player followed using this user ID and the Players:GetNameFromUserIdAsync() method.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false/true

History 6

554 Change Default of FollowUserId from 0 to
553 Change Default of FollowUserId from to 0
486 Change ThreadSafety of FollowUserId from ReadOnly to ReadSafe
462 Change ThreadSafety of FollowUserId from to ReadOnly
323 Change ValueType of FollowUserId from int to int64
169 Add FollowUserId

Tags: [ReadOnly, NotReplicated]

FollowUserIdReplicated
CreatorHub

Type		Default
int64

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of FollowUserIdReplicated from 0 to
553 Add FollowUserIdReplicated

Tags: [Hidden, NotScriptable]

FriendStatusChanged
CreatorHub

Parameters (2)
player	Player
friendStatus	FriendStatus

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

483 Change Parameters of FriendStatusChanged from (player: Instance, friendStatus: FriendStatus) to (player: Player, friendStatus: FriendStatus)
462 Change ThreadSafety of FriendStatusChanged from to Unsafe
47 Add FriendStatusChanged

GameplayPaused
CreatorHub

Type		Default
bool

This property indicates if the player is currently in a pause state in a place with StreamingEnabled activated. It is set on the client but replicated to the server.

History 8

554 Change Default of GameplayPaused from false to
553 Change Default of GameplayPaused from to false
486 Change ThreadSafety of GameplayPaused from ReadOnly to ReadSafe
462 Change ThreadSafety of GameplayPaused from to ReadOnly
386 Change WriteSecurity of GameplayPaused from None to NotAccessibleSecurity
386 Change Tags of GameplayPaused from [ReadOnly, NotReplicated] to []
386 Change CanLoad of GameplayPaused from false to true
384 Add GameplayPaused

GetData
CreatorHub

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

Thread safety	Unsafe

History 1

664 Add GetData

GetFriendStatus
CreatorHub

Parameters (1)
player	Player
Returns (1)
FriendStatus

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

483 Change Parameters of GetFriendStatus from (player: Instance) to (player: Player)
462 Change ThreadSafety of GetFriendStatus from to Unsafe
47 Add GetFriendStatus

GetFriendsOnline
CreatorHub

Parameters (1)		Default
maxFriends	int	200
Returns (1)
Array

This function returns a dictionary array of online friends, using a 30 second cache. In the returned array, some fields are only present for certain location types; for example, PlaceId won't be present when LocationType is 0 (mobile website).

Name	Type	Description
`VisitorId`	number	The UserId of the friend.
`UserName`	string	The username of the friend.
`DisplayName`	string	The DisplayName of the friend.
`LastOnline`	string	When the friend was last online.
`IsOnline`	boolean	If the friend is currently online.
`LastLocation`	string	The name of the friend's current location.
`PlaceId`	number	The place ID of the friend's last location.
`GameId`	string	The DataModel.JobId of the friend's last location.
`LocationType`	number	The location type of the friend's last location.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of GetFriendsOnline from to Unsafe
204 Change ReturnType of GetFriendsOnline from Dictionary to Array
204 Change Parameters of GetFriendsOnline from (maxFriends: int = 50) to (maxFriends: int = 200)
119 Add GetFriendsOnline

Tags: [Yields]

GetGameSessionID
CreatorHub

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

Security	RobloxSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetGameSessionID from to Unsafe
133 Add GetGameSessionID

GetJoinData
CreatorHub

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

Returns a dictionary containing information describing how the player joins the experience. The dictionary contains any of the following fields:

Key	Value Type	Description
`SourceGameId`	number	The DataModel.GameId of the experience the `Player` teleported from. Only present if the player teleports to the current experience and if a server calls the teleport function.
`SourcePlaceId`	number	The DataModel.PlaceId of the place the `Player` teleported from. Only present if the player teleports to the current place and a server calls the teleport function.
`ReferredByPlayerId`	number	The UserId of the player who invited the current player to the experience. Use this data to identify the referrer and trigger reward logic.
`Members`	array	An array containing the UserId numbers of the users teleported alongside the player. Only present if the player teleported as part of a group.
`TeleportData`	variant	Reflects the `teleportData` specified in the original teleport. Useful for sharing information between servers the player teleports to. Only present if `teleportData` was specified and a server calls the teleport function.
`LaunchData`	string	A plain or JSON encoded string that contains launch data specified in a deep link URL or ExperienceInviteOptions.LaunchData.
`GameJoinContext`	dictionary	A dictionary that includes relevant information based on the context of the join. It contains the following keys: `JoinSource`: JoinSource `ItemType`: optional AvatarItemType `AssetId`: optional `string` `OutfitId`: optional `string` `AssetType`: optional AssetType

If a server initiates the player's teleport, the dictionary that this method returns includes the player's teleport data. The GetJoinData() method can only be used to fetch teleport data on the server. To fetch the data on the client, use TeleportService:GetLocalPlayerTeleportData().

Unlike TeleportService:GetLocalPlayerTeleportData(), GetJoinData() only provides teleport data that meets the following security criteria:

It's guaranteed to have been sent by a Roblox server in the past 48 hours.
It's guaranteed to have been sent with this Player.
The SourcePlaceId and SourceGameId are guaranteed to be the place and universe the data was sent from. This means you can verify the teleport data came from an approved place.

As this data is transmitted by the client, it can still potentially be abused by an exploiter. Sensitive data such as player currency should be transmitted via a secure solution like Memory Stores.

It may behave in a non-standard way.

Thread safety	Unsafe

History 3

624 Change Tags of GetJoinData from [] to [CustomLuaState]
462 Change ThreadSafety of GetJoinData from to Unsafe
333 Add GetJoinData

Tags: [CustomLuaState]

GetMouse
CreatorHub

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

This method returns the Mouse being used by the client. The player's mouse instance can be used to track user mouse input including left and right mouse button clicks and movement and location.

Note that UserInputService provides additional methods, properties, and events to track user input, especially for devices that do not use a mouse.

Thread safety	Unsafe

History 3

483 Change ReturnType of GetMouse from Instance to Mouse
462 Change ThreadSafety of GetMouse from to Unsafe
71 Add GetMouse

GetNetworkPing
CreatorHub

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

Returns the isolated network latency of the player in seconds. "Ping" is a measurement of the time taken for data to be sent from the client to the server, then back again. It doesn't involve data deserialization or processing.

For client-side LocalScripts, this function can only be called on the Players.LocalPlayer. This function is useful in identifying and debugging issues that occur in high network latency scenarios. It's also useful for masking latency, such as adjusting the speed of throwing animations for projectiles.

Thread safety	Safe

History 3

562 Change ThreadSafety of GetNetworkPing from Unsafe to Safe
488 Change ReturnType of GetNetworkPing from int to float
481 Add GetNetworkPing

GetRankInGroup
CreatorHub

Parameters (1)
groupId	int64
Returns (1)
int

This method returns the player's rank in the group as an integer between 0 and 255, where 0 is a non-member and 255 is the group's owner.

Using this in a Script, as opposed to a LocalScript, will not get you the most up-to-date information. If a player leaves a group while they are in the experience, GetRankInGroup() will still think they're in that group until they leave. However, this does not happen when used with a LocalScript because the method caches results, so multiple calls of GetRankInGroup() on the same player with the same group ID will yield the same result as when the method was first called with the given group ID. The caching behavior is on a per-peer basis: a server does not share the same cache as a client.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of GetRankInGroup from to Unsafe
323 Change Parameters of GetRankInGroup from (groupId: int) to (groupId: int64)
69 Add GetRankInGroup

Tags: [Yields]

GetRoleInGroup
CreatorHub

Parameters (1)
groupId	int64
Returns (1)
string

This method returns the player's role in the group as a string, or Guest if the player isn't part of the group.

Using this in a Script, as opposed to a LocalScript, will not get you the most up-to-date information. If a player leaves a group while they are in the experience, GetRoleInGroup() will still think they're in that group until they leave. However, this does not happen when used with a LocalScript because the method caches results, so multiple calls of GetRoleInGroup() on the same player with the same group ID will yield the same result as when the method was first called with the given group ID. The caching behavior is on a per-peer basis: a server does not share the same cache as a client.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of GetRoleInGroup from to Unsafe
323 Change Parameters of GetRoleInGroup from (groupId: int) to (groupId: int64)
69 Add GetRoleInGroup

Tags: [Yields]

GetUnder13
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetUnder13 from to Unsafe
83 Add GetUnder13

Guest
CreatorHub

Type		Default
bool

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

554 Change Default of Guest from false to
553 Change Default of Guest from to false
486 Change ThreadSafety of Guest from ReadOnly to ReadSafe
469 Change Tags of Guest from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
462 Change ThreadSafety of Guest from to ReadOnly
47 Add Guest

Tags: [Hidden, ReadOnly, NotReplicated]

HasAppearanceLoaded
CreatorHub

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

This method returns whether or not the appearance of the player's Character has loaded. Appearance includes items such as the player's Shirt, Pants, and Accessories.

This is useful when determining whether a player's appearance has loaded after they first join the experience, which can be tracked using the Players.PlayerAdded event.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of HasAppearanceLoaded from to Unsafe
218 Add HasAppearanceLoaded

HasVerifiedBadge
CreatorHub

Type		Default
bool

This property indicates if the player has a Verified badge.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 1

554 Add HasVerifiedBadge

HealthDisplayDistance
CreatorHub

Type		Default
float

This property sets the distance in studs at which this player will see other Humanoid health bars. If set to 0, the health bars will not be displayed. This property is set to StarterPlayer.HealthDisplayDistance by default.

If a humanoid's health bar is visible, you can set the display type using Humanoid.DisplayDistanceType.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 5

554 Change Default of HealthDisplayDistance from 100 to
553 Change Default of HealthDisplayDistance from to 100
486 Change ThreadSafety of HealthDisplayDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of HealthDisplayDistance from to ReadOnly
147 Add HealthDisplayDistance

Idled
CreatorHub

Parameters (1)
time	double

This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point. The event continues to fire every 30 seconds for as long as the player remains idle.

This event only fires in client scripts, not server scripts; use a RemoteEvent to notify the server of idle players.

Roblox automatically disconnects players that have been idle for at least 20 minutes, so this event is useful for warning players that they will be disconnected soon, disconnecting players prior to those 20 minutes, or other away from keyboard (AFK) features.

To track how often automatic disconnects occur, try correlating this event with occurrences of Players.PlayerRemoving.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of Idled from to Unsafe
47 Add Idled

InternalCharacterAppearanceLoaded
CreatorHub

Type		Default
bool

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of InternalCharacterAppearanceLoaded from false to
553 Add InternalCharacterAppearanceLoaded

Tags: [Hidden, NotScriptable]

IsBestFriendsWith
CreatorHub

Parameters (1)
userId	int64
Returns (1)
bool

This function was once used to return whether a player is best friends with the specified user, but the best friend feature has since been removed.

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of IsBestFriendsWith from to Unsafe
323 Change Parameters of IsBestFriendsWith from (userId: int) to (userId: int64)
206 Change Tags of IsBestFriendsWith from [Yields] to [Yields, Deprecated]
47 Add IsBestFriendsWith

Tags: [Yields, Deprecated]

IsFriendsWith
CreatorHub

Parameters (1)
userId	int64
Returns (1)
bool

This method sends a request to Roblox asking whether a player is a friend of another user, given the UserId of that user. This method caches results so multiple calls on the same player with the same userId may not yield the most up-to-date result.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of IsFriendsWith from to Unsafe
323 Change Parameters of IsFriendsWith from (userId: int) to (userId: int64)
47 Add IsFriendsWith

Tags: [Yields]

IsInGroup
CreatorHub

Parameters (1)
groupId	int64
Returns (1)
bool

This method sends a request to Roblox asking whether a player is a member of a group, given the ID of that group.

Using this in a Script, as opposed to a LocalScript, will not get you the most up-to-date information. If a player leaves a group while they are in the experience, IsInGroup() will still think they're in that group until they leave. However, this does not happen when used with a LocalScript because the method caches results, so multiple calls of IsInGroup() on the same player with the same group ID will yield the same result as when the method was first called with the given group ID. The caching behavior is on a per-peer basis: a server does not share the same cache as a client.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of IsInGroup from to Unsafe
323 Change Parameters of IsInGroup from (groupId: int) to (groupId: int64)
47 Add IsInGroup

Tags: [Yields]

IsVerified
CreatorHub

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

Returns a boolean value indicating that player's verification status. When true, the player is verified. Verification includes, but isn't limited to, non-VOIP phone number or government ID verification.

When implementing IsVerified, exercise caution to ensure that the implementation does not inadvertently block all unverified users.

Note that the method can only be called on the backend server. Calling it client-side results in an error. Additionally, this method will always return false in Studio.

Thread safety	Unsafe

History 1

573 Add IsVerified

Kick
CreatorHub

Parameters (1)		Default
message	string
Returns (1)
null

This method allows an experience to gracefully disconnect a client and optionally provide a message to the disconnected user. This is useful for moderating abusive users. You should only allow specific users whom you trust to trigger this method on other users.

Calling this method on a Player with no arguments disconnects the user from the server and provides a default notice message. Calling this method on a Player along with a string as the first argument replaces the default message with the provided string.

When using this method from a LocalScript, only the local user's client can be kicked.

Thread safety	Unsafe

History 4

573 Change ReturnType of Kick from void to null
462 Change ThreadSafety of Kick from to Unsafe
196 Change Parameters of Kick from () to (message: string = )
121 Add Kick

Kill
CreatorHub

Parameters (0)
No parameters.

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	Unsafe

History 1

553 Add Kill

Tags: [Hidden]

LoadBoolean
CreatorHub

Parameters (1)
key	string
Returns (1)
bool

This function returns a boolean value that was previously saved to the player with Player:SaveBoolean() with the same key. Returns false if the key doesn't exist, not nil.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of LoadBoolean from to Unsafe
252 Change Tags of LoadBoolean from [] to [Deprecated]
47 Add LoadBoolean

Tags: [Deprecated]

LoadCharacter
CreatorHub

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

This method creates a new character for the player, removing the old one. It also clears the player's Backpack and PlayerGui. This is useful in cases where you want to reload the character without killing the player, such as when you want to load a new character appearance after changing the player's CharacterAppearance.

After calling LoadCharacter() for an individual player, it is not recommended to call it again for the same player until after that player's CharacterAppearanceLoaded event has fired.

Character Loading Event Order

Calling the LoadCharacter() method on any Player fires events in the following order:

The character appearance initializes.
The character rig builds and scales.
The character moves to the spawn location.
Player.Character sets.
Object.Changed fires on the Player with a value of Character.
The character's Parent sets to the DataModel.
Player.CharacterAdded fires.
Player.CharacterAppearanceLoaded fires.

It will block the calling thread until completion.

Thread safety	Unsafe

History 6

573 Change ReturnType of LoadCharacter from void to null
462 Change ThreadSafety of LoadCharacter from to Unsafe
290 Change Parameters of LoadCharacter from (inGame: bool = true) to ()
250 Change Tags of LoadCharacter from [] to [Yields]
55 Change Security of LoadCharacter from LocalUserSecurity to None
47 Add LoadCharacter

Tags: [Yields]

LoadCharacterAppearance
CreatorHub

Parameters (1)
assetInstance	Instance
Returns (1)
null

The LoadCharacterAppearance Player function places the given instance either in the player's Player.Character, head, or StarterGear based on the instance's class.

This is useful when giving a player's character an asset from the Roblox catalog, such as a hat or piece of gear.

It is similar to Player:LoadCharacter(), except it does not reload the entire character instance, StarterGear, or PlayerGui.

Note:

Accessory, Shirt, ShirtGraphic, CharacterMesh, BodyColors, and Accoutrement are parented to the player's character.
Decal, FileMesh, SpecialMesh, BlockMesh, CylinderMesh, and Texture are parented to the character's head.
Tool is parented to the player's StarterGear.
All other classes are ignored.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

573 Change ReturnType of LoadCharacterAppearance from void to null
462 Change ThreadSafety of LoadCharacterAppearance from to Unsafe
373 Change Tags of LoadCharacterAppearance from [] to [Deprecated]
68 Add LoadCharacterAppearance

Tags: [Deprecated]

LoadCharacterBlocking
CreatorHub

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

It will block the calling thread until completion.

Security	LocalUserSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of LoadCharacterBlocking from void to null
462 Change ThreadSafety of LoadCharacterBlocking from to Unsafe
288 Add LoadCharacterBlocking

Tags: [Yields]

LoadCharacterWithAvatarRules
CreatorHub

Parameters (1)
avatarRules	AvatarRules
Returns (1)
null

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

672 Add LoadCharacterWithAvatarRules

Tags: [Yields]

LoadCharacterWithHumanoidDescription
CreatorHub

Parameters (1)
humanoidDescription	HumanoidDescription
Returns (1)
null

This method spawns a player character with everything equipped in the passed in HumanoidDescription.

After calling this method for an individual player, it is not recommended to call it again for the same player until after that player's CharacterAppearanceLoaded event has fired.

See also HumanoidDescription System, an article which explains the humanoid description system in greater detail and provides several scripting examples.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

573 Change ReturnType of LoadCharacterWithHumanoidDescription from void to null
483 Change Parameters of LoadCharacterWithHumanoidDescription from (humanoidDescription: Instance) to (humanoidDescription: HumanoidDescription)
462 Change ThreadSafety of LoadCharacterWithHumanoidDescription from to Unsafe
363 Add LoadCharacterWithHumanoidDescription

Tags: [Yields]

LoadData
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Security	LocalUserSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of LoadData from void to null
462 Change ThreadSafety of LoadData from to Unsafe
252 Change Tags of LoadData from [] to [Deprecated]
47 Add LoadData

Tags: [Deprecated]

LoadInstance
CreatorHub

Parameters (1)
key	string
Returns (1)
Instance

This function returns an instance that was previously saved to the player with Player:SaveInstance() with the same key. Returns nil if the key doesn't exist.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of LoadInstance from to Unsafe
252 Change Tags of LoadInstance from [] to [Deprecated]
47 Add LoadInstance

Tags: [Deprecated]

LoadNumber
CreatorHub

Parameters (1)
key	string
Returns (1)
double

This function was once used by an ancient data persistence method to return a number value that was previously saved to the player with Player:SaveNumber() with the same key. Returns 0 if the key doesn't exist, not nil.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of LoadNumber from to Unsafe
252 Change Tags of LoadNumber from [] to [Deprecated]
60 Change ReturnType of LoadNumber from float to double
47 Add LoadNumber

Tags: [Deprecated]

LoadString
CreatorHub

Parameters (1)
key	string
Returns (1)
string

This function returns a string value that was previously saved to the player with Player:SaveString() with the same key. Returns an empty string ("") if the key doesn't exist, not nil.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of LoadString from to Unsafe
252 Change Tags of LoadString from [] to [Deprecated]
47 Add LoadString

Tags: [Deprecated]

LocaleId
CreatorHub

Type		Default
string

This property shows the locale ID that the local player has set for their Roblox account. It holds a string with the two letter code, for example en-us.

See also LocalizationService.RobloxLocaleId, the locale ID used for localizing internal content. This will be a different value when Roblox does not yet internally support the local player's set locale.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 4

554 Change Default of LocaleId from to
486 Change ThreadSafety of LocaleId from ReadOnly to ReadSafe
462 Change ThreadSafety of LocaleId from to ReadOnly
338 Add LocaleId

Tags: [Hidden, ReadOnly, NotReplicated]

MaxSimulationRadius
CreatorHub

Type		Default
float

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 4

554 Change Default of MaxSimulationRadius from 0 to
553 Add MaxSimulationRadius
125 Remove MaxSimulationRadius
64 Add MaxSimulationRadius

Tags: [Hidden, NotScriptable]

MaximumSimulationRadius
CreatorHub

Type		Default
float

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 7

554 Change Default of MaximumSimulationRadius from 1000 to
553 Change Default of MaximumSimulationRadius from to 1000
486 Change ThreadSafety of MaximumSimulationRadius from ReadOnly to ReadSafe
469 Change Tags of MaximumSimulationRadius from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of MaximumSimulationRadius from true to false
462 Change ThreadSafety of MaximumSimulationRadius from to ReadOnly
125 Add MaximumSimulationRadius

Tags: [Hidden, NotReplicated]

MembershipType
CreatorHub

Type		Default
MembershipType

This property can only be read from to determine membership (it cannot be set to another membership type). It holds a MembershipType enum of the account's membership type.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

554 Change Default of MembershipType from None to
553 Change Default of MembershipType from to None
486 Change ThreadSafety of MembershipType from ReadOnly to ReadSafe
462 Change ThreadSafety of MembershipType from to ReadOnly
47 Add MembershipType

Tags: [ReadOnly, NotReplicated]

MembershipTypeReplicate
CreatorHub

Type		Default
MembershipType

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of MembershipTypeReplicate from None to
553 Add MembershipTypeReplicate

Tags: [Hidden, NotScriptable]

Move
CreatorHub

Parameters (2)		Default
walkDirection	Vector3
relativeToCamera	bool	false
Returns (1)
null

This method causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls).

This is useful when scripting NPC Humanoids that move around a map but are not controlled by an actual player's input.

Note that the function's second argument indicates whether the provided Vector3 should move the player relative to world coordinates (false) or the player's Camera (true).

Thread safety	Unsafe

History 3

573 Change ReturnType of Move from void to null
462 Change ThreadSafety of Move from to Unsafe
163 Add Move

NameDisplayDistance
CreatorHub

Type		Default
float

This property sets the distance in studs at which this player will see other Humanoid names. If the property is set to 0, names are hidden. This property is set to StarterPlayer.NameDisplayDistance by default.

If a humanoid's name is visible, you can set the display type using Humanoid.DisplayDistanceType.

Thread safety	ReadSafe
Category	Camera
Loaded/Saved	true

History 5

554 Change Default of NameDisplayDistance from 100 to
553 Change Default of NameDisplayDistance from to 100
486 Change ThreadSafety of NameDisplayDistance from ReadOnly to ReadSafe
462 Change ThreadSafety of NameDisplayDistance from to ReadOnly
147 Add NameDisplayDistance

Neutral
CreatorHub

Type		Default
bool

This property determines whether the player is on a specific team.

When true, the player is not on a specific team. This also means that the Team property will be nil and the TeamColor will be white.
When false, the player is on a specific team. The Team property will correspond to the Team that the player is on, as will the TeamColor.

Thread safety	ReadSafe
Category	Team
Loaded/Saved	true

History 5

554 Change Default of Neutral from true to
553 Change Default of Neutral from to true
486 Change ThreadSafety of Neutral from ReadOnly to ReadSafe
462 Change ThreadSafety of Neutral from to ReadOnly
47 Add Neutral

OnTeleport
CreatorHub

Parameters (3)
teleportState	TeleportState
placeId	int64
spawnName	string

This event fires when the TeleportState of a player changes. This event is useful for detecting whether a teleportation was successful.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of OnTeleport from to Unsafe
322 Change Parameters of OnTeleport from (teleportState: TeleportState, placeId: int, spawnName: string) to (teleportState: TeleportState, placeId: int64, spawnName: string)
130 Add OnTeleport

OnTeleportInternal
CreatorHub

Parameters (3)
teleportState	TeleportState
teleportInfo	Dictionary
customLoadingScreen	Instance

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add OnTeleportInternal

Tags: [Hidden]

OsPlatform
CreatorHub

Type		Default
string

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 8

554 Change Default of OsPlatform from to
486 Change ThreadSafety of OsPlatform from ReadOnly to ReadSafe
469 Change Tags of OsPlatform from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of OsPlatform from true to false
462 Change ThreadSafety of OsPlatform from to ReadOnly
451 Change CanLoad of OsPlatform from false to true
451 Change Tags of OsPlatform from [] to [NotReplicated]
293 Add OsPlatform

Tags: [Hidden, NotReplicated]

OverrideStreamRadii
CreatorHub

Parameters (2)
minRadius	int
targetRadius	int

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

666 Add OverrideStreamRadii

Tags: [Hidden]

OverrideStreamingRadii
CreatorHub

Parameters (2)
minRadius	int
targetRadius	int
Returns (1)
null

Security	RobloxSecurity
Thread safety	Unsafe

History 1

666 Add OverrideStreamingRadii

PartyId
CreatorHub

Type		Default
string

A read-only string identifying the party the player currently belongs to within the experience. If the player is not in a party, this value is an empty string.

This property is essential for integrating with the Roblox Party feature. Use it in combination with SocialService:GetPlayersByPartyId() and SocialService:GetPartyAsync() to access information about a player's party and its members.

Note that this service does not work during playtesting in Roblox Studio; to test aspects of your experience using it, you must publish the experience and play it in the Roblox application.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Write security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

669 Change WriteSecurity of PartyId from WritePlayerSecurity to RobloxSecurity
664 Add PartyId

Tags: [Hidden, NotReplicated]

PinStreamingForInstance
CreatorHub

Parameters (2)
instance	Instance
depth	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

675 Add PinStreamingForInstance

PinStreamingStart
CreatorHub

Parameters (2)
instance	Instance
depth	int

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

675 Add PinStreamingStart

Tags: [Hidden]

PlatformName
CreatorHub

Type		Default
string

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

554 Change Default of PlatformName from to
486 Change ThreadSafety of PlatformName from ReadOnly to ReadSafe
469 Change Tags of PlatformName from [] to [Hidden]
462 Change ThreadSafety of PlatformName from to ReadOnly
423 Add PlatformName

Tags: [Hidden]

PlayerCharacterLoaded
CreatorHub

Parameters (1)
metrics	Dictionary

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

622 Add PlayerCharacterLoaded

Tags: [Hidden]

PlayerChatTranslationSettingsLocaleSetFromLua
CreatorHub

Parameters (1)
newLocaleId	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

611 Add PlayerChatTranslationSettingsLocaleSetFromLua

Tags: [Hidden]

PlayerExperienceSettingsLocaleSetFromLua
CreatorHub

Parameters (1)
newLocaleId	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add PlayerExperienceSettingsLocaleSetFromLua

Tags: [Hidden]

RawJoinData
CreatorHub

Type		Default
BinaryString

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

554 Change Default of RawJoinData from to
553 Add RawJoinData

Tags: [Hidden, NotScriptable]

RemoteFriendRequestSignal
CreatorHub

Parameters (2)
otherUserId	int64
eventType	FriendRequestEvent

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

553 Add RemoteFriendRequestSignal

Tags: [Hidden]

RemoteInsert
CreatorHub

Parameters (2)
url	string
position	Vector3

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	Unsafe

History 1

553 Add RemoteInsert

Tags: [Hidden]

RemoveCharacter
CreatorHub

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

Security	LocalUserSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of RemoveCharacter from void to null
462 Change ThreadSafety of RemoveCharacter from to Unsafe
47 Add RemoveCharacter

RemoveReplicationFocus
CreatorHub

Parameters (1)
part	BasePart
Returns (1)
null

Thread safety	Unsafe

History 1

660 Add RemoveReplicationFocus

RemoveReplicationFocusPosition
CreatorHub

Parameters (2)
center	Vector3
radius	int
Returns (1)
null

Security	RobloxSecurity
Thread safety	Unsafe

History 1

662 Add RemoveReplicationFocusPosition

ReplicationFocus
CreatorHub

Type		Default
Instance

This property sets the part to focus replication around a player. Different Roblox systems that communicate over the network (such as physics, streaming, etc.) replicate at different rates depending on how close objects are to the replication focus.

When this property is nil, it reverts to its default behavior which is to treat the local player's character's PrimaryPart as the replication focus.

This property should only be set on the server with a Script, not a LocalScript. Note that this property does not change or update network ownership of parts.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of ReplicationFocus from to
553 Change Default of ReplicationFocus from to
486 Change ThreadSafety of ReplicationFocus from ReadOnly to ReadSafe
462 Change ThreadSafety of ReplicationFocus from to ReadOnly
329 Change ValueType of ReplicationFocus from Object to Instance
313 Add ReplicationFocus

RequestFriendship
CreatorHub

Parameters (1)
player	Player
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of RequestFriendship from void to null
483 Change Parameters of RequestFriendship from (player: Instance) to (player: Player)
462 Change ThreadSafety of RequestFriendship from to Unsafe
47 Add RequestFriendship

RequestStreamAroundAsync
CreatorHub

Parameters (2)		Default
position	Vector3
timeOut	double	0
Returns (1)
null

For experiences where instance streaming is enabled, requests that the server stream to the player regions (parts and terrain) around the specified X, Y, Z location in the 3D world. It is useful if the experience knows that the player's CFrame will be set to the specified location in the near future. Without providing the location with this call, the player may not have streamed in content for the destination, resulting in a streaming pause or other undesirable behavior.

The effect of this call will be temporary and there are no guarantees of what will be streamed in around the specified location. Client memory limits and network conditions may impact what will be available on the client.

Usage Precaution

Requesting streaming around an area is not a guarantee that the content will be present when the request completes, as streaming is affected by the client's network bandwidth, memory limitations, and other factors.

It will block the calling thread until completion.

Thread safety	Unsafe

History 5

573 Change ReturnType of RequestStreamAroundAsync from void to null
462 Change ThreadSafety of RequestStreamAroundAsync from to Unsafe
429 Add RequestStreamAroundAsync
428 Remove RequestStreamAroundAsync
429 Add RequestStreamAroundAsync

Tags: [Yields]

RequestStreamingPin
CreatorHub

Parameters (2)
instance	Instance
depth	int

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

675 Add RequestStreamingPin

Tags: [Hidden]

RespawnLocation
CreatorHub

Type		Default
SpawnLocation

If set, the player will respawn at the given SpawnLocation which must meet the following criteria:

Descendant of Workspace.
The SpawnLocation.TeamColor property is set to the player's TeamColor or the SpawnLocation.Neutral property is set to true.

Alternatives

A Player will spawn from SpawnLocations belonging to their team. In some cases it may be simpler to change the player's Team instead.
Implement your own custom spawn logic using PVInstance:PivotTo() to manually move the Character.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of RespawnLocation from to
553 Change Default of RespawnLocation from to
486 Change ThreadSafety of RespawnLocation from ReadOnly to ReadSafe
462 Change ThreadSafety of RespawnLocation from to ReadOnly
329 Change ValueType of RespawnLocation from Object to SpawnLocation
182 Add RespawnLocation

RevokeFriendship
CreatorHub

Parameters (1)
player	Player
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of RevokeFriendship from void to null
483 Change Parameters of RevokeFriendship from (player: Instance) to (player: Player)
462 Change ThreadSafety of RevokeFriendship from to Unsafe
47 Add RevokeFriendship

SaveBoolean
CreatorHub

Parameters (2)
key	string
value	bool
Returns (1)
null

This function is used to save a boolean value that can be loaded again at a later time using Player:LoadBoolean().

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

573 Change ReturnType of SaveBoolean from void to null
462 Change ThreadSafety of SaveBoolean from to Unsafe
252 Change Tags of SaveBoolean from [] to [Deprecated]
47 Add SaveBoolean

Tags: [Deprecated]

SaveData
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Security	LocalUserSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of SaveData from void to null
462 Change ThreadSafety of SaveData from to Unsafe
252 Change Tags of SaveData from [] to [Deprecated]
47 Add SaveData

Tags: [Deprecated]

SaveInstance
CreatorHub

Parameters (2)
key	string
value	Instance
Returns (1)
null

This function was once used by an ancient data persistence method to save an instance which can be loaded again at a later time using Player:LoadInstance()..

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

573 Change ReturnType of SaveInstance from void to null
462 Change ThreadSafety of SaveInstance from to Unsafe
252 Change Tags of SaveInstance from [] to [Deprecated]
47 Add SaveInstance

Tags: [Deprecated]

SaveNumber
CreatorHub

Parameters (2)
key	string
value	double
Returns (1)
null

This function was once used by an ancient data persistence method to save a number value that can be loaded again at a later time using Player:LoadNumber().

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 5

573 Change ReturnType of SaveNumber from void to null
462 Change ThreadSafety of SaveNumber from to Unsafe
252 Change Tags of SaveNumber from [] to [Deprecated]
60 Change Parameters of SaveNumber from (key: string, value: float) to (key: string, value: double)
47 Add SaveNumber

Tags: [Deprecated]

SaveString
CreatorHub

Parameters (2)
key	string
value	string
Returns (1)
null

This function was once used by an ancient data persistence method to save a string value that can be loaded again at a later time using Player:LoadString().

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

573 Change ReturnType of SaveString from void to null
462 Change ThreadSafety of SaveString from to Unsafe
252 Change Tags of SaveString from [] to [Deprecated]
47 Add SaveString

Tags: [Deprecated]

ScopeCheckInitiated
CreatorHub

Parameters (3)
guid	string
serializedScopes	Array
metadata	Dictionary

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add ScopeCheckInitiated

Tags: [Hidden]

ScriptSecurityError
CreatorHub

Parameters (3)
hash	string
error	string
stack	string

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	Unsafe

History 1

553 Add ScriptSecurityError

Tags: [Hidden]

ServerToClientUnfilteredChatReplicate
CreatorHub

Parameters (1)
value	bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add ServerToClientUnfilteredChatReplicate

Tags: [Hidden]

ServerUpdatedHead
CreatorHub

Parameters (2)
assetType	AssetType
assetId	int64

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

597 Add ServerUpdatedHead

Tags: [Hidden]

SetAccountAge
CreatorHub

Parameters (1)
accountAge	int
Returns (1)
null

This method sets the AccountAge of the player in days, meaning the age of the account itself relative to when it was first created.

Security	PluginSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of SetAccountAge from void to null
462 Change ThreadSafety of SetAccountAge from to Unsafe
151 Change Security of SetAccountAge from LocalUserSecurity to PluginSecurity
47 Add SetAccountAge

SetBlockListInitialized
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

593 Add SetBlockListInitialized

SetCharacterAppearanceJson
CreatorHub

Parameters (1)
jsonBlob	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of SetCharacterAppearanceJson from void to null
479 Add SetCharacterAppearanceJson

SetChatTranslationSettingsLocaleId
CreatorHub

Parameters (1)
locale	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

611 Add SetChatTranslationSettingsLocaleId

SetExperienceSettingsLocaleId
CreatorHub

Parameters (1)
locale	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of SetExperienceSettingsLocaleId from void to null
546 Add SetExperienceSettingsLocaleId

SetMembershipType
CreatorHub

Parameters (1)
membershipType	MembershipType
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SetMembershipType from void to null
462 Change ThreadSafety of SetMembershipType from to Unsafe
47 Add SetMembershipType

SetModerationAccessKey
CreatorHub

Parameters (1)
moderationAccessKey	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of SetModerationAccessKey from void to null
538 Add SetModerationAccessKey

SetShutdownMessage
CreatorHub

Parameters (1)
message	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add SetShutdownMessage

Tags: [Hidden]

SetSuperSafeChat
CreatorHub

Parameters (1)
value	bool
Returns (1)
null

This method sets whether or not the player sees chat filtered by TextService:FilterStringAsync() rather than normal chats.

local Players = game:GetService("Players")

local player = Players.LocalPlayer
player:SetSuperSafeChat(true)

Regardless of whether a player has filtered chat enabled, all chat should be filtered by TextService when broadcast to other players or on the player's own screen. TextService:FilterStringAsync() returns a TextFilterResult object that can be filtered differently according to the message's intended use.

Security	PluginSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of SetSuperSafeChat from void to null
462 Change ThreadSafety of SetSuperSafeChat from to Unsafe
151 Change Security of SetSuperSafeChat from LocalUserSecurity to PluginSecurity
47 Add SetSuperSafeChat

SetUnder13
CreatorHub

Parameters (1)
value	bool
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work.

Security	RobloxSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of SetUnder13 from void to null
462 Change ThreadSafety of SetUnder13 from to Unsafe
83 Change Security of SetUnder13 from LocalUserSecurity to RobloxSecurity
47 Add SetUnder13

Tags: [Deprecated]

SimulationRadius
CreatorHub

Type		Default
float

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

554 Change Default of SimulationRadius from 10 to
553 Change Default of SimulationRadius from to 10
486 Change ThreadSafety of SimulationRadius from ReadOnly to ReadSafe
469 Change Tags of SimulationRadius from [] to [Hidden]
462 Change ThreadSafety of SimulationRadius from to ReadOnly
61 Add SimulationRadius

Tags: [Hidden]

SimulationRadiusChanged
CreatorHub

Parameters (1)
radius	float

Security	LocalUserSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of SimulationRadiusChanged from to Unsafe
138 Add SimulationRadiusChanged

StatsAvailable
CreatorHub

Parameters (1)
info	string

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	Unsafe

History 1

553 Add StatsAvailable

Tags: [Hidden]

StepIdOffset
CreatorHub

Type		Default
int

Security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 1

663 Add StepIdOffset

StreamingPinComplete
CreatorHub

Parameters (1)
instance	Instance

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

675 Add StreamingPinComplete

SuperSafeChatReplicate
CreatorHub

Type		Default
bool

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

554 Change Default of SuperSafeChatReplicate from false to
553 Add SuperSafeChatReplicate

Tags: [Hidden, NotScriptable]

Team
CreatorHub

Type		Default
Team

This property is a reference to a Team object within the Teams service. If the player isn't on a team or has an invalid TeamColor, this property is nil. When this property is set, the player has joined the Team and the Team.PlayerAdded event fires on the associated team. Similarly, Team.PlayerRemoved fires when the property is unset from a certain Team.

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Team
Loaded/Saved	true

History 6

554 Change Default of Team from to
553 Change Default of Team from to
486 Change ThreadSafety of Team from ReadOnly to ReadSafe
462 Change ThreadSafety of Team from to ReadOnly
329 Change ValueType of Team from Object to Team
250 Add Team

Tags: [NotReplicated]

TeamColor
CreatorHub

Type		Default
BrickColor

This property determines which Team a player is associated with according to that team's Team.TeamColor. If no Team object has the associated BrickColor, the player will not be associated with a team.

It's often a better idea to set Player.Team to the respective Team instead of using this property. Setting this property often leads to repetition of the same BrickColor value for a certain team across many scripts.

Thread safety	ReadSafe
Category	Team
Loaded/Saved	true

History 5

554 Change Default of TeamColor from to
553 Change Default of TeamColor from to
486 Change ThreadSafety of TeamColor from ReadOnly to ReadSafe
462 Change ThreadSafety of TeamColor from to ReadOnly
47 Add TeamColor

Teleported
CreatorHub

Type		Default
bool

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

554 Change Default of Teleported from false to
553 Change Default of Teleported from to false
486 Change ThreadSafety of Teleported from ReadOnly to ReadSafe
462 Change ThreadSafety of Teleported from to ReadOnly
205 Add Teleported

Tags: [Hidden, ReadOnly, NotReplicated]

TeleportedIn
CreatorHub

Type		Default
bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 6

554 Change Default of TeleportedIn from false to
553 Change Default of TeleportedIn from to false
486 Change ThreadSafety of TeleportedIn from ReadOnly to ReadSafe
469 Change Tags of TeleportedIn from [] to [Hidden]
462 Change ThreadSafety of TeleportedIn from to ReadOnly
215 Add TeleportedIn

Tags: [Hidden]

ThirdPartyTextChatRestrictionStatus
CreatorHub

Type		Default
ChatRestrictionStatus

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false/true

History 1

663 Add ThirdPartyTextChatRestrictionStatus

Tags: [ReadOnly, NotReplicated]

UnfilteredChat
CreatorHub

Type		Default
bool

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

554 Change Default of UnfilteredChat from false to
553 Change Default of UnfilteredChat from to false
547 Add UnfilteredChat

Tags: [Hidden, ReadOnly, NotReplicated]

UnpinStreaming
CreatorHub

Parameters (2)
instance	Instance
depth	int

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

675 Add UnpinStreaming

Tags: [Hidden]

UnpinStreamingForInstance
CreatorHub

Parameters (2)
instance	Instance
depth	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

675 Add UnpinStreamingForInstance

UpdatePlayerBlocked
CreatorHub

Parameters (2)
userId	int64
blocked	bool
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of UpdatePlayerBlocked from void to null
462 Change ThreadSafety of UpdatePlayerBlocked from to Unsafe
344 Add UpdatePlayerBlocked

UserId
CreatorHub

Type		Default
int64

This property contains a read-only integer that uniquely and consistently identifies the user's account on Roblox. Unlike the player's DisplayName which may change, this value will never change for the same account.

This property is essential when saving/loading player data using GlobalDataStores.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

554 Change Default of UserId from 0 to
553 Change Default of UserId from to 0
486 Change ThreadSafety of UserId from ReadOnly to ReadSafe
462 Change ThreadSafety of UserId from to ReadOnly
323 Change ValueType of UserId from int to int64
210 Add UserId

VRDevice
CreatorHub

Type		Default
string

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

554 Change Default of VRDevice from to
486 Change ThreadSafety of VRDevice from ReadOnly to ReadSafe
469 Change Tags of VRDevice from [] to [Hidden]
462 Change ThreadSafety of VRDevice from to ReadOnly
235 Add VRDevice

Tags: [Hidden]

VREnabled
CreatorHub

Type		Default
bool

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 1

557 Add VREnabled

Tags: [Hidden, NotReplicated]

WaitForDataReady
CreatorHub

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

This function is used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the player's data

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of WaitForDataReady from to Unsafe
252 Change Tags of WaitForDataReady from [Yields] to [Yields, Deprecated]
47 Add WaitForDataReady

Tags: [Yields, Deprecated]

isFriendsWith
CreatorHub

Parameters (1)
userId	int64
Returns (1)
bool

It exists only for backward compatibility, and should not be used for new work. IsFriendsWith should be used instead.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

553 Change PreferredDescriptor of isFriendsWith from to IsFriendsWith
462 Change ThreadSafety of isFriendsWith from to Unsafe
323 Change Parameters of isFriendsWith from (userId: int) to (userId: int64)
61 Add isFriendsWith

Tags: [Yields, Deprecated]

loadBoolean
CreatorHub

Parameters (1)
key	string
Returns (1)
bool

It exists only for backward compatibility, and should not be used for new work. LoadBoolean should be used instead.

Thread safety	Unsafe

History 3

553 Change PreferredDescriptor of loadBoolean from to LoadBoolean
462 Change ThreadSafety of loadBoolean from to Unsafe
61 Add loadBoolean

Tags: [Deprecated]

loadInstance
CreatorHub

Parameters (1)
key	string
Returns (1)
Instance

It exists only for backward compatibility, and should not be used for new work. LoadInstance should be used instead.

Thread safety	Unsafe

History 3

553 Change PreferredDescriptor of loadInstance from to LoadInstance
462 Change ThreadSafety of loadInstance from to Unsafe
61 Add loadInstance

Tags: [Deprecated]

loadNumber
CreatorHub

Parameters (1)
key	string
Returns (1)
double

It exists only for backward compatibility, and should not be used for new work. LoadNumber should be used instead.

Thread safety	Unsafe

History 4

553 Change PreferredDescriptor of loadNumber from to LoadNumber
462 Change ThreadSafety of loadNumber from to Unsafe
60 Change ReturnType of loadNumber from float to double
50 Add loadNumber

Tags: [Deprecated]

loadString
CreatorHub

Parameters (1)
key	string
Returns (1)
string

It exists only for backward compatibility, and should not be used for new work. LoadString should be used instead.

Thread safety	Unsafe

History 3

553 Change PreferredDescriptor of loadString from to LoadString
462 Change ThreadSafety of loadString from to Unsafe
61 Add loadString

Tags: [Deprecated]

saveBoolean
CreatorHub

Parameters (2)
key	string
value	bool
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work. SaveBoolean should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of saveBoolean from void to null
553 Change PreferredDescriptor of saveBoolean from to SaveBoolean
462 Change ThreadSafety of saveBoolean from to Unsafe
61 Add saveBoolean

Tags: [Deprecated]

saveInstance
CreatorHub

Parameters (2)
key	string
value	Instance
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work. SaveInstance should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of saveInstance from void to null
553 Change PreferredDescriptor of saveInstance from to SaveInstance
462 Change ThreadSafety of saveInstance from to Unsafe
61 Add saveInstance

Tags: [Deprecated]

saveNumber
CreatorHub

Parameters (2)
key	string
value	double
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work. SaveNumber should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of saveNumber from void to null
553 Change PreferredDescriptor of saveNumber from to SaveNumber
462 Change ThreadSafety of saveNumber from to Unsafe
61 Add saveNumber

Tags: [Deprecated]

saveString
CreatorHub

Parameters (2)
key	string
value	string
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work. SaveString should be used instead.

Thread safety	Unsafe

History 4

573 Change ReturnType of saveString from void to null
553 Change PreferredDescriptor of saveString from to SaveString
462 Change ThreadSafety of saveString from to Unsafe
61 Add saveString

Tags: [Deprecated]

userId
CreatorHub

Type		Default
int64

It exists only for backward compatibility, and should not be used for new work. UserId should be used instead.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 8

554 Change Default of userId from 0 to
553 Change Default of userId from to 0
553 Change PreferredDescriptor of userId from to UserId
486 Change ThreadSafety of userId from ReadOnly to ReadSafe
462 Change ThreadSafety of userId from to ReadOnly
323 Change ValueType of userId from int to int64
213 Change Tags of userId from [] to [Deprecated]
47 Add userId

Tags: [Deprecated]

waitForDataReady
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work. WaitForDataReady should be used instead.

It will block the calling thread until completion.

Thread safety	Unsafe

History 3

553 Change PreferredDescriptor of waitForDataReady from to WaitForDataReady
462 Change ThreadSafety of waitForDataReady from to Unsafe
50 Add waitForDataReady

Tags: [Yields, Deprecated]

Removed members 19

BlockUser
CreatorHub

Parameters (1)
player	Instance
Returns (1)
string

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Security	RobloxScriptSecurity

History 3

310 Remove BlockUser
295 Change Tags of BlockUser from [Yields] to [Yields, Deprecated]
270 Add BlockUser

Tags: [Yields, Deprecated]

ClanTag
CreatorHub

Type		Default
string

Category
Loaded/Saved	false

History 2

180 Remove ClanTag
147 Add ClanTag

GetWebPersonalServerRank
CreatorHub

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

It will block the calling thread until completion.

Security	LocalUserSecurity

History 7

273 Remove GetWebPersonalServerRank
272 Add GetWebPersonalServerRank
273 Remove GetWebPersonalServerRank
79 Change Tags of GetWebPersonalServerRank from [Yields] to [backend, Yields]
78 Change Tags of GetWebPersonalServerRank from [backend, Yields] to [Yields]
79 Change Tags of GetWebPersonalServerRank from [Yields] to [backend, Yields]
47 Add GetWebPersonalServerRank

Tags: [backend, Yields]

HasBuildPermission
CreatorHub

Parameters (1)
role	BuildPermission
Returns (1)
bool

History 2

52 Remove HasBuildPermission
47 Add HasBuildPermission

HasBuildTools
CreatorHub

Type		Default
bool

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

HoverOnPlayerChanged
CreatorHub

Parameters (1)
playerHoveredOn	Instance

Security	RobloxScriptSecurity

History 2

90 Remove HoverOnPlayerChanged
47 Add HoverOnPlayerChanged

IsUserAvailableForExperiment
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 3

535 Remove IsUserAvailableForExperiment
462 Change ThreadSafety of IsUserAvailableForExperiment from to Unsafe
296 Add IsUserAvailableForExperiment

Tags: [Deprecated]

JumpCharacter
CreatorHub

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

Security	RobloxScriptSecurity

History 2

338 Remove JumpCharacter
131 Add JumpCharacter

MouseDownOnPlayer
CreatorHub

Parameters (1)
playerMouseDownOn	Instance

Security	RobloxScriptSecurity

History 2

90 Remove MouseDownOnPlayer
47 Add MouseDownOnPlayer

MoveCharacter
CreatorHub

Parameters (2)
walkDirection	Vector2
maxWalkDelta	float
Returns (1)
void

Security	RobloxScriptSecurity

History 2

338 Remove MoveCharacter
131 Add MoveCharacter

PersonalServerRank
CreatorHub

Type		Default
int

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

PlayerJoinData
CreatorHub

Type		Default
PlayerJoinData

Its value can be read, but it cannot be modified.

Category
Loaded/Saved	false

History 2

335 Remove PlayerJoinData
331 Add PlayerJoinData

Tags: [ReadOnly]

ReceivedJoinTelemetry
CreatorHub

Parameters (1)
details	Dictionary

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 2

623 Remove ReceivedJoinTelemetry
553 Add ReceivedJoinTelemetry

Tags: [Hidden]

ReplicatedLocaleId
CreatorHub

Type		Default
string

It cannot be accessed by script code.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

574 Remove ReplicatedLocaleId
554 Change Default of ReplicatedLocaleId from to
553 Add ReplicatedLocaleId

Tags: [Hidden, NotReplicated, NotScriptable]

ReplicatedLocaleIdInternal
CreatorHub

Type		Default
string

It cannot be accessed by script code.

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

574 Remove ReplicatedLocaleIdInternal
554 Change Default of ReplicatedLocaleIdInternal from to
553 Add ReplicatedLocaleIdInternal

Tags: [Hidden, NotReplicated, NotScriptable]

SaveLeaderboardData
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Security	LocalUserSecurity

History 5

258 Remove SaveLeaderboardData
257 Add SaveLeaderboardData
258 Remove SaveLeaderboardData
252 Change Tags of SaveLeaderboardData from [] to [Deprecated]
47 Add SaveLeaderboardData

Tags: [Deprecated]

SetClanTag
CreatorHub

Parameters (1)
newClanTag	string
Returns (1)
void

Security	PluginSecurity

History 3

180 Remove SetClanTag
151 Change Security of SetClanTag from LocalUserSecurity to PluginSecurity
145 Add SetClanTag

SetWebPersonalServerRank
CreatorHub

Parameters (1)
rank	int
Returns (1)
bool

It will block the calling thread until completion.

Security	WritePlayerSecurity

History 5

273 Remove SetWebPersonalServerRank
272 Add SetWebPersonalServerRank
273 Remove SetWebPersonalServerRank
71 Change Parameters of SetWebPersonalServerRank from (Rank: int) to (rank: int)
47 Add SetWebPersonalServerRank

Tags: [Yields]

UnblockUser
CreatorHub

Parameters (1)
player	Instance
Returns (1)
string

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Security	RobloxScriptSecurity

History 3

310 Remove UnblockUser
295 Change Tags of UnblockUser from [Yields] to [Yields, Deprecated]
270 Add UnblockUser

Tags: [Yields, Deprecated]

Write security	NotAccessibleSecurity
Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

Engine API

Website

Related

History 5

History 2

History 1

History 1

History 3

History 7

History 5

History 5

History 5

Third Person

First Person

History 5

History 5

History 6

History 3

History 6

History 6

History 3

History 3

History 2

History 6

History 2

History 3

History 3

History 2

History 2

History 3

History 1

History 2

Notes

History 7

History 8

History 7

History 7

History 7

History 7

History 9

History 7

History 7

Usage Notes

History 6

History 2

History 6

History 2

History 3

See Also

History 8

History 1

History 3

History 4

History 2

History 3

History 3

History 3

History 3

History 3

History 2

History 6

History 2

History 1

History 5

History 2

History 2

History 4

History 3

History 3

History 1

History 4

History 1

History 3