We use cookies on this site to enhance your user experience

UserGameSettings

UserGameSettings

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.

You can access this object from a LocalScript via: UserSettings/GameSettings
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.

Properties

Name Type Description
ComputerCameraMovementMode

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

ComputerMovementMode

The movement type in-use by the client via Computer input.

ControlMode

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

float

Describes how sensitive the camera is when using a gamepad.

float

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

float

A float representing the sensitivity of the client’s mouse.

RotationType

Controls how the client’s character is rotated.

SavedQualitySetting

The graphics quality level set by the client.

TouchCameraMovementMode

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

TouchMovementMode

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

Inherited from Instance

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
int

Returns the camera’s Y-invert value.

bool

Returns true if the specified onboardingId has been recorded as complete via UserGameSettings/SetOnboardingCompleted.

bool

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

bool

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

void

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

void

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

void

Records that the user has finished the specified onboardingId.

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.

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild

Events

Name Type Description

Fires if the user’s full screen mode is changed.

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

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving