UserGameSettings

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

Indicates whether badge notifications are visible to the client.

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

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

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

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

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

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

Describes how sensitive the camera is when using a gamepad.

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

The current graphics quality level being used by the client.

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

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

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

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

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

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

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

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

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

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

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

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

Controls how the client's character is rotated.

The graphics quality level set by the client.

Indicates whether Roblox Studio should launch in a maximized window.

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

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

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

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

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

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

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

Indicates whether the VR vignette comfort effect is enabled.

A float between 0 and 2 representing the volume of in-game voice chat.

Indicates whether the client is currently running in VR mode.

The intensity of camera rotation when turning in VR.

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

Returns the camera's Y-invert value.

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.

See also:

• UserGameSettings:SetOnboardingCompleted(), sets onboarding as completed

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

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

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

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

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.

See also:

• UserGameSettings:GetOnboardingCompleted(), checks if onboarding has been completed

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.

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.