コンソール変数エディタ は、プロジェクトで設定されたすべてのコンソール変数に関する情報を表示する単一のパネルで、すべての変数を表示/編集するための中央集中的な場所を提供します。プリセットを作成することで、複数のプロジェクトで同じコンソール変数と値を使用することができます。また、コンソール変数エディタは、 マルチユーザー セッションにおける複数のコンピュータでの変数の制御にも対応しています。
Console Variables Editor プラグインには、コンソール変数エディタで作成したコンソール変数プリセットにアクセスして、制御するためのブループリント API も追加されています。詳細については、「ブループリント API リファレンス」を参照してください。
コンソール変数エディタを使用するには、プロジェクトで Console Variables Editor プラグインを有効にします。プロジェクトでプラグインを有効にする手順については、「プラグインの操作方法」を参照してください。
メインメニューで、[Window (ウィンドウ)] > [Console Varieables (コンソール変数)] を選択し、コンソール変数エディタを開きます。このパネルは Unreal Editor の任意の場所にドッキングできます。
コンソール変数リスト
このリストには、現在トラッキングされているすべてのコンソール変数と実行されたコマンドが含まれています。コンソール変数エディタを初めて開くと、コンソール変数が追加されていない空白のプリセットがロードされます。プラグイン設定で、[Add All Changed Console Variables to Current Preset (現在のプリセットに変更されたコンソール変数をすべて追加する)] が True に設定されている場合、コンソール変数は、多くの場合 [Project Settings (プロジェクト設定)] で設定されるため、すでにリスト内に変数が表示されることがあります。
コンソール変数およびコマンドをリストに追加するには、[(+) Add Console Variable (コンソール変数を追加)] をクリックして、入力ボックスでコマンドまたは変数を検索します。テキストを入力すると、テキスト フィールドの下に検索に一致したコンソール変数名を表示するリストが表示されますが、stat unit などのコンソール コマンドは候補リストに表示されない場合があります。
入力したコンソール変数が有効な場合は、その変数がリストに表示されます。有効な値を持つコンソール変数またはコマンドを入力すると、その値でコマンドが実行され、コンソール変数が新しい値でリストに表示されます。
変数をリストに追加すると、現在の値が プリセット値 として保存されます。個々の変数は、行のチェックボックスをオフにすることで、起動時の値にリセットしたり、変更内容を一時的に戻したりすることができます。
リストからコンソール変数を削除するには、コンソール変数の行の右側にカーソルを重ねて、削除 ボタンをクリックします。リストからコンソール変数を削除すると、その値はプラグインがロードされたときに設定されていた値にリセットされます。
コンソール変数にカーソルを重ねると、その説明と値の意味がツールチップで表示されます。
コンソール変数リストの各行には、以下の表で指定された順序でセルのグループが含まれています。それぞれの列ヘッダをクリックすると、[Sort Order Number (ソート順番号)]、[Console Variable Name (コンソール変数名)]、および [Source (ソース)] でリストをソートすることができます。
| 列 | 説明 |
|---|---|
| Sort Order Number | コンソール変数がリストに表示される順序です。この列でソートしている場合は、行をドラッグアンドドロップすると、順序を変更できます。 他の列でソートしている場合は、[Set Sort Order (ソート順を設定)] をクリックすることで、リストのソート順が一致するように更新することができます。詳細については、「表示オプション」を参照してください。 |
| Checkbox | この行をオフにすることで、個々のコンソール変数に行われた変更を一時的に無効にすることができます。オフにすると、コンソール変数の値は、起動時にプラグインがロードされたときのコンソール変数の値に設定されます。 行を再度オンにすると、行をオフにする前に前回キャッシュされた値が設定されます。行がオフになっていたときにコンソール変数に行われた変更は、行を再度オンにしても反映されません。 現在、切り替えることができるのはコンソール変数のみです。 |
| Console Variable Name | コンソール変数の名前を表示します。名前にカーソルを重ねると、そのコンソール変数が存在する場合は、ヘルプ テキストが表示されます。 |
| Value | コンソール変数の編集可能なフィールドは、変数またはコマンドのタイプに一致します。 値フィールドを変更すると、コンソール コマンドまたは変数が実行されます。マルチユーザーが有効な場合、マルチユーザー セッションのユーザーは、これらの変数を更新された値に設定するか、ローカル マシンでコマンドを実行します。 変数の値にカーソルを重ねると、次の 3 つの値が表示されます。
変数の現在値がプリセット値と異なる場合は、値をリセットするオプションが値ウィジェットの横に表示されます。[Reset (リセット)] をクリックすると、変数は再びプリセット値に設定されます。 |
| Source | 変数を設定するために前回使用した方法を示します。前回の方法がコンソール変数エディタを使用した方法の場合、[Source (ソース)] タイプは [Console (コンソール)] です。 |
表示オプション
リストに表示される行をカスタマイズするには、表示オプション をクリックします。各オプションについては、以下の表を参照してください。
| オプション | 説明 |
|---|---|
| Show | |
| Show Constructor | オンの場合、コードのデフォルトのコンストラクタで設定されたすべてのコンソール変数が表示されます。つまり、これはエンジン クラスが起動し、コンソール変数が設定された場合に該当します。 |
| Show Scalability | オンの場合、[Scalability (スケーラビリティ)] オプションで設定されたすべてのコンソール変数が表示されます。 |
| Show Game Setting | オンの場合、UGameUserSettings(config=GameUserSettings) で設定されたすべてのコンソール変数が表示されます。 |
| Show Project Setting | オンの場合、[Project Settings (プロジェクト設定)] で設定されたすべてのコンソール変数が表示されます。 |
| Show System Settings ini | オンの場合、[System Settings (システム設定)] で設定されたすべてのコンソール変数が表示されます。 |
| Show Device Profile | オンの場合、[Device Profiles (デバイス プロファイル)] で設定されたすべてのコンソール変数が表示されます。 |
| Show Game Override | オンの場合、適切に実行するために特定の値を必要とするプラットフォームなど、ゲーム内のオーバーライドで設定されたすべてのコンソール変数が表示されます。 |
| Show Console Variables ini | オンの場合、Engine/Config/ConsoleVariables.ini の [Startup] セクションで設定されたすべてのコンソール変数を表示します。 |
| Show Command line | オンの場合、[Command-Line Arguments (コマンドライン引数)] で設定されたすべてのコンソール変数が表示されます。 |
| Show Code | オンの場合、コンストラクタ以外のソース コード (通常はプラグイン) で設定されたすべてのコンソール変数が表示されます。 |
| Show Console | オンの場合、ブループリント、CMD 入力、またはコンソール変数エディタで設定されたすべてのコンソール変数が表示されます。 |
| Show Only Modified | オンの場合、現在の値がプリセット値と異なるすべてのコンソール変数が表示されます。 |
| Sort | |
| Set Sort Order | 選択されている場合、コンソール変数リストの現在の順序が保存されます。 |
| Options | |
| Track All Variable Changes | このオプションは、プラグイン設定の [Add All Changed Console Variables to Current Preset] と同じです。 |
検索
検索には、プリセット検索とグローバル検索の 2 つのタイプがあります。入力したテキストはすべて検索トークンになります。パイプ文字はテキストを OR トークンに分離し、スペースはテキストを AND トークンに結合します。
たとえば、入力したテキストが「lumen|screen percentage」である場合、検索トークンは「lumen」と「screen percentage」になります。この検索では、「lumen」を含む結果か、「screen」および「percent」の両方を含む結果が返されます。
プリセット検索
プリセット検索は、検索時のデフォルトのオプションです。プリセットのコンソール変数の中で、名前、ソース、またはヘルプ テキストが検索トークンに一致しないものは、リストから除外されます。
グローバル検索
検索フィールドにテキストを入力してから、[Search All (すべて検索)] をクリックすると、グローバル検索を有効にすることができます。Unreal Engine のコンソール変数の中で、名前 が検索トークンに一致するものがリストに表示されます。入力した検索トークンは、検索フィールドの下に表示されます。一致した変数はリストで行として表示され、プリセットの行と同様に操作することができます。
検索トークンをクリックすると、オン/オフを切り替えることができます。
トークンを 右クリック、または Ctrl + クリック すると、個別に削除できます。
削除 ボタンをクリックすると、すべての検索トークンが削除され、プリセット検索に戻ります。
グローバル検索リストのコンソール変数をプリセットに追加することができます。これには、行にカーソルを重ねて、行に [Add CVAR (CVAR を追加)] が表示されたら、これをクリックします。すべての変数の変更のトラッキングを有効にしている場合、このビューで変更した変数は、現在のプリセットにも追加されます。
プリセット
[Presets (プリセット] パネルを開くと、プリセットを保存したりロードしたりすることができます。プリセットをロードすると、現在のリストにあるすべての変数がリストから削除されますが、その値は影響されません。新しくロードされたプリセットのすべての変数は、所定の行がオフになっていない限り、保存された値に設定されます。
マルチユーザー
プロジェクトで Multi-User プラグインが有効になっており、コンソール変数エディタに [Multi-User (マルチユーザー)] オプションが表示されている場合、変数の変更やコマンド コールをセッション内の他のユーザーに伝搬させることができます。
[Multi-User Controls (マルチユーザー コントロール)] をクリックすると、コンソール変数エディタの下部に [Multi-User] の設定が表示されます。このコントロール パネルから、個々のセッション メンバーでコンソール変数の同期の有効/無効を切り替えることができます。
プラグイン設定
[Project Settings (プロジェクト設定)] > [Plugins (プラグイン)] > [Console Variables Editor (コンソール変数エディタ)] で、コンソール変数エディタの機能と表示をカスタマイズすることができます。以下の表で、すべてのプラグイン設定について説明します。
| 設定 | 説明 |
|---|---|
| Unchecked Row Display Type | オフになっている行の値入力で、値をどのように表示するかを決定します。以下は、オフになっている行の表示オプションです。
|
| Add All Changed Console Variables to Current Preset | オンの場合、コンソール変数エディタ以外で変更されたコンソール変数がリストに追加されます。コンソール変数のみがこの方法でトラッキングされます。コンソール変数エディタ以外で入力したコマンドは追加されません。 |
| Changed Console Variable Skip List | [Add All Changed Console Variables to Current Preset] が有効な場合、コンソール変数エディタ以外でコンソール変数が変更されると、ここにリストされたコンソール変数は除外されます。 |