stingray.PluginManager ネームスペース リファレンス

説明

Stingray プラグ インシステムと対話するインタフェースです。

PluginManager はシングルトンで、クラスのインスタンスを作成せずに使用できます。

その他の関連リファレンス項目

Core

この参照ページは、次の概要トピックと関連付けられています

「リリース ノート > Stingray 1.7 リリース ノート」

関数

add_hot_reload_directory ( dir ) プラグイン DLL のホット リロードでモニタされるディレクトリを追加します。

パラメータ

dir :

string

新しい DLL をモニタするディレクトリです。

戻り値

この関数は値を返しません。

新しいプラグインが、既にロードされたプラグインの名前と一致する 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 はそのままになります。

loaded_plugins ( ) : string[] すべてのロードされたプラグインの名前のリストを返します。

パラメータ

この関数はパラメータを受け入れません。

戻り値

string[]

すべてのロードされたプラグインの名前のリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

load_plugin ( path ) : string? 指定されたパスからプラグインを動的にロードし、その名前を返します。

パラメータ

path :

string

ファイルへのパスです。

戻り値

string?

成功した場合は、ロードされたプラグインの名前を返し、それ以外の場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

そのようなファイルが存在しない場合、またはロードできない場合、この関数は nil を返します。

load_relative_plugin ( relative_path ) : string? 指定された相対パスからプラグインを動的にロードし、その名前を返します。

パラメータ

relative_path :

string

アプリケーションのプラグイン ディレクトリからプラグインへの相対パスです。

戻り値

string?

成功した場合は、ロードされたプラグインの名前を返し、それ以外の場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

そのようなファイルが存在しない場合、またはロードできない場合、この関数は nil を返します。

remove_hot_reload_directory ( dir ) add_hot_reload_directory() によって追加されたホット リロード ディレクトリを除去します。

パラメータ

dir :

string

新しい DLL でモニタされなくなったディレクトリです。

戻り値

この関数は値を返しません。

unload_plugin ( name ) 指定された名前を持つプラグインをロード解除します。

パラメータ

name :

string

プラグインの名前です。

戻り値

この関数は値を返しません。