このページには、Stingray Editor のステータス バーにあるコマンド ラインからゲームに送信できるすべてのコンソール コマンドを一覧表示しています。

コマンドの送信方法の詳細については、「ステータス バーからコマンドを送信する」を参照してください。

• apex
• crash
• file_system
• game
• graph
• help
• lua
• memory_resources
• memory_tree
• network
• particles
• perfhud
• physics
• profiler
• pump
• reboot
• refresh
• renderer
• statistics
• streamer_stats
• vector_field

Apex Cloth の物理システムに対するランタイムのデバッグをコントロールします。このコマンドは、APEX システムがご使用の Stingray エンジンのバージョンで有効になっている場合にのみ使用できます。

次のパラメータのいずれかが必要です。

• show <PARAMETER>: 指定した視覚化パラメータを表示します。
• hide <PARAMETER>: 指定した視覚化パラメータを非表示にします。

<PARAMETER> 設定は次の値を受け入れます。normals、tangents、bitangents、lod-benefits、bone-frames、collision-volumes、collision-volumes-wire、mesh、skeleton、skinned-positions、velocities、および wind。

ゲームのクラッシュ処理システムをテストするためにクラッシュを発生させます。

次のパラメータのいずれかが必要です。

• access_violation: メモリ アクセス違反を発生させます。
• alignment: 間違ったメモリ割り当てを使用してデータにアクセスします。
• assert: アサートを誘発させるために assert(false) を呼び出します。
• div_by_0: ゼロで除算します。
• error: システム エラーを発生させます。
• fpu: ゼロによる浮動小数点除算を発生させます。
• out_of_memory: 過剰なメモリが割り当てます。
• purecall: pure virtual として宣言された関数を呼び出します。

低速のファイル システムでのゲームの実行をシミュレートします。

次のパラメータの 1 つのみを受け入れます。

• emulate_seek_time <SECONDS>: ファイル システムへのアクセスの最小シーク時間を設定します。この遅延は、連続メモリ位置からの読み取りを除いて、すべてのディスクの読み取り操作に適用されます。

ゲームをコントロールします。

次のパラメータのいずれかが必要です。

• pause: ゲームを一時停止します。
• unpause: 一時停止したゲームを再開します。

ゲームのビューポートに、時間の経過に伴ったプロファイル データの変更を表示するグラフを描画します。

次のセクションで説明するパラメータのいずれかが必要です。

ユーザが指定する <FIELD> 名の設定が統計システムによって追跡される値と一致する必要があることに注意してください。これは、application.fps または lua.gc.total など、既定でエンジンが追跡する任意の値にすることができます。これは、Lua コードで stingray.Profiler.record_statistics() 関数を呼び出して追跡するように要求した値にすることもできます。

可視性

• show: 表示できるすべてのグラフを一覧表示します。
• show <NAME>: 指定した名前でグラフを表示します。
• hide: すべてのグラフを非表示にします。
• hide <NAME>: 指定した名前でグラフを非表示にします。

スクリーン レイアウトと位置

• layout <MODE>: グラフを描画するためのレイアウト モードを設定します。<MODE> パラメータは次の値のいずれかを受け入れます。fill、top、bottom、left、または right。
• size <SIZE>: グラフの推奨サイズをピクセル単位で設定します。実際のサイズは、推奨レイアウト設定を満たすために調整される場合があることに注意してください。

グラフとデータをカスタマイズする

• make <NAME>: 指定した名前で新しいグラフを作成します。
• add <GRAPH> <FIELD>: 指定したグラフに数値フィールドを追加します。
• add_vector3 <GRAPH> <FIELD>: 指定したグラフに Vector3 フィールドを追加します。
• remove <GRAPH> <FIELD>: 指定したグラフから指定したフィールドを削除します。
• profile <COUNTER> <ON/OFF>: プロファイル グラフで指定したカウンタのオンまたはオフを切り替えます。<ON/OFF> の設定は、値 on または off を受け入れます。それ以外の任意の値を使用すると、現在のステータスが切り替わります。

グラフ データの表示方法をカスタマイズする

• range <GRAPH>: 指定したグラフの範囲を自動的に計算された値に設定します。
• range <GRAPH> <MIN> <MAX>: 指定した最小および最大の浮動小数点値を使用するように、指定したグラフの範囲を設定します。
• history <GRAPH> <ITEMS>: 指定したグラフに表示するヒストリ項目数を設定します。
• color <FIELD> <COLOR>: 指定したフィールドのカラーを設定します。white、yellow、purple、cyan、red、green、blue、black、3 桁および 6 桁の 16 進数の RGB 値(FFF、F0F0F0 など)を受け入れます。既定値は yellow です。

使用可能なすべてのコンソール コマンドのリストと各コマンドの簡単な説明を表示するログを出力します。

任意のコマンドで使用できるパラメータについての詳細を取得するには、help への引数としてそのコマンド名を付加します。たとえば、次のようになります。

> help profiler

Lua メモリ割り当てのログ記録をコントロールします。

次のパラメータの 1 つのみを受け入れます。

• trace: 次のフレームで行われる Lua メモリ割り当てを追跡し、それらを Log Console に出力します。

リソースによって使用されるメモリ量をコンソール ログに出力します。リソースのタイプごとに、そのタイプのすべてのリソースに割り当てられた合計メモリ、およびそのタイプの最大リソースの名前を受け取ります。

次のパラメータのいずれかが必要です。

• all: レポート内のすべてのタイプのリソースが含まれます。
• sound: レポート内のオーディオ リソースのみが含まれます。
• texture_categories [details]: テクスチャ リソースのみが含まれます。各タイプのより詳細な情報を取得するには、オプションの details 設定を追加します。
• list <TYPE>: 指定したタイプのリソースに関する詳細情報が含まれます。たとえば、memory_resources list unit などです。

エンジンの現在のメモリ使用状況を、階層ツリー構造に整理したログに出力します。

メモリ ツリーの出力

ネットワーク システムの操作をコントロールし、ネットワークの指定したピアとの不適切な接続をシミュレーションできます。

次のセクションで説明するパラメータのいずれかが必要です。

接続の強さ

以下に示すパラメータでは、[#peer] 設定はオプションです。これを省略すると、操作は既定のピアに適用されます。ピアを指定した場合は、先頭に # 文字を付けてその ID を指定する必要があります。

確率値は、0.0 から 1.0 までの値として表す必要があります。

• packet_loss [#peer] <PROBABILITY>: 指定したピアとの間に発生するパケット損失シミュレーションの確率を設定します。
• packet_loss_duration [#peer] <LOSS_DURATION> <PASS_DURATION>: パケット損失シミュレーションの持続時間を秒単位で設定します。
• duplication [#peer] <PROBABILITY>: 指定したピアとの間に発生する重複したパケットの確率を設定します。
• latency [#peer] <MIN_LATENCY> <MAX_LATENCY>: 指定したピアとの接続をシミュレーションするために最小遅延と最大遅延を秒単位で設定します。遅延シミュレーションを無効にするには、両方の値を 0 に設定します。
• limit <UPLOAD_KBPS> <DOWNLOAD_KBPS>: アップロードとダウンロードの転送速度の制限をキロビット毎秒単位で設定します。

ログ記録レベル

• log silent: メッセージはログに書き込まれません。
• log warnings: 警告メッセージのみがログに書き込まれます。
• log messages: 簡単なメッセージと警告メッセージがログに書き込まれます。
• log spew: 詳細なメッセージと警告メッセージがログに書き込まれます。

パーティクル システムに対するランタイムのデバッグをコントロールします。

すべてのパラメータの <ON/OFF> の設定は、値 on または off を受け入れます。それ以外の任意の値を使用すると、現在のステータスが切り替わります。

ゲーム内のデバッグ

• debug <ON/OFF>: ゲームのビューポートでパーティクル システムが描画されるかどうかを決定します。
• debug_collision_cache <ON/OFF>: ゲームのビューポートで衝突のキャッシュが描画されるかどうかを決定します。
• debug_collision_cache_plane_half_width <VALUE>: ゲームのビューポートで衝突のキャッシュが描画される場合の平面の半分の幅を設定します。
• list: アクティブなパーティクルの効果が一覧表示されます。

ゲームのビューポートでパフォーマンス統計情報を描画します。

次のセクションで説明するパラメータのいずれかが必要です。

サブシステム

• artist: グラフィックス パフォーマンス統計情報の表示を切り替えます。
• lua: Lua 環境のパフォーマンス統計情報の表示を切り替えます。
• culling: レンダー カリングの統計情報の表示を切り替えます。
• audio: オーディオ サブシステムの統計情報の表示を切り替えます。
• memory: メモリ統計情報の表示を切り替えます。
• texture_streaming: テクスチャ ストリーミング システムのメモリ統計情報とステータスの表示を切り替えます。
• network: ネットワーク システムのパフォーマンスの表示を切り替えます。

ネットワーク統計情報

• network_messages: ネットワーク メッセージ統計情報の表示を切り替えます。
• network_peer <INDEX>: 指定したインデックスを持つピアに関する統計情報の表示を切り替えます。<INDEX> 設定の範囲は 1 から接続したピアの現在の数の間である必要があります。
• network_peers: 接続したピアのリストを切り替えます。
• network peers <UNITS>: ピア グラフで使用する単位のタイプを設定します。<UNITS> 設定の値は、キロビット毎秒を示す kbps、または bytes のいずれかを選択できます。
• network_ping: ピアごとのネットワーク ping の統計情報の表示を切り替えます。
• network_qos: クオリティー オブ サービス(QOS)システムの統計情報の表示を切り替えます。

物理システムに対するランタイムのデバッグをコントロールします。

次のセクションで説明するパラメータのいずれかが必要です。

すべてのパラメータの <ON/OFF> の設定は、値 on または off を受け入れます。それ以外の任意の値を使用すると、現在のステータスが切り替わります。

ゲーム内のデバッグ

• debug <ON/OFF>: ゲームのビューポートで物理シェイプが描画されるかどうかを決定します。
• debug_raycasts <ON/OFF>: ゲームのビューポートでレイキャストが描画されるかどうかを決定します。
• debug_overlaps <ON/OFF>: ゲームのビューポートで物理オーバーラップが描画されるかどうかを決定します。
• debug_movers <ON/OFF>: ゲームのビューポートで物理ムーバが描画されるかどうかを決定します。
• scale <VALUE>: 視覚化スケールを設定します。スケールを無効にするには 0 を使用します。
• show <PARAMETER>: 指定した視覚化パラメータを表示します。
• hide <PARAMETER>: 指定した視覚化パラメータを非表示にします。

show および hide の <PARAMETER> 設定は次の値を受け入れます。world_axes、body_axes、body_mass_axes、body_lin_velocity、body_ang_velocity、body_joint_groups、contact_point、contact_normal、contact_error、contact_force、actor_axes、collision_aabbs、collision_shapes、collision_axes、collision_compounds、collision_fnormals、collision_edges、collision_static、collision_dynamic、collision_pairs、joint_local_frames、joint_limits、particle_system_position、particle_system_velocity、particle_system_collision_normal、particle_system_bounds、particle_system_grid、particle_system_broadphase_bounds、particle_system_max_motion_distance、cull_box

Log Console でのデバッグ

• debug_events <ON/OFF>: 接続している物理イベントをデバッグするかどうかを決定します。
• dump_metadata: Log Console に PhysX メタデータが含まれるファイルを送信します。

PhysX ビジュアル デバッガでのデバッグ

• connect: localhost:5425 を待機するビジュアル デバッガにゲームを接続します。
• connect <HOST> <PORT>: 指定したホストとポスト番号を待機するビジュアル デバッガにゲームを接続します。
• disconnect: ビジュアル デバッガからゲームを切断します。

組み込みパフォーマンス プロファイリング システムをコントロールします。

次のパラメータのいずれかが必要です。

• pause: プロファイラ内のゲームを一時停止します。
• unpause: 一時停止されたプロファイラ内のゲームを再開します。
• stall <seconds>: 失速警報のしきい値を設定します。

ポンプ モードで実行している場合は、ゲームは 1 フレームずつ進みます。

ゲーム アプリケーションを再起動します。

次の任意の数のパラメータを受け入れます。すべてのパラメータはオプションで、同じコマンド ラインで複数のパラメータを指定できます。

• -ini <RESOURCE>: 既定の settings.ini ファイルの代わりに指定したリソースを使用します。
• -editor-ini <RESOURCE>: エディタの初期化ファイルとして指定したリソースを使用します。
• -force-unload true: メモリからすべてのリソースを強制的にロード解除します。
• -wait-for-debugger true: エディタの Lua デバッガへの接続を待機します。
• -flag <NAME>=<VALUE>: 初期化ファイルで設定した値をオーバーライドする、再起動したゲームの設定パラメータを設定します。<VALUE> の設定には、true、false、または数値を指定できます。

ゲームに最後にロードされてから、変更されたすべてのリソースを強制的に再ロードします。

レンダラーをコントロールします。

次のパラメータのいずれかが必要です。

• reload_shader_lib <LIB>: 指定したシェーダ ライブラリを再ロードします。
• reload_config <CONFIG>: 指定したレンダー設定を再ロードします。
• caps <VARIABLE> <VALUE>: 指定したレンダー キャップを設定します。
• settings <VARIABLE> <VALUE>: 指定したレンダー設定値を設定します。

Log Console に現在の統計情報の記録を出力します。たとえば、次のようになります。

application.fps = 32.638138
application.smoothed_fps = 49.530058
lua.gc.total = 1008.000000
lua.frame_alloc_count = 0.000000
memory.default_allocator.size = 53.452225
lua.gc.estimate = 1003.000000
application.smoothed_delta_time = 20.189760
lua.frame_alloc_bytes = 0.000000
memory.page_allocator.size = 56.937500
application.delta_time = 30.639002
lua.gc.percentage = 0.007976
lua.gc.collection_ms = 0.500000

テクスチャ ストリーミング システムで管理される各リソースの記録を出力します。「テクスチャ ストリーミング」を参照してください。

各記録には、次の情報が含まれています。

• total mips: 現在のプラットフォームに関してコンパイル済みのテクスチャ リソースに含まれる mip レベルの合計数。
• resident mips: 現在のプラットフォームでテクスチャのメモリに常にロードされる mip レベル数。
• current mip: テクスチャに対するストリーマの共有メモリ プールに現在ロードされている mip レベル。
• resident texture mem: 常駐 mip レベルのみのメモリ消費量。
• streamable texture mem: 共有メモリ プールに現在ロードされている mip レベルのメモリ消費量。

ベクトル フィールドのランタイムのデバッグをコントロールします。

次のパラメータのいずれかが必要です。

• draw <NAME>: ゲームのビューポートでデータが描画されるベクトル フィールドの名前を指定します。
• draw_color <COLOR>: ベクトル フィールドの描画に使用するカラーを設定します。white、yellow、purple、cyan、red、green、blue、black、3 桁および 6 桁の 16 進数の RGB 値(FFF、F0F0F0 など)を受け入れます。既定値は yellow です。
• draw_count <SAMPLES>: ベクトル フィールドの描画に使用するサンプル数を設定します。既定値は 20000 です。
• draw_lifetime <LIFETIME>: 各描画サンプルが表示された状態を保つ時間の長さを秒単位で設定します。既定値は 2 です。
• draw_length <LENGTH>: 各描画サンプルの長さをメートル単位で設定します。