UserGameSettings
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
O UserGameSettings é uma classe singleton encontrada dentro do singleton UserSettings singleton.Ela contém várias configurações persistentes relacionadas a como o usuário deseja controlar sua Câmerae seu personagem.
Você pode acessar este objeto a partir de um LocalScript via:
Este objeto tem a intenção de ser usado apenas no cliente, pois não serve a nenhum propósito no servidor.Também refletirá suas próprias configurações ao testar no Roblox Studio.
Amostras 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)Resumo
Propriedades
O modo de movimento da câmera atualmente em uso pelo cliente no Área de trabalho.
O tipo de controles usados pelo cliente no Área de trabalho.
Alterna se o cliente pode ou não usar o modo Mouse Lock Switch.
Descreve quão sensível a câmera é ao usar um controle / controle de jogo.
Um flutuante entre 0 e 1 que representa o volume do cliente do jogo.
Um flutuante entre 0 e 4 que representa a sensibilidade da sensibilidade da câmera do cliente.
Controla como o personagem do cliente é girado.
O nível de qualidade gráfica definido pelo cliente.
O tipo de câmera em uso pelo cliente enquanto em um dispositivo móvel.
O tipo de controles usados pelo cliente em um dispositivo móvel.
Métodos
Retorna o valor Y-invert da Câmera.
Verifica se o onboarding foi concluído.
Retorna verdadeiro se a janela do usuário do Roblox estiver no modo de tela cheia.
Retorna verdadeiro se a sessão de jogo do cliente estiver no Roblox Studio.
Se chamado, o Roblox alterna a opção de menu para inverter o eixo de câmera do usuário.
Se chamado, o Roblox alterna a opção de menu para controlar a sensibilidade da câmera com gamepads.
Define a integração como concluída.
Eventos
Dispara se o modo de tela cheia do usuário for alterado.
Dispedido quando o cliente do usuário muda entre o modo do Studio e o modo do jogo. Isso é disparado periodicamente no Roblox Studio quando uma sessão começa.
Propriedades
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
O modo de movimento da câmera atualmente em uso pelo cliente no Área de trabalho.
ComputerMovementMode
O tipo de controles usados pelo cliente no Área de trabalho.
Fullscreen
GamepadCameraSensitivity
Descreve quão sensível a câmera é ao usar um controle / controle de jogo.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Um flutuante entre 0 e 4 que representa a sensibilidade da sensibilidade da câmera do cliente.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
O tipo de câmera em uso pelo cliente enquanto em um dispositivo móvel.
TouchMovementMode
O tipo de controles usados pelo cliente em um dispositivo móvel.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Métodos
GetOnboardingCompleted
Verifica se o onboarding dado já foi concluído ou não, o que é útil para evitar mostrar a animação de onboarding novamente.
Se o onboardingId não for um dos IDs aceitos, um erro é lançado.
O processo de integração é de uma maneira. Isso significa que, como desenvolvedor, você pode forçar o processo de integração a ser concluído, mas não pode redefini-lo.
Veja também:
- UserGameSettings:SetOnboardingCompleted() , define a integração como concluída
Parâmetros
O ID de integração para perguntar.
Devolução
Se ou não o onboarding em particular foi concluído ainda.
InFullScreen
Retorna verdadeiro se a janela do usuário do Roblox estiver no modo de tela cheia.
Devolução
InStudioMode
Retorna verdadeiro se a sessão de jogo do cliente estiver no Roblox Studio.
Devolução
SetCameraYInvertVisible
Se chamado, o Roblox alterna a opção de menu para inverter o eixo de câmera do usuário.
Devolução
SetGamepadCameraSensitivityVisible
Se chamado, o Roblox alterna a opção de menu para controlar a sensibilidade da câmera com gamepads.
Devolução
SetOnboardingCompleted
Define o onboarding dado como concluído, para que não seja mostrado novamente ao usuário na próxima vez que jogar.
Atualmente, essa função só aceita DynamicThumbstick, e é usada para persistir em rastrear se o jogador terminou ou não o tutorial do esquema de controle Dynamic Thumbstick.Se o onboardingId não for um dos IDs aceitos, um erro é lançado.
O processo de integração é de uma maneira. Isso significa que, como desenvolvedor, você pode forçar o processo de integração a ser concluído, mas não pode redefini-lo.
Veja também:
- UserGameSettings:GetOnboardingCompleted() , verifica se o onboarding foi concluído
Parâmetros
O ID de integração para definir como concluído.
Devolução
Eventos
FullscreenChanged
Dispara se o modo de tela cheia do usuário for alterado.O evento só disparará em dispositivos de desktop que possam alternar o modo de tela cheia.O jogo sempre estará em tela cheia em dispositivos móveis e consoles.
Parâmetros
Amostras 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
Dispedido quando o cliente do usuário muda entre o modo do Studio e o modo do jogo. Isso é disparado periodicamente no Roblox Studio quando uma sessão começa.