 |
CriWare Unreal Engine
Plug-ins for CriWare solutions.
|
|
CriWare Unreal Engine
Plug-ins for CriWare solutions.
|
このマニュアルは、サウンドミドルウェア「Atom」に関連するコンソールコマンドをまとめたものです。各コマンドは機能ごとに分類されており、デバッグ、パフォーマンスチューニング、再生制御などに役立ちます。
ゲームエンジンやアプリケーションのコンソールを開き、コマンドを入力して実行します。
引数に 0 / 1 が指定されているものは、多くの場合 0 が「無効」、1 が「有効」を意味します。
[ ] で囲まれた引数は、必要に応じて値を指定します。
Unreal Engineでコンソール コマンドを開くには、キーボードのチルダ キー (~) を押します。チルダ キーは通常、1 キーの左側にあり、` と ~ の両方が付いています。
コンソール コマンドは、 Unreal Editorウィンドウの下部にある下部ツールバーにも表示されます。
ほとんどのAtomコマンドは、**[CVar Name] [Value]** 構文を使用して、特定の コンソール変数 (CVar) を目的の値に設定します。
コンソールに入力したコマンドは、エディターにリアルタイムで反映されます。
コンソール コマンドは、ゲーム内、エディター内、または -server スイッチを使用してゲームがすでに開始されている場合はサーバーのコンソールから実行できます。
Atom固有のコマンドと CVars には、**atom.** というプレフィックスが付きます。
コンソールは自動提案と自動補完をサポートしているため、コンソールに「atom.」と入力して、使用可能なコマンドのリストを選択できます。
3D空間上でのサウンドの状態を視覚的に表示する機能に関連するコマンドです。
| コマンド | 説明 | 引数 |
|---|---|---|
| atom.3dVisualize.Enabled | すべての3D視覚化機能の有効/無効を切り替えます。 | 0: 無効, 1: 有効 |
| atom.3dVisualize.ActiveSounds | アクティブなサウンドの視覚化モードを設定します。 | 0: 無効 1: 音量（線形） 2: 音量（dB） 3: 距離 4: ランダムカラー 5: オクルージョン |
| atom.3dVisualize.ActiveSounds.Type | 視覚化の対象となるサウンドの種類を設定します。 | 0: すべて 1: コンポーネントのみ 2: 非コンポーネントのみ |
| atom.3dVisualize.Attenuation | キューで設定された減衰範囲の視覚化を有効にします。 | 0: 無効, 1: 有効 |
| atom.3dVisualize.Listeners | リスナーの位置を視覚化します。 | 0: 無効, 1: 有効 |
| atom.3dVisualize.SpatialSources | 空間化された音源を視覚化します。 | 0: 無効, 1: 有効 |
| atom.3dVisualize.VirtualLoops | 仮想ループの状態を視覚化します。 | 0: 無効, 1: 有効 |
| atom.3dVisualize.MultiPositionSources | マルチポジション音源を視覚化します。 | 0: 無効, 1: 有効 |
このコンソール変数は、アクティブなAtomサウンドの3D可視化時の表示内容を切り替えます。
値ごとに以下のような意味があります。
| 値 | モード名 | 説明 |
|---|---|---|
| 0 | Not Enabled | 可視化を無効化します。アクティブサウンドの3D表示は行われません。 |
| 1 | Volume (Lin) | サウンドの音量（リニア値）に応じて色や表示が変化します。音量が高いほど明るく表示されます。 |
| 2 | Volume (dB) | サウンドの音量（デシベル値）に応じて色や表示が変化します。dBスケールでの可視化です。 |
| 3 | Distance | サウンドとリスナーの距離に応じて色や表示が変化します。距離が近いほど明るく表示されます。 |
| 4 | Random color | 各サウンドをランダムな色で表示します。デバッグや識別用に便利です。 |
| 5 | Occlusion | 遮蔽（オクルージョン）状態を可視化します。遮蔽されているサウンドは異なる色で表示されます。 |
atom.3dVisualize.Attenuation コマンドを使用してAttenuation Viewを有効にすると、詳細パネルで Developer -> Debug チェックボックスがオンになっているAtomキューのみが表示されます。
サウンドに関する様々な情報を画面に表示するためのコマンドです。
| コマンド | 説明 | 引数 |
|---|---|---|
| 全般 | ||
| atom.Debug.Display.X / Y | デバッグテキストの表示位置をX, Y座標で指定します。 | 数値（ピクセル単位） |
| Sounds | ||
| atom.Debug.Sounds | 現在再生中のサウンドに関するデバッグ情報を表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.Sounds.Max | デバッグ表示するサウンドの最大数を設定します。 | 数値（デフォルト: 32） |
| atom.Debug.Sounds.ShowPath | サウンドアセットの完全なパスを表示します。 | 0: 無効, 1: 有効 |
| atom.Debug.Sounds.Sort | 表示されるサウンドのソート順を指定します。 | Class, Distance, Name, Priority, Time, Wave, Volume |
| atom.Debug.Sounds.TextColor | デバッグテキストの色を指定します。 | White, Red, Yellow, Blueなど |
| SoundCues | ||
| atom.Debug.SoundCues | SoundCueのデバッグ情報を表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.SoundCues.Minimal | SoundCueのデバッグ情報を簡易表示モードにします。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundCues.ShowDistance | SoundCueまでの距離を表示します。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundCues.ShowPath | SoundCueアセットの完全なパスを表示します。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundCues.Spacing.Char / Tab | デバッグテキストの文字間隔とタブ幅を指定します。 | 数値 |
| SoundWaves | ||
| atom.Debug.SoundWaves | SoundWaveのデバッグ情報を表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.SoundWaves.Minimal | SoundWaveのデバッグ情報を簡易表示モードにします。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundWaves.ShowDistance | SoundWaveまでの距離を表示します。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundWaves.ShowPath | SoundWaveアセットの完全なパスを表示します。 | 0: 無効, 1: 有効 |
| SoundModulators | ||
| atom.Debug.SoundModulators | SoundModulatorのデバッグ情報を表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.SoundModulators.Filter.Buses | 表示するバスをフィルタリングします。 | [Enabled] [Filter] (True/False フィルタ文字列) |
| atom.Debug.SoundModulators.Filter.Mixes | 表示するミックスをフィルタリングします。 | [Filter] (フィルタ文字列) |
| atom.Debug.SoundModulators.Enable.Matrix | モジュレーションマトリックスの表示を切り替えます。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundModulators.Enable.Generators | ジェネレータの表示を切り替えます。 | 0: 無効, 1: 有効 |
| atom.Debug.SoundModulators.Filter.Generators | 表示するジェネレータを名前でフィルタリングします。 | [Name] (フィルタ文字列) |
| atom.Debug.SoundModulators.Filter.Generators.Type | 表示するジェネレータをタイプでフィルタリングします。 | [Name] [Enabled] (タイプ名 True/False) |
| atom.Modulation.Debug.UpdateRate | モジュレーションのデバッグ情報の更新間隔を設定します。 | 数値（秒） |
| Debug (追加コマンド) | ||
| atom.Debug.PlaySoundCue | 指定した SoundCue を再生します。 | -Name [SoundName]: 短縮名で再生 -Path [ObjectPath]: パスで指定して再生 -Radius [Distance]: 空間化を有効化し距離を指定 -Azimuth [Angle]: 方位角を指定 -Elevation [Angle]: 仰角を指定 -AllViews: 全ビューポートで再生 -LogSubtitles: 字幕をログ出力 |
| atom.Debug.PlaySoundWave | 指定した SoundWave を再生します。 | -Name [SoundName]: 短縮名で再生 -Path [ObjectPath]: パスで指定して再生 -Radius [Distance]: 空間化を有効化し距離を指定 -Azimuth [Angle]: 方位角を指定 -Elevation [Angle]: 仰角を指定 -AllViews: 全ビューポートで再生 -LogSubtitles: 字幕をログ出力 |
| atom.Debug.StopSound | デバッグサウンドを停止します。 | オプション: -AllViews |
| atom.Debug.SoundPlaybacks | サウンド再生情報をビューポートに表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.SoundRacks | SoundRack情報をビューポートに表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
| atom.Debug.Streaming | ストリームキャッシュ情報をビューポートに表示します。 | 0: 無効, 1: 有効 オプション: -AllViews |
空間音響、エフェクト、音量など、サウンドの再生方法を制御するコマンドです。
| コマンド | 説明 | 引数 |
|---|---|---|
| 全般 | ||
| atom.soundscape.ResetSoundscape | すべてのアクティブなSoundscape Paletteをリスタートします。 | なし |
| atom.ClearMutesAndSolos | すべてのミュートとソロ設定をクリアします。 | 1で実行 |
| atom.AnalysisTimeShift | ベイク済みの分析データの再生タイミングをずらします。 | 数値（秒） |
| atom.SetAudioChannelCount | ソースのオーディオチャンネル数を強制的に変更します。 | 数値（0で無効） |
| atom.Modulation.SetPitchRange | ピッチモジュレーションの最大範囲を設定します。 | 数値（セミトーン単位） |
| 有効化 / 無効化 | ||
| atom.AllowAudioSpatialization | オーディオの空間化（3Dパンニング）を許可します。 | 0: 無効, 1: 有効 |
| atom.DisableStereoSpread | 3Dサウンドのステレオスプレッドを無効化し、単一地点から再生します。 | 0: 有効, 1: 無効 |
| atom.UseListenerOverrideForSpread | スプレッド計算にオーバーライドされたリスナー距離を使用するか設定します。 | 0: 実際の距離, 1: オーバーライド距離 |
| atom.DisableDistanceAttenuation | 距離による音量減衰を無効化します。 | 0: 有効, 1: 無効 |
| atom.DisableOcclusion | 障害物による音の遮蔽（オクルージョン）を無効化します。 | 0: 有効, 1: 無効 |
| atom.EnableOcclusionFilterScale | オクルージョン計算時にフィルター補正を適用します。 | 0: 無効, 1: 有効 |
| atom.DisableEnvelopeFollowing | エンベロープフォロワーを無効化します。 | 0: 有効, 1: 無効 |
| atom.DisableSourceEffects | ソースエフェクトを無効化します。 | 0: 有効, 1: 無効 |
| atom.DisableAppVolume | アプリケーション全体の音量設定を無視します。 | 0: 有効, 1: 無効 |
| atom.DisableOwnerNotify | SetOwnerの通知を無効化します。 | 0: 有効, 1: 無効 |
| atom.BypassPlayWhenSilent | サイレント時に再生処理をバイパスするか設定します。 | 0: 無効, 1: 有効 |
CPU負荷やメモリ使用量を管理するためのコマンドです。
| コマンド | 説明 | 引数 |
|---|---|---|
| 仮想ループ | ||
| atom.VirtualLoops.Enabled | 仮想ループ機能を有効化します。 | 0: 無効, 1: 有効 |
| atom.VirtualLoops.PerfDistance | 仮想ループに切り替わる距離の閾値を設定します。 | 数値（距離） |
| atom.VirtualLoops.UpdateRate.Min / Max | 仮想ループの更新間隔の最小値と最大値を設定します。 | 数値（秒） |
| atom.VirtualLoops.ForceUpdateListenerMoveDistance | リスナーがこの距離以上移動した場合に仮想ループを強制更新します。 | 数値（距離） |
| ストリーミングとキャッシュ | ||
| atom.streamcache.AtomSoundWaveDefaultLoadingBehavior | AtomSoundWaveのデフォルトの読み込み動作を設定します。 | 0: オンデマンド, 1: 読み込み時保持, 2: 読み込み時準備, 3: 再生時にロード |
| atom.streamcache.AtomSoundBankDefaultLoadingBehavior | AtomSoundBankのデフォルトの読み込み動作を設定します。 | 0: デフォルト, 1: ..., 3: オンデマンド |
| atom.streamcaching.PrimeSoundOnAtomComponents | SetSound時にサウンドを自動的にキャッシュに読み込むか設定します。 | 0: 無効, 1: 有効 |
| atom.editor.ForceAtomNonStreaming | エディタ上で非ストリーミング再生を強制します。 | 0: 無効, 1: 有効 |
| スレッド管理 | ||
| AtomThread.SuspendAtomThread | Atomスレッドを一時停止または再開します。 | 0: 再開, 1: 一時停止 |
| AtomThread.AboveNormalPriority | Atomスレッドの優先度を通常より高く設定します。 | 0: 通常, 1: 高優先度 |
| AtomThread.EnableAtomCommandLogging | Atomコマンドの送受信をログに出力します。 | 0: 無効, 1: 有効 |
| コマンドバッファ | ||
| AtomThread.EnableBatchProcessing | コマンドのバッチ処理を有効化します。 | 0: 無効, 1: 有効 |
| AtomThread.BatchAsyncBatchSize | 非同期バッチ処理で一度に処理するコマンド数を設定します。 | 数値 |
| AtomCommand.FenceWaitTimeMs | フェンスの待機時間を設定します。 | 数値（ミリ秒） |
| atom.FlushCommandBufferOnTimeout | タイムアウト時にコマンドバッファをフラッシュするか設定します。 | 0: 無効, 1: 有効 |
| atom.CommandBufferFlushWaitTimeMs | コマンドバッファのフラッシュ待機時間を設定します。 | 数値（ミリ秒） |
| atom.CommandBufferMaxSizeInMb | コマンドバッファの最大サイズを設定します。 | 数値（MB） |
| atom.CommandBufferInitialCapacity | コマンドバッファの初期容量を設定します。 | 数値（要素数） |
| その他 | ||
| atom.AtomSoundDistanceOptimizationLength | 距離最適化によりカリングされるサウンドの最大持続時間を設定します。 | 数値（秒、デフォルト: 1.0） |
| atom.AtomGameplayVolumes.Enabled | ゲームプレイボリュームシステムを有効化します。 | 0: 無効, 1: 有効 |
| atom.AtomGameplayVolume.UpdateRate | ゲームプレイボリュームの更新間隔を設定します。 | 数値（秒） |
| atom.FlushAtomRenderThreadOnGC | GC（ガベージコレクション）実行時にAtomレンダリングスレッドをフラッシュします。 | 0: 無効, 1: 有効 |
Atomシステムの監視や、シーケンサーとの連携などに関するコマンドです。
| コマンド | 説明 | 引数 |
|---|---|---|
| Atom Monitor | ||
| atom.Monitor.Start | Atom Monitorを開始します。 | [Port=<ポート番号>] |
| atom.Monitor.Stop | Atom Monitorを停止します。 | なし |
| atom.Monitor.EnableOutputLog | Atom Monitorの情報をログに出力します。 | 0: 無効, 1: 有効 |
| atom.Monitor.LogStatus | Atom Monitorの現在の状態をログに出力します。 | なし |
| シーケンサー | ||
| Sequencer.Atom.MaxDesyncTolerance | オーディオとシーケンサー間の非同期の最大許容時間を設定します。 | 数値（秒） |
| Sequencer.Atom.IgnoreAudioSyncDuringWorldTimeDilation | ワールドタイムのスケール変更時にオーディオ同期を無視するか設定します。 | true: 無視, false: 同期 |
| Sequencer.Atom.UseAtomClockForAudioDesync | オーディオの非同期判定にAtomレンダースレッドのクロックを使用します。 | 0: 無効, 1: 有効 |
| Sequencer.Atom.PlayAudioWhenPlaybackJumps | シーケンサーの再生位置がジャンプした際にオーディオを再生します。 | true/false |
| その他 | ||
| atom.DumpActiveSounds | 現在アクティブなサウンドの全情報をログに出力します。 | なし |
| atom.ReportAtomRuntimes | アクティブなAtomランタイムの一覧をログに出力します。 | なし |
| atom.MaxWorldDistance | オーディオが聞こえる最大距離を指定します。 | 数値（距離） |
| atom.rack.clearbrokenrackassets | 破損している可能性のあるラックアセットの親子関係をチェック・修正します。 | 0: 無効, 1: 有効 |
| atom.InteriorData.UseIAtomActiveSoundUpdate | Atomの内部データ更新ロジックを切り替えます。 | 0: 無効, 1: 有効 |
| atom.FocusData.InitializeFocusFactorOnFirstUpdate | フォーカス係数の初期化タイミングを設定します。 | 0: 無効, 1: 有効 |
1.16.0