UserGameSettings

Mostrar obsoleto

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

No creable
Configuración de usuario

El UserGameSettings es una clase de clave única que se encuentra dentro del singleton Class.UserSettings . Contiene varias configuraciones persistentes relacionadas con cómo el usuario quiere controlar su cámara y su personaje.

Puede acceder a este objeto desde un LocalScript vía:


UserSettings():GetService("UserGameSettings")

Este objeto está destinado solo para ser usado en el cliente, ya que no sirve ningún propósito en el servidor. También reflejará su propia configuración al probar en 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

El modo de movimiento de la cámara que el cliente en el equipo de escritorioestá usando actualmente.

ComputerMovementMode

Leer paralelo

El tipo de controles que el cliente está usando en el equipo de escritorio.

ControlMode

Leer paralelo

Alterna si el cliente puede usar o no el modo de Mouse Lock Switch.

Fullscreen

Leer paralelo
Seguridad de scripts Roblox

GamepadCameraSensitivity

Leer paralelo

Describe lo sensibles que son la cámara y el controlador de juegos cuando se usa.

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

Un flotante entre 0 y 1 representando el volumen del cliente del juego.

MasterVolumeStudio

Leer paralelo
Seguridad de scripts Roblox

MaxQualityEnabled

Leer paralelo
Seguridad de scripts Roblox

MouseSensitivity

Leer paralelo

Un flotante entre 0 y 4 que representa la sensibilidad de la sensibilidad de la cámara del cliente.

OnboardingsCompleted

Leer paralelo
Seguridad de scripts Roblox

PartyVoiceVolume

Leer paralelo
Seguridad de scripts Roblox

RCCProfilerRecordFrameRate

Leer paralelo

RCCProfilerRecordTimeFrame

Leer paralelo

RotationType

Leer paralelo

Controla cómo se gira el personaje del cliente.

SavedQualityLevel

Leer paralelo

El nivel de calidad gráfica establecido por el cliente.

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

El tipo de cámara que el cliente está usando mientras está en un dispositivo móvil.

TouchMovementMode

Leer paralelo

El tipo de controles que el cliente está usando en un dispositivo móvil.

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

Restablece el valor de inversión Y de la cámara.


Devuelve

GetOnboardingCompleted

Comprueba si se ha completado o no el onboarding dado, lo cual es útil para evitar mostrar la animación de onboarding de nuevo.

Si onboardingId no es uno de los ID de aceptados, se lanza un error.

El proceso de onboarding es un solo camino. Esto significa que, como desarrollador, puedes obligar el proceso de onboarding a completarse, pero no puedes reiniciarlo.

Véase también:

Parámetros

onboardingId: string

El ID de onboarding para preguntar.


Devuelve

Si el onboarding en particular se ha completado o no.

InFullScreen

Regresa cierto si la ventana de Roblox del usuario está en modo pantalla completa.


Devuelve

InStudioMode

Regresa cierto si la sesión del juego del cliente está en Roblox Studio.


Devuelve

SetCameraYInvertVisible

void

Si se llama, Roblox alterna la opción de menú para invertir el eje de la cámara del usuario.


Devuelve

void

SetGamepadCameraSensitivityVisible

void

Si se llama, Roblox alterna la opción de menú para controlar la sensibilidad de la cámara con gamepads.


Devuelve

void

SetOnboardingCompleted

void

Establece el onboarding dado como completado, por lo que no se mostrará al usuario la próxima vez que jugar.

Actualmente, esta función solo acepta DynamicThumbstick , y se usa para rastrear persistentemente si el jugador ha terminado o no el tutorial para el controlador Dynamic Thumbstick. Si onboardingId no es uno de los ID admitidos, se muestra un error.

El proceso de onboarding es un solo camino. Esto significa que, como desarrollador, puedes obligar el proceso de onboarding a completarse, pero no puedes reiniciarlo.

Véase también:

Parámetros

onboardingId: string

La ID de onboarding para establecer como completada.


Devuelve

void

Eventos

FullscreenChanged

Dispara si el modo de pantalla completa del usuario se cambia. El evento solo se disparará en los dispositivos de escritorio que pueden alternar el modo de pantalla completa. El juego siempre estará en modo de pantalla completa en dispositivos móviles y consolas.

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

Se activa cuando el cliente del usuario cambia entre el modo de estudio y el modo de juego. Esto se activa periódicamente en Roblox Studio cuando comienza una sesión.

Parámetros

isStudioMode: bool