UserGameSettings

非推奨を表示
作成できません
ユーザー設定

The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.

You can access this object from a LocalScript via:


UserSettings():GetService("UserGameSettings")

This object is intended to be used on the client only, as it serves no purpose on the server. It will also reflect your own settings when testing in 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

並列読み取り

The camera movement mode currently in-use by the client on desktop.

ComputerMovementMode

並列読み取り

The type of controls being used by the client on desktop.

ControlMode

並列読み取り

Toggles whether or not the client can use the Mouse Lock Switch mode.

Fullscreen

並列読み取り
Robloxのスクリプトセキュリティ

GamepadCameraSensitivity

並列読み取り

Describes how sensitive the camera is when using a gamepad.

GraphicsOptimizationMode

並列読み取り
Robloxのスクリプトセキュリティ

GraphicsQualityLevel

並列読み取り
Robloxのスクリプトセキュリティ

HasEverUsedVR

並列読み取り
Robloxのスクリプトセキュリティ

MasterVolume

並列読み取り
Robloxのスクリプトセキュリティ

A float between 0 and 1 representing the volume of the game's client.

MasterVolumeStudio

並列読み取り
Robloxのスクリプトセキュリティ

MaxQualityEnabled

並列読み取り
Robloxのスクリプトセキュリティ

MouseSensitivity

並列読み取り

A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.

OnboardingsCompleted

並列読み取り
Robloxのスクリプトセキュリティ

PartyVoiceVolume

並列読み取り
Robloxのスクリプトセキュリティ

RCCProfilerRecordFrameRate

並列読み取り

RCCProfilerRecordTimeFrame

並列読み取り

RotationType

並列読み取り

Controls how the client's character is rotated.

SavedQualityLevel

並列読み取り

The graphics quality level set by the client.

StartMaximized

複製されていません
スクリプト作成できません
並列読み取り
Robloxのスクリプトセキュリティ

StartScreenPosition

複製されていません
スクリプト作成できません
並列読み取り
Robloxのスクリプトセキュリティ

StartScreenSize

複製されていません
スクリプト作成できません
並列読み取り
Robloxのスクリプトセキュリティ

TouchCameraMovementMode

並列読み取り

The camera type in-use by the client while on a mobile device.

TouchMovementMode

並列読み取り

The type of controls being used by the client on a mobile device.

UsedCoreGuiIsVisibleToggle

並列読み取り
Robloxのスクリプトセキュリティ

UsedCustomGuiIsVisibleToggle

並列読み取り
Robloxのスクリプトセキュリティ

UsedHideHudShortcut

並列読み取り
Robloxのスクリプトセキュリティ

VREnabled

並列読み取り
Robloxのスクリプトセキュリティ

VRRotationIntensity

並列読み取り
Robloxのスクリプトセキュリティ

VRSmoothRotationEnabled

並列読み取り
Robloxのスクリプトセキュリティ

VignetteEnabled

並列読み取り
Robloxのスクリプトセキュリティ

方法

GetCameraYInvertValue

Returns the camera's Y-invert value.


戻り値

GetOnboardingCompleted

Checks whether or not the given onboarding has been completed yet, which is useful for avoiding showing the onboarding animation again.

If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

See also:

パラメータ

onboardingId: string

The onboarding ID to inquire about.


戻り値

Whether or not the onboarding in particular has been completed yet.

InFullScreen

Returns true if the user's Roblox window is in full screen mode.


戻り値

InStudioMode

Returns true if the client's game session is in Roblox Studio.


戻り値

SetCameraYInvertVisible

void

If called, Roblox toggles the menu option to invert the user's camera y axis.


戻り値

void

SetGamepadCameraSensitivityVisible

void

If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.


戻り値

void

SetOnboardingCompleted

void

Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.

Currently, this function only accepts DynamicThumbstick, and it is used to persistently track whether or not the player has finished the tutorial for the Dynamic Thumbstick control scheme. If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

See also:

パラメータ

onboardingId: string

The onboarding ID to set as completed.


戻り値

void

イベント

FullscreenChanged

Fires if the user's full screen mode is changed. The event will only fire on desktop devices that can toggle full screen mode. The game will always be in full screen on mobile devices and consoles.

パラメータ

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

Fired when the user's client switches between studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.

パラメータ

isStudioMode: bool