SSP拡張イベント†
OnAITalk†
- \aなどによる会話が求められた際に発生。
- SSTP以外でブレイクされた際に発生。
- バルーン切替
- バルーンがタイムアウトせずに閉じられた
- 選択肢以外でバルーンがタイムアウトした際に発生。
- 解説
選択肢以外でバルーンがタイムアウトした際に発生。
- パラメータ
- バッテリ残量が非常に少なくなった際に発生。
- バッテリ残量が少なくなった際に発生。
- バッテリ状態の通知
- 解説
バッテリの残量やAC電源／バッテリの切り替えなど、電源の状態が変わった際に通知されるイベントです。
これを利用することにより、バッテリが満充電になった際にメッセージを表示するなどの機能が可能となります。
- 補足
バッテリがない機械では一切通知されません。 Windows NT4ではサポートされていません。
電源状態が変化した際以外に、ゴースト起動時にNOTIFY（喋らない）で別途通知されます。
ゴーストの内部状態を初期化する時などに使うと良いでしょう。
- パラメータ
| Reference0 | バッテリ残量の割合(％) 検出できなかった場合は-1 |
| Reference1 | バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1 |
| Reference2 | 電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源 |
- ゴーストキャッシュから出た際に発生。
- ゴーストキャッシュに入った際に発生。
- ゴースト終了
- 着せ替え変更通知
- SSP起動時、先にmateria.exeが起動されていた際に発生。
OnExecuteHTTPComplete†
- \![execute,http-get / post]でasyncオプションを指定して成功した際に発生。
- 解説
\![execute,http-get / post]でasyncオプションを指定して成功した際に発生。
- 補足
execute-httpを参照 http://emily.shillest.net/specwiki/index.php?SSP%2F%E4%BB%95%E6%A7%98%E6%9B%B8%2Fexecute-http
- パラメータ
| Reference0 | post/get |
| Reference1 | ASYNC IDで指定した文字列がそのまま入る |
| Reference2 | URLそのまま |
| Reference3 | 取得したファイルのフルパス |
| Reference4 | 取得結果コード ( timeout,fileio,200,204,403,404... ) |
| Reference5 | Set-Cookieでクッキーを受け取ったらその文字列（次回すぐ使えるよう加工済） |
OnExecuteHTTPFailure†
- \![execute,http-get / post]でasyncオプションを指定して失敗した際に発生。
- 解説
\![execute,http-get / post]でasyncオプションを指定して失敗した際に発生。
- 補足
execute-httpを参照 http://emily.shillest.net/specwiki/index.php?SSP%2F%E4%BB%95%E6%A7%98%E6%9B%B8%2Fexecute-http
- パラメータ
| Reference0 | post/get |
| Reference1 | ASYNC IDで指定した文字列がそのまま入る |
| Reference2 | URLそのまま |
| Reference3 | 取得したファイルのフルパス |
| Reference4 | 取得結果コード ( timeout,fileio,200,204,403,404... ) |
| Reference5 | Set-Cookieでクッキーを受け取ったらその文字列（次回すぐ使えるよう加工済） |
- ゴースト起動
- SSP起動時、先に猫どりふが起動されていた際に発生。
- ネットワーク接続状態の変化通知
- \![notifyother]での失敗通知
- \![notifyplugin]での失敗通知
- 解説
\![notifyplugin]での失敗通知
- 補足
SSP/2.01.29以降
- パラメータ
| Reference0 | notfound (見つからなかった) / disabled (無効設定中) / 204などPLUGINの実行結果 |
| Reference1 | 名前/ID - タグで指定したものと全く同じ |
| Reference2 | 実行しようとしたイベントID |
| Reference3以降 | 実行しようとしたイベントのReference0以降 |
- 他ゴーストのトーク通知
- 解説
\![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
- \![raiseother]での失敗通知
- \![raiseplugin]での失敗通知
- 解説
\![raiseplugin]での失敗通知
- 補足
SSP/2.01.29以降
- パラメータ
| Reference0 | notfound (見つからなかった) / disabled (無効設定中) / 204などPLUGINの実行結果 |
| Reference1 | 名前/ID - タグで指定したものと全く同じ |
| Reference2 | 実行しようとしたイベントID |
| Reference3以降 | 実行しようとしたイベントのReference0以降 |
- スクリーンセーバーが終了した際に発生。
- スクリーンセーバーが起動した際に発生。
- サウンドが終了した際に発生。
- スタンバイ状態からの回復
- スタンバイ状態へ
- TeachBoxからの入力があった際に発生。
- 解説
TeachBoxからの入力があった際に発生。
- パラメータ
| Reference0 | 入力された言葉。 |
| Reference1 | Reference0に対して入力された言葉。 |
- 通知領域バルーンがクリックされた
- 通知領域バルーンタイムアウト/閉じ
OnURLQuery†
- URL D&D時の通知
SSTPイベント†
- 音楽演奏反応
- 解説
SSTPプロトコル NOTIFY/1.1 仕様に従って、「Event:OnMusicPlay」が本体に送信された時に、
発生するイベントです。
- 補足
現在、この仕様によってSSTP送信するアプリケーションは、Winamp2用プラグインである
「YunaSexyFont Plug-in 2000」(Version 7.9b21)のみです。
また、このプラグインでは、Reference0に、演奏開始した曲のタイトル
(Winamp上での表記、デフォルトでは「(アーティスト名) - (曲名)」)が代入されてリクエストされます。
- パラメータ
その他のイベント†
- サーバの応答無し
- 解説
ドロップイベント(「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
OnSSTPBlacklisting†
- SSTPの特定IPからの受信禁止処理
OnSSTPBreak†
- SSTP受信中断
- トランスレートイベント
- 解説
このイベントは特殊で、各リクエストのあと実行すべきスクリプトがあった場合必ず発生します。
Reference0には直前のスクリプトが入ります。
もし、このスクリプトを変更する必要があった場合に変更して返すと、
そのスクリプトが実際に使われます。
- 補足
MATERIAではバグで、\xタグを実行するともう一度このイベントが発生します。
MATERIAで\xタグを使う場合、トランスレートを複数回実行しても大丈夫なように作る必要があります。
- パラメータ
- サンプル
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
この場合、直前の何らかのイベントで”トランスレートします。”と返しています。
このイベントでトランスレートされるため、実際には”トランスレートしました。”と表示されます。
インストールイベント†
- インストール完了
- 解説
インストールがエラーを起こさずに完了した場合に発生するイベントです。
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
- インストール拒否
- 解説
インストールしようとしたアーカイブが、
ドロップされたゴーストと別のゴーストを指名していた場合に発生するイベントです。
- パラメータ
- サンプル
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†
- ファイル・フォルダドロップ開始
- 解説
ファイルやフォルダがドラッグ＆ドロップされた際に発生するイベントです。
複数のファイルやフォルダが同時にドロップされた場合は、バイト値 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が同時にドラッグ＆ドロップされています。
- ファイルドロップ開始
- ファイルドロップ直前
- 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
です。
- テキストデータのドロップ
- アップデート情報作成完成
- 解説
「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
OnURLDropped†
- 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
OnURLDropping†
- URLドロップ開始
- 解説
ブラウザ等からアーカイブのＵＲＬをドラッグ＆ドロップされた時に発生します。
- 補足
イベントが発生するのは、URLがローカル(file://～)でなく、
インストール可能なアーカイブ(拡張子がNAR・ZIP・LZH)の時のみです。
- パラメータ
- サンプル
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
- 壁紙設定
ネットワーク更新イベント†
- ファイルダウンロード開始
- 解説
ネットワーク更新中に、ファイルのダウンロードを開始する時に発生するイベントです。
- 補足
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]
タグで実行した更新チェックが、何らかの理由で失敗した際に呼ばれるイベントです。
- 補足
エラー内容を示す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という値が入ることがあります。
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、
OnUpdateOtherFailureが発生します。
イベント名のみの変更で、他に違いはありません。
- パラメータ
| Reference0 | エラー内容(timeout/md5 miss/404等) |
| 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が発生します。
- 補足
Reference3はCROW / SSP 2.0以降の実装です。
SSPで、ゴーストと同時にバルーンやシェルも更新する機能が有効の場合、ゴースト以外の更新時には、
OnUpdateOtherReadyが発生します。
イベント名のみの変更で、他に違いはありません。
- パラメータ
| Reference0 | 更新を行うファイルの数-1 |
| 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つです。
- パラメータ
- サンプル
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
OnRSSComplete
- 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 | 当たり判定識別子 |
- サンプル
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
メールチェックイベント†
OnBIFF2Complete†
- 新着メール通知
- 解説
MATERIAの設定で「新着のみ通知」とした時に、メールチェックが終了した時に発生するイベントです。
なお、このイベントは、自動でメールチェックを行なった時に新着メールがない時には発生しません。
また、このイベントに対してエラーで返した場合、「OnBIFFComplete」イベントが発生します。
- 補足
MATERIA Phase583では、Reference5・6は送られてきません。
また、Reference3は、前回チェック時とのメール総数の増減を示すため、例えば、
メールチェックで2通を確認(2通)→メール受信(0通)→新着メール到着(1通)
という状態でこのイベントが発生すると、-1となります。
また、本体側の設定により、Reference4～6は送られてこない場合があります。
- パラメータ
| Reference0 | スプールされているメールの通数 |
| Reference1 | スプールされているメールのバイト数 |
| Reference2 | チェックするサーバ名 |
| Reference3 | 前回チェック時より増減したメールの通数 |
| Reference4 | 個々のメールのヘッダー部分 |
| Reference5 | 個々のメールのサイズ |
| Reference6 | 個々のメールのuidl |
OnBIFFBegin†
- メールチェック開始
- 解説
メールチェックイベントが指示された直後に発生するイベントです。
この後、メールサーバから情報の取得を行います。
- 補足
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
OnBIFFComplete†
- メールチェック成功
- 解説
メールチェックが成功した時に、呼び出されるイベントです。
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]個々のメールの概要 |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnBIFFComplete
Reference0: 1
Reference1: 1004
Reference2: mail1
Reference3: 1
Reference4: Return-Path: Received: from xxx.xxxx.ne.jp ([xxx.xxx.xxx.xxx])
by xxx.xxx.ne.jp (post.office MTA v1.9.3 ID# 0100110-37427) with ESMTP id AAA1696
for ; Sat, 5 Apr 2003 22:03:51 +0900
Received: from xxx.xxx.ne.jp (xxx.xxx.ne.jp [xxx.xxx.xxx.xxx])
by xxxx.xxxx.ne.jp (8.11.4/8.11.4) with ESMTP id h35D1BE14824
for ; Sat, 5 Apr 2003 22:01:11 +0900 (JST) (envelope-from xxxx@xxxx.jp)
Received: from [xxx.xxx.xxx.xxx] (xxxx.xxxx.ne.jp [xxx.xxx.xxx.xxx])
by xxxx.xxxx.ne.jp (8.9.3/8.9.3) with ESMTP id WAA20388
for ; Sat, 5 Apr 2003 22:03:42 +0900
Date: Sat, 05 Apr 2003 22:03:51 +0900
From: xxxx@xxxx.jp
To: xxxx@xxxx.jp
Subject: testmail
Message-Id: <20030405220343.5FE8.xxxx@xxxx.jp>
MIME-Version: 1.0
Content-Type: text/plain; charset="US-ASCII"
Content-Transfer-Encoding: 7bit
X-Mailer: Becky! ver. 2.05.10
Reference5: 1 1004
Reference6: 1 20030405130351851.AAA1696@xxxx.xxxx.ne.jp
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]メール1通届いています。\e
OnBIFFFailure†
- メールチェック失敗
- 解説
何らかの理由でメールチェックが失敗した場合に発生するイベントです。
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。
現在起こるエラーは
timeout：メールサーバから一定時間応答がない
kick ：メールサーバで認証に失敗した
defect ：本体でのメール設定の情報が不足している
です。
- パラメータ
| Reference0 | エラー内容(timeout/kick/defect） |
| Reference2 | チェックするサーバ名(SSP,CROWでは、アカウント名) |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnBIFFFailure
Reference0: defect
Reference2: mail1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]メールチェックに失敗しました。\e
外部アプリ-きのこイベント†
- きのこスキンを切り替えた際に発生。
- 解説
きのこスキンを切り替えた際に発生。
- パラメータ
| Reference0 | 切り替えた後のきのこの情報。 |
| Reference1 | 切り替えた後のきのこの情報。 |
| Reference2 | 切り替えた後のきのこの情報。 |
- きのこスキンを切り替えようとしている際に発生。
- 解説
きのこスキンを切り替えようとしている際に発生。
- パラメータ
| Reference0 | 切り替える直前のきのこの情報。 |
| Reference1 | 切り替える直前のきのこの情報。 |
| Reference2 | 切り替える直前のきのこの情報。 |
- きのこスキンが頭に生えた際に発生。
- 解説
きのこスキンが頭に生えた際に発生。
- パラメータ
| Reference0 | そのきのこの情報。 |
| Reference1 | そのきのこの情報。 |
| Reference2 | そのきのこの情報。 |
- きのこスキンが頭から消えた際に発生。Reference0
- きのこスキンをドロップでインストールした際に発生。
- システムリソースが20％を切った際に発生。
- システムリソースが40％を切った際に発生。
外部アプリ-猫どりふイベント†
- ヒットしなかった落下物が可視領域内から消滅した際に発生。
- 落下物を再投下する際に発生。
- 解説
落下物を再投下する際に発生。
- パラメータ
| Reference0 | 落下物の名前。 |
| Reference1 | 落下物の対象ゴースト名。 |
| Reference2 | 落下物のカテゴリ名。 |
| Reference3 | きのこフラグ。きのこにあった場合は1、そうでなければ0。 |
| Reference4 | 落下物のターゲット名。 |
- 落下物が可視領域内に出現した際に発生。
- 解説
落下物が可視領域内に出現した際に発生。
- パラメータ
| Reference0 | 落下物の名前。 |
| Reference1 | 落下物の対象ゴースト名。 |
| Reference2 | 落下物のカテゴリ名。 |
| Reference3 | きのこフラグ。きのこにあった場合は1、そうでなければ0。 |
| Reference4 | 落下物のターゲット名。 |
- 落下物がヒットした際に発生。
- 解説
落下物がヒットした際に発生。
- パラメータ
| Reference0 | 落下物の名前。 |
| Reference1 | 落下物の対象ゴースト名。 |
| Reference2 | 落下物のカテゴリ名。 |
| Reference3 | きのこフラグ。きのこにあった場合は1、そうでなければ0。 |
| Reference4 | 落下物のターゲット名。 |
- ヒットした落下物が可視領域内から消滅した際に発生。
外部アプリイベント†
- 外部アプリケーションが起動した際に発生。
- 解説
外部アプリケーションが起動した際に発生。
- パラメータ
| Reference0 | アプリケーション名。 |
| Reference1 | アプリケーションの情報。 |
- 外部アプリケーションが終了した際に発生。
- 解説
外部アプリケーションが終了した際に発生。
- パラメータ
| Reference0 | アプリケーション名。 |
| Reference1 | アプリケーションの情報。 |
- 外部アプリケーションの存在を通知された際に発生。
- 解説
外部アプリケーションの存在を通知された際に発生。
- パラメータ
| Reference0 | アプリケーション名。 |
| Reference1 | アプリケーションの情報。 |
- 外部アプリケーションがドキュメントファイルを開いた際に発生。
- 外部アプリケーションか何らかの処理が完了した際に発生。
- 外部アプリケーションのバージョン情報を通知された際に発生。
- ウェブサイトの更新・新着情報を通知された際に発生。
時間イベント†
時計合わせイベント†
OnSNTPBegin†
- 時計合わせ開始
- 解説
時計合わせイベントが指示された直後に発生するイベントです。
この後、SNTPサーバから情報の取得を行います。
- 補足
MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、
その時点で「200 OK」としてValue(内容は問わない)を返さないと、
このゴーストにおいて時計合わせ機能は使用不能と判断し、メニューから選択できなくなります。
（但し、MATERIA 583 においては、このチェックリクエストは発生していません）
- パラメータ
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnSNTPBegin
Reference0: time-nw.nist.gov
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]時計あわせ開始。\e
OnSNTPCompare†
- 時計合わせ情報取得
- 解説
SNTPサーバより情報の取得に成功した時に、呼び出されるイベントです。
Reference1,2 には、それぞれSNTPサーバとローカルマシンの時刻が、次の順番に、
半角カンマで区切られて代入されます。
(年),(月),(日),(時),(分),(秒),
- 補足
ＳＳＰでは、代入される時刻に、ミリ秒単位の項目が追加されて、
(年),(月),(日),(時),(分),(秒),(ミリ秒)
…と送られてきます。
- パラメータ
| Reference0 | 接続先のSNTPサーバ名 |
| Reference1 | カンマでセパレートされた正確な(SNTP サーバ側の)時刻 |
| Reference2 | カンマでセパレートされた現在の(自分のマシン側の)時刻 |
| Reference3 | SNTPサーバと自分のマシンとの時刻のずれ(秒,常に正) |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnSNTPCompare
Reference0: time-nw.nist.gov
Reference1: 2003,3,11,20,40,19,
Reference2: 2003,3,11,20,40,19,
Reference3: 0
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ぴったり合っています。\e
OnSNTPCorrect†
- 時計合わせ完了
- 解説
さくらスクリプトの「\6」タグ処理により、時計合わせが実際に行われた直後に呼び出されるイベントです。
- 補足
MATERIA 583 では、このイベントは発生しません。
また、Reference1はＳＳＰのみ発生し、それぞれSNTPサーバとローカルマシンの時刻が、
次の順番に、半角カンマで区切られて代入されます。
(年),(月),(日),(時),(分),(秒),(ミリ秒)
- パラメータ
| Reference0 | 接続先のSNTPサーバ名 |
| Reference1 | カンマでセパレートされた正確な(SNTP サーバ側の)時刻(SSPのみ) |
OnSNTPFailure†
- 時計合わせ情報取得失敗
消滅イベント†
- 他のゴーストが消えた
- 消滅指示後のキャンセル
- 解説
「OnVanishSelected」イベントにより本体へ送られたさくらスクリプトを再生中に、
バルーンをダブルクリックすると、消滅指示をキャンセルした(引きとめられた)ものとみなし、
このイベントが発生します。
- 補足
「OnVanishSelecting」イベント中に、本体をダブルクリックした際にも発生し、
そのときはこのイベントと同時に消滅確認ダイアログが表示されます。
ここで「はい」を選ぶと「OnVanishSelected」イベントが発生し、
その最中に本体をダブルクリックすると「OnMouseDoubleClick」が発生し消滅は取り消されます。
Reference0,1の送信はSSP 1.11系からです。
- パラメータ
| Reference0 | 中断されたスクリプト（存在すれば） |
| Reference1 | どちら側のバルーンから中断操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...) |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnVanishButtonHold
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示が、ダブルクリックにより中断されました。\e
- 消滅指示取り消し
- 解説
「OnVanishSelecting」イベントで表示された指示確認のダイアログボックスで
「指示を取り消す」旨の選択が行なわれた時に発生します。
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnVanishCancel
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示が取り消されました。\e
- ゴースト切り替え(前ゴースト消滅時)
- 解説
前のゴーストが、消滅指示イベント(または「 \![vanishbymyself] 」タグ実行)によって消滅した後に、
自分に切り替えられ、切り替え処理が完了後、
「OnGhostChanged」の代わりに一番最初に呼ばれるイベントです。
- 補足
このイベントに返答しない(204またはエラーを返した)場合、「OnGhostChanged」が発生します。
また、MATERIA Phase583 では、Reference0 は空データが送られてきます。
Reference1,2,7はSSP(1.10以降)でのみ利用できます。
- パラメータ
| Reference0 | 消されたゴーストの\0名(sakuraname) |
| Reference1 | 消されたゴーストのOnVanishSelectedイベントで喋ったスクリプト [SSP] |
| Reference2 | 消されたゴーストのフル名称(name) [SSP] |
| Reference7 | シェルの名前 [SSP] |
- 消滅指示実行
- 解説
「OnVanishSelecting」イベントで表示された指示確認のダイアログボックスで
「消滅」する旨の選択が行なわれた時に発生します。
このイベントで本体に返したスクリプトを実行し終えた瞬間に、消滅処理が行なわれ、
既にインストールされているゴーストに切り替わります。
- 補足
MATERIA においては「デフォルトであるさくらは消滅出来ない(指示しても拒否する)」
つまり「必ず切り替わる相手(さくら)がいる」ため、必ず消滅処理は行なわれます。
(仮に「first」フォルダをあらかじめ削除し、１体しかインストールされていない状況でも、
データは削除されてしまう)
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnVanishSelected
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示を実行します。
- 消滅が指示された
- 解説
ポップアップメニュー等から「消滅指示」が指示された直後に発生するイベントです。
この後「消滅を実行しますか？」と確認のダイアログ・ボックスが出ます。
- 補足
さくらスクリプト/2.0 の「 \![vanishbymyself] 」タグ実行時には、このイベントは発生せず、
その瞬間に消滅処理が実行されます。
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnVanishSelecting
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示を実行しますか？\e
情報通知イベント†
basewareversion†
- 実行環境のバージョン通知
installedghostname†
- インストールされているゴーストの名前を通知
- 解説
現在インストールされている、全ゴーストの名前を通知します。
この「全ゴースト」には自分自身も含みます。
- 補足
Reference0, 1, 2, ...にゴーストの名前が一体ずつ入ります。
Referenceの最大数は不定です。
通知されるのはsakura側キャラクターの名前ではなく、
ゴーストそのものの名前であることに注意してください。
- パラメータ
- サンプル
NOTIFY SHIORI/3.0
Charset: Shift_JIS
ID: installedghostname
Reference0: さくら
Reference1: つぐな･ツインルーク
Reference2: デベロッパーゴースト
Reference3: Alice in desktopland.
Reference4: まゆら＆黒うにゅう
Reference5: Emily/Phase4
Reference6: リリス＆ヌー
SecurityLevel: local
Sender: crow
SHIORI/3.0 204 No Content
Charset: Shift_JIS
Sender: リリス
- 着せ替え情報の通知
OnNotifyOSInfo†
- OS情報の通知
- ゴースト自身の情報通知
- ユーザ情報通知
otherghostname†
- 同時起動しているゴーストの名前を通知
- 解説
他に同時起動しているゴーストそれぞれについて、
sakura側キャラクタの名前と、現在のサーフェス番号を通知します。
（同時起動しているゴーストがいなくても通知自体は行われます）
- 補足
Reference0以降には以下のフォーマットで情報が入ります。
なお、[1]はバイト値1です。
sakura側の名前[1]sakura側のサーフェス番号[1]kero側のサーフェス番号
CROWには、自分自身を「他に同時起動しているゴースト」に含めて
通知してくるバグがあります。（ver0.5.2で確認）
- パラメータ
- サンプル
NOTIFY SHIORI/3.0
Charset: Shift_JIS
ID: otherghostname
Reference0: マッキー010
Reference1: つぐな010
SecurityLevel: local
Sender: SSP
SHIORI/3.0 204 No Content
Charset: Shift_JIS
Sender: リリス
（CROW ver0.5.2の場合）
NOTIFY SHIORI/3.0
Charset: Shift_JIS
ID: otherghostname
Reference0: マッキー010
Reference1: つぐな010
Reference2: リリス010
SecurityLevel: local
Sender: crow
SHIORI/3.0 204 No Content
Charset: Shift_JIS
Sender: リリス
ownerghostname†
rateofusegraph†
- 使ってるぞグラフの内容表示
- 解説
使ってるぞグラフの情報をそのまま通知します。
起動中何度も通知される可能性があります。
- 補足
Reference0以降には以下のフォーマットで情報が入ります。
なお、[1]はバイト値1です。
名前(name)[1]sakura名[1]kero名[1]起動回数[1]起動時間(分)[1]起動時間％[1](boot|install|vanish)
bootは起動中、installはインストールされている、vanishはログのみに情報が残存を示します。
- パラメータ
状態変更イベント†
- 通常起動
- 解説
本体起動時に発生するイベントです。
- 補足
インストール後初めての起動の場合は、このイベントは呼ばれず、OnFirstBootが発生します。
Reference6,7はMATERIA,SSPのみのサポートとなります。
また、異常終了時は常に通知されるとは限りません。
Reference7は\0側名、descript.txtのsakuranameエントリが入ります。
※SSPの1.09.17以前では実装ミスによりnameエントリが入っています。
- パラメータ
| Reference0 | 起動時のシェルの名称 |
| Reference6 | 前回の起動時に異常終了した際に"halt"が入る |
| Reference7 | 前回の起動時に異常終了した際に、その時起動していたゴーストの\0名(sakuraname)が入る |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnBoot
Reference0: 50%シェル
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]起動\e
- 全ゴースト終了指示
- デスクトップ変化
- 初回起動
- 解説
ゴーストインストール後の一番最初の起動において、
OnBootや、OnGhostChangedイベントの替わりにに呼び出されるイベントです。
- 補足
そのゴーストが、今までに消滅指示を受けたことがあれば、
その通産回数がReference0に入ります。
その本体で、最初の起動ならばReference0は0が入ります。
- パラメータ
| Reference0 | そのゴーストが Vanish された通算回数 |
| Reference7 | 起動時のシェルの名称 |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnFirsBoot
Reference0: 0
Reference7: master
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]初回起動\e
- シェル拡大/縮小率変更
- 最小化復帰
- 解説
アイコン化解除が指示された時に発生するイベントです。
実際にアイコン化解除処理が行われたあとに、この応答が処理されます。
- 補足
このイベントが応答を返さないと、何も表示されない状態になります。
必ず、サーフィスを表示するタグを応答に含めてください。
なお、CROWでは問題ありません。
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnWindowStateRestore
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]\1\s[10]\e
切り替えイベント†
- ゴースト呼び出し完了（呼び出し元）
- ゴースト呼び出し完了
- ゴースト呼び出し中
- ゴースト切り替え完了
- 解説
ゴースト切り替え完了後に、最初に呼ばれるイベントです。
- 補足
切り替えた先のゴーストがインストール後初の呼び出しだった場合、
このイベントは発生せず、OnFirstBootが発生します。
Reference2はSSP,CROWの時のみ通知されます。
Reference7はSSPのみ通知されます。
- パラメータ
| Reference0 | 直前のゴーストの\0側の名前 |
| Reference1 | 直前のゴーストの最後のスクリプト |
| Reference2 | 直前のゴーストのフルネーム(nameエントリ) [SSP/CROW] |
| Reference7 | シェルの名前 [SSP] |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnGhostChanged
Reference0: さくら
Reference1: \0\s[0]次のゴーストに変わります。\e
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]切り替わりました。\e
- ゴースト切り替え指示
- 解説
別のゴーストへの切り替えが指示された時に発生するイベントです。
自分自身へ切り替えたときにも発生します。
- 補足
メニューから切り替えた際にはReference1にはmanualが入ります。
本体に自動切換えの設定を行い、自動で切り替わった場合Reference1にはautomaticが入ります。
SSP,CROWの場合のみReference2が通知されます。
- パラメータ
| Reference0 | 次のゴーストの\0側の名前 |
| Reference1 | 切り替えメソッド（manual/automatic） |
| Reference2 | 次のゴーストのフルネーム(nameエントリ) [SSP/CROW] |
| Reference3 | 次のゴーストがインストールされているファイルパス [SSP] |
- サンプル
手動切り替え時
GET SHIORI/3.0
Sender: crow
ID: OnGhostChanging
Reference0: さくら
Reference1: manual
Reference2: .さくら
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]次のゴーストに変わります。\e
自動切換え時
GET SHIORI/3.0
Sender: crow
ID: OnGhostChanging
Reference0: さくら
Reference1: automatic
Reference2: .さくら
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
- 他のゴーストが起動
- 他のゴーストが切り替え完了
- 同時起動中のほかのゴーストが終了した
- シェル切り替え完了
- 解説
別のシェルへの切り替えが指示された時に発生するイベントです。
今までと同じシェルへ切り替えたときにも発生します。
- 補足
Reference1に入る内容は、Reference0と同一です。
Reference2の情報は、CROWとSSPのみです。Materiaでは通知されません。
- パラメータ
| Reference0 | 選択されたシェルの名称 |
| Reference1 | 選択されたシェルの名称 |
| Reference2 | 選択されたシェルのパス （例：shell/master/） |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnShellChanged
Reference0: 50%シェル
Reference1: 50%シェル
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]シェル変更を行います。\e
- シェル切り替え指示
- 解説
別のシェルへの切り替えが指示された時に発生するイベントです。
- 補足
シェルインストールにより切り替わった場合は、このイベントは発生しません。
Reference2の情報は、CROWとSSPのみです。Materiaでは通知されません。
- パラメータ
| Reference0 | 選択されたシェルの名称 |
| Reference2 | 選択されたシェルのパス （例：shell/master/） |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnShellChanging
Reference0: 50%シェル
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK Value: \0\s[0]シェル切り替えを行います。\e
選択肢イベント†
- アンカークリック
- 解説
アンカーをクリックしたときに発生するイベントです。
- 補足
アンカーがクリックされても、このイベントに応答を返さなければバルーンは閉じず、
そのままの状態を維持します。
- パラメータ
| Reference0 | 選択されたアンカーが持つ識別子 |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnAnchorSelect
Reference0: anchor1
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\\s[0]アンカー１が選ばれました。\e
- アンカークリック（拡張情報付き）
- 選択肢フォーカス変化
- 解説
アンカー以外の選択肢の上にカーソルが乗った瞬間および外れた瞬間に発生するイベントです。
外れた際はReference0とReference1には空文字列が入ります。
サイレントイベントのため、応答があっても無視されます。
- 補足
選択肢を決定する直前にも発生します。
その場合、応答はReference0のみで空文字列が入ります。
- パラメータ
| Reference0 | 選択肢のタイトル |
| Reference1 | ジャンプラベル |
| Reference2 | 以下拡張情報 |
- サンプル
（選択肢にフォーカスが移った場合）
GET SHIORI/3.0
Sender: embryo
ID: OnChoiceEnter
Reference0: 選択肢1
Reference1: sel1
Reference2: expanddata
Reference3:
Reference4:
Reference5:
Reference6:
Reference7:
Reference8:
Reference9:
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
（選択肢からフォーカスが離れた場合）
GET SHIORI/3.0
Sender: crow
ID: OnChoiceEnter
Reference0:
Reference1:
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
（決定する直前のイベント）
GET SHIORI/3.0
Sender: crow
ID: OnChoiceEnter
Reference0:
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 204 No Content
- 選択肢上でマウスが「しばらく上で止まっている」
- 選択肢クリック（拡張情報付き）
- 解説
選択肢をクリックした時に発生するイベントです。
- パラメータ
| Reference0 | 選択された選択肢 |
| Reference1 | 選択された選択肢が持つ識別子 |
| Reference2 | 以降拡張情報 |
- 選択肢タイムアウト
- 解説
選択肢がタイムアウトしたときに発生するイベントです。
Reference0には、この選択肢を出したスクリプトが入ります。
- 補足
[MATERIA] タイムアウト時間はは約15秒です。
[SSP] タイムアウト時間はユーザ側で設定できます。
- パラメータ
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnChoiceTimeout
Reference0: \0\s[0]\q[選択肢１,sel1,expand]\q[選択肢２,sel2]\e
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]選択肢がタイムアウトしました。\e
入力ボックスイベント†
- コミュニケート
- 解説
外部から話し掛けられた瞬間に発生するイベントです。
ユーザから話し掛けられた場合、Reference0はuserという文字列が入り、
ゴーストから話し掛けられた場合は、そのゴーストの名前が入ります。
- パラメータ
| Reference0 | 送り元の名前（user/ゴースト名) |
| Reference1 | スクリプト |
| Reference2 | 以下拡張情報 |
- サンプル
GET SHIORI/3.0
Sender: crow
ID: OnCommunicate
Reference0: さくら
Reference1: \0\s[0]こんにちは。\e
Reference2: 0,10
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]こんにちは、さくらさん。\e
- CommunicateBox入力中止
- TeachBox入力中止
- 解説
TeachBoxが閉じられた際に発生。
- 補足
SSP/2.01.07以降
- パラメータ
| Reference0 | (空欄) |
| Reference1 | cancel（×やESCで閉じた） |
- InputBoxクローズ
- 解説
InputBoxが閉じた際に発生するイベントです。
ユーザーが値を入力してリターンを押した場合と、タイムアウトした場合があります。
タイムアウトした場合は、入力値の代わりにtimeoutという文字列が返ります。
- 補足
InputBoxを閉じた際には必ずこのイベントが発生するとは限りません。
InputBoxを開くタグの第3引数の頭にOnがついていない場合のみこのイベントが発生します。
第3引数の頭にOnがついていると、このイベントは発生せず、第3引数で指定したイベントが発生します。
その際にはReference0で入力した文字列もしくはtimeoutが渡されます。
- パラメータ
| Reference0 | \![open,inputbox]で指定した識別子 |
| Reference1 | 入力した文字列か、timeout |
- サンプル
入力が決定した場合
GET SHIORI/3.0
Sender: crow
ID: OnUserInput
Reference0: ユーザー
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ユーザー入力を受け付けました。\e
入力がタイムアウトした場合
GET SHIORI/3.0
Sender: crow
ID: OnUserInput
Reference0: timeout
SecurityLevel: local
Charset: Shift_JIS
SHIORI/3.0 200 OK
Value: \0\s[0]ユーザー入力がタイムアウトしました。\e
- InputBox入力中止
|
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
icon_m.png
icon_s.png
icon_c.png
