PcoWSkbVqDnWTu_dm2ix
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

bool

AllTutorialsDisabled

CustomCameraMode

CameraMode

bool

CameraYInverted

[Hidden] [NotReplicated]
bool

ChatVisible

ComputerCameraMovementMode

ComputerCameraMovementMode

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

ComputerMovementMode

ComputerMovementMode

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

ControlMode

ControlMode

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

bool

Fullscreen

float

GamepadCameraSensitivity

Describes how sensitive the camera is when using a gamepad.

int

GraphicsQualityLevel

bool

HasEverUsedVR

bool

IsUsingCameraYInverted

[Hidden] [ReadOnly] [NotReplicated]
bool

IsUsingGamepadCameraSensitivity

[Hidden] [ReadOnly] [NotReplicated]
float

MasterVolume

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

bool

MicroProfilerWebServerEnabled

[Hidden]
string

MicroProfilerWebServerIP

[Hidden] [ReadOnly] [NotReplicated]
int

MicroProfilerWebServerPort

[Hidden] [ReadOnly] [NotReplicated]
float

MouseSensitivity

A float between 0 and 100 representing the sensitivity of the client’s mouse.

Vector2

MouseSensitivityFirstPerson

[Hidden] [NotReplicated]
Vector2

MouseSensitivityThirdPerson

[Hidden] [NotReplicated]
bool

OnScreenProfilerEnabled

[Hidden]
string

OnboardingsCompleted

bool

PerformanceStatsVisible

[Hidden]
int

RCCProfilerRecordFrameRate

int

RCCProfilerRecordTimeFrame

RotationType

RotationType

Controls how the client’s character is rotated.

SavedQualitySetting

SavedQualityLevel

The graphics quality level set by the client.

bool

StartMaximized

[NotReplicated] [NotScriptable]
Vector2

StartScreenPosition

[NotReplicated] [NotScriptable]
Vector2

StartScreenSize

[NotReplicated] [NotScriptable]
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.

bool

UsedCoreGuiIsVisibleToggle

bool

UsedCustomGuiIsVisibleToggle

bool

UsedHideHudShortcut

bool

VREnabled

int

VRRotationIntensity

bool

VignetteEnabled

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance

bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects

int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

int

GetCameraYInvertValue ( )

Returns the camera’s Y-invert value.

bool

GetOnboardingCompleted ( string onboardingId )

Checks if onboarding has been completed

bool

GetTutorialState ( string tutorialId )

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

ResetOnboardingCompleted ( string onboardingId )

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

void

SetTutorialState ( string tutorialId , bool value )

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.

Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.

Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name

RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes

Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes

Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance’s ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

FullscreenChanged ( bool isFullscreen )

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

RBXScriptSignal

PerformanceStatsVisibleChanged ( bool isPerformanceStatsVisible )

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.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples


UserGameSettings Listener

A basic example that shows how you can listen to changes in the user’s settings.
With this code pasted into a LocalScript running in the StarterPlayerScripts, you can change settings in Roblox’s game menu, and see their values appear in the output as detected changes.