UserGameSettings
*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.
El UserGameSettings es una clase singleton encontrada dentro del singleton UserSettings.Contiene varias configuraciones persistentes relacionadas con cómo el usuario quiere controlar su cámara y su personaje.
Puedes acceder a este objeto desde un LocalScript a través de:
Este objeto está destinado a ser utilizado solo en el cliente, ya que no tiene ningún propósito en el servidor.También reflejará tus propias configuraciones al probar en Roblox Studio.
Muestras de código
A basic example that shows how you can listen to changes in the user's settings. With this code pasted into a LocalScript running in the StarterPlayerScripts, you can change settings in Roblox's game menu, and see their values appear in the output as detected changes.
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
El modo de movimiento de la cámara actualmente en uso por el cliente en equipo de escritorio.
El tipo de controles que utiliza el cliente en el equipo de escritorio.
Alterna si el cliente puede o no usar el modo de bloqueo del ratón.
Describe lo sensible que es la cámara al usar un controlador para juego.
Un flotante entre 0 y 1 que representa el volumen del cliente del juego.
Un flotante entre 0 y 4 que representa la sensibilidad de la sensibilidad de la cámara del cliente.
Controla cómo se gira el personaje del cliente.
El nivel de calidad gráfica establecido por el cliente.
El tipo de cámara en uso por el cliente mientras está en un dispositivo móvil.
El tipo de controles que utiliza el cliente en un dispositivo móvil.
Métodos
Devuelve el valor Y-invertido de la cámara.
Comprueba si el onboarding se ha completado.
Regresa verdadero si la ventana de Roblox del usuario está en modo de pantalla completa.
Regresa verdadero si la sesión de juego del cliente está en Roblox Studio.
Si se llama, Roblox alterna la opción de menú para invertir el eje de la cámara del usuario.
Si se llama, Roblox alterna la opción de menú para controlar la sensibilidad de la cámara con los gamepads.
Establece el onboarding como completado.
Eventos
Se activa si se cambia el modo de pantalla completa del usuario.
Se despedaza cuando el cliente del usuario cambia entre el modo de Studio y el modo en el juego. Esto se dispara periódicamente en Roblox Studio cuando comienza una sesión.
Propiedades
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
El modo de movimiento de la cámara actualmente en uso por el cliente en equipo de escritorio.
ComputerMovementMode
El tipo de controles que utiliza el cliente en el equipo de escritorio.
Fullscreen
GamepadCameraSensitivity
Describe lo sensible que es la cámara al usar un controlador para juego.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Un flotante entre 0 y 4 que representa la sensibilidad de la sensibilidad de la cámara del cliente.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
El tipo de cámara en uso por el cliente mientras está en un dispositivo móvil.
TouchMovementMode
El tipo de controles que utiliza el cliente en un dispositivo móvil.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Métodos
GetOnboardingCompleted
Comprueba si el onboarding dado ya se ha completado o no, lo que es útil para evitar mostrar la animación de onboarding de nuevo.
Si onboardingId no es uno de los ID aceptados, se genera un error.
El proceso de integración es de un solo sentido. Esto significa que, como desarrollador, puedes forzar el proceso de integración a completarse, pero no puedes restablecerlo.
Vea también:
- UserGameSettings:SetOnboardingCompleted() , establece la capacitación como completada
Parámetros
El ID de onboarding para preguntar.
Devuelve
Si o no el embarque en particular se ha completado aún.
InFullScreen
Regresa verdadero si la ventana de Roblox del usuario está en modo de pantalla completa.
Devuelve
InStudioMode
Regresa verdadero si la sesión de juego del cliente está en Roblox Studio.
Devuelve
SetCameraYInvertVisible
Si se llama, Roblox alterna la opción de menú para invertir el eje de la cámara del usuario.
Devuelve
SetGamepadCameraSensitivityVisible
Si se llama, Roblox alterna la opción de menú para controlar la sensibilidad de la cámara con los gamepads.
Devuelve
SetOnboardingCompleted
Establece el onboarding dado como completado, por lo que no se mostrará de nuevo 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 esquema de control de Dynamic Thumbstick.Si onboardingId no es uno de los ID aceptados, se genera un error.
El proceso de integración es de un solo sentido. Esto significa que, como desarrollador, puedes forzar el proceso de integración a completarse, pero no puedes restablecerlo.
Vea también:
- UserGameSettings:GetOnboardingCompleted() , comprueba si el onboarding se ha completado
Parámetros
El ID de onboarding para establecer como completado.
Devuelve
Eventos
FullscreenChanged
Se activa si se cambia el modo de pantalla completa del usuario.El evento solo se disparará en dispositivos de escritorio que puedan alternar el modo de pantalla completa.El juego siempre estará en pantalla completa en dispositivos móviles y consolas.
Parámetros
Muestras de código
A LocalScript that demonstrates how you can detect whether a game is in full screen or not.
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 despedaza cuando el cliente del usuario cambia entre el modo de Studio y el modo en el juego. Esto se dispara periódicamente en Roblox Studio cuando comienza una sesión.