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 Singleton-Klasse, die innerhalb des Singletons UserSettings gefunden wird.Es enthält verschiedene dauerhafte Einstellungen, die sich darauf beziehen, wie der Benutzer seine Kamera und seinen Charakter steuern möchte.
Du kannst auf dieses Objekt von einem LocalScript zugreifen über:
Dieses Objekt ist nur für den Client gedacht, da es auf dem Server keinen Zweck erfüllt.Es wird auch deine eigenen Einstellungen widerspiegeln, wenn du in Roblox Studio testest.
Code-Beispiele
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)Zusammenfassung
Eigenschaften
Der Kamerabewegungsmodus, der derzeit vom Client auf dem Desktop verwendet wird.
Die Art von Steuerelementen, die vom Client auf dem Desktop verwendet werden.
Schaltet um, ob der Client den Maus-Sperrmodus-Modus verwenden kann oder nicht.
Beschreibt, wie empfindlich die Kamera ist, wenn ein Gamepad verwendet wird.
Eine Flut zwischen 0 und 1, die die Lautstärke des Spielclients darstellt.
Eine Flut zwischen 0 und 4, die die Empfindlichkeit der Kamerasensitivität des Clients darstellt.
Steuert, wie sich der Charakter des Clients dreht.
Die von dem Client festgelegte Grafikqualitätsstufe.
Der Kameratyp, der vom Client verwendet wird, während er auf einem mobilen Gerät ist.
Die Art der Steuerelemente, die vom Client auf einem mobilen Gerät verwendet werden.
Methoden
Gibt den Y-Invertierungs-Wert der Kamera zurück.
Überprüft, ob die Einarbeitung abgeschlossen ist.
Gibt wahr zurück, wenn das Roblox-Fenster des Benutzers im Vollbildmodus ist.
Gibt wahr zurück, wenn die Spielsitzung des Clients in Roblox Studio ist.
Wenn aufgerufen, schaltet Roblox die Menüoption um, um die Kameraachse des Benutzers umzukehren.
Wenn aufgerufen, schaltet Roblox die Menüoption um, um die Kamerasensitivität mit Gamepads zu steuern.
Setzt Onboarding als abgeschlossen ein.
Ereignisse
Feuert, wenn der volle Bildschirmmodus des Benutzers geändert wird.
Feuert, wenn der Client des Benutzers zwischen Studio- und In-Game-Modus wechselt. Dies wird in Roblox Studio regelmäßig abgefeuert, wenn eine Sitzung beginnt.
Eigenschaften
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
Der Kamerabewegungsmodus, der derzeit vom Client auf dem Desktop verwendet wird.
ComputerMovementMode
Die Art von Steuerelementen, die vom Client auf dem Desktop verwendet werden.
ControlMode
Schaltet um, ob der Client den Maus-Sperrmodus-Modus verwenden kann oder nicht.
Fullscreen
GamepadCameraSensitivity
Beschreibt, wie empfindlich die Kamera ist, wenn ein Gamepad verwendet wird.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Eine Flut zwischen 0 und 4, die die Empfindlichkeit der Kamerasensitivität des Clients darstellt.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Der Kameratyp, der vom Client verwendet wird, während er auf einem mobilen Gerät ist.
TouchMovementMode
Die Art der Steuerelemente, die vom Client auf einem mobilen Gerät verwendet werden.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Methoden
GetOnboardingCompleted
Überprüft, ob oder nicht das angegebene Onboarding bereits abgeschlossen wurde, was nützlich ist, um die Onboarding-Animation erneut nicht anzuzeigen.
Wenn onboardingId nicht eine der akzeptierten IDs ist, wird ein Fehler geworfen.
Der Onboarding-Prozess ist einseitig. Das bedeutet, dass du als Entwickler den Onboarding-Prozess zur Fertigstellung zwingen kannst, aber nicht zurücksetzen kannst.
Siehe auch:
- UserGameSettings:SetOnboardingCompleted() , legt onboarding als abgeschlossen fest
Parameter
Die Onboarding-ID, um nachzufragen.
Rückgaben
Ob das Onboarding insgesamt abgeschlossen ist oder noch nicht.
InFullScreen
Gibt wahr zurück, wenn das Roblox-Fenster des Benutzers im Vollbildmodus ist.
Rückgaben
InStudioMode
Gibt wahr zurück, wenn die Spielsitzung des Clients in Roblox Studio ist.
Rückgaben
SetCameraYInvertVisible
Wenn aufgerufen, schaltet Roblox die Menüoption um, um die Kameraachse des Benutzers umzukehren.
Rückgaben
SetGamepadCameraSensitivityVisible
Wenn aufgerufen, schaltet Roblox die Menüoption um, um die Kamerasensitivität mit Gamepads zu steuern.
Rückgaben
SetOnboardingCompleted
Setzt das angegebene Onboarding als abgeschlossen, so dass es dem Benutzer beim nächsten Mal nicht erneut angezeigt wird, wenn er spielen.
Derzeit akzeptiert diese Funktion nur DynamicThumbstick, und sie wird verwendet, um dauerhaft zu verfolgen, ob der Spieler das Tutorial für das Dynamic-Thumbstick-Steuerschema abgeschlossen hat oder nicht.Wenn onboardingId nicht eine der akzeptierten IDs ist, wird ein Fehler geworfen.
Der Onboarding-Prozess ist einseitig. Das bedeutet, dass du als Entwickler den Onboarding-Prozess zur Fertigstellung zwingen kannst, aber nicht zurücksetzen kannst.
Siehe auch:
- UserGameSettings:GetOnboardingCompleted() , prüft, ob die einführung abgeschlossen ist
Parameter
Die Onboarding-ID, die als abgeschlossen festgelegt werden kann.
Rückgaben
Ereignisse
FullscreenChanged
Feuert, wenn der volle Bildschirmmodus des Benutzers geändert wird.Das Ereignis wird nur auf Desktop-Geräten feuern, die den Vollbildmodus umschalten können.Das Spiel wird immer im Vollbild auf mobilen Geräten und Konsolen angezeigt.
Parameter
Code-Beispiele
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
Feuert, wenn der Client des Benutzers zwischen Studio- und In-Game-Modus wechselt. Dies wird in Roblox Studio regelmäßig abgefeuert, wenn eine Sitzung beginnt.