UserGameSettings

顯示已棄用項目

*此內容是使用 AI(Beta 測試版)翻譯,可能含有錯誤。若要以英文檢視此頁面,請按一下這裡

無法建立
使用者設定

UserGameSettings 是一個單一的類別,在 UserSettings 的單一中。它包含關於用戶想要如何控制相攝影機和角色的各種持續設定。

您可以使用 LocalScript 來存取此對象:


UserSettings():GetService("UserGameSettings")

此對象只適用於客戶端,因為它不能在伺服器上使用。它也會在 Roblox Studio 測試時反射您自己的設置。

範例程式碼

UserGameSettings Listener

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)

概要

屬性

方法

活動

屬性

AllTutorialsDisabled

平行讀取
Roblox 指令碼安全性
平行讀取
Roblox 指令碼安全性

ChatVisible

平行讀取
Roblox 指令碼安全性

ComputerCameraMovementMode

平行讀取

客戶桌面目前使用的鏡頭移動模式。

ComputerMovementMode

平行讀取

客桌面端使用的控制類型。

ControlMode

平行讀取

切換是否啟用或否啟用客戶端使用滑鼠鎖定開關模式。

Fullscreen

平行讀取
Roblox 指令碼安全性

GamepadCameraSensitivity

平行讀取

說明使用遊戲控制器時鏡頭的敏感度。

GraphicsOptimizationMode

平行讀取
Roblox 指令碼安全性

GraphicsQualityLevel

平行讀取
Roblox 指令碼安全性

HasEverUsedVR

平行讀取
Roblox 指令碼安全性

MasterVolume

平行讀取
Roblox 指令碼安全性

在 0 和 1 之間代表遊戲客戶端音量的 漂浮

MasterVolumeStudio

平行讀取
Roblox 指令碼安全性

MaxQualityEnabled

平行讀取
Roblox 指令碼安全性

MouseSensitivity

平行讀取

一個值在 0 和 4 之間代表客戶端鏡頭敏感度的浮點。

OnboardingsCompleted

平行讀取
Roblox 指令碼安全性

PartyVoiceVolume

平行讀取
Roblox 指令碼安全性

RCCProfilerRecordFrameRate

平行讀取

RCCProfilerRecordTimeFrame

平行讀取

RotationType

平行讀取

控制客戶端的角色旋轉方式。

SavedQualityLevel

平行讀取

客戶設定的圖形品質等級。

StartMaximized

未複製
無法建立指令碼
平行讀取
Roblox 指令碼安全性

StartScreenPosition

未複製
無法建立指令碼
平行讀取
Roblox 指令碼安全性

StartScreenSize

未複製
無法建立指令碼
平行讀取
Roblox 指令碼安全性

TouchCameraMovementMode

平行讀取

客戶端在移動設裝置上使用的鏡頭類型。

TouchMovementMode

平行讀取

客戶端使用的控制類型。

UsedCoreGuiIsVisibleToggle

平行讀取
Roblox 指令碼安全性

UsedCustomGuiIsVisibleToggle

平行讀取
Roblox 指令碼安全性

UsedHideHudShortcut

平行讀取
Roblox 指令碼安全性

VREnabled

平行讀取
Roblox 指令碼安全性

VRRotationIntensity

平行讀取
Roblox 指令碼安全性

VRSmoothRotationEnabled

平行讀取
Roblox 指令碼安全性

VignetteEnabled

平行讀取
Roblox 指令碼安全性

方法

GetCameraYInvertValue

返回攝影機的 Y 反轉值。


返回

GetOnboardingCompleted

檢查是否已完成提供的 onboarding,這有助於避免顯示 onboarding 動畫再次。

如果 onboardingId 不是接受的 ID 之一,將發生錯誤。

onboarding 過程是單向的。這意味著,作為開發人員,您可以強制 onboarding 過程完成,但不能重設。

也看:

參數

onboardingId: string

可以查詢的 onboarding ID。


返回

即使是否已完成特定的 onboarding 尚未完成。

InFullScreen

如果使用者的 Roblox 視窗處於全螢幕模式,則返回為真。


返回

InStudioMode

如果客戶端的遊戲會話是在 Roblox Studio 中,則返回 true。


返回

SetCameraYInvertVisible

void

如果呼叫,Roblox 會切換使用者的視角,以反向滾動視角軸。


返回

void

SetGamepadCameraSensitivityVisible

void

如果呼叫,Roblox 會切換選單選項來控制遊戲手柄的鏡頭敏感度。


返回

void

SetOnboardingCompleted

void

將讓用戶在線上時間設置為已完成,因此下次玩 遊玩耍時牆紙不會再顯示。

目前,此功能只接受 動態棒子 ,並且用於持續跟蹤玩家是否完成動態棒子控制程式的教學。如果 onboardingId 不是接受的 ID 之一,發生錯誤。

onboarding 過程是單向的。這意味著,作為開發人員,您可以強制 onboarding 過程完成,但不能重設。

也看:

參數

onboardingId: string

設為已完成的 onboarding ID。


返回

void

活動

FullscreenChanged

如果使用者的完整螢幕模式已變更,則會發生此事件。這個事件只會在桌上型裝置上發生,這些裝置可以切換全螢幕模式。遊戲將在移動裝置和控制台上全螢幕。

參數

isFullscreen: bool

範例程式碼

Full Screen Mode Detection

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 中會在會話開始時每隔一段時間發射。

參數

isStudioMode: bool