UserGameSettings

Visualizza obsoleti

non costruibile

opzioni utente

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.

Campioni di codice

UserGameSettings Listener

local gameSettings = UserSettings().GameSettings

local function onGameSettingChanged(nameOfSetting)
	-- Fetch the value of this setting through a pcall to make sure we can retrieve it.
	-- Sometimes the event fires with properties that LocalScripts can't access.
	local canGetSetting, setting = pcall(function()
		return gameSettings[nameOfSetting]
	end)

	if canGetSetting then
		print("Your " .. nameOfSetting .. " has changed to: " .. tostring(setting))
	end
end

gameSettings.Changed:Connect(onGameSettingChanged)

Sommario

Proprietà

AllTutorialsDisabled:bool
lettura parallela
CameraMode:Enum.CustomCameraMode
lettura parallela
ChatVisible:bool
lettura parallela
ComputerCameraMovementMode:Enum.ComputerCameraMovementMode
lettura parallela
The camera movement mode currently in-use by the client on desktop.
ComputerMovementMode:Enum.ComputerMovementMode
lettura parallela
The type of controls being used by the client on desktop.
ControlMode:Enum.ControlMode
lettura parallela
deprecato
Toggles whether or not the client can use the Mouse Lock Switch mode.
Fullscreen:bool
lettura parallela
GamepadCameraSensitivity:number
lettura parallela
Describes how sensitive the camera is when using a gamepad.
GraphicsQualityLevel:number
lettura parallela
HasEverUsedVR:bool
lettura parallela
MasterVolume:number
lettura parallela
A float between 0 and 1 representing the volume of the game's client.
MasterVolumeStudio:number
lettura parallela
MouseSensitivity:number
lettura parallela
A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.
OnboardingsCompleted:string
lettura parallela
RCCProfilerRecordFrameRate:number
lettura parallela
RCCProfilerRecordTimeFrame:number
lettura parallela
RotationType:Enum.RotationType
lettura parallela
Controls how the client's character is rotated.
SavedQualityLevel:Enum.SavedQualitySetting
lettura parallela
The graphics quality level set by the client.
StartMaximized:bool
non replicato
non programmabile
lettura parallela
StartScreenPosition:Vector2
non replicato
non programmabile
lettura parallela
StartScreenSize:Vector2
non replicato
non programmabile
lettura parallela
TouchCameraMovementMode:Enum.TouchCameraMovementMode
lettura parallela
The camera type in-use by the client while on a mobile device.
TouchMovementMode:Enum.TouchMovementMode
lettura parallela
The type of controls being used by the client on a mobile device.
UsedCoreGuiIsVisibleToggle:bool
lettura parallela
UsedCustomGuiIsVisibleToggle:bool
lettura parallela
UsedHideHudShortcut:bool
lettura parallela
VREnabled:bool
lettura parallela
VRRotationIntensity:number
lettura parallela
VRSmoothRotationEnabled:bool
lettura parallela
VignetteEnabled:bool
lettura parallela

View all inherited from Instance

Metodi

GetCameraYInvertValue():number
Returns the camera's Y-invert value.
GetOnboardingCompleted(onboardingId : string):bool
Checks if onboarding has been completed.
InFullScreen():bool
Returns true if the user's Roblox window is in full screen mode.
InStudioMode():bool
Returns true if the client's game session is in Roblox Studio.
SetCameraYInvertVisible():void
If called, Roblox toggles the menu option to invert the user's camera y axis.
SetGamepadCameraSensitivityVisible():void
If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
SetOnboardingCompleted(onboardingId : string):void
Sets onboarding as completed.

View all inherited from Instance

Eventi

FullscreenChanged(isFullscreen : bool):RBXScriptSignal
Fires if the user's full screen mode is changed.
StudioModeChanged(isStudioMode : bool):RBXScriptSignal
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.

View all inherited from Instance

Proprietà

AllTutorialsDisabled

bool

lettura parallela

sicurezza script roblox

CameraMode

Enum.CustomCameraMode

lettura parallela

sicurezza script roblox

ChatVisible

bool

lettura parallela

sicurezza script roblox

ComputerCameraMovementMode

Enum.ComputerCameraMovementMode

lettura parallela

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

ComputerMovementMode

Enum.ComputerMovementMode

lettura parallela

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

ControlMode

Enum.ControlMode

lettura parallela

DEPRECATO

This property has been deprecated. You can enable mouse-locked third-person control, or "Shift Lock Mode", through the Enum.MouseBehavior in PlayerScripts:RegisterTouchCameraMovementMode() and PlayerScripts:RegisterComputerCameraMovementMode().

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

Fullscreen

bool

lettura parallela

sicurezza script roblox

GamepadCameraSensitivity

number

lettura parallela

Describes how sensitive the camera is when using a gamepad.

GraphicsQualityLevel

number

lettura parallela

sicurezza script roblox

HasEverUsedVR

bool

lettura parallela

sicurezza script roblox

MasterVolume

number

lettura parallela

sicurezza script roblox

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

MasterVolumeStudio

number

lettura parallela

sicurezza script roblox

MouseSensitivity

number

lettura parallela

A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.

OnboardingsCompleted

string

lettura parallela

sicurezza script roblox

RCCProfilerRecordFrameRate

number

lettura parallela

RCCProfilerRecordTimeFrame

number

lettura parallela

RotationType

Enum.RotationType

lettura parallela

Controls how the client's character is rotated.

SavedQualityLevel

Enum.SavedQualitySetting

lettura parallela

The graphics quality level set by the client.

StartMaximized

bool

non replicato

non programmabile

lettura parallela

sicurezza script roblox

StartScreenPosition

Vector2

non replicato

non programmabile

lettura parallela

sicurezza script roblox

StartScreenSize

Vector2

non replicato

non programmabile

lettura parallela

sicurezza script roblox

TouchCameraMovementMode

Enum.TouchCameraMovementMode

lettura parallela

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

TouchMovementMode

Enum.TouchMovementMode

lettura parallela

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

UsedCoreGuiIsVisibleToggle

bool

lettura parallela

sicurezza script roblox

UsedCustomGuiIsVisibleToggle

bool

lettura parallela

sicurezza script roblox

UsedHideHudShortcut

bool

lettura parallela

sicurezza script roblox

VREnabled

bool

lettura parallela

sicurezza script roblox

VRRotationIntensity

number

lettura parallela

sicurezza script roblox

VRSmoothRotationEnabled

bool

lettura parallela

sicurezza script roblox

VignetteEnabled

bool

lettura parallela

sicurezza script roblox

View all inherited from Instance

Metodi

GetCameraYInvertValue

number

Returns the camera's Y-invert value.

Restituzioni

number

GetOnboardingCompleted

bool

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.

Parametri

onboardingId: string

The onboarding ID to inquire about.

Restituzioni

bool

Whether or not the onboarding in particular has been completed yet.

InFullScreen

bool

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

Restituzioni

bool

InStudioMode

bool

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

Restituzioni

bool

SetCameraYInvertVisible

void

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

Restituzioni

void

SetGamepadCameraSensitivityVisible

void

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

Restituzioni

void

SetOnboardingCompleted

void

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.

Parametri

onboardingId: string

The onboarding ID to set as completed.

Restituzioni

void

View all inherited from Instance

Eventi

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.

Parametri

isFullscreen: bool

Campioni di codice

Full Screen Mode Detection

local gameSettings = UserSettings().GameSettings

local function checkFullScreenMode()
	local inFullscreen = gameSettings:InFullScreen()
	if inFullscreen then
		print("Full Screen mode enabled!")
	else
		print("Full Screen mode disabled!")
	end
end

checkFullScreenMode()
gameSettings.FullscreenChanged:Connect(checkFullScreenMode)

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.

Parametri

isStudioMode: bool

View all inherited from Instance