UserGameSettings
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
The UserGameSettings è una classe singleton trovata all'interno del singleton Class.UserSettings . Contiene varie impostazioni persistenti che si riferiscono a come l'utente vuole controllare la loro Telecamerae il loro personaggio.
Puoi accedere a questo oggetto da un LocalScript via:
Questo oggetto è destinato solo all'uso del client, poiché non serve a nessun scopo sul Server. Rifletterà anche le tue impostazioni quando si testa in Roblox Studio.
Campioni di codice
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)Sommario
Proprietà
Il modo di movimento della fotocamera attualmente in uso dal client sul Desktop.
Il tipo di controlli utilizzati dal client sul Desktop.
Attiva o disattiva se il client può usare la modalità Mouse Lock Switch.
Descrive quanto sia sensibile la fotocamera quando si usa un gamepad.
Un fluttua tra 0 e 1 rappresentante il volume del client del Gioco.
Un fluttua tra 0 e 4 rappresentante la sensibilità della sensibilità della fotocamera del client.
Controlla il modo in cui il personaggio del client è ruotato.
Il livello di qualità grafica impostato dal client.
Il tipo di fotocamera in uso dal client mentre si trova su un Dispositivomobile.
Il tipo di controlli utilizzati dal client su un Dispositivomobile.
Metodi
Restituisce il valore Y invertito della Telecamera.
Controlla se l'onboarding è stato completato.
Restituisce vero se la finestra Roblox dell'utente è in modalità a schermo pieno.
Restituisce vero se la sessione di gioco del client è in Roblox Studio.
Se chiamato, Roblox attiva l'opzione menu per invertire l'asse della telecamera dell'utente.
Se chiamato, Roblox attiva l'opzione del menu per controllare la sensibilità della fotocamera con i gamepad.
Imposta l'onboarding come completato.
Eventi
Si attiva se viene cambiato il modo dello schermo dell'utente.
Si attiva quando il client dell'utente passa da modalità studio a modalità in gioco. Questo viene attivato periodically in Roblox Studio quando una sessione inizia.
Proprietà
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
Il modo di movimento della fotocamera attualmente in uso dal client sul Desktop.
ComputerMovementMode
Il tipo di controlli utilizzati dal client sul Desktop.
Fullscreen
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Un fluttua tra 0 e 4 rappresentante la sensibilità della sensibilità della fotocamera del client.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Il tipo di fotocamera in uso dal client mentre si trova su un Dispositivomobile.
TouchMovementMode
Il tipo di controlli utilizzati dal client su un Dispositivomobile.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Metodi
GetOnboardingCompleted
Controlla se l'onboarding fornito è stato completato o meno, che è utile per evitare di mostrare di nuovo l'animazione dell'onboarding.
Se onboardingId non è uno degli ID accettati, viene visualizzato un errore.
Il processo di onboarding è un processo unico. Ciò significa che, come sviluppatore, puoi forzare il processo di onboarding alla conclusione ma non puoi ripristinarlo.
Vedi anche:
- UserGameSettings:SetOnboardingCompleted() , imposta l'onboarding come completato
Parametri
L'ID onboarding per chiedere.
Restituzioni
Indipendentemente dal fatto che l'onboarding in particolare sia stato completato ancora.
InFullScreen
Restituisce vero se la finestra Roblox dell'utente è in modalità a schermo pieno.
Restituzioni
InStudioMode
Restituisce vero se la sessione di gioco del client è in Roblox Studio.
Restituzioni
SetCameraYInvertVisible
Se chiamato, Roblox attiva l'opzione menu per invertire l'asse della telecamera dell'utente.
Restituzioni
SetGamepadCameraSensitivityVisible
Se chiamato, Roblox attiva l'opzione del menu per controllare la sensibilità della fotocamera con i gamepad.
Restituzioni
SetOnboardingCompleted
Imposta l'onboarding dato come completato, quindi non sarà mostrato all'utente la prossima volta che Giocare.
Attualmente, questa funzione accetta solo DynamicThumbstick , e viene utilizzata per persistere nel tracciare se il giocatore ha finito o meno il tutorial per il controllo del Dynamic Thumbstick. Se onboardingId non è uno dei ID accettati, viene visualizzato un errore.
Il processo di onboarding è un processo unico. Ciò significa che, come sviluppatore, puoi forzare il processo di onboarding alla conclusione ma non puoi ripristinarlo.
Vedi anche:
- UserGameSettings:GetOnboardingCompleted() , controlla se l'onboarding è stato completato
Parametri
L'ID dell'onboarding impostato come completato.
Restituzioni
Eventi
FullscreenChanged
Si attiva se viene cambiato il modo dello schermo dell'utente. L'evento si attiva solo sui dispositivi desktop che possono attivare la modalità schermo intero. Il gioco sarà sempre in modalità schermo pieno su dispositivi mobile e console.
Parametri
Campioni di codice
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
Si attiva quando il client dell'utente passa da modalità studio a modalità in gioco. Questo viene attivato periodically in Roblox Studio quando una sessione inizia.