\aなどによる会話が求められた際に発生。
\aなどによる会話が求められた際に発生。
SSTP以外でブレイクされた際に発生。
SSTP以外でスクリプトをブレークされた際に発生します。補足
Reference1の送信はSSP 1.11系からです。パラメータ
Reference0 ブレークされたスクリプト Reference1 どちら側のバルーンからブレーク操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...)
バルーン切替
バルーンが切替られたときに発生するイベントです。 バルーンの切替は瞬時に処理されるので、Changing/Changedの2段構えではなく、OnBalloonChangeという名前となっています。補足
1.10.04からの実装です。 ※その前から試験実装されていましたが、Reference1のパスは通知していません。パラメータ
Reference0 バルーンの名前 Reference1 バルーンのパス （相対パスか絶対パスかは処理系依存 SSPは絶対パス）
バルーンがタイムアウトせずに閉じられた
タイムアウトせず、ユーザがクリックすることでバルーンを閉じた場合に発生します。パラメータ
Reference0 再生中だったスクリプト
選択肢以外でバルーンがタイムアウトした際に発生。
選択肢以外でバルーンがタイムアウトした際に発生。パラメータ
Reference0 スクリプト。
バッテリ残量が非常に少なくなった際に発生。
バッテリ残量が非常に少なくなってきた際に発生します。 通知されるタイミングはWindowsの電源管理の設定に依存します。補足
電源状態が変化した際以外に、ゴースト起動時にNOTIFY（喋らない）で必要に応じて別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。パラメータ
Reference0 バッテリ残量の割合(％) 検出できなかった場合は-1 Reference1 バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1 Reference2 電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源
バッテリ残量が少なくなった際に発生。
バッテリ残量が少なくなってきた際に発生します。 通知されるタイミングはWindowsの電源管理の設定に依存します。補足
電源状態が変化した際以外に、ゴースト起動時にNOTIFY（喋らない）で必要に応じて別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。パラメータ
Reference0 バッテリ残量の割合(％) 検出できなかった場合は-1 Reference1 バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1 Reference2 電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源
バッテリ状態の通知
バッテリの残量やAC電源／バッテリの切り替えなど、電源の状態が変わった際に通知されるイベントです。これを利用することにより、バッテリが満充電になった際にメッセージを表示するなどの機能が可能となります。補足
バッテリがない機械では一切通知されません。 Windows NT4ではサポートされていません。 電源状態が変化した際以外に、ゴースト起動時にNOTIFY（喋らない）で別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。パラメータ
Reference0 バッテリ残量の割合(％) 検出できなかった場合は-1 Reference1 バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1 Reference2 電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源
ゴーストキャッシュから出た際に発生。
ゴーストキャッシュから出た際に発生。補足
SSPは設定を変えない限り、常にゴースト終了後も再度立ち上げる際に備えてゴーストを読み込んだままにしています。 終了時に必ず何かの処理を行う必要がある場合、このイベントにも対応する必要があります。
ゴーストキャッシュに入った際に発生。
ゴーストキャッシュに入った際に発生。
ゴースト終了
SHIORIが開放される直前に通知されます。 このイベント内でゴースト内部の処理の後始末を行うとよいでしょう。補足
このイベントはNotifyイベントです。 スクリプトを返しても再生されません。
着せ替え変更通知
着せ替え設定が変更されたことを通知します。補足
このイベントは切り替え時に複数Notifyされる可能性があります。 先に着せ替えグループなどの関係で自動的にON/OFFされる通知が入った後に、最後にユーザが操作したものが通知されます。パラメータ
Reference0 キャラクターウィンドウID (0=Sakura 1=Kero 2...) Reference1 着せ替え要素定義の名前 Reference2 0=OFF 1=ON
SSP起動時、先にmateria.exeが起動されていた際に発生。
SSP起動時、先にmateria.exeが起動されていた際に発生。
ゴースト起動
SHIORIが読み込まれた直後に通知されます。 このイベント内でゴースト内部の処理の初期化を行うとよいでしょう。補足
このイベントはNotifyイベントです。 スクリプトを返しても再生されません。
SSP起動時、先に猫どりふが起動されていた際に発生。
SSP起動時、先に猫どりふが起動されていた際に発生。
ネットワーク接続状態の変化通知
接続/切断など、ネットワーク接続状態が変わった際に発生します。補足
ゴースト起動直後の1発目の通知はNOTIFYで、その後はGETとなる点に注意してください。パラメータ
Reference0 online または offline Reference1 現在居るマシンに割り当てられているIPアドレスのバイト値1区切りリスト
他ゴーストのトーク通知
\![set,otherghosttalk,true]で有効にすると、ほかのゴーストが喋った時にこのイベントが通知されるようになります。補足
SecurityLevelヘッダは、元のトークの状態が引き継がれます。パラメータ
Remote SSTP等で喋ったトークを引っ掛けた場合はこのイベントのSecurityLevelもremoteになります。
サンプル
Reference0 ゴースト名 Reference1 ゴーストのSakura名 Reference2 トーク状態。break(中断した),communicate(コミュ),remote(非ローカルSSTP由来) Reference3 イベントID。OnBootなどトークの原因となったイベント。SSTPなど非イベント由来はからっぽ Reference4 しゃべったスクリプト Reference5 イベントのReference群をバイト値1区切りで
GET SHIORI/3.0
ID: OnOtherGhostTalk
Reference0: Emily/Phase4
Reference1: Emily
Reference2: break,communicate
Reference3: OnCommunicate
Reference4: \h\s[4]なにいってるのかわからないよ…
Reference5: ほげほげ
SecurityLevel: local
スクリーンセーバーが終了した際に発生。
スクリーンセーバーが終了した際に発生。
スクリーンセーバーが起動した際に発生。
スクリーンセーバーが起動した際に発生。
サウンドが終了した際に発生。
サウンドが終了した際に発生。パラメータ
Reference0 再生ファイル名。
スタンバイ状態からの回復
スタンバイ状態から戻った時に通知されます。
スタンバイ状態へ
スタンバイ（スリープ）状態へとシステムが移行する時に通知されます。補足
このイベントにスクリプトを返しても実行されません。(NOTIFYイベント）
TeachBoxからの入力があった際に発生。
TeachBoxからの入力があった際に発生。パラメータ
Reference0 入力された言葉。 Reference1 Reference0に対して入力された言葉。
通知領域バルーンがクリックされた
\![set,trayballoon]パラメータ
で表示した通知領域バルーンがクリックして消された際に発生します。
Reference0 タイトル文字列 (--title指定) Reference1 表示テキスト (--text指定、改行は無視)
通知領域バルーンタイムアウト/閉じ
\![set,trayballoon]パラメータ
で表示した通知領域バルーンが、タイムアウトで自然に消えた、あるいは×ボタンで消された際に発生します。
Reference0 タイトル文字列 (--title指定) Reference1 表示テキスト (--text指定、改行は無視)
URL D&D時の通知
URLがキャラクターウィンドウにドラッグ＆ドロップされた際に通知されます。 これに対してスクリプトを返す(200)と、OnURLDropping -> Droppedという通常のダウンロード処理がキャンセルされます。ゴースト側でURLを独自に処理したい場合のみスクリプトを返してください。パラメータ
Reference0 URL Reference1 キャラクターウィンドウID (Sakura=0 Kero=1 2...) Reference2 ダウンロードするファイルのMIME
音楽演奏反応
SSTPプロトコル NOTIFY/1.1 仕様に従って、「Event:OnMusicPlay」が本体に送信された時に、発生するイベントです。補足
現在、この仕様によってSSTP送信するアプリケーションは、Winamp2用プラグインである「YunaSexyFont Plug-in 2000」(Version 7.9b21)のみです。 また、このプラグインでは、Reference0に、演奏開始した曲のタイトル(Winamp上での表記、デフォルトでは「(アーティスト名) - (曲名)」)が代入されてリクエストされます。パラメータ
Reference0 曲のデータ（タイトル）
サーバの応答無し
ドロップイベント(「OnURL〜」)、ネットワーク更新イベント、ヘッドラインセンスイベント、メールチェックイベント等で、サーバからデータをダウンロードする際に、一定時間相手サーバからの応答が無い時に発生します。補足
ＳＳＰでは、Reference0に、このままサーバからの応答が無い場合にタイムアウトエラーになるまでの時間(単位：秒)が入ります。パラメータ
サンプル
Reference0 タイムアウトエラーまでの時間(単位：秒)
GET SHIORI/3.0
Sender: crow
ID: OnNetworkHeavy
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]サーバーの応答がありません。\e
おすすめメニューのサイトクリック
右クリックメニューで現れる、「おすすめ」「ポータル」メニューの中からサイトを選んでクリックすると発生するイベントです。パラメータ
サンプル
Reference0 選択されたサイトの名称 Reference1 選択されたサイトのURL
GET SHIORI/3.0
Sender: crow
ID: OnRecommendsiteChoice
Reference0: CROW
Reference1: http://crow.aqrs.jp/
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]CROWのサイトをオープンします。\e
SSTPの特定IPからの受信禁止処理
ネットワークからのSSTPプロトコルSENDリクエストに対し、「ブラックリスティング」を指示した時に、このイベントが発生します。 このイベントが発生すると、最後にSENDリクエストを送信したIPアドレスがブラックリストファイルに記録され、以後、そのIPアドレスからのSENDリクエストが無視(読み上げられなくなる)されます。パラメータ
Reference0 最後に送信されたSSTP送信元の IP アドレス
SSTP受信中断
SSTPプロトコルのSENDによって受信したメッセージを読み上げている時に、バルーンをダブルクリックして、読み上げの中止を指示した時に発生するイベントです。補足
Reference1の送信はSSP 1.11系からです。パラメータ
Reference0 受信を中断されたスクリプト Reference1 どちら側のバルーンからブレーク操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...)
トランスレートイベント
このイベントは特殊で、各リクエストのあと実行すべきスクリプトがあった場合必ず発生します。補足
Reference0には直前のスクリプトが入ります。
もし、このスクリプトを変更する必要があった場合に変更して返すと、
そのスクリプトが実際に使われます。
MATERIAではバグで、\xタグを実行するともう一度このイベントが発生します。パラメータ
MATERIAで\xタグを使う場合、トランスレートを複数回実行しても大丈夫なように作る必要があります。
サンプル
Reference0 処理するべきスクリプト。
GET SHIORI/3.0
ID: OnTranslate
Reference0: \0\s[0]トランスレートします。\e
Sender: crow
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]トランスレートしました。\e
この場合、直前の何らかのイベントで”トランスレートします。”と返しています。
このイベントでトランスレートされるため、実際には”トランスレートしました。”と表示されます。
インストール開始
アーカイブがドラッグ＆ドロップされインストールが開始した時に発生します。サンプル
GET SHIORI/3.0
Sender: crow
ID: OnInstallBegin
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]インストール開始。\e
インストール完了
インストールがエラーを起こさずに完了した場合に発生するイベントです。補足
SSPでは、OnInstallCompleteEx -> OnInstallComplete の順で発生します。
OnInstallCompleteEx でスクリプトを返した場合、こちらは発生しません。
Reference0にはインストールした物の種別が入りますが、現在のところ以下のとおりです。パラメータ
install.txtに書かれる識別子と同じものが入ります。
shell：シェル
ghost：ゴースト
supplement：ゴースト用追加ファイル
balloon：バルーン
plugin：プラグイン
headline：ヘッドラインセンサ
ghost with balloon：バルーンつきゴースト
shell with balloon：バルーンつきシェル
calendar skin：カレンダースキン [SSPのみ]
calendar plugin：スケジュールセンサ [SSPのみ]
SSP 1.10.17以降、試験的にReferenceで送られる仕様を変更していましたが、互換性の問題が生じたため1.10.21で元に戻りました。より詳しい情報を取りたい場合はOnInstallCompleteExに対応してください。
サンプル
Reference0 インストールした物の種別 Reference1 インストールした物の名前 Reference2 "with balloon" など複数インストールする場合、2つめのインストールした物の名前
GET SHIORI/3.0
Sender: crow
ID: OnInstallComplete
Reference0: ghost with balloon
Reference1: さくら＆うにゅう
Reference2: さくらバルーン
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]インストール完了しました。\e
インストール完了(拡張)
インストールがエラーを起こさずに完了した場合に発生するイベントです。補足
互換を確保するため、このイベントを無視してスクリプトを返さない（200 OK以外）場合、続けてOnInstallCompleteが発生します。
Reference0にはインストールした物の種別が入りますが、現在のところ以下のとおりです。パラメータ
install.txtに書かれる識別子と同じものが入るとは限りません。特にwith balloonなどの場合は、サンプルにあるようにghost[1]balloonなどというふうにバイト値1区切りで渡されます。
shell：シェル
ghost：ゴースト
supplement：ゴースト用追加ファイル
balloon：バルーン
plugin：プラグイン
headline：ヘッドラインセンサ
calendar skin：カレンダースキン [SSPのみ]
calendar plugin：スケジュールセンサ [SSPのみ]
サンプル
Reference0 インストールした物の種別（複数ある場合はバイト値1区切り） Reference1 インストールした物の名前（複数ある場合はバイト値1区切り） Reference2 インストールした場所（複数ある場合はバイト値1区切り）
GET SHIORI/3.0
Sender: SSP
ID: OnInstallCompleteEx
Reference0: ghost[1]balloon[1]headline
Reference1: Emily/Phase4[1]エミリ専用バルーン[1]SSP BUGTRAQヘッドライン
Reference2: C:\SSP\ghost\emily4\[1]C:\SSP\balloon\emily4\[1]C:\SSP\headline\bugtraq\
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]インストール完了しました。\e
インストール失敗
インストールが何らかの理由で失敗した場合に発生するイベントです。補足
失敗した場合、Reference0に失敗の理由が入ります。
unlha32 unlha32ロード失敗
extraction 解凍失敗（アーカイブが破損）
invalid type install.txtが不正
artificial ユーザが手動中断
unsupported その他サポートしていないアーカイブをインストールしようとした
MATERIAでは、Reference0には何も返りません。パラメータ
SSPのみ中断時にReference0でartificialの通知を返します。
サンプル
Reference0 失敗の理由(unlha32/extraction/invalid type/artificial/unsupported)
GET SHIORI/3.0
Sender: crow
ID: OnInstallFailure
Reference0: invalid type
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]インストール失敗しました。\e
インストール拒否
インストールしようとしたアーカイブが、ドロップされたゴーストと別のゴーストを指名していた場合に発生するイベントです。パラメータ
サンプル
Reference0 指名されているゴーストの名前
GET SHIORI/3.0
Sender: crow
ID: OnInstallRefuse
Reference0: さくら
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]このゴーストにはインストールできません。\e
キーを押した
キーボードのキーが押された時に発生します。補足
特殊キーの識別子一覧です。パラメータ
back tab clear return control pause escape space prior next end home
left up right down delete f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12
サンプル
Reference0 押されたキーの識別子 Reference1 キーコード Reference2 キーを押したままの時の繰り返し回数（SSPのみ） Reference3 キーイベントが来たキャラクターウインドウID（SSPのみ）
GET SHIORI/3.0
Sender: crow
ID: OnKeyPress
Reference0: a
Reference1: 65
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]Ａが押されました。\e
サーフィス変化
サーフィスが変化したときに呼ばれるイベントです。補足
変化したサーフィス番号が渡されます。
表示されていなければ、-1が入ります。
サイレントイベントなので、応答は無視されます。パラメータ
また、SSPではNOTIFYイベントとして発生します。
SSPではReference2に、\p[2]以降用対応のための拡張情報が入ります。
Reference3,4...と増えていくのではなく、ID,サーフィス番号,幅,高さ という形式でReference2のみ追加される点に注意してください。
この拡張情報は0番(メイン側)、1番(サブ側)が切り替わった場合でも常に通知されますので、Reference2が存在すればその情報を常に利用すると良いでしょう。
サンプル
Reference0 メイン側キャラのサーフィス番号 Reference1 サブ側キャラのサーフィス番号 Reference2 キャラID,サーフィス番号,サーフィス幅,サーフィス高さ [SSP]
GET SHIORI/3.0
Sender: crow
ID: OnSurfaceChange
Reference0: 0
Reference1: 10
SecurityLevel: local
Charset: Shift_JIS
NOTIFY SHIORI/3.0
Sender: SSP
ID: OnSurfaceChange
Reference0: 0
Reference1: 10
Reference2: 2,200,150,300
SecurityLevel: local
Charset: UTF-8
サーフィス復帰指示
サーフィスが変化した後、一定時間で呼び出されるイベントです。補足
このイベントに応答することにより、初期サーフィスに戻すことができますが、
戻すかどうかは各ゴーストに任されています。
また、このイベントはメイン側がサーフィス0でサブ側がサーフィス10の場合は発生しません。
それ以外に変化したときのみ呼ばれます。
CROWでは、変化後50秒経過後に呼ばれます。パラメータ
サンプル
Reference0 メイン側キャラのサーフィス番号 Reference1 サブ側キャラのサーフィス番号
GET SHIORI/3.0
Sender: crow
ID: OnSurfaceRestore
Reference0: 1
Reference1: 10
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]\1\s[10]\e
ファイル・フォルダドロップ開始
ファイルやフォルダがドラッグ＆ドロップされた際に発生するイベントです。補足
過去互換用です。OnFileDrop2/Exなどを利用してください。パラメータ
また、別途互換用にOnFileDroppedも送られてきますがこちらも利用非推奨です。
Reference0 ドロップされたファイル又はドロップされたフォルダ Reference1 メインキャラ側なら0、サブキャラ側なら1、以下２・３…
旧仕様のため使用非推奨
ファイル・フォルダドロップ開始
ファイルやフォルダがドラッグ＆ドロップされた際に発生するイベントです。補足
複数のファイルやフォルダが同時にドロップされた場合は、バイト値 1 でセパレートされます。
Reference1にどのキャラにドラッグされたという情報が入ります。
このイベントをエラーで返さない(「200 OK」とし、Valueを返した)場合、SHIORIモジュール側で判断・処理したものとみなし、以後の処理(現時点で該当するのはマスタイベント)を行ないません。パラメータ
MATERIA,CROWでは現在サブキャラ側にドラッグされてもイベントは発生しません。
サンプル
Reference0 ドロップされたファイル又はドロップされたフォルダ Reference1 メインキャラ側なら0、サブキャラ側なら1
GET SHIORI/3.0
Sender: crow
ID: OnFileDrop2
Reference0: C:\sample.pngC:\test.txt
Reference1: 0
SecurityLevel: local
Charset: Shift_JIS
この例では、メインキャラ側にsample.pngとtest.txtが同時にドラッグ＆ドロップされています。
ファイルドロップ開始
ファイルがドラッグ＆ドロップされた際に発生するイベントです。 複数のファイルが同時にドロップされた場合は、バイト値 1 でセパレートされます。 ＊補足 ドロップされたファイルがアーカイブ(NAR、ZIP、LZH)の場合、このイベントは発生せず、インストールイベントが発生します。パラメータ
Reference0 ドロップされたファイル
ファイルドロップ直前
ファイルやフォルダがドラッグ＆ドロップされる直前（マウスが重ねられた）際におきるイベントです。パラメータ
Reference0 ドロップされたファイル又はドロップされたフォルダ（1つめのみ） Reference1 メインキャラ側なら0、サブキャラ側なら1、以下2、3…
NARファイル作成完了
「OnNarCreating」イベントによるNARファイルの作成が完了すると、このイベントが発生します。パラメータ
Reference2 には、NARファイル化されたデータの種類として、
ghost ゴースト
shell シェル
balloon バルーン
plugin プラグイン
…が入ります。
サンプル
Reference0 install.txtに記述されたnameの値 Reference1 生成したnarのファイル名 Reference2 install.txtに記述された種別
GET SHIORI/3.0
Sender: crow
ID: OnNarCreated
Reference0: サンプルゴースト
Reference1: sample.nar
Reference2: ghost
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]nar作成完了。\e
この例は、フォルダsampleをドラッグ＆ドロップしたものです。
その時のinstall.txtの中身は
type,ghost
name,サンプルゴースト
directory,samplefolder
です。
NARファイル作成開始
ゴーストにインストール情報を記述したテキストファイル「install.txt」を含むフォルダをドラッグ＆ドロップした時に発生するイベントです。補足
この後、「install.txt」の情報を元に、NARファイルが作成され、「OnNarCreated」イベントが呼ばれます。
生成するnarのファイル名はドラッグしたフォルダの拡張子をnarに変更したものになります。パラメータ
ドラッグしたフォルダの直下にinstall.txtがある必要があります。
サンプル
Reference0 install.txtに記述されたnameの値 Reference1 生成するnarのファイル名 Reference2 install.txtに記述された種別
GET SHIORI/3.0
Sender: crow
ID: OnNarCreating
Reference0: サンプルゴースト
Reference1: sample.nar
Reference2: ghost
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]narを作成します。\e
この例は、フォルダsampleをドラッグ＆ドロップしたものです。
その時のinstall.txtの中身は
type,ghost
name,サンプルゴースト
directory,samplefolder
です。
テキストデータのドロップ
テキストデータをD&Dした時に発生します。補足
応答しない場合の標準動作は「SakuraScriptっぽいなら実行、それ以外は無視」です。パラメータ
Reference0 テキストデータそのもの 改行はバイト値1に置換 Reference1 キャラID(メイン=0、以下1,2...)
アップデート情報作成完成
「OnUpdatedataCreating」イベントによる「updates2.dau」ファイルへのアップデート情報の作成が完了すると、このイベントが発生します。パラメータ
サンプル
Reference0 今起動しているゴーストのメインキャラ側の名称
GET SHIORI/3.0
Sender: crow
ID: OnUpdatedataCreated
Reference0: さくら
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]updates2.dau作成完了\e
アップデート情報作成開始
ゴーストに「updates2.dau」ファイル(空のテキストファイル)及び、アップデート対象とするファイルを含むフォルダをドラッグ＆ドロップした時に、発生するイベントです。補足
この後、「updates2.dau」にアップデートファイルのMD5情報が作成されてから、「OnUpdatedataCreated」イベントが呼ばれます。
MATERIAでは、ファイルがドロップされるとまず「OnFileDrop2」イベントが呼ばれ、そのイベントに対してエラーで返されると、このイベントを呼ぶかを判断しています。パラメータ
(参照：「OnFileDrop2」イベント)
CROWでは、updates2.dauを含んでいれば、OnFileDrop2が発生せずにこのイベントが発生します。
サンプル
Reference0 今起動しているゴーストのメインキャラ側の名称
GET SHIORI/3.0
Sender: crow
ID: OnUpdatedataCreating
Reference0: さくら
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]updates2.dau作成開始\e
URLドロップ失敗
OnURLDroppingによって開始されたダウンロードが失敗した、もしくはユーザーがダウンロード中にバルーンをダブルクリックする事で中断を指示した場合に発生します。補足
このイベントが発生した場合、Reference0 はダウンロードされる予定だったファイルのローカルマシン上での絶対パス、Reference1 には、そのエラーの内容が入ります。
現在起こるエラーは
artifical ユーザーによる中断
timeout ファイルのダウンロード失敗
ダウンロードが失敗(もしくは中断)した時には、Reference0 で示されるパス上には、ファイルは存在しません(イベント発生時に削除される)。パラメータ
サンプル
Reference0 ダウンロードされる筈だったファイル（ローカルマシン上での絶対パス） Reference1 失敗の理由(artificial/timeout)
GET SHIORI/3.0
Sender: crow
ID: OnURLDropFailure
Reference0: C:\Crow\nar\sample.nar
Reference1: timeout
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]タイムアウトで失敗しました。\e
URLドロップ完了
「OnURLDropping」により発生したファイルのダウンロードが完了した時に発生します。補足
現在の MATERIA phase583 では、イベントは発生していますが、返した Value は処理されず破棄されているようです。(OnTrancelateが発生しないため、処理されない)パラメータ
また、このイベントの後、強制的に一連のインストールイベントに移行します。
サンプル
Reference0 ダウンロードしたファイルのローカルマシン上での絶対パス
GET SHIORI/3.0
Sender: crow
ID: OnURLDropped
Reference0: C:\Crow\nar\sample.nar
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ダウンロード完了しました。\e
URLドロップ開始
ブラウザ等からアーカイブのＵＲＬをドラッグ＆ドロップされた時に発生します。補足
イベントが発生するのは、URLがローカル(file://〜)でなく、インストール可能なアーカイブ(拡張子がNAR・ZIP・LZH)の時のみです。パラメータ
サンプル
Reference0 ドロップされたURL
GET SHIORI/3.0
Sender: crow
ID: OnURLDropping
Reference0: http://crow.aqrs.jp/sample.nar
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]http://crow.aqrs.jp/sample.narをダウンロードします。\e
壁紙設定
BMP、JPEGなど、OSの壁紙として設定できそうなファイルがドロップされた際に発生します。パラメータ
このイベントに応答すると、本体の壁紙変更機能が動作し、壁紙が変更されます。
Reference0 ドロップされたファイル Reference1 メインキャラ側なら0、サブキャラ側なら1、以下2、3…
ファイルダウンロード開始
ネットワーク更新中に、ファイルのダウンロードを開始する時に発生するイベントです。補足
Reference1と2は0から開始され、5個のファイルがあり、最初のファイルをダウンするときはパラメータ
Reference1は0、Reference2は4となります。
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOther.OnDownloadBeginが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 ファイル名 Reference1 今のファイルが全体の何番目か(0始まり） Reference2 更新するファイルの総数-1 Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdate.OnDownloadBegin
Reference0: descript.txt
Reference1: 0
Reference2: 1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]\1\descript.txtのダウンロード開始。\e
MD5の照合開始
ファイルをダウンロードした後、MD5を照合する前に発生するイベントです。補足
この後、MD5が一致すれば、OnUpdate.OnMD5CompareComplete
一致しなければ、OnUpdate.OnMD5CompareFailureが発生します。
Reference3はCROW / SSP 2.0以降の実装です。パラメータ
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOther.OnMD5CompareBeginが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 ファイル名 Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdate.OnMD5CompareBegin
Reference0: descript.txt
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]MD5照合開始。\e
MD5一致
ダウンロードしたファイルのMD5が一致した時に発生するイベントです。補足
Reference3はCROW / SSP 2.0以降の実装です。パラメータ
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOther.OnMD5CompareCompleteが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 ファイル名 Reference1 正しいMD5 Reference2 ダウンロードしたファイルのMD5 Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdate.OnMD5CompareComplete
Reference0: descript.txt
Reference1: 5cc07522bb987c722bbfc30ff9e832ac
Reference2: 5cc07522bb987c722bbfc30ff9e832ac
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]MD5一致。\e
MD5不一致
ダウンロードしたファイルのMD5が一致しなかった時に発生するイベントです。補足
Reference3はCROW / SSP 2.0以降の実装です。パラメータ
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOther.OnMD5CompareFailureが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 ファイル名 Reference1 正しいMD5 Reference2 ダウンロードしたファイルのMD5 Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdate.OnMD5CompareFailure
Reference0: readme.txt
Reference1: d83db404627e0a740d698d41f340a961
Reference2: 2d6f4e7a19a3e243daa6a623adef8390
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]MD5が一致しませんでした。\e
ネットワーク更新開始
ネットワーク更新が指示された直後に発生するイベントです。補足
この後、更新情報の取得を行います。
Reference3はCROW / SSP 2.0以降の実装です。パラメータ
Reference0,1はSSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOtherBeginが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 名前(descriptのnameエントリ) Reference1 更新対象のディレクトリへのパス Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdateBegin
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ネットワーク更新開始。\e
ネットワーク更新チェック完了
\![updatebymyself,checkonly]パラメータ
タグを実行した際に、チェックが正常終了した後で発生するイベントです。
何らかの理由で失敗した場合は、このイベントは呼ばれず、OnUpdateCheckFailureが呼ばれます。
更新するファイルがなかった場合は、Reference0にnoneが返ります。
Reference0 状態（changed/none) Reference1 カンマで区切られた更新ファイル名のリスト Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
ネットワーク更新チェック失敗
\![updatebymyself,checkonly]補足
タグで実行した更新チェックが、何らかの理由で失敗した際に呼ばれるイベントです。
エラー内容を示すReference0は、OnUpdateFailureと同じです。パラメータ
詳しいリストについてはそちらをご覧下さい。
Reference0 エラー内容(timeout/md5 miss/404等) Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
ネットワーク更新完了
ネットワーク更新で、すべてのファイルをダウンしインストールが完了された後に呼び出されるイベントです。補足
何らかの理由で失敗した場合は、このイベントは呼ばれず、OnUpdateFailureが呼ばれます。
更新するファイルがなかった場合は、Reference0にnoneが返ります。
Materia仕様書にはnoneのみ規定されているので、もし更新の有無で喋り内容を変えたい場合は、Reference0がnoneかnoneでないかを判別するように処理することをおすすめします。パラメータ
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOtherCompleteが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 状態（changed/none) Reference1 カンマで区切られた更新ファイル名のリスト Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
更新ファイルがなかった場合
GET SHIORI/3.0
Sender: crow
ID: OnUpdateComplete
Reference0: none
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]更新ファイルなし。\e
更新を行った場合
GET SHIORI/3.0
Sender: crow
ID: OnUpdateComplete
Reference0: changed
Reference1: ghost/master/descript.txt,shell/master/surfaces.txt
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ネットワーク更新完了。
ネットワーク更新失敗
何らかの理由でネットワーク更新が失敗した場合に発生するイベントです。補足
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。
現在起こるエラーは
404 そのステータスコードで失敗。404以外の数値もあり。
timeout 転送タイムアウト
md5 miss MD5不一致
too slow 転送タイムアウト(MATERIA)
artificial バルーンダブルクリックでの手動中断
fileio ディスク容量不足等ファイルの書き込みに失敗(SSP)
readonly ゴーストディレクトリが書き込み禁止のため更新できない(SSP)
です。
MATERIAでは、このイベントが2回発生することがあるようです。パラメータ
その場合、2度目のReference0には200という値が入ることがあります。
Reference1はSSP 2.01.86以降の実装です。
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOtherFailureが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 エラー内容(timeout/md5 miss/404等) Reference1 エラーになったファイル名 ファイルが関係ない場合は空 Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdateFailure
Reference0: md5 miss
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]md5が一致せず、更新失敗しました。\e
ネットワーク更新準備完了
ネットワーク更新を開始し、実際に更新するファイルがあった場合に発生するイベントです。補足
更新するファイルがなかった場合はこのイベントは発生せず、OnUpdateCompleteが発生します。
Reference1はSSPのみの実装です。パラメータ
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、OnUpdateOtherReadyが発生します。
イベント名のみの変更で、他に違いはありません。
サンプル
Reference0 更新を行うファイルの数-1 Reference1 カンマで区切られた更新予定ファイルのリスト Reference3 タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)
GET SHIORI/3.0
Sender: crow
ID: OnUpdateReady
Reference0: 1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]更新ファイルが2つあります。\e
ヘッドラインセンス結果の読み上げ
ヘッドラインセンスにより情報が収拾・分析され、その結果が更新されていた場合、このイベントが発生します。補足
Reference2 にセットされるデータ(OnFind フェーズ)は、
「First」： 1ページ目(次ページが存在する)
「First and Last」：1ページ目(次ページは無く、この１ページのみの場合)
「Last」： 最終ページ
「Next」： 上記３項目に該当しないページ
となる。
また、このイベントが発生した後、空の識別子を選択(例「 \q[次のページへ,] 」)を指示すると、改ページが指定したものとみなされ、次ページのヘッドラインデータをもった「OnHeadlinesense.OnFind」イベントが発生する。
ヘッドラインデータは、さくらスクリプト形式であるが、MATERIA Phase583においては、パラメータ
データ中に「\-」(終了指示タグ)などが含まれてる事がある(データの抽出での問題)ため、そのままValueとして返すと、問題が発生する場合がある。
そのため、特に制御を意図するタグとして解釈・誤動作しないように整形する処理を施す必要がある。
サンプル
Reference0 対象サイト名 Reference1 対象URL Reference2 OnFind フェーズ Reference3 ヘッドラインデータ本体(さくらスクリプト断片)
GET SHIORI/3.0
Sender: crow
ID: OnHeadlinesense.OnFind
Reference0: CROW
Reference1: http://crow.aqrs.jp/
Reference2: First
Reference3: V0.4.0公開。\nリンクページ更新。\n
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]\b[2]CROW ヘッドライン。\nV0.4.0公開。\nリンクページ更新。\n\n\q[続きを読む,]\n\q[サイトを開く,http://crow.aqrs.jp/]\n\q[やめる,読み上げ中止]\e
ヘッドラインセンス開始
ヘッドラインセンスが指示された直後に発生するイベントです。補足
この後、サイト情報の取得・分析を行います。
MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、その時点で「200 OK」としてValue(内容は問わない)を返さないと、このゴーストにおいてヘッドラインセンス機能は使用不能と判断し、メニューから選択できなくなり、また、自動チェックも行われません。パラメータ
サンプル
Reference0 対象サイト名 Reference1 対象URL
GET SHIORI/3.0
Sender: crow
ID: OnHeadlinesenseBegin
Reference0: CROW
Reference1: http://crow.aqrs.jp/
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]「CROW」のヘッドラインを取得中します。\e
ヘッドラインセンス成功(更新無し)
ヘッドラインセンスは正常終了したが、更新が無かった場合に発生する。パラメータ
そのため、Reference0 は、必ず「no update」(更新無し)がセットされる。
サンプル
Reference0 成功事由 ( 「no update」固定)
GET SHIORI/3.0
Sender: crow
ID: OnHeadlinesenseComplete
Reference0: no update
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]更新なし。\e
ヘッドラインセンス失敗
何らかの理由でヘッドラインセンスが失敗した場合に発生するイベントです。パラメータ
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。
現在起こるエラーは
can't download ： ファイルが取れなかった
can't analyze ： 有効なヘッドライン情報を解析・取得できなかった
の2つです。
サンプル
Reference0 失敗事由 (説明参照)
GET SHIORI/3.0
Sender: crow
ID: OnHeadlinesenseFailure
Reference0: can't download
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ヘッドラインをダウンロードできませんでした。\e
GET SHIORI/3.0
Sender: crow
ID: OnHeadlinesenseFailure
Reference0: can't analyze
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]解析できませんでした。\e
RSS受信成功
RSSの受信に成功した場合に発生します。補足
Reference0にRSSのタイトル、Reference1にRSSフィードを提供しているWebページのURL(RSS自身ではない点に注意！)が渡されます。
更新があった場合のReferenceの数は可変です。Reference2から順に以下の書式で渡されます。
タイトル[1]URL[1]更新日時
[1]はバイト値1です。日付がない場合（タイトル[1]URL）もあります。
更新日時のフォーマットは以下の通りです。カンマ区切りです。
年,月,日,時,分,秒
今後の拡張は[1]でさらに区切って追加していく方法で行われますので、バイト値1で区切られた要素数をあらかじめ決め打ちして解析する方法は避けてください。パラメータ
要素数がからっぽのフィードの場合、Reference2以降は存在しません。
現在のところ、暫定仕様です。
Reference0 RSSのタイトル Reference1 RSSフィードを提供しているWebページのURL(RSS自身ではない点に注意！) Reference2 （これ以降、RSSのデータ - 説明参照）
マウスクリック
マウスがクリックされた時に発生するイベントです。補足
SHIORI/3.0仕様より Reference5 が加わり、右クリックを行なった場合もこのイベントが発生します。パラメータ
なお、右クリックでイベントが発生した時に、エラーで返さない(「200 OK」とし、Valueを返した)場合、メニュー表示(及びその動作に起因するイベント)が発生しません。
サンプル
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 常に0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 クリックされたボタン(0またはなし：左 / 1：右 / 2：中(Windowsやマウス依存))
判定のない場所を右クリックした例
GET SHIORI/3.0
Sender: crow
ID: OnMouseClick
Reference0: 79
Reference1: 305
Reference2: 0
Reference3: 0
Reference5: 1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
頭の部分を左クリックした例
GET SHIORI/3.0
Sender: crow
ID: OnMouseClick
Reference0: 116
Reference1: 71
Reference2: 0
Reference3: 0
Reference4: Head
Reference5: 0
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
マウス左ボタンダブルクリック
マウスの左ボタンをダブルクリックした時に発生するイベントです。補足
Reference5が来ない場合も考慮して処理してください。パラメータ
サンプル
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 常に0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 クリックされたボタン(0またはなし：左 / 1：右 / 2：中(Windowsやマウス依存))
GET SHIORI/3.0
Sender: crow
ID: OnMouseDoubleClick
Reference0: 91
Reference1: 58
Reference2: 0
Reference3: 0
Reference4: Head
Reference5: 0
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]頭をダブルクリックされました。\e
マウスドラッグ終了
ゴーストのウインドウをドラッグし終わった時に発生します。パラメータ
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウスドラッグ開始
ゴーストのウインドウをドラッグし始めた時に発生します。パラメータ
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウスが当たり判定内に入った
マウスが特定の当たり判定領域に入ったことを示します。パラメータ
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウスがウインドウ内に入った
マウスがキャラクターのウインドウ内に入ったことを示します。パラメータ
当たり判定は考慮せず、単純にウインドウ内に入ったかどうかで通知されます。
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウスが当たり判定外に出た
マウスが特定の当たり判定領域から出たことを示します。パラメータ
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウスがウインドウから出た
マウスがキャラクターのウインドウ内から出たことを示します。パラメータ
当たり判定は考慮せず、単純にウインドウ内に入ったかどうかで通知されます。
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 0 Reference3 スコープ番号 Reference4 当たり判定識別子 Reference5 0
マウス移動
サーフィス上で、マウスが移動した時に発生するイベントです。パラメータ
サンプル
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 常に0 Reference3 スコープ番号 Reference4 当たり判定識別子
GET SHIORI/3.0
Sender: crow
ID: OnMouseMove
Reference0: 107
Reference1: 61
Reference2: 0
Reference3: 0
Reference4: Head
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
マウスホイール回転
マウスのホイールが回転した時に発生するイベントです。補足
あくまでも参考程度ですが、現在のところ、回転量は1ノッチ（1回かちんと動く量）あたり+-120を示します。ノッチがないマウス等では変わってきます。パラメータ
サンプル
Reference0 マウスカーソルの x 座標（ローカル座標） Reference1 マウスカーソルの y 座標（ローカル座標） Reference2 マウスホイールの回転量および回転方向 (上が＋、下が−） Reference3 スコープ番号 Reference4 当たり判定識別子
GET SHIORI/3.0
Sender: crow
ID: OnMouseWheel
Reference0: 76
Reference1: 199
Reference2: 120
Reference3: 0
Reference4: Face
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
新着メール通知
MATERIAの設定で「新着のみ通知」とした時に、メールチェックが終了した時に発生するイベントです。補足
なお、このイベントは、自動でメールチェックを行なった時に新着メールがない時には発生しません。
また、このイベントに対してエラーで返した場合、「OnBIFFComplete」イベントが発生します。
MATERIA Phase583では、Reference5・6は送られてきません。パラメータ
また、Reference3は、前回チェック時とのメール総数の増減を示すため、例えば、
メールチェックで2通を確認(2通)→メール受信(0通)→新着メール到着(1通)
という状態でこのイベントが発生すると、-1となります。
また、本体側の設定により、Reference4〜6は送られてこない場合があります。
Reference0 スプールされているメールの通数 Reference1 スプールされているメールのバイト数 Reference2 チェックするサーバ名 Reference3 前回チェック時より増減したメールの通数 Reference4 個々のメールのヘッダー部分 Reference5 個々のメールのサイズ Reference6 個々のメールのuidl
メールチェック開始
メールチェックイベントが指示された直後に発生するイベントです。補足
この後、メールサーバから情報の取得を行います。
MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、その時点で「200 OK」としてValue(内容は問わない)を返さないと、このゴーストにおいてメールチェック機能は使用不能と判断し、メニューから選択できなくなり、また、自動でのメールチェックも行われません。パラメータ
（但し、MATERIA 583 においては、このチェックリクエストは発生していません）
サンプル
Reference2 チェックするサーバ名(SSP,CROWでは、アカウント名)
GET SHIORI/3.0
Sender: crow
ID: OnBIFFBegin
Reference2: mail1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]メールチェック開始。\e
メールチェック成功
メールチェックが成功した時に、呼び出されるイベントです。補足
Reference4 は、個々のメールのヘッダ部分が、改行をバイト値 1、メールの区切りをバイト値２で区切った形式で送られてきます。
Reference5 は、個々のメールのサイズが、「(メールの通数目) (サイズ)」をバイト値１で区切った形式で送られてきます。
Reference6 は、個々のメールのuidl(個々のメールを識別するID)が、バイト値１で区切った形式で送られてきます。
[SSP拡張]
Reference7に、個々のメールの概要が、バイト値１で区切った形式で送られてきます。
今のところ送信者とタイトルをつなげたものですが、今後変更される、またユーザーの設定で変更できるようにする可能性があります。
MATERIA Phase583では、Reference3・5・6は送られてきません。パラメータ
SSPでは、Reference4のヘッダ情報は、「Message-ID:」「From:」「Subject:」「Date:」「X-Priority:」「X-MSMail-Priority:」「X-Mailer:」「X-MimeOLE:」のみが送られてきます。
また、Reference3ですが、メールをuidl等から判別し、増加した数のみを通知します。
また、本体側の設定により、Reference4〜7は送られてこない場合があります。
サンプル
Reference0 スプールされているメールの通数 Reference1 スプールされているメールのバイト数 Reference2 チェックするサーバ名(SSP,CROWでは、アカウント名) Reference3 前回チェック時より増加したメールの通数(SSPのみ) Reference4 個々のメールのヘッダー部分 Reference5 個々のメールのサイズ Reference6 個々のメールのuidl Reference7 [SSP]個々のメールの概要