1
0
mirror of synced 2024-12-11 07:16:00 +01:00
OpenTaiko/TJAPlayer3/Plugins/IPluginActivity.cs

77 lines
4.7 KiB
C#
Raw Normal View History

2021-09-21 00:16:38 +02:00
namespace TJAPlayer3
{
/// <summary>
/// <para>Activity プラグインへのインターフェース。</para>
/// <para>DTXMania は、IPluginActivity に対して、以下のライフサイクルを実行します。</para>
/// <para>(1) DTXMania の起動処理の最後セットアップ画面が表示される直前に一度だけ、On初期化()_OnManagedリソースの作成()_OnUnmanagedリソースの作成() をこの順番で1回ずつ呼び出します。</para>
/// <para>(2) DTXMania の終了処理の最初Thank you for playing が消えた直後に一度だけ、OnUnmanagedリソースの解放()_OnManagedリソースの解放()_On終了() をこの順番で1回ずつ呼び出します。</para>
/// <para>(3) DTXMania の起動中、すなわち(1)(2)の間は、どんなシーンであっても、常に On進行描画() を1フレームにつき1回ずつ呼び出します。</para>
/// <para>(4) Direct3D デバイスのリセット時には、デバイスのリセット前に OnUnmanagedリソースの解放() を1回呼び出し、デバイスをリセットしたのち、OnUnmanagedリソースの作成() を1回呼び出します。</para>
/// <para>(5) Direct3D デバイスのロスト時には、デバイスの再生成前に OnUnmanagedリソースの解放()_OnManagedリソースの解放() を1回ずつ呼び出し、デバイスを再生成したのち、OnManagedリソースの作成()_OnUnmanagedリソースの作成() を1回ずつ呼び出します。</para>
/// </summary>
public interface IPluginActivity
{
/// <summary>
/// <para>プラグインの初期化を行います。</para>
/// <para>DTXMania の起動処理の最後セットアップ画面が表示される直前に、DTXMania から一度だけ呼び出されます。</para>
/// <param name="PluginHost">プラグインが、ホストDTXManiaの情報にアクセスするためのオブジェクト。</param>
/// </summary>
void On初期化( global::TJAPlayer3.IPluginHost PluginHost );
/// <summary>
/// <para>プラグインの終了処理を行います。</para>
/// <para>DTXMania の終了処理の最初Thank you for playing が消えた直後に、DTXMania から一度だけ呼び出されます。</para>
/// </summary>
void On終了();
/// <summary>
/// Managed リソースを作成します。
/// </summary>
void OnManagedリソースの作成();
/// <summary>
/// Unmanaged リソースを作成します。
/// </summary>
void OnUnmanagedリソースの作成();
/// <summary>
/// Unmanaged リソースを解放します。
/// </summary>
void OnUnmanagedリソースの解放();
/// <summary>
/// Managed リソースを解放します。
/// </summary>
void OnManagedリソースの解放();
/// <summary>
/// <para>プラグインの進行と描画を行います。</para>
/// <para>※現在の DTXMania では、進行と描画は分離されていません。</para>
/// <para>※BeginScene()/EndScene() は DTXMania 側で行うため、プラグイン側では不要です。</para>
/// <para>※keyboard.tポーリング() は DTXMania 側で行いますのでプラグイン側では行わないで下さい。</para>
/// <param name="pad">パッド入力。他のプラグインが入力占有中である場合は null が渡されます。</param>
/// <param name="keyboard">キーボード入力。他のプラグインが入力占有中である場合は null が渡されます。</param>
/// </summary>
void On進行描画( global::TJAPlayer3.CPad pad, FDK.IInputDevice keyboard );
/// <summary>
/// <para>ステージが変わる度に呼び出されます。</para>
/// <para>呼び出しタイミングは、新しいステージの活性化直後かつ描画開始前です。</para>
/// </summary>
void Onステージ変更();
/// <summary>
/// <para>選曲画面で選択曲が変更された場合に呼び出されます。</para>
/// <para>同じ set.def に属する曲の難易度がHH×2で変更された場合でも呼び出されます。</para>
/// <para>ただし、選択が曲でないBOX, BACK, RANDOM など)場合には呼び出されません。</para>
/// </summary>
/// <param name="str選択曲ファイル名">選択されている曲のファイルの名前。絶対パス。</param>
/// <param name="n曲番号inブロック">選択されている曲のブロック内の曲番号(04)。</param>
void On選択曲変更( string str選択曲ファイル名, int n曲番号inブロック );
void On演奏クリア( global::TJAPlayer3.CScoreIni scoreIni );
void On演奏失敗( global::TJAPlayer3.CScoreIni scoreIni );
void On演奏キャンセル( global::TJAPlayer3.CScoreIni scoreIni );
}
}