UserGameSettings
*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
ユーザーゲーム設定は、UserSettings のシングルトン内にある単一クラスです。カメラのコントロール、およびキャラクターのコントロールに関連するさまざまな持続設定を保持します。
このオブジェクトにアクセスするには、LocalScript を介して：
このオブジェクトは、サーバーで目的を果たさないため、クライアントでのみ使用することを目的としています。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 インバート値を返します。
オンボーディングが完了したかどうかをチェックします。
ユーザーの Roblox ウィンドウがフルスクリーンモードである場合、返回は真です。
クライアントのゲームセッションが Roblox Studio にある場合、 true を返します。
呼び出されると、Roblox はユーザーのカメラの Y 軸を反向にするメニューオプションを切り替えます。
呼び出されると、Roblox はゲームパッドのカメラ感度をコントロールするメニューオプションを切り替えます。
ボードに登録を完了するように設定します。
イベント
ユーザーのフル画面モードが変更された場合にファイアを起動します。
ユーザーのクライアントがスタジオモードとゲームモードを切り替えるときに発動します。これは、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
与えられたオンボーディングがまだ完了していないかどうかをチェックします。これは、オンボーディングアニメーションを再び表示することを避けるのに便利です。
onboardingId が受け入れられる ID の 1 つでない場合、エラーが発生します。
オンボーディングプロセスは 1 方通行です。これは、開発者として、オンボーディングプロセスを完了することができますが、リセットすることはできません。
参照してください:
- UserGameSettings:SetOnboardingCompleted() 、ボードに乗るを完了した
パラメータ
オンボーディングID を入力してください。
戻り値
特定のオンボードが完了しているかどうかにかかわらず。
SetCameraYInvertVisible
呼び出されると、Roblox はユーザーのカメラの Y 軸を反向にするメニューオプションを切り替えます。
戻り値
SetGamepadCameraSensitivityVisible
呼び出されると、Roblox はゲームパッドのカメラ感度をコントロールするメニューオプションを切り替えます。
戻り値
SetOnboardingCompleted
オンボードを完了したとして設定すると、次回ユーザーがプレイするときに再び表示されなくなります。
現在、この関数は ダイナミックサムネイル のみを受け入れ、ダイナミックサムネイルコントロールスキームのチュートリアルを完了したかどうかを永久に追跡するために使用されます。如果 onboardingId が受け入れられる ID の 1つでない場合、エラーが発生します。
オンボーディングプロセスは 1 方通行です。これは、開発者として、オンボーディングプロセスを完了することができますが、リセットすることはできません。
参照してください:
- UserGameSettings:GetOnboardingCompleted() 、ボードに乗ることができるかどうかをチェックします
パラメータ
オンボーディング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)StudioModeChanged
ユーザーのクライアントがスタジオモードとゲームモードを切り替えるときに発動します。これは、Roblox Studio のセッション開始時に期間的に発生します。