Stingray エンジンは、このページに説明されているすべてのコマンドライン パラメータを受け入れます。
コマンドライン プロンプトから Stingray エンジンを起動した場合、これらのパラメータを使用して、ゲームでロードすべきプロジェク トデータを指定したり、コンパイルおよびバンドル プロセスを起動したり、エンジン操作の他の特定の側面を制御できます。
さらに、Stingray エディタの Connections パネルでターゲットを設定する際に、コマンドライン パラメータを提供できます。「Connections パネルを使用する」を参照してください。
特に指定がない限り、すべてのパラメータはオプションです。
ゲームプレイ コードでは、stingray.Application.argv () 関数を呼び出してエンジンの起動に使用したすべてのコマンドライン パラメータをにアクセスできます。これを使用して、このページに表示されているすべてのパラメータ、または名前や意味を定義するカスタム パラメータを読み込んで応答することができます。
特定の toolchain ディレクトリのプロジェクト設定を使用して、エンジンを実行します(これにより、必要に応じてデータもコンパイルされます)。
stingray_win64_dev.exe --toolchain C:\work\toolchain
特定のフォルダからコンパイルされたデータを使用してエンジンを実行します。
stingray_win64_dev.exe --data-dir D:\Projects\testbed_data\win32
バンドルされたデータを使用してエンジンを実行します。
stingray_win64_dev.exe --bundle-dir D:\Projects\testbed_data\win32_bundled
TCP/IP ファイル サーバからストリーム データを使用してエンジンを実行します。--data-dir は、エンジンが使用すべきファイル サーバ上のディレクトリです。--secret は、そのディレクトリの .stingray-asset-server-secret ファイルの内容と一致する必要があります。
stingray_win64_dev.exe --host 172.64.22.32 --data-dir D:\Projects\testbed_data\win32 --secret PqdjliMO52Tu4As+FxuJig==
特定のプラットフォーム(win32、xb1、android、macosx、ios、ps4)の toolchain 設定からプロジェクト データをクロスコンパイルします。
stingray_win64_dev.exe --compile-for ps4 --toolchain C:\work\toolchain
toolchain 設定を使用して、バンドル プロジェクト データをクロスコンパイルします。
stingray_win64_dev.exe --compile-for ps4 --bundle --toolchain C:\work\toolchain
マッピングされた core フォルダを使用して、Win32 プロジェクト データをコンパイルします。
stingray_win64_dev.exe --compile --source-dir D:\projects\testbed --data-dir D:\projects\testbed_data\win32 --map-source-dir core C:\work\toolchain
Win32 プロジェクト データをコンパイルしてバンドルします。
stingray_win64_dev.exe --compile --bundle --source-dir D:\projects\testbed --data-dir D:\projects\testbed_data\win32 --bundle-dir D:\projects\testbed_data\win32_bundled --map-source-dir core C:\work\toolchain
エンジンの引数のリストの終わりを指定します。-- に続く引数は、ゲームの引数であるとみなされます。これらはエンジンでは無視されますが、Application.argv () では使用できます。(Application.argv () には、エンジンの引数もすべて含まれます。)
このパラメータを使用する場合、--data-dir--bundle-dir または --source-dir を指定する必要はありません。代わりに、現在のプロジェクト設定がフォルダ DIRECTORY/settings から読み込まれ、そこからディレクトリが推定されます。
--toolchain パラメータを使用する場合、データはまずデータ ディレクトリにコンパイルされ、その後そのデータでエンジンが起動されます。--bundle パラメータと組み合わせて使用する場合、データはバンドルされ、バンドル ディレクトリから実行されます。
--toolchain を --compile-for とともに使用することもできます。その場合、データは指定したプラットフォーム用にコンパイルされ、実行可能ファイルは終了します。
コンパイルされたデータのディレクトリを指定します。
エンジンを実行する際、指定されていれば、データはこのディレクトリから読み込まれます。
--compile を使用する場合、このパラメータは、エンジンがプロジェクトのためにコンパイルするデータの保存先を指定します。
バンドルされたデータのディレクトリを指定します。
エンジンを実行する際、指定されていれば、バンドルされたデータはこのディレクトリから読み込まれます。
--bundle を使用する場合、コンパイラはバンドルされたデータをこのディレクトリにビルドします。
バンドルされたデータのロード元となる URL を指定します。エンジンの実行中に、この HTTP フォルダからバンドル データがストリーミングされます。
settings.ini ではなく指定した .ini ファイルから設定をロードするように、エンジンに指示します。
すべてのレンダリング機能を無効にします。エンジンをサーバとして実行する場合に、メモリと処理時間を節約するために使用されます。
サイレント モードで起動するよう、エンジンに指示します。このモードでは、エンジンはアサートおよびエラー時にはプロンプトを表示しません
コールスタックのロギングにモジュールを追加します。コールスタックを移動するときに使用されます。Windows でのみ使用できます。
Forward モードで初期化を実行するよう、エンジンに指示します。このモードでは、エンジンの初期化全体が、更新ループの前に実行されます。これは、Web と UWP を除くすべてのプラットフォームの既定値です。
保留モードで初期化を実行するよう、エンジンに指示します。このモードでは、エンジンの初期化の一部が、更新ループで実行されます。これは、Web と UWP の既定値です。
エンジン プラグインを検索するためにディレクトリを追加します。複数の --plugin-dir 引数を使用して、ディレクトリを追加できます。
この引数で提供されるプラグイン ディレクトリは、自動的にホット リロード可能に設定されます。ディレクトリ dir 内に既にロードされたプラグインの名前と一致する新しいプラグインがあり、そのプラグインがホット リロード インタフェースをサポートしている場合、そのプラグインがリロードされます。
エンジンは使用している DLL をロックし、デバッガは任意の数の古い .pdb ファイルをロックできるため、プラグインの事前作成手順に、次の手順を追加することをお勧めします。
rename ${plugin}.dll ${plugin}.dll.old rename ${plugin}.pdb ${plugin}.${timestamp}.pdb.old del *.old
名前変更することで、エンジンで引き続き古い DLL を使用しながら、新しい DLL を作成できます。デバッガは検出したすべての PDB をロックするため、PDB の名前変更時にタイムスタンプを追加する必要があります。最後の del コマンドは、失敗を許容するために設定する必要があります。DLL と PDB がまだ使用されている場合は失敗し、DLL と PDB はそのままになります。
Lua init() 関数の実行後に実行する Lua コードの一部を指定します。
エンジンのコンソール サーバがホストされる TCP/IP ポートを指定します。外部ツールはこのポートに接続して、実行中のエンジンと通信できます。
エンジンの 1 つのコピーのみ同時に実行できるほとんどのコンソールでは、このパラメータで指定されていない限り、エンジンはポート 14030 を使用します。
Xbox One では、XboxOne デスクトップ接続の既定のポートであるため、ポート 4601 が使用されます。
多くのエンジンのインスタンスが同時に実行されている可能性のある PC では、指定されていない限り、コンソール サーバはランダムな空きポートを使用します。PC では、コンソールは開いている TCP/IP ポートで「stingray_*.exe」と呼ばれる実行中の実行可能ファイルを検索し、接続先の実行中のゲーム エンジンを見つけます。
エディタの Lua デバッガが接続するまで開始を遅らせるようにエンジンに指示し、ブレークポイントの位置など、必要なすべてのデバッグ情報を送信します。これは、--wait を使用せずに、プロジェクトの起動前にデバッガを完全に初期化するための信頼できる方法です。
実行する前に、指定された秒数、ログ コンソールへの接続を待機するようエンジンに指示します。これにより、ロギング コンソールはゲームの初期出力をキャプチャするようになります。
エラーが発生した場合、ロギング コンソールへの接続を待機するようエンジンに指示します。これにより、ロギング コンソールで初期エラーがキャプチャされるようになります。
ゲームを実行する代わりに、プロジェクトのソース ディレクトリにあるデータをコンパイルするよう、エンジンに指示します。
このパラメータを使用する場合、以下も指定する必要があります。
--source-dir パラメータを使用して、プロジェクトのソース ディレクトリを指定します。
--data-dir パラメータを使用して、コンパイルされたデータの宛先を指定します。
ゲームを実行する代わりに、プロジェクトのコンパイルされたデータからバンドルを作成するよう、エンジンに指示します。
このパラメータを使用する場合、以下も指定する必要があります。
--data-dir パラメータを使用して、コンパイルされたデータを含むディレクトリを指定します。
--bundle-dir パラメータを使用して、バンドルされたデータの宛先を指定します。
--compile を使用する場合、このパラメータはプロジェクトのソース フォルダの場所を指定します。
--compile または --bundle を使用する場合、このパラメータは、データをコンパイルするプラットフォームをエンジンに指示します。platform の値には win32、ps4、android、ios または xb1 を指定できます。
--compile または --bundle を使用する場合、このパラメータは、データのコンパイルおよびバンドル手順の完了後、ゲームを引き続き実行するようエンジンに指示します。実行中のプラットフォーム以外のプラットフォーム用にクロスコンパイルしている場合は、このパラメータを使用できません。
このフラグが有効な場合、コンパイラはローカルでコンパイルする前に、コンパイルされたデータがあるかどうか、ネットワークにクエリーします。これによりコンパイル時間を短縮できます(ただし、コンパイルの問題をデバッグしにくくなります)。フラグが有効な場合、コンパイラは環境変数 SR_REMOTE_CACHE_IP で指定されたアドレスで、コンパイルされたファイルがあるかどうかキャッシュ サーバを探し、特定のファイル タイプのコンパイルされたバージョンをクエリーします。
コンパイル中にデバッグ情報を .lua ファイルから除去する必要のあることを、データ コンパイラに指示します。
すべてのリソースを 2 回コンパイルし、結果を比較することで、コンパイルが決定論的であることを確認するようにデータ コンパイラに指示します。
このパラメータを使用して、ソース パスを --source-directory 以外のディレクトリにマップできます。これは、通常、core フォルダをマッピングするために使用されます。
--map-source-dir core c:\work
core フォルダのソース パスがすべて SOURCE_DIRECTORY/core ではなく c:¥work¥core からロードされるようになります。
これを使用して、core以外の共有フォルダを指定できます。
--map-source-dir の 2 番目の引数は、マッピングされたディレクトリのディレクトリではなく、他の場所でルート ディレクトリを指定します。マッピングされたディレクトリの名前は、このルートに結合されます。
シリアルでコンパイルするよう(並列化なし)、エンジンに指示します。これは通常、data-compile のデバッグに使用されます(シリアルで実行する方が理解しやすいため)。パラレル コンパイルが失敗した場合に、作業を継続する方法としても使用できます。
指定したフラグが true であると仮定してこのリソースをコンパイルするよう指定します。
指定したフラグが false であると仮定してこのリソースをコンパイルするよう指定します。
デバッグのためにのみ使用されます。エンジンが起動プロセスでフリーズしたため、続行する前にデバッガをアタッチできることを示します。
エンジンはバージョン番号をプリントします。
起動後、物理メタデータ ファイルをダンプするよう、エンジンに指示します。このファイルは、物理オブジェクトをコンパイルする各プラットフォームで必要です。ビルド済みファイルが core/physx_metadata にあるため、このパラメータを使用する必要はありません。
サムネイル サーバ モードで起動するよう、エンジンに指示します。このモードでは、エンジンはプロジェクト リソースにサムネイル イメージを生成する要求をリッスンして、要求に応えます。
ユニット テストを実行するようエンジンに指示します。
長期実行ユニット テスト --test-for-minutes および --test-f r-hours を有効にします
指定した NAME と一致するテストのみ実行されます。
最後にエラーを報告する代わりに、各テストに対してハード アサートを実行します。
ユニット テストでディスクへの接触を許可します。
ユニット テストでネットワークの使用を許可します。
ファイル サーバからストリーミングしたデータを使用してエンジンを実行します。エンジンは指定した IP アドレスでファイル サーバに接触し、その --data-dir または --bundle-dir からプロジェクトをストリーミングします。
複数のサーバに接続する場合は、IP のカンマ区切りリストを使用できます。
複数のホストに引数を指定して、複数のアドレスでファイル サーバを探すことができます。これは、ファイル サーバが複数のネットワーク カードを搭載したマシンである場合に役立ちます。
任意のクライアントがアセット サーバに接続できないようにするセキュリティ オプションです。サーバに接続できるようにするには、クライアントが同じ --secret 引数で開始する必要があります。さらに、アクセスできるのは、.stingray-asset-server-directory というファイルを含むディレクトリのみです。.stingray-asset-server-directory ファイルの内容は重要ではありません。
モバイル デバイスでは、エンジンは WiFi 経由でのストリーミングを高速化するために、提供されたファイルをローカルにキャッシュします。何らかの理由でそのキャッシュを無効にする場合は、このパラメータを使用できます。
このパラメータを使用して、ファイル キャッシュに既定以外のディレクトリを指定できます。これを使用して、モバイル以外のプラットフォームでファイルのキャッシングを有効にすることもできます。
この引数を使用すると、ローカル ファイル キャッシュのすべてのファイルがクリアされます。
この引数を使用すると、すべてのストリーミング リソースはエンジンの起動時に接触されるため、後で再生するときに停止しないように、ローカルにキャッシュされます。
この引数が使用されている場合、ファイル サーバのすべてのコンテンツは、後でファイル サーバに接続しなくてもエンジンを実行できるように、指定されたディレクトリにローカルにインストールされます。
--install-dir 引数と同じですが、ユーザ指定ディレクトリではなくインストール用の既定のディレクトリを使用します。IOS でのみ使用できます。
アセット サーバ モードで起動するように、エンジンに指示します。このモードでは、エンジンはポート 14032 でデータをコンパイルする要求をリッスンして、この要求に応えます。
このパラメータが使用される場合、エンジンはまず settings.ini(または --ini パラメータで指定されたもの)から設定をロードし、次に --editor-ini で指定されたファイルから設定をロードし、これを使用して settings.ini から設定をオーバーライドします。
これは通常、エディタ モードでエンジンを開始するために使用されます。
エンジンをポンプ モードにします。この場合、明示的に指示された場合を除いて(TCP/IP 接続経由で)、新しいフレームには移動しません。
実行される複数のアプリケーションのコピーを区別するために、Application.session_id () でクエリーできる整数を設定します。
Android で実行可能ファイルに情報を渡すために、Java レイヤで使用される内部パラメータです。
自動ウィンドウ作成を無効にし、ウィンドウ作成をゲームプレイ レイヤの責任にします
ビューポート プロバイダ モードで起動するように、エンジンに指示します。このモードでは、エンジンは独自のウィンドウを作成しません。
エンジンのメイン ウィンドウの寸法を指定します。
エンジンは親プロセスのコンソールに自動的にはアタッチしません
エンジンのメイン ウィンドウを、指定したウィンドウの子ウィンドウとして作成するよう指定します。(Windows のみ。)
エンジンでの Raw WM_INPUT メッセージの使用を無効にします。