UserGameSettings 是一个发现在 UserSettings 内的单独类。它包含关于用户想要如何控制相镜头和角色的各种持久设置。
您可以通过访问此对象从 LocalScript 访问:
UserSettings():GetService("UserGameSettings")
这个对象是用于客户端的,因为它在服务器上的任何时候都不会提供任何用途。它还会在 Roblox Studio 中测试时反映您自己的设置。
代码示例
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。
返回 true 如果用户的 Roblox 窗口处于全屏模式。
如果客户端的游戏会话在 Roblox Studio 中,返回 true。
如果调用,Roblox 会切换菜单选项来反向用户的相机 y 轴。
如果调用,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() , 将会议室设置为已完成
参数
您可以在此处输入查询 ID。
返回
无论是否已完成特定的 onboarding 。
SetCameraYInvertVisible
如果调用,Roblox 会切换菜单选项来反向用户的相机 y 轴。
返回
SetGamepadCameraSensitivityVisible
如果调用,Roblox 会切换菜单选项来控制游戏手柄的相机敏感度。
返回
SetOnboardingCompleted
将在提交时设置提交的 onboarding 为已完成,因此下次玩家再次游玩放时不会显示给用户。
目前,此功能只接受 DynamicThumbstick ,并且用于持续跟踪是否有玩家完成 Dynamic Thumbstick 控制器的教程。如果 onboardingId 不是接受的 ID 之一,将发生错误。
onboarding 过程是单向的。这意味着,作为开发人员,您可以强制 onboarding 过程的完成,但不能重置它。
还请参阅:
- UserGameSettings:GetOnboardingCompleted() , 检查是否完成了 onboarding
参数
在线时间ID设置为已完成。
返回
活动
FullscreenChanged
如果用户的全屏模式已更改,就会发生。 事件只会在支持全屏模式的桌面设备上发生。 游戏总是在移动设备和控制台上全屏。
参数
代码示例
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)