UserGameSettings

Mostrar obsoleto
No creable
Configuración de usuario

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.

Muestras de código

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)

Resumen

Propiedades

Métodos

Eventos

Propiedades

AllTutorialsDisabled

Leer paralelo
Seguridad de scripts Roblox
Leer paralelo
Seguridad de scripts Roblox

ChatVisible

Leer paralelo
Seguridad de scripts Roblox

ComputerCameraMovementMode

Leer paralelo

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

ComputerMovementMode

Leer paralelo

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

ControlMode

Leer paralelo

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

Fullscreen

Leer paralelo
Seguridad de scripts Roblox

GamepadCameraSensitivity

Leer paralelo

Describes how sensitive the camera is when using a gamepad.

GraphicsOptimizationMode

Leer paralelo
Seguridad de scripts Roblox

GraphicsQualityLevel

Leer paralelo
Seguridad de scripts Roblox

HasEverUsedVR

Leer paralelo
Seguridad de scripts Roblox

MasterVolume

Leer paralelo
Seguridad de scripts Roblox

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

MasterVolumeStudio

Leer paralelo
Seguridad de scripts Roblox

MaxQualityEnabled

Leer paralelo
Seguridad de scripts Roblox

MouseSensitivity

Leer paralelo

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

OnboardingsCompleted

Leer paralelo
Seguridad de scripts Roblox

PartyVoiceVolume

Leer paralelo
Seguridad de scripts Roblox

RCCProfilerRecordFrameRate

Leer paralelo

RCCProfilerRecordTimeFrame

Leer paralelo

RotationType

Leer paralelo

Controls how the client's character is rotated.

SavedQualityLevel

Leer paralelo

The graphics quality level set by the client.

StartMaximized

No replicado
No programable
Leer paralelo
Seguridad de scripts Roblox

StartScreenPosition

No replicado
No programable
Leer paralelo
Seguridad de scripts Roblox

StartScreenSize

No replicado
No programable
Leer paralelo
Seguridad de scripts Roblox

TouchCameraMovementMode

Leer paralelo

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

TouchMovementMode

Leer paralelo

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

UsedCoreGuiIsVisibleToggle

Leer paralelo
Seguridad de scripts Roblox

UsedCustomGuiIsVisibleToggle

Leer paralelo
Seguridad de scripts Roblox

UsedHideHudShortcut

Leer paralelo
Seguridad de scripts Roblox

VREnabled

Leer paralelo
Seguridad de scripts Roblox

VRRotationIntensity

Leer paralelo
Seguridad de scripts Roblox

VRSmoothRotationEnabled

Leer paralelo
Seguridad de scripts Roblox

VignetteEnabled

Leer paralelo
Seguridad de scripts Roblox

Métodos

GetCameraYInvertValue

Returns the camera's Y-invert value.


Devuelve

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:

Parámetros

onboardingId: string

The onboarding ID to inquire about.


Devuelve

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.


Devuelve

InStudioMode

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


Devuelve

SetCameraYInvertVisible

void

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


Devuelve

void

SetGamepadCameraSensitivityVisible

void

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


Devuelve

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:

Parámetros

onboardingId: string

The onboarding ID to set as completed.


Devuelve

void

Eventos

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.

Parámetros

isFullscreen: bool

Muestras de código

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.

Parámetros

isStudioMode: bool