このリファレンスには、Stingray エンジンで公開されているネイティブの C プラグイン API に対する参照可能なガイドが含まれています。これらの API を使用して、エンジンが提供するサービスにアクセスすることができます。
エンジン プラグインの記述に関する背景情報、およびこのリファレンスでの API の使用方法の概要については、SDK ヘルプを参照してください。
このリファレンス内のマテリアルは、主に次のカテゴリに分類されます。
PluginApi 構造体は、エンジンにフックするためにプラグインが実装する必要があるメイン インタフェースを表します。エンジンは PluginApi 内で関数を呼び出すときに、エンジンが提供する他のサービスにアクセスする際にプラグインが使用できる GetApiFunction を渡します。これらのエンジン サービスのリストについては、PluginApiID 列挙を参照してください。
通常、これらのサービス API の名前の末尾には Api が付いています。たとえば、RenderBufferApi、AllocatorApi、FileSystemApi、FlowNodesApi などです。
プラグインが要求できるエンジン サービス API の 1 つは ScriptApi です。プラグインは、Lua を使用して実行中のプロジェクトと相互作用する場合と同じように、C を使用して実行中のプロジェクトと相互作用できるようになります。ScriptApi を使用すると、ゲームのワールド、レベル、ユニット、エンティティ、物理アクターなどを管理する関数にアクセスできます。
このゲームプレイ API を構成する構造体の名前の末尾には、通常は CApi が付きます。たとえば、WorldCApi、ApplicationCApi、UnitCApi などです。
これは、ゲームのプログラミングで使用される一般的なタイプのオブジェクトおよびデータ構造を処理するためのオプションのヘルパー セットです。この基本的な API は、ユーザに便利な環境を適用し、ベクトルおよび行列、メモリ バッファ、ハッシュ、および文字列を簡単に処理できるようにすることを目的としています。これらのヘルパーは plugin_foundation フォルダ内にあり、すべてのメンバーは stingray_plugin_foundation ネームスペース内に集められています。