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à

Metodi

Eventi

Proprietà

AllTutorialsDisabled

Lettura Parallela
Sicurezza Script Roblox
Lettura Parallela
Sicurezza Script Roblox

ChatVisible

Lettura Parallela
Sicurezza Script Roblox

ComputerCameraMovementMode

Lettura Parallela

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

ComputerMovementMode

Lettura Parallela

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

ControlMode

Lettura Parallela

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

Fullscreen

Lettura Parallela
Sicurezza Script Roblox

GamepadCameraSensitivity

Lettura Parallela

Describes how sensitive the camera is when using a gamepad.

GraphicsOptimizationMode

Lettura Parallela
Sicurezza Script Roblox

GraphicsQualityLevel

Lettura Parallela
Sicurezza Script Roblox

HasEverUsedVR

Lettura Parallela
Sicurezza Script Roblox

MasterVolume

Lettura Parallela
Sicurezza Script Roblox

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

MasterVolumeStudio

Lettura Parallela
Sicurezza Script Roblox

MaxQualityEnabled

Lettura Parallela
Sicurezza Script Roblox

MouseSensitivity

Lettura Parallela

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

OnboardingsCompleted

Lettura Parallela
Sicurezza Script Roblox

PartyVoiceVolume

Lettura Parallela
Sicurezza Script Roblox

RCCProfilerRecordFrameRate

Lettura Parallela

RCCProfilerRecordTimeFrame

Lettura Parallela

RotationType

Lettura Parallela

Controls how the client's character is rotated.

SavedQualityLevel

Lettura Parallela

The graphics quality level set by the client.

StartMaximized

Non Replicato
Non programmabile
Lettura Parallela
Sicurezza Script Roblox

StartScreenPosition

Non Replicato
Non programmabile
Lettura Parallela
Sicurezza Script Roblox

StartScreenSize

Non Replicato
Non programmabile
Lettura Parallela
Sicurezza Script Roblox

TouchCameraMovementMode

Lettura Parallela

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

TouchMovementMode

Lettura Parallela

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

UsedCoreGuiIsVisibleToggle

Lettura Parallela
Sicurezza Script Roblox

UsedCustomGuiIsVisibleToggle

Lettura Parallela
Sicurezza Script Roblox

UsedHideHudShortcut

Lettura Parallela
Sicurezza Script Roblox

VREnabled

Lettura Parallela
Sicurezza Script Roblox

VRRotationIntensity

Lettura Parallela
Sicurezza Script Roblox

VRSmoothRotationEnabled

Lettura Parallela
Sicurezza Script Roblox

VignetteEnabled

Lettura Parallela
Sicurezza Script Roblox

Metodi

GetCameraYInvertValue

Returns the camera's Y-invert value.


Restituzioni

GetOnboardingCompleted

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.

See also:

Parametri

onboardingId: string

The onboarding ID to inquire about.


Restituzioni

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

InFullScreen

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


Restituzioni

InStudioMode

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


Restituzioni

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.

See also:

Parametri

onboardingId: string

The onboarding ID to set as completed.


Restituzioni

void

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