UserGameSettings
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
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:
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.
Amostras de código
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)Resumo
Propriedades
El modo de movimiento de la cámara que el cliente en el equipo de escritorioestá usando actualmente.
El tipo de controles que el cliente está usando en el equipo de escritorio.
Alterna si el cliente puede usar o no el modo de Mouse Lock Switch.
Describe lo sensibles que son la cámara y el controlador de juegos cuando se usa.
Un flotador 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 que el cliente está usando mientras está en un dispositivo móvil.
El tipo de controles que el cliente está usando en un dispositivo móvil.
Métodos
Restablece el valor de inversión Y de la cámara.
Revisa si se ha completado el onboarding.
Regresa cierto si la ventana de Roblox del usuario está en modo pantalla completa.
Regresa cierto si la sesión del 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 gamepads.
Establece el onboarding como completado.
Eventos
Dispara si el modo de pantalla completa del usuario se cambia.
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.
Propriedades
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
El modo de movimiento de la cámara que el cliente en el equipo de escritorioestá usando actualmente.
ComputerMovementMode
El tipo de controles que el cliente está usando en el equipo de escritorio.
Fullscreen
GamepadCameraSensitivity
Describe lo sensibles que son la cámara y el controlador de juegos cuando se usa.
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 que el cliente está usando mientras está en un dispositivo móvil.
TouchMovementMode
El tipo de controles que el cliente está usando en un dispositivo móvil.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Métodos
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:
- UserGameSettings:SetOnboardingCompleted() , establece el onboarding como completado
Parâmetros
El ID de onboarding para preguntar.
Devolução
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.
Devolução
InStudioMode
Regresa cierto si la sesión del juego del cliente está en Roblox Studio.
Devolução
SetCameraYInvertVisible
Si se llama, Roblox alterna la opción de menú para invertir el eje de la cámara del usuario.
Devolução
SetGamepadCameraSensitivityVisible
Si se llama, Roblox alterna la opción de menú para controlar la sensibilidad de la cámara con gamepads.
Devolução
SetOnboardingCompleted
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:
- UserGameSettings:GetOnboardingCompleted() , comprueba si el onboarding se ha completado
Parâmetros
La ID de onboarding para establecer como completada.
Devolução
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
Amostras de código
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.