PLUGIN Eventリスト

このページでは、ベースウェアからプラグインに対して通知されるイベントについてまとめています。

PLUGIN/2.0の通信仕様そのものについて等は、PLUGIN/2.0のページにあります。

[NOTIFY]の表示があるイベントは、必ずNOTIFYコマンドで通知されます。
NOTIFYコマンドで通知されたイベントにスクリプトを返却しても一切無視されます。

特に表示がないイベントは、状況によってNOTIFY、GETのいずれでも通知される可能性があります。

PLUGIN Event

version

プラグインのロード直後に発生。
プラグインはこのイベントに対し、Valueヘッダでプラグインのバージョン情報を返却する。
Charsetヘッダで文字コードを指定すると、以後のリクエストに用いる文字コードを指定可能(規定値Shift_JIS)。
他のイベントとレスポンス形式が異なる事に注意。

  • SSP
installedplugin

インストール済プラグインを列挙して通知。[NOTIFY]

Reference*
バイト値1区切りで、プラグイン名,プラグインID
  • SSP
ghostpathlist

読み込んでいるゴーストフォルダのパス。[NOTIFY]

Reference*
読み込んでいるゴーストフォルダのフルパス。
複数フォルダが指定されている場合Reference1以降もありうる。
  • SSP
balloonpathlist

読み込んでいるバルーンフォルダのパス。[NOTIFY]

Reference0
読み込んでいるバルーンフォルダのフルパス。
  • SSP
headlinepathlist

読み込んでいるヘッドラインフォルダのパス。[NOTIFY]

Reference*
読み込んでいるヘッドラインフォルダのフルパス。
  • SSP
pluginpathlist

読み込んでいるプラグインフォルダのパス。[NOTIFY]

Reference*
読み込んでいるプラグインフォルダのフルパス。
  • SSP
OnSecondChange

秒経過で発生。
何秒ごとに通知されるかは、descript.txtのsecondchangeintervalで設定可能。

  • SSP
OnGhostBoot

ゴースト起動時に発生。

Reference0
バイト値1区切りで、起動したゴーストの\0以降各キャラクターウィンドウのHWND。
未構築の場合等、0が入る場合がある。
Reference1
起動したゴースト名。
Reference2
起動したゴーストの現在のシェル名。
Reference3
起動したゴーストのID (Owned SSTPで送られるものと同じ)。
Reference4
起動したゴーストのフルパス。
  • SSP
OnGhostExit

ゴースト終了時に発生。[NOTIFY]

Reference0
バイト値1区切りで、終了したゴーストの\0以降各キャラクターウィンドウのHWND。
未構築の場合等、0が入る場合がある。
Reference1
終了したゴースト名。
Reference2
終了したゴーストの現在のシェル名。
Reference3
終了したゴーストのID (Owned SSTPで送られるものと同じ)。
Reference4
終了したゴーストのフルパス。
  • SSP
OnGhostInfoUpdate

ゴーストの情報が変更されたときに発生。
ロード時にも発生する事がある。[NOTIFY]

Reference0
バイト値1区切りで、変更があったゴーストの\0以降各キャラクターウィンドウのHWND。
未構築の場合等、0が入る場合がある。
Reference1
変更があったゴースト名。
Reference2
変更があったゴーストの現在のシェル名。
Reference3
変更があったゴーストのID (Owned SSTPで送られるものと同じ)。
Reference4
変更があったゴーストのフルパス。
  • SSP
OnMenuExec

オーナードローメニューからプラグインが実行された際に発生。
何らかのリアクション推奨。

Reference0
バイト値1区切りで、プラグインを呼び出したゴーストの\0以降各キャラクターウィンドウのHWND。
未構築の場合等、0が入る場合がある。
Reference1
プラグインを呼び出したゴースト名。
Reference2
プラグインを呼び出したゴーストの現在のシェル名。
Reference3
プラグインを呼び出したゴーストのID (Owned SSTPで送られるものと同じ)。
Reference4
プラグインを呼び出したゴーストのフルパス。
  • SSP
OnInstallComplete

何かのインストールが完了した際に発生。

Reference0
バイト値1区切りで、インストールタイプ。
Reference1
バイト値1区切りで、インストールされたものの名前。
Reference2
バイト値1区切りで、インストールされたもののフルパス。
  • SSP
OnChoiceSelect(Ex)/OnAnchorSelect(Ex)/\q等に指定された任意名イベント

選択肢・アンカー選択時に発生するSHIORI Eventのプラグイン側フック。
プラグインがゴーストに送信したスクリプトおよび、プラグインがゴーストに通知したイベントに対してゴーストから返信されたスクリプトに、選択肢・アンカー系のさくらスクリプトタグが含まれる場合、その一回に限って選択肢・アンカー選択時にSHIORI側に通知されるのと同じイベントが、プラグイン側にも横流し通知される。

Reference*
発生した選択肢・アンカー系SHIORI EventのReference。
  • SSP
\![raiseplugin]および\![notifyplugin]に指定された任意名イベント

\![raiseplugin]および\![notifyplugin]の実行で発生。
\![notifyplugin]の場合は[NOTIFY]

Reference*
指定された任意の引数。
  • SSP