Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
UserGameSettings
Inherits from: Instance → Object
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:
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.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, NotReplicated
Code samples: View on Creator Hub (UserGameSettings-Listener).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| UserGameSettings.AllTutorialsDisabled | boolean | Indicates whether all in-game tutorials have been disabled by the user. |
| UserGameSettings.BadgeVisible | boolean | Indicates whether badge notifications are visible to the client. |
| UserGameSettings.CameraMode | CustomCameraMode | The custom camera mode currently in-use by the client. |
| UserGameSettings.ChatVisible | boolean | Indicates whether the in-game chat is visible to the client. |
| UserGameSettings.ComputerCameraMovementMode | ComputerCameraMovementMode | The camera movement mode currently in-use by the client on desktop. |
| UserGameSettings.ComputerMovementMode | ComputerMovementMode | The type of controls being used by the client on desktop. |
| UserGameSettings.ControlMode | ControlMode | Toggles whether or not the client can use the Mouse Lock Switch mode. |
| UserGameSettings.Fullscreen | boolean | Indicates whether the client's window is currently in full screen mode. |
| UserGameSettings.GamepadCameraSensitivity | float | Describes how sensitive the camera is when using a gamepad. |
| UserGameSettings.GraphicsOptimizationMode | GraphicsOptimizationMode | The graphics optimization mode used by the client to balance visual quality and performance. |
| UserGameSettings.GraphicsQualityLevel | int | The current graphics quality level being used by the client. |
| UserGameSettings.HasEverUsedVR | boolean | Indicates whether the user has ever launched the client in VR mode. |
| UserGameSettings.MasterVolume | float | A float between 0 and 1 representing the volume of the game's client. |
| UserGameSettings.MasterVolumeStudio | float | A float between 0 and 1 representing the master volume used in Roblox Studio. |
| UserGameSettings.MaxQualityEnabled | boolean | Indicates whether the client's graphics quality is set to the maximum available level. |
| UserGameSettings.MouseSensitivity | float | A float between 0 and 4 representing the sensitivity of the client's camera sensitivity. |
| UserGameSettings.OnboardingsCompleted | string | A comma-separated list of onboarding IDs that the user has completed. |
| UserGameSettings.PartyVoiceVolume | float | A float between 0 and 1 representing the volume of party voice chat. |
| UserGameSettings.PeoplePageLayout | PeoplePageLayout | The layout style used to display the people page in the in-game menu. |
| UserGameSettings.PlayerListVisible | boolean | Indicates whether the in-game player list is visible to the client. |
| UserGameSettings.PlayerNamesEnabled | boolean | Indicates whether player names are displayed above characters in the game. |
| UserGameSettings.RCCProfilerRecordFrameRate | int | Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data. |
| UserGameSettings.RCCProfilerRecordTimeFrame | int | Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured. |
| UserGameSettings.RotationType | RotationType | Controls how the client's character is rotated. |
| UserGameSettings.SavedQualityLevel | SavedQualitySetting | The graphics quality level set by the client. |
| UserGameSettings.StartMaximized | boolean | Indicates whether Roblox Studio should launch in a maximized window. |
| UserGameSettings.StartScreenPosition | Vector2 | The screen position of the client's window when the application launches. |
| UserGameSettings.StartScreenSize | Vector2 | The size of the client's window when the application launches. |
| UserGameSettings.TouchCameraMovementMode | TouchCameraMovementMode | The camera type in-use by the client while on a mobile device. |
| UserGameSettings.TouchMovementMode | TouchMovementMode | The type of controls being used by the client on a mobile device. |
| UserGameSettings.UsedCoreGuiIsVisibleToggle | boolean | Indicates whether the user has toggled the visibility of core GUI elements. |
| UserGameSettings.UsedCustomGuiIsVisibleToggle | boolean | Indicates whether the user has toggled the visibility of custom GUI elements. |
| UserGameSettings.UsedHideHudShortcut | boolean | Indicates whether the user has used the keyboard shortcut for hiding the HUD. |
| UserGameSettings.VignetteEnabled | boolean | Indicates whether the VR vignette comfort effect is enabled. |
| UserGameSettings.VoiceChatVolume | float | A float between 0 and 2 representing the volume of in-game voice chat. |
| UserGameSettings.VREnabled | boolean | Indicates whether the client is currently running in VR mode. |
| UserGameSettings.VRRotationIntensity | int | The intensity of camera rotation when turning in VR. |
| UserGameSettings.VRSmoothRotationEnabled | boolean | Indicates whether smooth rotation is used instead of snap rotation in VR. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
UserGameSettings.AllTutorialsDisabled
Indicates whether all in-game tutorials have been disabled by the user.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.BadgeVisible
Indicates whether badge notifications are visible to the client.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.CameraMode
The custom camera mode currently in-use by the client.
| Field | Value |
|---|---|
| type | CustomCameraMode |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.ChatVisible
Indicates whether the in-game chat is visible to the client.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.ComputerCameraMovementMode
The camera movement mode currently in-use by the client on desktop.
| Field | Value |
|---|---|
| type | ComputerCameraMovementMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.ComputerMovementMode
The type of controls being used by the client on desktop.
| Field | Value |
|---|---|
| type | ComputerMovementMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.ControlMode
Deprecated. This property has been deprecated. You can enable mouse-locked third-person control, or "Shift Lock Mode", through the MouseBehavior in PlayerScripts:RegisterTouchCameraMovementMode() and PlayerScripts:RegisterComputerCameraMovementMode().
Toggles whether or not the client can use the Mouse Lock Switch mode.
| Field | Value |
|---|---|
| type | ControlMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.Fullscreen
Indicates whether the client's window is currently in full screen mode.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.GamepadCameraSensitivity
Describes how sensitive the camera is when using a gamepad.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.GraphicsOptimizationMode
The graphics optimization mode used by the client to balance visual quality and performance.
| Field | Value |
|---|---|
| type | GraphicsOptimizationMode |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.GraphicsQualityLevel
The current graphics quality level being used by the client.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.HasEverUsedVR
Indicates whether the user has ever launched the client in VR mode.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.MasterVolume
A float between 0 and 1 representing the volume of the game's client.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.MasterVolumeStudio
A float between 0 and 1 representing the master volume used in Roblox Studio.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.MaxQualityEnabled
Indicates whether the client's graphics quality is set to the maximum available level.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.MouseSensitivity
A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.OnboardingsCompleted
A comma-separated list of onboarding IDs that the user has completed.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
UserGameSettings.PartyVoiceVolume
A float between 0 and 1 representing the volume of party voice chat.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.PeoplePageLayout
The layout style used to display the people page in the in-game menu.
| Field | Value |
|---|---|
| type | PeoplePageLayout |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.PlayerListVisible
Indicates whether the in-game player list is visible to the client.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.PlayerNamesEnabled
Indicates whether player names are displayed above characters in the game.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.RCCProfilerRecordFrameRate
Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.RCCProfilerRecordTimeFrame
Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.RotationType
Controls how the client's character is rotated.
| Field | Value |
|---|---|
| type | RotationType |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
UserGameSettings.SavedQualityLevel
The graphics quality level set by the client.
| Field | Value |
|---|---|
| type | SavedQualitySetting |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Players"] |
UserGameSettings.StartMaximized
Indicates whether Roblox Studio should launch in a maximized window.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.StartScreenPosition
The screen position of the client's window when the application launches.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.StartScreenSize
The size of the client's window when the application launches.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.TouchCameraMovementMode
The camera type in-use by the client while on a mobile device.
| Field | Value |
|---|---|
| type | TouchCameraMovementMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.TouchMovementMode
The type of controls being used by the client on a mobile device.
| Field | Value |
|---|---|
| type | TouchMovementMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Control |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
UserGameSettings.UsedCoreGuiIsVisibleToggle
Indicates whether the user has toggled the visibility of core GUI elements.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.UsedCustomGuiIsVisibleToggle
Indicates whether the user has toggled the visibility of custom GUI elements.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.UsedHideHudShortcut
Indicates whether the user has used the keyboard shortcut for hiding the HUD.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.VignetteEnabled
Indicates whether the VR vignette comfort effect is enabled.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.VoiceChatVolume
A float between 0 and 2 representing the volume of in-game voice chat.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.VREnabled
Indicates whether the client is currently running in VR mode.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.VRRotationIntensity
The intensity of camera rotation when turning in VR.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
UserGameSettings.VRSmoothRotationEnabled
Indicates whether smooth rotation is used instead of snap rotation in VR.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| UserGameSettings:GetCameraYInvertValue | int | Returns the camera's Y-invert value. |
| UserGameSettings:GetOnboardingCompleted | boolean | Checks if onboarding has been completed. |
| UserGameSettings:InFullScreen | boolean | Returns true if the user's Roblox window is in full screen mode. |
| UserGameSettings:InStudioMode | boolean | Returns true if the client's game session is in Roblox Studio. |
| UserGameSettings:SetCameraYInvertVisible | () | If called, Roblox toggles the menu option to invert the user's camera y axis. |
| UserGameSettings:SetGamepadCameraSensitivityVisible | () | If called, Roblox toggles the menu option to control the camera sensitivity with gamepads. |
| UserGameSettings:SetOnboardingCompleted | () | Sets onboarding as completed. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
UserGameSettings:GetCameraYInvertValue
Returns the camera's Y-invert value.
Returns
| Type | Description |
|---|---|
| int | The camera's current Y-axis inversion multiplier. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
UserGameSettings:GetOnboardingCompleted
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
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| onboardingId | string | The onboarding ID to inquire about. |
Returns
| Type | Description |
|---|---|
| boolean | Whether or not the onboarding in particular has been completed yet. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Players"] |
UserGameSettings:InFullScreen
Returns true if the user's Roblox window is in full screen mode.
Returns
| Type | Description |
|---|---|
| boolean | Whether the user's Roblox window is in full screen mode. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Players"] |
UserGameSettings:InStudioMode
Returns true if the client's game session is in Roblox Studio.
Returns
| Type | Description |
|---|---|
| boolean | Whether the current client session is running in Roblox Studio. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Players"] |
UserGameSettings:SetCameraYInvertVisible
If called, Roblox toggles the menu option to invert the user's camera y axis.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
UserGameSettings:SetGamepadCameraSensitivityVisible
If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
UserGameSettings:SetOnboardingCompleted
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
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| onboardingId | string | The onboarding ID to set as completed. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Players"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| UserGameSettings.FullscreenChanged | Fires if the user's full screen mode is changed. | |
| UserGameSettings.StudioModeChanged | 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 from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
UserGameSettings.FullscreenChanged
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| isFullscreen | boolean | Whether the user's Roblox window is now in full screen mode. |
| Field | Value |
|---|---|
| security | None |
Code samples: View on Creator Hub (Full-Screen-Mode-Detection).
UserGameSettings.StudioModeChanged
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| isStudioMode | boolean | Whether the client session is now running in Roblox Studio. |
| Field | Value |
|---|---|
| security | None |