【UE5】GameUserSettingsを使ったユーザー設定メモ

はじめに

• ゲームのオプション画面を作成する際に「GameUserSettings」を使用した時のメモ
• 作成したオプション画面は以下の様なシンプルな画面
  

GameUserSettingsとは

• 解像度やグラフィック品質などのゲームオプションメニューで変更する設定情報を管理・保存するためのUnreal Engineの標準的なクラス
• GameUserSettingsから各種情報の取得/設定/保存が行える

各種値の取得

• 「GetGameUserSettings」ノードから各種情報を取得可能
• 「解像度」「画面モード」「グラフィック品質」など
• 取得する内容によって型が異なるので注意
  

各種値の設定

• 「GetGameUserSettings」ノードから各種情報を設定可能
• 基本的に取得ノードに対して設定ノードが存在してる
  

設定の適用

• 「GetGameUserSettings」->「ApplySettings」ノードで、設定した情報の適用が可能
• 「Check for Command Line Overrides」はコマンドラインで設定した内容を上書きするフラグだが、コマンドラインで内容を設定していなければチェックを付いていても問題ない
  

保存場所

• 各種保存場所に.iniファイルが保存される
• Editor
  • "プロジェクト名"\Saved\Config\WindowsEditor\GameUserSettings.ini
• Package(Development)
  • "パッケージフォルダ\Saved\Config\Windows\GameUserSettings.ini"
• Package(Shipping)
  • C:\Users"ユーザー名"\AppData\Local"プロジェクト名"\Saved\Config\Windows\GameUserSettings.ini

GameUserSettings.ini

;METADATA=(Diff=true, UseCommands=true)
[/Script/Engine.GameUserSettings]
bUseVSync=False
bUseDynamicResolution=False
ResolutionSizeX=1680
ResolutionSizeY=1050
LastUserConfirmedResolutionSizeX=2560
LastUserConfirmedResolutionSizeY=1440
FullscreenMode=0
LastConfirmedFullscreenMode=1
PreferredFullscreenMode=0
Version=5
AudioQualityLevel=0
LastConfirmedAudioQualityLevel=0
FrameRateLimit=144.000000
DesiredScreenWidth=1280
bUseDesiredScreenHeight=False
DesiredScreenHeight=720
LastUserConfirmedDesiredScreenWidth=1280
LastUserConfirmedDesiredScreenHeight=720
LastRecommendedScreenWidth=-1.000000
LastRecommendedScreenHeight=-1.000000
LastCPUBenchmarkResult=-1.000000
LastGPUBenchmarkResult=-1.000000
LastGPUBenchmarkMultiplier=1.000000
bUseHDRDisplayOutput=False
HDRDisplayOutputNits=1000

独自の設定項目追加

• GameUserSettingsを継承する事で、独自の設定項目を追加できます
• 以下の内容を参考にさせて頂きました、詳しくはこちらをご参照ください
  【UE4・UE5】〈Tips〉C++からGameUserSettingsを継承して独自のオプション項目を簡単に作る方法
  UE5 GameUserSettings/DeveloperSettingsについてのメモ