UserGameSettings
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
The UserGameSettings è una classe singola trovata all'interno del singolo UserSettings singolo.Contiene varie impostazioni persistenti relative a come l'utente vuole controllare la sua Telecamerae il suo personaggio.
Puoi accedere a questo oggetto da un LocalScript via:
Questo oggetto è destinato ad essere utilizzato solo sul 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à
La modalità di movimento della fotocamera attualmente in uso dal client sul Desktop.
Il tipo di controlli utilizzati dal client sul Desktop.
Attiva/disattiva se il client può o meno utilizzare la modalità Mouse Lock Switch.
Descrive quanto la fotocamera sia sensibile quando si utilizza un gamepad.
Un galleggiante tra 0 e 1 che rappresenta il volume del client del Gioco.
Un float tra 0 e 4 che rappresenta la sensibilità della sensibilità della fotocamera del client.
Controlla come viene ruotato il personaggio del client.
Il livello di qualità grafica impostato dal client.
Il tipo di fotocamera in uso dal client mentre su un Dispositivomobile.
Il tipo di controlli utilizzati dal client su un Dispositivomobile.
Metodi
Restituisce il valore Y-invert della Telecamera.
Verifica 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 fotocamera dell'utente.
Se chiamato, Roblox attiva l'opzione menu per controllare la sensibilità della fotocamera con i gamepad.
Imposta l'onboarding come completato.
Eventi
Si accende se la modalità a schermo completo dell'utente viene cambiata.
Spedito quando il client dell'utente passa tra la modalità Studio e la modalità in gioco. Questo viene spedito periodicamente in Roblox Studio quando inizia una sessione.
Proprietà
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
La modalità di movimento della fotocamera attualmente in uso dal client sul Desktop.
ComputerMovementMode
Il tipo di controlli utilizzati dal client sul Desktop.
ControlMode
Attiva/disattiva se il client può o meno utilizzare la modalità Mouse Lock Switch.
Fullscreen
GamepadCameraSensitivity
Descrive quanto la fotocamera sia sensibile quando si utilizza un gamepad.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Un float tra 0 e 4 che rappresenta 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 su un Dispositivomobile.
TouchMovementMode
Il tipo di controlli utilizzati dal client su un Dispositivomobile.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Metodi
GetOnboardingCompleted
Verifica se l'onboarding fornito è stato completato o meno, il che è utile per evitare di mostrare nuovamente l'animazione di onboarding.
Se onboardingId non è uno degli ID accettati, viene generato un errore.
Il processo di onboarding è unidirezionale. Ciò significa che, come sviluppatore, puoi forzare il processo di onboarding a completamento ma non puoi ripristinarlo.
Vedi anche:
- UserGameSettings:SetOnboardingCompleted() , imposta l'onboarding come completato
Parametri
L'ID di onboarding da interrogare.
Restituzioni
Se o meno l'onboarding in particolare è stato ancora completato.
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 fotocamera dell'utente.
Restituzioni
SetGamepadCameraSensitivityVisible
Se chiamato, Roblox attiva l'opzione menu per controllare la sensibilità della fotocamera con i gamepad.
Restituzioni
SetOnboardingCompleted
Imposta l'onboarding fornito come completato, quindi non verrà mostrato nuovamente all'utente la prossima volta che Giocare.
Attualmente, questa funzione accetta solo DynamicThumbstick, e viene utilizzata per tracciare persistentemente se il giocatore abbia o meno finito il tutorial per lo schema di controllo Dynamic Thumbstick.Se onboardingId non è uno degli ID accettati, viene generato un errore.
Il processo di onboarding è unidirezionale. Ciò significa che, come sviluppatore, puoi forzare il processo di onboarding a completamento ma non puoi ripristinarlo.
Vedi anche:
- UserGameSettings:GetOnboardingCompleted() , controlla se l'onboarding è stato completato
Parametri
L'ID di onboarding da impostare come completato.
Restituzioni
Eventi
FullscreenChanged
Si accende se la modalità a schermo completo dell'utente viene cambiata.L'evento verrà attivato solo su dispositivi desktop che possono attivare la modalità a schermo pieno.Il gioco sarà sempre in pieno schermo su dispositivi mobili 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
Spedito quando il client dell'utente passa tra la modalità Studio e la modalità in gioco. Questo viene spedito periodicamente in Roblox Studio quando inizia una sessione.