UserGameSettings¶
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.
Description¶
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-game 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:
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.
Inheritance¶
Object → Instance → UserGameSettings
Nova inheritance: Instance → UserGameSettings
Properties¶
AllTutorialsDisabled Supported Property Indicates whether all in-game tutorials have been disabled by the user.
Indicates whether all in-game tutorials have been disabled by the user.
RobloxScriptSecurityCameraMode Supported Property The custom camera mode currently in-use by the client.
The custom camera mode currently in-use by the client.
RobloxScriptSecurityCameraSensitivity Supported Property
ComputerCameraMovementMode Supported Property The camera movement mode currently in-use by the client on desktop.
The camera movement mode currently in-use by the client on desktop.
ComputerMovementMode Supported Property The type of controls being used by the client on desktop.
The type of controls being used by the client on desktop.
ControlMode Supported Property Deprecated Toggles whether or not the client can use the Mouse Lock Switch mode.
Toggles whether or not the client can use the Mouse Lock Switch mode.
Fullscreen Supported Property Indicates whether the client's window is currently in full screen mode.
Indicates whether the client's window is currently in full screen mode.
RobloxScriptSecurityMasterVolume Supported Property A float between 0 and 1 representing the volume of the game's client.
A float between 0 and 1 representing the volume of the game's client.
A float between 0 and 1 representing the volume of the game's client.
RotationType Supported Property Controls how the client's character is rotated.
SavedQualityLevel Supported Property The graphics quality level set by the client.
The graphics quality level set by the client.
TouchCameraMovementMode Supported Property The camera type in-use by the client while on a mobile device.
The camera type in-use by the client while on a mobile device.
TouchMovementMode Supported Property The type of controls being used by the client on a mobile device.
The type of controls being used by the client on a mobile device.
UsedHideHudShortcut Supported Property Indicates whether the user has used the keyboard shortcut for hiding the HUD.
Indicates whether the user has used the keyboard shortcut for hiding the HUD.
RobloxScriptSecurityVirtualVersion Supported Property
Methods¶
GetTutorialState Supported Function
No description available.
RobloxScriptSecurityInFullScreen Supported Function Returns true if the user's Roblox window is in full screen mode.
Returns true if the user's Roblox window is in full screen mode.
InStudioMode Supported Function Returns true if the client's game session is in Roblox Studio.
Returns true if the client's game session is in Roblox Studio.
SetTutorialState Supported Function
No description available.
RobloxScriptSecurityEvents¶
FullscreenChanged Supported Event Fires if the user's full screen mode is changed.
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.
StudioModeChanged Supported Event 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.
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.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
31 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's UserGameSettings class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
BadgeVisible |
BadgeVisible: bool |
Not yet | Indicates whether badge notifications are visible to the client. | RobloxScriptSecurity |
ChatVisible |
ChatVisible: bool |
Not yet | Indicates whether the in-game chat is visible to the client. | RobloxScriptSecurity |
GamepadCameraSensitivity |
GamepadCameraSensitivity: float |
Not yet | Describes how sensitive the camera is when using a gamepad. | — |
GraphicsOptimizationMode |
GraphicsOptimizationMode: GraphicsOptimizationMode |
Not yet | The graphics optimization mode used by the client to balance visual quality and performance. | RobloxScriptSecurity |
GraphicsQualityLevel |
GraphicsQualityLevel: int |
Not yet | The current graphics quality level being used by the client. | RobloxScriptSecurity |
HasEverUsedVR |
HasEverUsedVR: bool |
Not yet | Indicates whether the user has ever launched the client in VR mode. | RobloxScriptSecurity |
MasterVolumeStudio |
MasterVolumeStudio: float |
Not yet | A float between 0 and 1 representing the master volume used in Roblox Studio. | RobloxScriptSecurity |
MaxQualityEnabled |
MaxQualityEnabled: bool |
Not yet | Indicates whether the client's graphics quality is set to the maximum available level. | RobloxScriptSecurity |
MouseSensitivity |
MouseSensitivity: float |
Not yet | A float between 0 and 4 representing the sensitivity of the client's camera sensitivity. | — |
OnboardingsCompleted |
OnboardingsCompleted: string |
Not yet | A comma-separated list of onboarding IDs that the user has completed. | RobloxScriptSecurity |
PartyVoiceVolume |
PartyVoiceVolume: float |
Not yet | A float between 0 and 1 representing the volume of party voice chat. | RobloxScriptSecurity |
PeoplePageLayout |
PeoplePageLayout: PeoplePageLayout |
Not yet | The layout style used to display the people page in the in-game menu. | RobloxScriptSecurity |
PlayerListVisible |
PlayerListVisible: bool |
Not yet | Indicates whether the in-game player list is visible to the client. | RobloxScriptSecurity |
PlayerNamesEnabled |
PlayerNamesEnabled: bool |
Not yet | Indicates whether player names are displayed above characters in the game. | RobloxScriptSecurity |
RCCProfilerRecordFrameRate |
RCCProfilerRecordFrameRate: int |
Not yet | Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data. | — |
RCCProfilerRecordTimeFrame |
RCCProfilerRecordTimeFrame: int |
Not yet | Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured. | — |
UsedCoreGuiIsVisibleToggle |
UsedCoreGuiIsVisibleToggle: bool |
Not yet | Indicates whether the user has toggled the visibility of core GUI elements. | RobloxScriptSecurity |
UsedCustomGuiIsVisibleToggle |
UsedCustomGuiIsVisibleToggle: bool |
Not yet | Indicates whether the user has toggled the visibility of custom GUI elements. | RobloxScriptSecurity |
VignetteEnabled |
VignetteEnabled: bool |
Not yet | Indicates whether the VR vignette comfort effect is enabled. | read None / write RobloxScriptSecurity |
VoiceChatVolume |
VoiceChatVolume: float |
Not yet | A float between 0 and 2 representing the volume of in-game voice chat. |
RobloxScriptSecurity |
VREnabled |
VREnabled: bool |
Not yet | Indicates whether the client is currently running in VR mode. | RobloxScriptSecurity |
VRRotationIntensity |
VRRotationIntensity: int |
Not yet | The intensity of camera rotation when turning in VR. | RobloxScriptSecurity |
VRSmoothRotationEnabled |
VRSmoothRotationEnabled: bool |
Not yet | Indicates whether smooth rotation is used instead of snap rotation in VR. | read None / write RobloxScriptSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GetCameraYInvertValue |
UserGameSettings:GetCameraYInvertValue(): int |
Not yet | Returns the camera's Y-invert value. | — |
GetDefaultFramerateCap |
UserGameSettings:GetDefaultFramerateCap(): int |
Not yet | — | RobloxScriptSecurity |
GetOnboardingCompleted |
UserGameSettings:GetOnboardingCompleted(onboardingId: string): bool |
Not yet | Checks if onboarding has been completed. | — |
ResetOnboardingCompleted |
UserGameSettings:ResetOnboardingCompleted(onboardingId: string): null |
Not yet | — | RobloxScriptSecurity |
SetCameraYInvertVisible |
UserGameSettings:SetCameraYInvertVisible(): null |
Not yet | If called, Roblox toggles the menu option to invert the user's camera y axis. | — |
SetGamepadCameraSensitivityVisible |
UserGameSettings:SetGamepadCameraSensitivityVisible(): null |
Not yet | If called, Roblox toggles the menu option to control the camera sensitivity with gamepads. | — |
SetOnboardingCompleted |
UserGameSettings:SetOnboardingCompleted(onboardingId: string): null |
Not yet | Sets onboarding as completed. | — |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
PerformanceStatsVisibleChanged |
PerformanceStatsVisibleChanged(isPerformanceStatsVisible: bool) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: UserGameSettings
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.