UserGameSettings
CreatorHub

The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.

Its interface does not cross the network boundary.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Member index 88

History		Member
657		AllTutorialsDisabled: bool
687		BadgeVisible: bool
657		CameraMode: CustomCameraMode
657		CameraYInverted: bool
657		ChatTranslationEnabled: bool
657		ChatTranslationFTUXShown: bool
657		ChatTranslationLocale: string
657		ChatTranslationToggleEnabled: bool
657		ChatVisible: bool
657		CompletedTutorials: string
657		ComputerCameraMovementChanged: bool
657		ComputerCameraMovementMode: ComputerCameraMovementMode
657		ComputerMovementChanged: bool
657		ComputerMovementMode: ComputerMovementMode
657		ControlMode: ControlMode
657		DefaultCameraID: string
657		FramerateCap: int
657		Fullscreen: bool
657		GamepadCameraSensitivity: float
657		GraphicsOptimizationMode: GraphicsOptimizationMode
657		GraphicsQualityLevel: int
657		HapticStrength: float
657		HasEverUsedVR: bool
657		IsUsingCameraYInverted: bool
657		IsUsingGamepadCameraSensitivity: bool
657		MasterVolume: float
657		MasterVolumeStudio: float
657		MaxQualityEnabled: bool
657		MicroProfilerWebServerEnabled: bool
657		MicroProfilerWebServerIP: string
657		MicroProfilerWebServerPort: int
657		MouseSensitivity: float
657		MouseSensitivityFirstPerson: Vector2
657		MouseSensitivityThirdPerson: Vector2
657		OnScreenProfilerEnabled: bool
657		OnboardingsCompleted: string
657		PartyVoiceVolume: float
691		PeoplePageLayout: PeoplePageLayout
657		PerformanceStatsVisible: bool
657		PlayerHeight: float
689		PlayerListVisible: bool
687		PlayerNamesEnabled: bool
657		PreferredTextSize: PreferredTextSize
657		PreferredTransparency: float
657		QualityResetLevel: int
657		RCCProfilerRecordFrameRate: int
657		RCCProfilerRecordTimeFrame: int
683		ReadAloud: bool
657		ReducedMotion: bool
657		RotationType: RotationType
657		SavedQualityLevel: SavedQualitySetting
657		StartMaximized: bool
657		StartScreenPosition: Vector2
657		StartScreenSize: Vector2
721		StudioPreferredTextSize: PreferredTextSize
657		TouchCameraMovementChanged: bool
657		TouchCameraMovementMode: TouchCameraMovementMode
657		TouchMovementChanged: bool
657		TouchMovementMode: TouchMovementMode
657		UiNavigationKeyBindEnabled: bool
657		UsedCoreGuiIsVisibleToggle: bool
657		UsedCustomGuiIsVisibleToggle: bool
657		UsedHideHudShortcut: bool
657		VRComfortSetting: VRComfortSetting
657		VREnabled: bool
657		VRRotationIntensity: int
657		VRSafetyBubbleMode: VRSafetyBubbleMode
657		VRSmoothRotationEnabled: bool
657		VRSmoothRotationEnabledCustomOption: bool
657		VRThirdPersonFollowCamEnabled: bool
657		VRThirdPersonFollowCamEnabledCustomOption: bool
657		VignetteEnabled: bool
657		VignetteEnabledCustomOption: bool
657		gaID: string
462		GetCameraYInvertValue(): int
623		GetDefaultFramerateCap(): int
462		GetOnboardingCompleted(onboardingId: string): bool
462		GetTutorialState(tutorialId: string): bool
462		InFullScreen(): bool
462		InStudioMode(): bool
573		ResetOnboardingCompleted(onboardingId: string): null
573		SetCameraYInvertVisible(): null
573		SetGamepadCameraSensitivityVisible(): null
573		SetOnboardingCompleted(onboardingId: string): null
573		SetTutorialState(tutorialId: string, value: bool): null
462		FullscreenChanged(isFullscreen: bool)
462		PerformanceStatsVisibleChanged(isPerformanceStatsVisible: bool)
462		StudioModeChanged(isStudioMode: bool)
67 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
702		PredictionMode: PredictionMode
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
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: 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
698		QueryDescendants(selector: string): Instances
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 5

History		Member
304		ImageUploadPromptBehavior: UploadSetting
342		MicroProfilerEnabled: bool
295		UseBasicMouseSensitivity: bool
581		VRPlayMode: VRPlayMode
304		VideoUploadPromptBehavior: UploadSetting

Description

The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.

The properties on this class reflect both the user-facing options exposed in the in-experience settings menu (such as graphics quality, master volume, camera and control modes) as well as other contextual user-configurable state that is not surfaced in the menu itself (such as internal onboarding progress, VR comfort options, window layout, and debug or profiling configuration). As a result, some properties listed here may not correspond to anything visible in the settings UI, and many are restricted to internal Roblox scripts.

You can access this object from a LocalScript via:

1	`UserSettings():GetService("UserGameSettings")`

This object is intended to be used on the client only, as it serves no purpose on the server. It will also reflect your own settings when testing in Roblox Studio.

History 346
Hide member changes

721 Add StudioPreferredTextSize
697 Change Tags of UserGameSettings from [NotCreatable, UserSettings, NotReplicated] to [NotCreatable, Service, NotReplicated]
691 Add PeoplePageLayout
689 Add PlayerListVisible
687 Add PlayerNamesEnabled
687 Add BadgeVisible
683 Add ReadAloud
681 Remove ReadAloud
682 Add ReadAloud
657 Change Default of gaID from to
657 Change Default of VignetteEnabledCustomOption from to
657 Change Default of VignetteEnabled from to
657 Change Default of VRThirdPersonFollowCamEnabledCustomOption from to
657 Change Default of VRThirdPersonFollowCamEnabled from to
657 Change Default of VRSmoothRotationEnabledCustomOption from to
657 Change Default of VRSmoothRotationEnabled from to
657 Change Default of VRSafetyBubbleMode from to
657 Change Default of VRRotationIntensity from to
657 Change Default of VREnabled from to
657 Change Default of VRComfortSetting from to
657 Change Default of UsedHideHudShortcut from to
657 Change Default of UsedCustomGuiIsVisibleToggle from to
657 Change Default of UsedCoreGuiIsVisibleToggle from to
657 Change Default of UiNavigationKeyBindEnabled from to
657 Change Default of TouchMovementMode from to
657 Change Default of TouchMovementChanged from to
657 Change Default of TouchCameraMovementMode from to
657 Change Default of TouchCameraMovementChanged from to
657 Change Default of StartScreenSize from to
657 Change Default of StartScreenPosition from to
657 Change Default of StartMaximized from to
657 Change Default of SavedQualityLevel from to
657 Change Default of RotationType from to
657 Change Default of ReducedMotion from to
657 Change Default of RCCProfilerRecordTimeFrame from to
657 Change Default of RCCProfilerRecordFrameRate from to
657 Change Default of QualityResetLevel from to
657 Change Default of PreferredTransparency from to
657 Change Default of PreferredTextSize from to
657 Change Default of PlayerHeight from to
657 Change Default of PerformanceStatsVisible from to
657 Change Default of PartyVoiceVolume from to
657 Change Default of OnboardingsCompleted from to
657 Change Default of OnScreenProfilerEnabled from to
657 Change Default of MouseSensitivityThirdPerson from to
657 Change Default of MouseSensitivityFirstPerson from to
657 Change Default of MouseSensitivity from to
657 Change Default of MicroProfilerWebServerPort from to
657 Change Default of MicroProfilerWebServerIP from to
657 Change Default of MicroProfilerWebServerEnabled from to
657 Change Default of MaxQualityEnabled from to
657 Change Default of MasterVolumeStudio from to
657 Change Default of MasterVolume from to
657 Change Default of IsUsingGamepadCameraSensitivity from to
657 Change Default of IsUsingCameraYInverted from to
657 Change Default of HasEverUsedVR from to
657 Change Default of HapticStrength from to
657 Change Default of GraphicsQualityLevel from to
657 Change Default of GraphicsOptimizationMode from to
657 Change Default of GamepadCameraSensitivity from to
657 Change Default of Fullscreen from to
657 Change Default of FramerateCap from to
657 Change Default of DefaultCameraID from to
657 Change Default of ControlMode from to
657 Change Default of ComputerMovementMode from to
657 Change Default of ComputerMovementChanged from to
657 Change Default of ComputerCameraMovementMode from to
657 Change Default of ComputerCameraMovementChanged from to
657 Change Default of CompletedTutorials from to
657 Change Default of ChatVisible from to
657 Change Default of ChatTranslationToggleEnabled from to
657 Change Default of ChatTranslationLocale from to
657 Change Default of ChatTranslationFTUXShown from to
657 Change Default of ChatTranslationEnabled from to
657 Change Default of CameraYInverted from to
657 Change Default of CameraMode from to
657 Change Default of AllTutorialsDisabled from to
657 Change Tags of UserGameSettings from [NotCreatable, UserSettings] to [NotCreatable, UserSettings, NotReplicated]
645 Add PartyVoiceVolume
640 Add MaxQualityEnabled
640 Add GraphicsOptimizationMode
632 Add PreferredTextSize
628 Add HapticStrength
623 Add GetDefaultFramerateCap
619 Add MasterVolumeStudio
617 Add QualityResetLevel
611 Add FramerateCap
609 Add ChatTranslationLocale
599 Add ChatTranslationToggleEnabled
599 Add ChatTranslationFTUXShown
599 Add ChatTranslationEnabled
592 Add VignetteEnabledCustomOption
592 Add VRThirdPersonFollowCamEnabledCustomOption
592 Add VRThirdPersonFollowCamEnabled
592 Add VRSmoothRotationEnabledCustomOption
592 Add VRComfortSetting
581 Remove VRPlayMode
580 Add UiNavigationKeyBindEnabled
580 Add ReducedMotion
580 Add PreferredTransparency
578 Change Tags of ControlMode from [Deprecated] to []
576 Change Tags of ControlMode from [] to [Deprecated]
573 Change ReturnType of SetTutorialState from void to null
573 Change ReturnType of SetOnboardingCompleted from void to null
573 Change ReturnType of SetGamepadCameraSensitivityVisible from void to null
573 Change ReturnType of SetCameraYInvertVisible from void to null
573 Change ReturnType of ResetOnboardingCompleted from void to null
568 Add VRSafetyBubbleMode
568 Add PlayerHeight
565 Add VRPlayMode
553 Add gaID
553 Change Default of VignetteEnabled from to
553 Change Default of VRSmoothRotationEnabled from to
553 Change Default of VRRotationIntensity from to
553 Change Default of VREnabled from to
553 Change Default of UsedHideHudShortcut from to
553 Change Default of UsedCustomGuiIsVisibleToggle from to
553 Change Default of UsedCoreGuiIsVisibleToggle from to
553 Change Default of TouchMovementMode from to
553 Add TouchMovementChanged
553 Change Default of TouchCameraMovementMode from to
553 Add TouchCameraMovementChanged
553 Change Default of StartScreenSize from to
553 Change Default of StartScreenPosition from to
553 Change Default of StartMaximized from to
553 Change Default of SavedQualityLevel from to
553 Change Default of RotationType from to
553 Change Default of RCCProfilerRecordTimeFrame from to
553 Change Default of RCCProfilerRecordFrameRate from to
553 Change Default of PerformanceStatsVisible from to
553 Change Default of OnboardingsCompleted from to
553 Change Default of OnScreenProfilerEnabled from to
553 Change Default of MouseSensitivityThirdPerson from to
553 Change Default of MouseSensitivityFirstPerson from to
553 Change Default of MouseSensitivity from to
553 Change Default of MicroProfilerWebServerPort from to
553 Change Default of MicroProfilerWebServerIP from to
553 Change Default of MicroProfilerWebServerEnabled from to
553 Change Default of MasterVolume from to
553 Change Default of IsUsingGamepadCameraSensitivity from to
553 Change Default of IsUsingCameraYInverted from to
553 Change Default of HasEverUsedVR from to
553 Change Default of GraphicsQualityLevel from to
553 Change Default of GamepadCameraSensitivity from to
553 Change Default of Fullscreen from to
553 Change Default of DefaultCameraID from to
553 Change Default of ControlMode from to
553 Change Default of ComputerMovementMode from to
553 Add ComputerMovementChanged
553 Change Default of ComputerCameraMovementMode from to
553 Add ComputerCameraMovementChanged
553 Add CompletedTutorials
553 Change Default of ChatVisible from to
553 Change Default of CameraYInverted from to
553 Change Default of CameraMode from to
553 Change Default of AllTutorialsDisabled from to
543 Add VRSmoothRotationEnabled
528 Change Tags of DefaultCameraID from [Hidden] to [Hidden, NotReplicated]
526 Change WriteSecurity of MasterVolume from None to RobloxScriptSecurity
526 Change ReadSecurity of MasterVolume from None to RobloxScriptSecurity
522 Add DefaultCameraID
511 Change Tags of VignetteEnabled from [Hidden, NotReplicated] to []
511 Change ReadSecurity of VignetteEnabled from RobloxScriptSecurity to None
508 Add VignetteEnabled
486 Change ThreadSafety of VRRotationIntensity from ReadOnly to ReadSafe
486 Change ThreadSafety of VREnabled from ReadOnly to ReadSafe
486 Change ThreadSafety of UsedHideHudShortcut from ReadOnly to ReadSafe
486 Change ThreadSafety of UsedCustomGuiIsVisibleToggle from ReadOnly to ReadSafe
486 Change ThreadSafety of UsedCoreGuiIsVisibleToggle from ReadOnly to ReadSafe
486 Change ThreadSafety of TouchMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of TouchCameraMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of StartScreenSize from ReadOnly to ReadSafe
486 Change ThreadSafety of StartScreenPosition from ReadOnly to ReadSafe
486 Change ThreadSafety of StartMaximized from ReadOnly to ReadSafe
486 Change ThreadSafety of SavedQualityLevel from ReadOnly to ReadSafe
486 Change ThreadSafety of RotationType from ReadOnly to ReadSafe
486 Change ThreadSafety of RCCProfilerRecordTimeFrame from ReadOnly to ReadSafe
486 Change ThreadSafety of RCCProfilerRecordFrameRate from ReadOnly to ReadSafe
486 Change ThreadSafety of PerformanceStatsVisible from ReadOnly to ReadSafe
486 Change ThreadSafety of OnboardingsCompleted from ReadOnly to ReadSafe
486 Change ThreadSafety of OnScreenProfilerEnabled from ReadOnly to ReadSafe
486 Change ThreadSafety of MouseSensitivityThirdPerson from ReadOnly to ReadSafe
486 Change ThreadSafety of MouseSensitivityFirstPerson from ReadOnly to ReadSafe
486 Change ThreadSafety of MouseSensitivity from ReadOnly to ReadSafe
486 Change ThreadSafety of MicroProfilerWebServerPort from ReadOnly to ReadSafe
486 Change ThreadSafety of MicroProfilerWebServerIP from ReadOnly to ReadSafe
486 Change ThreadSafety of MicroProfilerWebServerEnabled from ReadOnly to ReadSafe
486 Change ThreadSafety of MasterVolume from ReadOnly to ReadSafe
486 Change ThreadSafety of IsUsingGamepadCameraSensitivity from ReadOnly to ReadSafe
486 Change ThreadSafety of IsUsingCameraYInverted from ReadOnly to ReadSafe
486 Change ThreadSafety of HasEverUsedVR from ReadOnly to ReadSafe
486 Change ThreadSafety of GraphicsQualityLevel from ReadOnly to ReadSafe
486 Change ThreadSafety of GamepadCameraSensitivity from ReadOnly to ReadSafe
486 Change ThreadSafety of Fullscreen from ReadOnly to ReadSafe
486 Change ThreadSafety of ControlMode from ReadOnly to ReadSafe
486 Change ThreadSafety of ComputerMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of ComputerCameraMovementMode from ReadOnly to ReadSafe
486 Change ThreadSafety of ChatVisible from ReadOnly to ReadSafe
486 Change ThreadSafety of CameraYInverted from ReadOnly to ReadSafe
486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
486 Change ThreadSafety of AllTutorialsDisabled from ReadOnly to ReadSafe
462 Change ThreadSafety of StudioModeChanged from to Unsafe
462 Change ThreadSafety of PerformanceStatsVisibleChanged from to Unsafe
462 Change ThreadSafety of FullscreenChanged from to Unsafe
462 Change ThreadSafety of SetTutorialState from to Unsafe
462 Change ThreadSafety of SetOnboardingCompleted from to Unsafe
462 Change ThreadSafety of SetGamepadCameraSensitivityVisible from to Unsafe
462 Change ThreadSafety of SetCameraYInvertVisible from to Unsafe
462 Change ThreadSafety of ResetOnboardingCompleted from to Unsafe
462 Change ThreadSafety of InStudioMode from to Unsafe
462 Change ThreadSafety of InFullScreen from to Unsafe
462 Change ThreadSafety of GetTutorialState from to Unsafe
462 Change ThreadSafety of GetOnboardingCompleted from to Unsafe
462 Change ThreadSafety of GetCameraYInvertValue from to Unsafe
462 Change ThreadSafety of VRRotationIntensity from to ReadOnly
462 Change ThreadSafety of VREnabled from to ReadOnly
462 Change ThreadSafety of UsedHideHudShortcut from to ReadOnly
462 Change ThreadSafety of UsedCustomGuiIsVisibleToggle from to ReadOnly
462 Change ThreadSafety of UsedCoreGuiIsVisibleToggle from to ReadOnly
462 Change ThreadSafety of TouchMovementMode from to ReadOnly
462 Change ThreadSafety of TouchCameraMovementMode from to ReadOnly
462 Change ThreadSafety of StartScreenSize from to ReadOnly
462 Change ThreadSafety of StartScreenPosition from to ReadOnly
462 Change ThreadSafety of StartMaximized from to ReadOnly
462 Change ThreadSafety of SavedQualityLevel from to ReadOnly
462 Change ThreadSafety of RotationType from to ReadOnly
462 Change ThreadSafety of RCCProfilerRecordTimeFrame from to ReadOnly
462 Change ThreadSafety of RCCProfilerRecordFrameRate from to ReadOnly
462 Change ThreadSafety of PerformanceStatsVisible from to ReadOnly
462 Change ThreadSafety of OnboardingsCompleted from to ReadOnly
462 Change ThreadSafety of OnScreenProfilerEnabled from to ReadOnly
462 Change ThreadSafety of MouseSensitivityThirdPerson from to ReadOnly
462 Change ThreadSafety of MouseSensitivityFirstPerson from to ReadOnly
462 Change ThreadSafety of MouseSensitivity from to ReadOnly
462 Change ThreadSafety of MicroProfilerWebServerPort from to ReadOnly
462 Change ThreadSafety of MicroProfilerWebServerIP from to ReadOnly
462 Change ThreadSafety of MicroProfilerWebServerEnabled from to ReadOnly
462 Change ThreadSafety of MasterVolume from to ReadOnly
462 Change ThreadSafety of IsUsingGamepadCameraSensitivity from to ReadOnly
462 Change ThreadSafety of IsUsingCameraYInverted from to ReadOnly
462 Change ThreadSafety of HasEverUsedVR from to ReadOnly
462 Change ThreadSafety of GraphicsQualityLevel from to ReadOnly
462 Change ThreadSafety of GamepadCameraSensitivity from to ReadOnly
462 Change ThreadSafety of Fullscreen from to ReadOnly
462 Change ThreadSafety of ControlMode from to ReadOnly
462 Change ThreadSafety of ComputerMovementMode from to ReadOnly
462 Change ThreadSafety of ComputerCameraMovementMode from to ReadOnly
462 Change ThreadSafety of ChatVisible from to ReadOnly
462 Change ThreadSafety of CameraYInverted from to ReadOnly
462 Change ThreadSafety of CameraMode from to ReadOnly
462 Change ThreadSafety of AllTutorialsDisabled from to ReadOnly
451 Add GraphicsQualityLevel
413 Change Tags of UserGameSettings from [UserSettings] to [NotCreatable, UserSettings]
412 Change Tags of UserGameSettings from [Service] to [UserSettings]
364 Add RCCProfilerRecordTimeFrame
364 Add RCCProfilerRecordFrameRate
349 Add StartScreenSize
349 Add StartScreenPosition
349 Add StartMaximized
342 Add OnScreenProfilerEnabled
342 Remove MicroProfilerEnabled
337 Add MicroProfilerWebServerEnabled
334 Change Tags of PerformanceStatsVisible from [] to [Hidden]
334 Add MicroProfilerWebServerPort
334 Add MicroProfilerWebServerIP
334 Add MicroProfilerEnabled
325 Add SetOnboardingCompleted
325 Add ResetOnboardingCompleted
325 Add GetOnboardingCompleted
325 Add OnboardingsCompleted
309 Add VREnabled
309 Add HasEverUsedVR
304 Remove VideoUploadPromptBehavior
304 Remove ImageUploadPromptBehavior
302 Add SetGamepadCameraSensitivityVisible
302 Add IsUsingGamepadCameraSensitivity
302 Add GamepadCameraSensitivity
301 Remove SetGamepadCameraSensitivityVisible
301 Remove IsUsingGamepadCameraSensitivity
301 Remove GamepadCameraSensitivity
302 Add SetGamepadCameraSensitivityVisible
302 Add IsUsingGamepadCameraSensitivity
302 Add GamepadCameraSensitivity
295 Remove UseBasicMouseSensitivity
291 Add SetCameraYInvertVisible
291 Add GetCameraYInvertValue
291 Add IsUsingCameraYInverted
291 Add CameraYInverted
268 Add UsedCustomGuiIsVisibleToggle
268 Add UsedCoreGuiIsVisibleToggle
259 Add PerformanceStatsVisibleChanged
259 Add PerformanceStatsVisible
254 Add ChatVisible
246 Add UseBasicMouseSensitivity
246 Add MouseSensitivityThirdPerson
246 Add MouseSensitivityFirstPerson
239 Add VRRotationIntensity
238 Remove VRRotationIntensity
239 Add VRRotationIntensity
211 Add UsedHideHudShortcut
200 Add MouseSensitivity
198 Add RotationType
196 Change WriteSecurity of SavedQualityLevel from RobloxScriptSecurity to None
196 Change ReadSecurity of SavedQualityLevel from RobloxScriptSecurity to None
196 Change WriteSecurity of MasterVolume from RobloxScriptSecurity to None
196 Change ReadSecurity of MasterVolume from RobloxScriptSecurity to None
177 Change WriteSecurity of ControlMode from RobloxScriptSecurity to None
177 Change ReadSecurity of ControlMode from RobloxScriptSecurity to None
176 Change WriteSecurity of ControlMode from None to RobloxScriptSecurity
176 Change ReadSecurity of ControlMode from None to RobloxScriptSecurity
177 Change WriteSecurity of ControlMode from RobloxScriptSecurity to None
177 Change ReadSecurity of ControlMode from RobloxScriptSecurity to None
176 Change ReadSecurity of VideoUploadPromptBehavior from None to RobloxScriptSecurity
176 Change WriteSecurity of VideoUploadPromptBehavior from None to RobloxScriptSecurity
176 Add TouchCameraMovementMode
176 Change ReadSecurity of SavedQualityLevel from None to RobloxScriptSecurity
176 Change WriteSecurity of SavedQualityLevel from None to RobloxScriptSecurity
176 Change WriteSecurity of ImageUploadPromptBehavior from None to RobloxScriptSecurity
176 Change ReadSecurity of ImageUploadPromptBehavior from None to RobloxScriptSecurity
176 Change WriteSecurity of Fullscreen from None to RobloxScriptSecurity
176 Change ReadSecurity of Fullscreen from None to RobloxScriptSecurity
176 Change ReadSecurity of ControlMode from None to RobloxScriptSecurity
176 Change WriteSecurity of ControlMode from None to RobloxScriptSecurity
176 Add ComputerMovementMode
176 Add ComputerCameraMovementMode
176 Change WriteSecurity of CameraMode from None to RobloxScriptSecurity
176 Change ReadSecurity of CameraMode from None to RobloxScriptSecurity
176 Change WriteSecurity of AllTutorialsDisabled from None to RobloxScriptSecurity
176 Change ReadSecurity of AllTutorialsDisabled from None to RobloxScriptSecurity
168 Add MasterVolume
156 Change ValueType of CameraMode from CameraMode to CustomCameraMode
153 Add TouchMovementMode
153 Add CameraMode
135 Add ImageUploadPromptBehavior
71 Add Fullscreen
47 Add StudioModeChanged
47 Add FullscreenChanged
47 Add SetTutorialState
47 Add InStudioMode
47 Add InFullScreen
47 Add GetTutorialState
47 Add VideoUploadPromptBehavior
47 Add SavedQualityLevel
47 Add ControlMode
47 Add AllTutorialsDisabled
47 Add UserGameSettings

Members 88

AllTutorialsDisabled
CreatorHub

Type		Default
bool

Indicates whether all in-experience tutorials have been disabled by the user.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 7

657 Change Default of AllTutorialsDisabled from to
553 Change Default of AllTutorialsDisabled from to
486 Change ThreadSafety of AllTutorialsDisabled from ReadOnly to ReadSafe
462 Change ThreadSafety of AllTutorialsDisabled from to ReadOnly
176 Change WriteSecurity of AllTutorialsDisabled from None to RobloxScriptSecurity
176 Change ReadSecurity of AllTutorialsDisabled from None to RobloxScriptSecurity
47 Add AllTutorialsDisabled

BadgeVisible
CreatorHub

Type		Default
bool

Indicates whether badge notifications are visible to the client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 1

687 Add BadgeVisible

CameraMode
CreatorHub

Type		Default
CustomCameraMode

The custom camera mode currently in-use by the client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 8

657 Change Default of CameraMode from to
553 Change Default of CameraMode from to
486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
462 Change ThreadSafety of CameraMode from to ReadOnly
176 Change WriteSecurity of CameraMode from None to RobloxScriptSecurity
176 Change ReadSecurity of CameraMode from None to RobloxScriptSecurity
156 Change ValueType of CameraMode from CameraMode to CustomCameraMode
153 Add CameraMode

CameraYInverted
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	true

History 5

657 Change Default of CameraYInverted from to
553 Change Default of CameraYInverted from to
486 Change ThreadSafety of CameraYInverted from ReadOnly to ReadSafe
462 Change ThreadSafety of CameraYInverted from to ReadOnly
291 Add CameraYInverted

Tags: [Hidden, NotReplicated]

ChatTranslationEnabled
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	true

History 2

657 Change Default of ChatTranslationEnabled from to
599 Add ChatTranslationEnabled

Tags: [Hidden, NotReplicated]

ChatTranslationFTUXShown
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	true

History 2

657 Change Default of ChatTranslationFTUXShown from to
599 Add ChatTranslationFTUXShown

Tags: [Hidden, NotReplicated]

ChatTranslationLocale
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	true

History 2

657 Change Default of ChatTranslationLocale from to
609 Add ChatTranslationLocale

Tags: [Hidden, NotReplicated]

ChatTranslationToggleEnabled
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	true

History 2

657 Change Default of ChatTranslationToggleEnabled from to
599 Add ChatTranslationToggleEnabled

Tags: [Hidden, NotReplicated]

ChatVisible
CreatorHub

Type		Default
bool

Indicates whether the in-experience chat is visible to the client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of ChatVisible from to
553 Change Default of ChatVisible from to
486 Change ThreadSafety of ChatVisible from ReadOnly to ReadSafe
462 Change ThreadSafety of ChatVisible from to ReadOnly
254 Add ChatVisible

CompletedTutorials
CreatorHub

Type		Default
string

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	true

History 2

657 Change Default of CompletedTutorials from to
553 Add CompletedTutorials

Tags: [Hidden, NotScriptable]

ComputerCameraMovementChanged
CreatorHub

Type		Default
bool

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	true

History 2

657 Change Default of ComputerCameraMovementChanged from to
553 Add ComputerCameraMovementChanged

Tags: [Hidden, NotReplicated, NotScriptable]

ComputerCameraMovementMode
CreatorHub

Type		Default
ComputerCameraMovementMode

The camera movement mode currently in-use by the client on desktop.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 5

657 Change Default of ComputerCameraMovementMode from to
553 Change Default of ComputerCameraMovementMode from to
486 Change ThreadSafety of ComputerCameraMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of ComputerCameraMovementMode from to ReadOnly
176 Add ComputerCameraMovementMode

ComputerMovementChanged
CreatorHub

Type		Default
bool

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	true

History 2

657 Change Default of ComputerMovementChanged from to
553 Add ComputerMovementChanged

Tags: [Hidden, NotReplicated, NotScriptable]

ComputerMovementMode
CreatorHub

Type		Default
ComputerMovementMode

The type of controls being used by the client on desktop.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 5

657 Change Default of ComputerMovementMode from to
553 Change Default of ComputerMovementMode from to
486 Change ThreadSafety of ComputerMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of ComputerMovementMode from to ReadOnly
176 Add ComputerMovementMode

ControlMode
CreatorHub

Type		Default
ControlMode

Toggles whether or not the client can use the Mouse Lock Switch mode.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 15

657 Change Default of ControlMode from to
578 Change Tags of ControlMode from [Deprecated] to []
576 Change Tags of ControlMode from [] to [Deprecated]
553 Change Default of ControlMode from to
486 Change ThreadSafety of ControlMode from ReadOnly to ReadSafe
462 Change ThreadSafety of ControlMode from to ReadOnly
177 Change WriteSecurity of ControlMode from RobloxScriptSecurity to None
177 Change ReadSecurity of ControlMode from RobloxScriptSecurity to None
176 Change WriteSecurity of ControlMode from None to RobloxScriptSecurity
176 Change ReadSecurity of ControlMode from None to RobloxScriptSecurity
177 Change WriteSecurity of ControlMode from RobloxScriptSecurity to None
177 Change ReadSecurity of ControlMode from RobloxScriptSecurity to None
176 Change ReadSecurity of ControlMode from None to RobloxScriptSecurity
176 Change WriteSecurity of ControlMode from None to RobloxScriptSecurity
47 Add ControlMode

DefaultCameraID
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	true

History 4

657 Change Default of DefaultCameraID from to
553 Change Default of DefaultCameraID from to
528 Change Tags of DefaultCameraID from [Hidden] to [Hidden, NotReplicated]
522 Add DefaultCameraID

Tags: [Hidden, NotReplicated]

FramerateCap
CreatorHub

Type		Default
int

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	true

History 2

657 Change Default of FramerateCap from to
611 Add FramerateCap

Tags: [Hidden, NotReplicated]

Fullscreen
CreatorHub

Type		Default
bool

Indicates whether the client's window is currently in full screen mode.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 7

657 Change Default of Fullscreen from to
553 Change Default of Fullscreen from to
486 Change ThreadSafety of Fullscreen from ReadOnly to ReadSafe
462 Change ThreadSafety of Fullscreen from to ReadOnly
176 Change WriteSecurity of Fullscreen from None to RobloxScriptSecurity
176 Change ReadSecurity of Fullscreen from None to RobloxScriptSecurity
71 Add Fullscreen

FullscreenChanged
CreatorHub

Parameters (1)
isFullscreen	bool

Fires if the user's full screen mode is changed. The event will only fire on desktop devices that can toggle full screen mode. The game will always be in full screen on mobile devices and consoles.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of FullscreenChanged from to Unsafe
47 Add FullscreenChanged

GamepadCameraSensitivity
CreatorHub

Type		Default
float

Describes how sensitive the camera is when using a gamepad.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 7

657 Change Default of GamepadCameraSensitivity from to
553 Change Default of GamepadCameraSensitivity from to
486 Change ThreadSafety of GamepadCameraSensitivity from ReadOnly to ReadSafe
462 Change ThreadSafety of GamepadCameraSensitivity from to ReadOnly
302 Add GamepadCameraSensitivity
301 Remove GamepadCameraSensitivity
302 Add GamepadCameraSensitivity

GetCameraYInvertValue
CreatorHub

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

Returns the camera's Y-invert value.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetCameraYInvertValue from to Unsafe
291 Add GetCameraYInvertValue

GetDefaultFramerateCap
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

623 Add GetDefaultFramerateCap

GetOnboardingCompleted
CreatorHub

Parameters (1)
onboardingId	string
Returns (1)
bool

Checks whether or not the given onboarding has been completed yet, which is useful for avoiding showing the onboarding animation again.

If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

History 2

462 Change ThreadSafety of GetOnboardingCompleted from to Unsafe
325 Add GetOnboardingCompleted

GetTutorialState
CreatorHub

Parameters (1)
tutorialId	string
Returns (1)
bool

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetTutorialState from to Unsafe
47 Add GetTutorialState

GraphicsOptimizationMode
CreatorHub

Type		Default
GraphicsOptimizationMode

The graphics optimization mode used by the client to balance visual quality and performance.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

657 Change Default of GraphicsOptimizationMode from to
640 Add GraphicsOptimizationMode

GraphicsQualityLevel
CreatorHub

Type		Default
int

The current graphics quality level being used by the client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

657 Change Default of GraphicsQualityLevel from to
553 Change Default of GraphicsQualityLevel from to
486 Change ThreadSafety of GraphicsQualityLevel from ReadOnly to ReadSafe
462 Change ThreadSafety of GraphicsQualityLevel from to ReadOnly
451 Add GraphicsQualityLevel

HapticStrength
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	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 2

657 Change Default of HapticStrength from to
628 Add HapticStrength

Tags: [Hidden, NotReplicated]

HasEverUsedVR
CreatorHub

Type		Default
bool

Indicates whether the user has ever launched the client in VR mode.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of HasEverUsedVR from to
553 Change Default of HasEverUsedVR from to
486 Change ThreadSafety of HasEverUsedVR from ReadOnly to ReadSafe
462 Change ThreadSafety of HasEverUsedVR from to ReadOnly
309 Add HasEverUsedVR

InFullScreen
CreatorHub

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

Returns true if the user's Roblox window is in full screen mode.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of InFullScreen from to Unsafe
47 Add InFullScreen

InStudioMode
CreatorHub

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

Returns true if the client's game session is in Roblox Studio.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of InStudioMode from to Unsafe
47 Add InStudioMode

IsUsingCameraYInverted
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/true

History 5

657 Change Default of IsUsingCameraYInverted from to
553 Change Default of IsUsingCameraYInverted from to
486 Change ThreadSafety of IsUsingCameraYInverted from ReadOnly to ReadSafe
462 Change ThreadSafety of IsUsingCameraYInverted from to ReadOnly
291 Add IsUsingCameraYInverted

Tags: [Hidden, ReadOnly, NotReplicated]

IsUsingGamepadCameraSensitivity
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/true

History 7

657 Change Default of IsUsingGamepadCameraSensitivity from to
553 Change Default of IsUsingGamepadCameraSensitivity from to
486 Change ThreadSafety of IsUsingGamepadCameraSensitivity from ReadOnly to ReadSafe
462 Change ThreadSafety of IsUsingGamepadCameraSensitivity from to ReadOnly
302 Add IsUsingGamepadCameraSensitivity
301 Remove IsUsingGamepadCameraSensitivity
302 Add IsUsingGamepadCameraSensitivity

Tags: [Hidden, ReadOnly, NotReplicated]

MasterVolume
CreatorHub

Type		Default
float

A float between 0 and 1 representing the volume of the game's client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 9

657 Change Default of MasterVolume from to
553 Change Default of MasterVolume from to
526 Change WriteSecurity of MasterVolume from None to RobloxScriptSecurity
526 Change ReadSecurity of MasterVolume from None to RobloxScriptSecurity
486 Change ThreadSafety of MasterVolume from ReadOnly to ReadSafe
462 Change ThreadSafety of MasterVolume from to ReadOnly
196 Change WriteSecurity of MasterVolume from RobloxScriptSecurity to None
196 Change ReadSecurity of MasterVolume from RobloxScriptSecurity to None
168 Add MasterVolume

MasterVolumeStudio
CreatorHub

Type		Default
float

A float between 0 and 1 representing the master volume used in Roblox Studio.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

657 Change Default of MasterVolumeStudio from to
619 Add MasterVolumeStudio

MaxQualityEnabled
CreatorHub

Type		Default
bool

Indicates whether the client's graphics quality is set to the maximum available level.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

657 Change Default of MaxQualityEnabled from to
640 Add MaxQualityEnabled

MicroProfilerWebServerEnabled
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 5

657 Change Default of MicroProfilerWebServerEnabled from to
553 Change Default of MicroProfilerWebServerEnabled from to
486 Change ThreadSafety of MicroProfilerWebServerEnabled from ReadOnly to ReadSafe
462 Change ThreadSafety of MicroProfilerWebServerEnabled from to ReadOnly
337 Add MicroProfilerWebServerEnabled

Tags: [Hidden]

MicroProfilerWebServerIP
CreatorHub

Type		Default
string

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/true

History 5

657 Change Default of MicroProfilerWebServerIP from to
553 Change Default of MicroProfilerWebServerIP from to
486 Change ThreadSafety of MicroProfilerWebServerIP from ReadOnly to ReadSafe
462 Change ThreadSafety of MicroProfilerWebServerIP from to ReadOnly
334 Add MicroProfilerWebServerIP

Tags: [Hidden, ReadOnly, NotReplicated]

MicroProfilerWebServerPort
CreatorHub

Type		Default
int

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/true

History 5

657 Change Default of MicroProfilerWebServerPort from to
553 Change Default of MicroProfilerWebServerPort from to
486 Change ThreadSafety of MicroProfilerWebServerPort from ReadOnly to ReadSafe
462 Change ThreadSafety of MicroProfilerWebServerPort from to ReadOnly
334 Add MicroProfilerWebServerPort

Tags: [Hidden, ReadOnly, NotReplicated]

MouseSensitivity
CreatorHub

Type		Default
float

A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of MouseSensitivity from to
553 Change Default of MouseSensitivity from to
486 Change ThreadSafety of MouseSensitivity from ReadOnly to ReadSafe
462 Change ThreadSafety of MouseSensitivity from to ReadOnly
200 Add MouseSensitivity

MouseSensitivityFirstPerson
CreatorHub

Type		Default
Vector2

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	true

History 5

657 Change Default of MouseSensitivityFirstPerson from to
553 Change Default of MouseSensitivityFirstPerson from to
486 Change ThreadSafety of MouseSensitivityFirstPerson from ReadOnly to ReadSafe
462 Change ThreadSafety of MouseSensitivityFirstPerson from to ReadOnly
246 Add MouseSensitivityFirstPerson

Tags: [Hidden, NotReplicated]

MouseSensitivityThirdPerson
CreatorHub

Type		Default
Vector2

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	true

History 5

657 Change Default of MouseSensitivityThirdPerson from to
553 Change Default of MouseSensitivityThirdPerson from to
486 Change ThreadSafety of MouseSensitivityThirdPerson from ReadOnly to ReadSafe
462 Change ThreadSafety of MouseSensitivityThirdPerson from to ReadOnly
246 Add MouseSensitivityThirdPerson

Tags: [Hidden, NotReplicated]

OnScreenProfilerEnabled
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 5

657 Change Default of OnScreenProfilerEnabled from to
553 Change Default of OnScreenProfilerEnabled from to
486 Change ThreadSafety of OnScreenProfilerEnabled from ReadOnly to ReadSafe
462 Change ThreadSafety of OnScreenProfilerEnabled from to ReadOnly
342 Add OnScreenProfilerEnabled

Tags: [Hidden]

OnboardingsCompleted
CreatorHub

Type		Default
string

A comma-separated list of onboarding IDs that the user has completed.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

657 Change Default of OnboardingsCompleted from to
553 Change Default of OnboardingsCompleted from to
486 Change ThreadSafety of OnboardingsCompleted from ReadOnly to ReadSafe
462 Change ThreadSafety of OnboardingsCompleted from to ReadOnly
325 Add OnboardingsCompleted

PartyVoiceVolume
CreatorHub

Type		Default
float

A float between 0 and 1 representing the volume of party voice chat.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

657 Change Default of PartyVoiceVolume from to
645 Add PartyVoiceVolume

PeoplePageLayout
CreatorHub

Type		Default
PeoplePageLayout

The layout style used to display the people page in the in-experience menu.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 1

691 Add PeoplePageLayout

PerformanceStatsVisible
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

657 Change Default of PerformanceStatsVisible from to
553 Change Default of PerformanceStatsVisible from to
486 Change ThreadSafety of PerformanceStatsVisible from ReadOnly to ReadSafe
462 Change ThreadSafety of PerformanceStatsVisible from to ReadOnly
334 Change Tags of PerformanceStatsVisible from [] to [Hidden]
259 Add PerformanceStatsVisible

Tags: [Hidden]

PerformanceStatsVisibleChanged
CreatorHub

Parameters (1)
isPerformanceStatsVisible	bool

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of PerformanceStatsVisibleChanged from to Unsafe
259 Add PerformanceStatsVisibleChanged

PlayerHeight
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	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

657 Change Default of PlayerHeight from to
568 Add PlayerHeight

Tags: [Hidden, NotReplicated]

PlayerListVisible
CreatorHub

Type		Default
bool

Indicates whether the in-experience player list is visible to the client.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 1

689 Add PlayerListVisible

PlayerNamesEnabled
CreatorHub

Type		Default
bool

Indicates whether player names are displayed above characters in the experience.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 1

687 Add PlayerNamesEnabled

PreferredTextSize
CreatorHub

Type		Default
PreferredTextSize

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	true

History 2

657 Change Default of PreferredTextSize from to
632 Add PreferredTextSize

Tags: [Hidden, NotReplicated]

PreferredTransparency
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	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

657 Change Default of PreferredTransparency from to
580 Add PreferredTransparency

Tags: [Hidden, NotReplicated]

QualityResetLevel
CreatorHub

Type		Default
int

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

657 Change Default of QualityResetLevel from to
617 Add QualityResetLevel

Tags: [Hidden]

RCCProfilerRecordFrameRate
CreatorHub

Type		Default
int

Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of RCCProfilerRecordFrameRate from to
553 Change Default of RCCProfilerRecordFrameRate from to
486 Change ThreadSafety of RCCProfilerRecordFrameRate from ReadOnly to ReadSafe
462 Change ThreadSafety of RCCProfilerRecordFrameRate from to ReadOnly
364 Add RCCProfilerRecordFrameRate

RCCProfilerRecordTimeFrame
CreatorHub

Type		Default
int

Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of RCCProfilerRecordTimeFrame from to
553 Change Default of RCCProfilerRecordTimeFrame from to
486 Change ThreadSafety of RCCProfilerRecordTimeFrame from ReadOnly to ReadSafe
462 Change ThreadSafety of RCCProfilerRecordTimeFrame from to ReadOnly
364 Add RCCProfilerRecordTimeFrame

ReadAloud
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	true

History 3

Tags: [Hidden, NotReplicated]

ReducedMotion
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	true

History 2

657 Change Default of ReducedMotion from to
580 Add ReducedMotion

Tags: [Hidden, NotReplicated]

ResetOnboardingCompleted
CreatorHub

Parameters (1)
onboardingId	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of ResetOnboardingCompleted from void to null
462 Change ThreadSafety of ResetOnboardingCompleted from to Unsafe
325 Add ResetOnboardingCompleted

RotationType
CreatorHub

Type		Default
RotationType

Controls how the client's character is rotated.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	false

History 5

657 Change Default of RotationType from to
553 Change Default of RotationType from to
486 Change ThreadSafety of RotationType from ReadOnly to ReadSafe
462 Change ThreadSafety of RotationType from to ReadOnly
198 Add RotationType

SavedQualityLevel
CreatorHub

Type		Default
SavedQualitySetting

The graphics quality level set by the client.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 9

657 Change Default of SavedQualityLevel from to
553 Change Default of SavedQualityLevel from to
486 Change ThreadSafety of SavedQualityLevel from ReadOnly to ReadSafe
462 Change ThreadSafety of SavedQualityLevel from to ReadOnly
196 Change WriteSecurity of SavedQualityLevel from RobloxScriptSecurity to None
196 Change ReadSecurity of SavedQualityLevel from RobloxScriptSecurity to None
176 Change ReadSecurity of SavedQualityLevel from None to RobloxScriptSecurity
176 Change WriteSecurity of SavedQualityLevel from None to RobloxScriptSecurity
47 Add SavedQualityLevel

SetCameraYInvertVisible
CreatorHub

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

If called, Roblox toggles the menu option to invert the user's camera y axis.

Thread safety	Unsafe

History 3

573 Change ReturnType of SetCameraYInvertVisible from void to null
462 Change ThreadSafety of SetCameraYInvertVisible from to Unsafe
291 Add SetCameraYInvertVisible

SetGamepadCameraSensitivityVisible
CreatorHub

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

If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.

Thread safety	Unsafe

History 5

573 Change ReturnType of SetGamepadCameraSensitivityVisible from void to null
462 Change ThreadSafety of SetGamepadCameraSensitivityVisible from to Unsafe
302 Add SetGamepadCameraSensitivityVisible
301 Remove SetGamepadCameraSensitivityVisible
302 Add SetGamepadCameraSensitivityVisible

SetOnboardingCompleted
CreatorHub

Parameters (1)
onboardingId	string
Returns (1)
null

Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.

Currently, this function only accepts DynamicThumbstick, and it is used to persistently track whether or not the player has finished the tutorial for the Dynamic Thumbstick control scheme. If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

History 3

573 Change ReturnType of SetOnboardingCompleted from void to null
462 Change ThreadSafety of SetOnboardingCompleted from to Unsafe
325 Add SetOnboardingCompleted

SetTutorialState
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

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

StartMaximized
CreatorHub

Type		Default
bool

Indicates whether Roblox Studio should launch in a maximized window.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of StartMaximized from to
553 Change Default of StartMaximized from to
486 Change ThreadSafety of StartMaximized from ReadOnly to ReadSafe
462 Change ThreadSafety of StartMaximized from to ReadOnly
349 Add StartMaximized

Tags: [NotReplicated, NotScriptable]

StartScreenPosition
CreatorHub

Type		Default
Vector2

The screen position of the client's window when the application launches.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of StartScreenPosition from to
553 Change Default of StartScreenPosition from to
486 Change ThreadSafety of StartScreenPosition from ReadOnly to ReadSafe
462 Change ThreadSafety of StartScreenPosition from to ReadOnly
349 Add StartScreenPosition

Tags: [NotReplicated, NotScriptable]

StartScreenSize
CreatorHub

Type		Default
Vector2

The size of the client's window when the application launches.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of StartScreenSize from to
553 Change Default of StartScreenSize from to
486 Change ThreadSafety of StartScreenSize from ReadOnly to ReadSafe
462 Change ThreadSafety of StartScreenSize from to ReadOnly
349 Add StartScreenSize

Tags: [NotReplicated, NotScriptable]

StudioModeChanged
CreatorHub

Parameters (1)
isStudioMode	bool

Fired when the user's client switches between Studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of StudioModeChanged from to Unsafe
47 Add StudioModeChanged

StudioPreferredTextSize
CreatorHub

Type		Default
PreferredTextSize

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

721 Add StudioPreferredTextSize

Tags: [Hidden, NotReplicated]

TouchCameraMovementChanged
CreatorHub

Type		Default
bool

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	true

History 2

657 Change Default of TouchCameraMovementChanged from to
553 Add TouchCameraMovementChanged

Tags: [Hidden, NotReplicated, NotScriptable]

TouchCameraMovementMode
CreatorHub

Type		Default
TouchCameraMovementMode

The camera type in-use by the client while on a mobile device.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 5

657 Change Default of TouchCameraMovementMode from to
553 Change Default of TouchCameraMovementMode from to
486 Change ThreadSafety of TouchCameraMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of TouchCameraMovementMode from to ReadOnly
176 Add TouchCameraMovementMode

TouchMovementChanged
CreatorHub

Type		Default
bool

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	true

History 2

657 Change Default of TouchMovementChanged from to
553 Add TouchMovementChanged

Tags: [Hidden, NotReplicated, NotScriptable]

TouchMovementMode
CreatorHub

Type		Default
TouchMovementMode

The type of controls being used by the client on a mobile device.

Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 5

657 Change Default of TouchMovementMode from to
553 Change Default of TouchMovementMode from to
486 Change ThreadSafety of TouchMovementMode from ReadOnly to ReadSafe
462 Change ThreadSafety of TouchMovementMode from to ReadOnly
153 Add TouchMovementMode

UiNavigationKeyBindEnabled
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	true

History 2

657 Change Default of UiNavigationKeyBindEnabled from to
580 Add UiNavigationKeyBindEnabled

Tags: [Hidden, NotReplicated]

UsedCoreGuiIsVisibleToggle
CreatorHub

Type		Default
bool

Indicates whether the user has toggled the visibility of core GUI elements.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of UsedCoreGuiIsVisibleToggle from to
553 Change Default of UsedCoreGuiIsVisibleToggle from to
486 Change ThreadSafety of UsedCoreGuiIsVisibleToggle from ReadOnly to ReadSafe
462 Change ThreadSafety of UsedCoreGuiIsVisibleToggle from to ReadOnly
268 Add UsedCoreGuiIsVisibleToggle

UsedCustomGuiIsVisibleToggle
CreatorHub

Type		Default
bool

Indicates whether the user has toggled the visibility of custom GUI elements.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of UsedCustomGuiIsVisibleToggle from to
553 Change Default of UsedCustomGuiIsVisibleToggle from to
486 Change ThreadSafety of UsedCustomGuiIsVisibleToggle from ReadOnly to ReadSafe
462 Change ThreadSafety of UsedCustomGuiIsVisibleToggle from to ReadOnly
268 Add UsedCustomGuiIsVisibleToggle

UsedHideHudShortcut
CreatorHub

Type		Default
bool

Indicates whether the user has used the keyboard shortcut for hiding the HUD.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of UsedHideHudShortcut from to
553 Change Default of UsedHideHudShortcut from to
486 Change ThreadSafety of UsedHideHudShortcut from ReadOnly to ReadSafe
462 Change ThreadSafety of UsedHideHudShortcut from to ReadOnly
211 Add UsedHideHudShortcut

VRComfortSetting
CreatorHub

Type		Default
VRComfortSetting

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	Control
Loaded/Saved	true

History 2

657 Change Default of VRComfortSetting from to
592 Add VRComfortSetting

Tags: [Hidden, NotReplicated]

VREnabled
CreatorHub

Type		Default
bool

Indicates whether the client is currently running in VR mode.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of VREnabled from to
553 Change Default of VREnabled from to
486 Change ThreadSafety of VREnabled from ReadOnly to ReadSafe
462 Change ThreadSafety of VREnabled from to ReadOnly
309 Add VREnabled

VRRotationIntensity
CreatorHub

Type		Default
int

The intensity of camera rotation when turning in VR.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 7

657 Change Default of VRRotationIntensity from to
553 Change Default of VRRotationIntensity from to
486 Change ThreadSafety of VRRotationIntensity from ReadOnly to ReadSafe
462 Change ThreadSafety of VRRotationIntensity from to ReadOnly
239 Add VRRotationIntensity
238 Remove VRRotationIntensity
239 Add VRRotationIntensity

VRSafetyBubbleMode
CreatorHub

Type		Default
VRSafetyBubbleMode

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	Control
Loaded/Saved	true

History 2

657 Change Default of VRSafetyBubbleMode from to
568 Add VRSafetyBubbleMode

Tags: [Hidden, NotReplicated]

VRSmoothRotationEnabled
CreatorHub

Type		Default
bool

Indicates whether smooth rotation is used instead of snap rotation in VR.

Write security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

657 Change Default of VRSmoothRotationEnabled from to
553 Change Default of VRSmoothRotationEnabled from to
543 Add VRSmoothRotationEnabled

VRSmoothRotationEnabledCustomOption
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	true

History 2

657 Change Default of VRSmoothRotationEnabledCustomOption from to
592 Add VRSmoothRotationEnabledCustomOption

Tags: [Hidden, NotReplicated]

VRThirdPersonFollowCamEnabled
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	true

History 2

657 Change Default of VRThirdPersonFollowCamEnabled from to
592 Add VRThirdPersonFollowCamEnabled

Tags: [Hidden, NotReplicated]

VRThirdPersonFollowCamEnabledCustomOption
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	true

History 2

657 Change Default of VRThirdPersonFollowCamEnabledCustomOption from to
592 Add VRThirdPersonFollowCamEnabledCustomOption

Tags: [Hidden, NotReplicated]

VignetteEnabled
CreatorHub

Type		Default
bool

Indicates whether the VR vignette comfort effect is enabled.

Write security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

657 Change Default of VignetteEnabled from to
553 Change Default of VignetteEnabled from to
511 Change Tags of VignetteEnabled from [Hidden, NotReplicated] to []
511 Change ReadSecurity of VignetteEnabled from RobloxScriptSecurity to None
508 Add VignetteEnabled

VignetteEnabledCustomOption
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	true

History 2

657 Change Default of VignetteEnabledCustomOption from to
592 Add VignetteEnabledCustomOption

Tags: [Hidden, NotReplicated]

gaID
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	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Configuration
Loaded/Saved	true

History 2

657 Change Default of gaID from to
553 Add gaID

Tags: [Hidden, NotReplicated, NotScriptable]

Removed members 5

ImageUploadPromptBehavior
CreatorHub

Type		Default
UploadSetting

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

304 Remove ImageUploadPromptBehavior
176 Change WriteSecurity of ImageUploadPromptBehavior from None to RobloxScriptSecurity
176 Change ReadSecurity of ImageUploadPromptBehavior from None to RobloxScriptSecurity
135 Add ImageUploadPromptBehavior

MicroProfilerEnabled
CreatorHub

Type		Default
bool

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

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 2

342 Remove MicroProfilerEnabled
334 Add MicroProfilerEnabled

Tags: [Hidden]

UseBasicMouseSensitivity
CreatorHub

Type		Default
bool

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

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 2

295 Remove UseBasicMouseSensitivity
246 Add UseBasicMouseSensitivity

Tags: [Hidden]

VRPlayMode
CreatorHub

Type		Default
VRPlayMode

Its interface does not cross the network boundary.

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

Write security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Control
Loaded/Saved	true

History 2

581 Remove VRPlayMode
565 Add VRPlayMode

Tags: [Hidden, NotReplicated]

VideoUploadPromptBehavior
CreatorHub

Type		Default
UploadSetting

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

304 Remove VideoUploadPromptBehavior
176 Change ReadSecurity of VideoUploadPromptBehavior from None to RobloxScriptSecurity
176 Change WriteSecurity of VideoUploadPromptBehavior from None to RobloxScriptSecurity
47 Add VideoUploadPromptBehavior

Engine API

Website

Related

History 7

History 1

History 8

History 5

History 2

History 2

History 2

History 2

History 5

History 2

History 2

History 5

History 2

History 5

History 15

History 4

History 2

History 7

History 2

History 7

History 2

History 1

History 2

History 2

History 2

History 5

History 2

History 5

History 2

History 2

History 5

History 7

History 9

History 2

History 2

History 5

History 5

History 5

History 5

History 5

History 5

History 5

History 5

History 2

History 1

History 6

History 2

History 2

History 1

History 1

History 2

History 2

History 2

History 5

History 5

History 3

History 2

History 3

History 5

History 9

History 3

History 5

History 3

History 3

History 5

History 5

History 5

History 2