UserGameSettings 是一個單一的類別，在 UserSettings 的單一中。它包含關於用戶想要如何控制相攝影機和角色的各種持續設定。
您可以使用 LocalScript 來存取此對象：
此對象只適用於客戶端，因為它不能在伺服器上使用。它也會在 Roblox Studio 測試時反射您自己的設置。
範例程式碼
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)概要
屬性
客戶桌面目前使用的鏡頭移動模式。
客桌面端使用的控制類型。
切換是否啟用或否啟用客戶端使用滑鼠鎖定開關模式。
說明使用遊戲控制器時鏡頭的敏感度。
一個值 0 到 1 之間代表遊戲客戶端音量的漂浮值。
一個值在 0 和 4 之間代表客戶端鏡頭敏感度的浮點。
控制客戶端的角色旋轉方式。
客戶設定的圖形品質等級。
客戶端在移動設裝置上使用的鏡頭類型。
客戶端使用的控制類型。
方法
返回攝影機的 Y 反轉值。
檢查是否已完成 onboarding。
如果使用者的 Roblox 視窗處於全螢幕模式，則返回為真。
如果客戶端的遊戲會話是在 Roblox Studio 中，則返回 true。
如果呼叫，Roblox 會切換使用者的視角，以反向滾動視角軸。
如果呼叫，Roblox 會切換選單選項來控制遊戲手柄的鏡頭敏感度。
設定 onboarding 為已完成。
活動
切換使用者的全螢幕模式時，發射。
使用者的客戶端在 Studio 模式和遊戲模式之間切換時發射。這在 Roblox Studio 中會在會話開始時每隔一段時間發射。
屬性
AllTutorialsDisabled
CameraMode
ChatVisible
Fullscreen
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
方法
GetOnboardingCompleted
檢查是否已完成提供的 onboarding，這有助於避免顯示 onboarding 動畫再次。
如果 onboardingId 不是接受的 ID 之一，將發生錯誤。
onboarding 過程是單向的。這意味著，作為開發人員，您可以強制 onboarding 過程完成，但不能重設。
也看：
- UserGameSettings:SetOnboardingCompleted() , 將 onboarding 設為已完成
參數
可以查詢的 onboarding ID。
返回
即使是否已完成特定的 onboarding 尚未完成。
SetCameraYInvertVisible
如果呼叫，Roblox 會切換使用者的視角，以反向滾動視角軸。
返回
SetGamepadCameraSensitivityVisible
如果呼叫，Roblox 會切換選單選項來控制遊戲手柄的鏡頭敏感度。
返回
SetOnboardingCompleted
將讓用戶在線上時間設置為已完成，因此下次玩 遊玩耍時牆紙不會再顯示。
目前，此功能只接受 動態棒子 ，並且用於持續跟蹤玩家是否完成動態棒子控制程式的教學。如果 onboardingId 不是接受的 ID 之一，發生錯誤。
onboarding 過程是單向的。這意味著，作為開發人員，您可以強制 onboarding 過程完成，但不能重設。
也看：
- UserGameSettings:GetOnboardingCompleted() 檢查是否完成了 onboarding
參數
設為已完成的 onboarding ID。
返回
活動
FullscreenChanged
如果使用者的完整螢幕模式已變更，則會發生此事件。這個事件只會在桌上型裝置上發生，這些裝置可以切換全螢幕模式。遊戲將在移動裝置和控制台上全螢幕。
參數
範例程式碼
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
使用者的客戶端在 Studio 模式和遊戲模式之間切換時發射。這在 Roblox Studio 中會在會話開始時每隔一段時間發射。