PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

UserGameSettings

Show deprecated

UserGameSettings

Show deprecated

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():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.

Properties

ComputerCameraMovementMode

ComputerCameraMovementMode

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

ComputerMovementMode

ComputerMovementMode

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

ControlMode

ControlMode

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

float

GamepadCameraSensitivity

Describes how sensitive the camera is when using a gamepad.

float

MasterVolume

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

float

MouseSensitivity

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

RotationType

RotationType

Controls how the client’s character is rotated.

SavedQualitySetting

SavedQualityLevel

The graphics quality level set by the client.

TouchCameraMovementMode

TouchCameraMovementMode

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

TouchMovementMode

TouchMovementMode

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

Functions

int

GetCameraYInvertValue ( )

Returns the camera’s Y-invert value.

bool

GetOnboardingCompleted ( string onboardingId )

Checks if onboarding has been completed

bool

InFullScreen ( )

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

bool

InStudioMode ( )

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

void

SetCameraYInvertVisible ( )

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

void

SetGamepadCameraSensitivityVisible ( )

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

void

SetOnboardingCompleted ( string onboardingId )

Sets onboarding as completed

Events

RBXScriptSignal

FullscreenChanged ( bool isFullscreen )

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

RBXScriptSignal

StudioModeChanged ( bool isStudioMode )

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.