API:Class/UserGameSettings

Client only:This object is client-side only! You should use a LocalScript instead of a Script when using it.
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Settings: This object has been marked as a settings object. It is used to hold persistent settings, which may be accessible by Roblox Studio's settings menu, or the in-game menu. This object cannot be created.

Configuration icon.pngUserGameSettings : Object Icon.pngInstance

A read-only version of the client's game settings. This can be accessed via the UserSettings function, like so: UserSettings():GetService("UserGameSettings").
Most of the properties in this class are read only, but CoreScripts are allowed to write to them.

Properties

Properties [toggle]

RotationTypeRotationType

Controls how the client's character is rotated.

|RMD member="API:Class/UserGameSettings/RotationType"|Controls how the client's character is rotated.|/RMD|
Controls how the client's character is rotated.

Functions

Functions [toggle]

intGetCameraYInvertValue ( )

Returns the camera's Y-invert value.

|RMD member="API:Class/UserGameSettings/GetCameraYInvertValue"|Returns the camera's Y-invert value.|/RMD|
boolInFullScreen ( )

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

|RMD member="API:Class/UserGameSettings/InFullScreen"|Returns true if the user's Roblox window is in full screen mode.|/RMD|
boolInStudioMode ( )

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

|RMD member="API:Class/UserGameSettings/InStudioMode"|Returns true if the client's game session is in Roblox Studio.|/RMD|
voidSetCameraYInvertVisible ( )

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

|RMD member="API:Class/UserGameSettings/SetCameraYInvertVisible"|If called, Roblox toggles the menu option to invert the user's camera y axis.|/RMD|
voidSetGamepadCameraSensitivityVisible ( )

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

|RMD member="API:Class/UserGameSettings/SetGamepadCameraSensitivityVisible"|If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.|/RMD|
Returns the camera's Y-invert value.
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.
Inherited from Object Icon.pngInstance:
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
Returns a signal that is fired when the specified property is changed on this object.


Events

Events [toggle]

FullscreenChanged ( bool isFullscreen )

Fired when the user changes between windowed and full-screen mode.

|RMD member="API:Class/UserGameSettings/FullscreenChanged"|Fired when the user changes between windowed and full-screen mode.|/RMD|
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.

|RMD member="API:Class/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.|/RMD|

FullscreenChanged ( bool isFullscreen )
Fired when the user changes between windowed and full-screen mode.
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 Object Icon.pngInstance:
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
Changed ( string property )
Fires after a property of the object changes.


Filtered Tag Debug Info:

hidden = 1

LocalUserSecurity = 1

RobloxPlaceSecurity = 1

deprecated = 1

PluginSecurity = 1

RobloxScriptSecurity = 2

RobloxSecurity = 2|RMD member="API:Class/UserGameSettings"|A read-only version of the client's game settings. This can be accessed via the UserSettings function, like so: UserSettings():GetService("UserGameSettings").
Most of the properties in this class are read only, but CoreScripts are allowed to write to them. |/RMD|