Stingray SDK とは、Stingray をカスタマイズおよび拡張するプラグインを作成するために使用できるプログラミング API および拡張機能のコレクションのことです。
この SDK は次の操作を実行する場合に使用します。
エディタに新しいコンテンツ編集ワークフローおよびツールを追加する。
Stingray ですぐに使用できない新しい種類のアート アセットを読み込む。
エディタまたはランタイム エンジンとサードパーティ製のライブラリ、アプリケーション、Web サービス、またはデータ ソースを統合する。
ゲーム中にプログラムを使用して新しいコンテンツを即座に生成する。
フローや Lua を使用しないで、C で独自のゲームプレイの相互作用コードを記述する。
その他。
お客様は Stingray SDK を使用して上記の種類のプラグインを作成できます。Stingray のソース コードにアクセスする必要はありません。(その他の理由によりソースにアクセスする場合は、アクセスできます。詳細については、ソース アクセスのヘルプを参照してください。)
時間を取って、Stingray の仕組みについて理解してください。Stingray を初めて使用する場合は、まずプロジェクトをいくつか作成し、Stingray 環境でコンテンツを作成することに慣れてから、プラグインを記述するようにします。
Stingray エコシステムのそれぞれの部分が、内部でどのように連携するのかについても理解する必要があります。これにより、プラグインに必要な機能とシステム全体への関連付けについて計画できるようになります。「システムの概要」および「Stingray の拡張方法」を参照してください。
サンプル プラグインを取得します。できるだけ多くの実際の作業用サンプルが必要になるため、オートデスクでは、エディタおよびエンジンをさまざまな方法で拡張する方法を示す一連のプラグインを具体的に作成する作業を行っています。
プラグイン用の新しいフォルダを作成します。プラグインで必要なすべてのファイルはここに配置します。
このフォルダ内に、プラグインを記述するための新しい .stingray_plugin ファイルを作成する必要があります。この記述ファイルには、プラグインに関するメタデータ、およびロードされたときにプラグインが何を行うかを定義する一連の「拡張機能」が含まれています。作業をすばやく開始するには、「Stingray プラグインを定義する」ページで最小限の記述をコピーするか、サンプル プラグインからコピーします。
ヒント: GitHub の stingray-plugin リポジトリから開始してください。このリポジトリには、移動して微調整できる .stingray_plugin サンプル ファイルなど、プラグインの基本的なフレームワークが格納されています。また、プラグイン ライブラリをコンパイルするのに必要なすべての作成ツールが用意されているため、エンジン、C または C + + のエディタを拡張する場合に特に便利です。
プラグインをエディタまたはエンジンにインストールし、ロードして、作業時にテストできるようにします。エディタの Plugin Manager を使用して .stingray_plugin ファイルを検索し、ロードする必要があります。
エディタにプラグインをインストールする方法の詳細については、このページを参照してください。
作業を開始してください。
エディタの拡張、エンジンの拡張、およびプロジェクト コンテンツの拡張に関するセクションでは、Stingray システムのさまざまな部分にフックするようプラグインを設定する方法が記載されています。
プラグインの作業中に、プラグインを再ロードして、最新の変更内容のテストおよび反復できるようにする必要が生じることがあります。「プラグインを再ロードする」を参照してください。
プラグインの準備ができたら、パッケージ化して、プラグインを使用する必要がある他のすべてのユーザに配布する必要があります。「プラグインの配布とインストール」を参照してください。