UserGameSettings
*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.
Die UserGameSettings ist eine einzelne Klasse, die in den UserSettings singleton. Sie enthält verschiedene persistente Einstellungen, die sich auf die Art und Weise zurückzuführen sind, wie der Benutzer seine Kamera steuern und seinen Charakter.
Du kannst auf dieses Objekt von einem LocalScript über Zugriffen zugreifen:
Dieses Objekt ist nur für den Client gedacht, da es keinen Zweck auf dem Server erfüllt. Es wird auch deine eigenen Einstellungen widerspiegeln, wenn du in Roblox Studio testest.
Code-Beispiele
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)Zusammenfassung
Eigenschaften
Der Kameramodus, der derzeit auf dem Client auf dem Desktop verwendet wird.
Die Art von Steuerelementen, die vom Client auf dem Desktop verwendet werden.
Schaltet ab, ob der Client den Maus-Schalter-Modus verwenden kann oder nicht.
Beschreibt, wie empfindlich die Kamera ist, wenn sie mit einem Gamepad verwendet wird.
Ein schwimmender zwischen 0 und 1, der die Lautstärke des Spiel클라이언ts repräsentiert.
Ein schwimmender zwischen 0 und 4, der die Kameraempfindlichkeit des Clients repräsentiert.
Steuert, wie der Charakter des Clients gedreht wird.
Die Grafikqualitätsstufe, die von dem Client festgelegt wird.
Der Kameratyp, der vom Client verwendet wird, während er auf einem mobilen Gerät ist.
Die Art von Steuerelementen, die vom Client auf einem mobilen Gerät verwendet werden.
Methoden
Kehrt den Y-Invert-Wert der Kamera zurück.
Überprüft, ob das Einarbeitungsprogramm abgeschlossen ist.
Kehrt wahr zurück, wenn das Roblox-Fenster des Benutzers im vollständigen Bildschirmmodus ist.
Kehrt wahr zurück, wenn die Spielsitzung des Clients in Roblox Studio ist.
Wenn aufgerufen, wechselt Roblox die Menüoption, um die Kamera des Benutzers Y-Achse umzukehren.
Wenn aufgerufen, wechselt Roblox die Menüoption, um die Kamerasensibilität mit Gamepads zu steuern.
Setzt die Einstellung als abgeschlossen.
Ereignisse
Feuert, wenn der Benutzer den Vollbildmodus ändert.
Wird ausgelöst, wenn der Client des Benutzers zwischen Studio- und In-Game-Modus wechselt. Dies wird in Roblox Studio periodisch ausgeführt, wenn eine Sitzung beginnt.
Eigenschaften
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
Der Kameramodus, der derzeit auf dem Client auf dem Desktop verwendet wird.
ComputerMovementMode
Die Art von Steuerelementen, die vom Client auf dem Desktop verwendet werden.
ControlMode
Schaltet ab, ob der Client den Maus-Schalter-Modus verwenden kann oder nicht.
Fullscreen
GamepadCameraSensitivity
Beschreibt, wie empfindlich die Kamera ist, wenn sie mit einem Gamepad verwendet wird.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Ein schwimmender zwischen 0 und 4, der die Kameraempfindlichkeit des Clients repräsentiert.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
SavedQualityLevel
Die Grafikqualitätsstufe, die von dem Client festgelegt wird.
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Der Kameratyp, der vom Client verwendet wird, während er auf einem mobilen Gerät ist.
TouchMovementMode
Die Art von Steuerelementen, die vom Client auf einem mobilen Gerät verwendet werden.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Methoden
GetOnboardingCompleted
Überprüft, ob das gegebene Onboarding noch abgeschlossen ist, was nützlich ist, um die Onboarding-Animation nicht erneut anzuzeigen.
Wenn onboardingId nicht einer der akzeptierten IDs ist, wird ein Fehler geworfen.
Der Onboarding-Prozess ist ein-Weg. Dies bedeutet, dass, als Entwickler, Sie den Onboarding-Prozess zur Vollendung zwingen können, aber nicht zurücksetzen können.
Siehe auch:
- UserGameSettings:SetOnboardingCompleted() , setzt das Onboarding als abgeschlossen
Parameter
Die Onboarding-ID, um nachzufragen.
Rückgaben
Ob die Onboarding-Bestimmungen insbesondere noch abgeschlossen sind.
InFullScreen
Kehrt wahr zurück, wenn das Roblox-Fenster des Benutzers im vollständigen Bildschirmmodus ist.
Rückgaben
InStudioMode
Kehrt wahr zurück, wenn die Spielsitzung des Clients in Roblox Studio ist.
Rückgaben
SetCameraYInvertVisible
Wenn aufgerufen, wechselt Roblox die Menüoption, um die Kamera des Benutzers Y-Achse umzukehren.
Rückgaben
SetGamepadCameraSensitivityVisible
Wenn aufgerufen, wechselt Roblox die Menüoption, um die Kamerasensibilität mit Gamepads zu steuern.
Rückgaben
SetOnboardingCompleted
Setzt die aufgegebene Onboarding als abgeschlossen, so dass es dem Benutzer nicht erneut angezeigt wird, wenn sie das nächste Mal spielen.
Derzeit akzeptiert diese Funktion nur DynamicThumbstick , und es wird verwendet, um die persistente Verfolgung zu überprüfen, ob der Spieler das Tutorial für die Dynamic Thumbstick-Steuereinheit abgeschlossen hat. Wenn onboardingId nicht einer der akzeptierten IDs ist, wird ein Fehler angezeigt.
Der Onboarding-Prozess ist ein-Weg. Dies bedeutet, dass, als Entwickler, Sie den Onboarding-Prozess zur Vollendung zwingen können, aber nicht zurücksetzen können.
Siehe auch:
- UserGameSettings:GetOnboardingCompleted() , prüft, ob das Onboarding abgeschlossen ist
Parameter
Die Onboarding-ID als abgeschlossen einstellen.
Rückgaben
Ereignisse
FullscreenChanged
Feuert, wenn der vollständige Bildschirmmodus des Benutzers geändert wird. Das Ereignis wird nur auf Desktop-Geräten abgefeuert, die den vollständigen Bildschirmmodus einschalten können. Das Spiel wird immer auf mobilen Geräten und Konsolen in voller Bildschirmansicht sein.
Parameter
Code-Beispiele
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
Wird ausgelöst, wenn der Client des Benutzers zwischen Studio- und In-Game-Modus wechselt. Dies wird in Roblox Studio periodisch ausgeführt, wenn eine Sitzung beginnt.