* U K I Y A H O N P O *
Nel mezzo del cammin di nostra vita mi ritrovai per una selva oscura,
che la diritta via era smarrita.
リロード   新規 下位ページ作成 編集 凍結 差分 添付 コピー 名前変更   ホーム 一覧 検索 最終更新 バックアップ リンク元   ヘルプ   最終更新のRSS
浮子屋商店もよろしく。

RefTest/Shiori

Top > RefTest > Shiori

SSP拡張イベント Edit

OnEmbryoExist Edit

ssp
SSP起動時、先にmateria.exeが起動されていた際に発生。

解説 Edit

SSP起動時、先にmateria.exeが起動されていた際に発生。

サンプル Edit



OnNekodorifExist Edit

ssp
SSP起動時、先に猫どりふが起動されていた際に発生。

解説 Edit

SSP起動時、先に猫どりふが起動されていた際に発生。

サンプル Edit



OnScreenSaverStart Edit

ssp
スクリーンセーバーが起動した際に発生。

解説 Edit

スクリーンセーバーが起動した際に発生。

サンプル Edit


OnScreenSaverEnd

Edit

ssp
スクリーンセーバーが終了した際に発生。

解説 Edit

スクリーンセーバーが終了した際に発生。

サンプル Edit



OnAITalk Edit

ssp
\aなどによる会話が求められた際に発生。

解説 Edit

\aなどによる会話が求められた際に発生。

サンプル Edit



OnTeach Edit

ssp
TeachBoxからの入力があった際に発生。

解説 Edit

TeachBoxからの入力があった際に発生。

パラメータ Edit

Reference0入力された言葉。
Reference1Reference0に対して入力された言葉。

サンプル Edit



OnCacheSuspend Edit

ssp
ゴーストキャッシュに入った際に発生。

解説 Edit

ゴーストキャッシュに入った際に発生。

サンプル Edit



OnCacheRestore Edit

ssp
ゴーストキャッシュから出た際に発生。

解説 Edit

ゴーストキャッシュから出た際に発生。

補足 Edit

  • SSPは設定を変えない限り、常にゴースト終了後も再度立ち上げる際に備えてゴーストを読み込んだままにしています。
    終了時に必ず何かの処理を行う必要がある場合、このイベントにも対応する必要があります。

サンプル Edit



OnSoundStop Edit

ssp
サウンドが終了した際に発生。

解説 Edit

サウンドが終了した際に発生。

パラメータ Edit

Reference0再生ファイル名。

サンプル Edit



OnBalloonBreak Edit

ssp
SSTP以外でブレイクされた際に発生。

解説 Edit

SSTP以外でスクリプトをブレークされた際に発生します。

補足 Edit

  • Reference1の送信はSSP 1.11系からです。

パラメータ Edit

Reference0ブレークされたスクリプト
Reference1どちら側のバルーンからブレーク操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...)

サンプル Edit



OnBalloonTimeout Edit

ssp
選択肢以外でバルーンがタイムアウトした際に発生。

解説 Edit

選択肢以外でバルーンがタイムアウトした際に発生。

パラメータ Edit

Reference0スクリプト。

サンプル Edit



OnBatteryLow Edit

ssp
バッテリ残量が少なくなった際に発生。

解説 Edit

バッテリ残量が少なくなってきた際に発生します。
通知されるタイミングはWindowsの電源管理の設定に依存します。

補足 Edit

  • 電源状態が変化した際以外に、ゴースト起動時にNOTIFY(喋らない)で必要に応じて別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。

パラメータ Edit

Reference0バッテリ残量の割合(%) 検出できなかった場合は-1
Reference1バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1
Reference2電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源

サンプル Edit



OnBatteryCritical Edit

ssp
バッテリ残量が非常に少なくなった際に発生。

解説 Edit

バッテリ残量が非常に少なくなってきた際に発生します。
通知されるタイミングはWindowsの電源管理の設定に依存します。

補足 Edit

  • 電源状態が変化した際以外に、ゴースト起動時にNOTIFY(喋らない)で必要に応じて別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。

パラメータ Edit

Reference0バッテリ残量の割合(%) 検出できなかった場合は-1
Reference1バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1
Reference2電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源

サンプル Edit



OnSysResume Edit

ssp
スタンバイ状態からの回復

解説 Edit

スタンバイ状態から戻った時に通知されます。

サンプル Edit



OnSysSuspend Edit

ssp
スタンバイ状態へ

解説 Edit

スタンバイ(スリープ)状態へとシステムが移行する時に通知されます。

補足 Edit

  • このイベントにスクリプトを返しても実行されません。(NOTIFYイベント)

サンプル Edit



OnBatteryNotify Edit

ssp
バッテリ状態の通知

解説 Edit

バッテリの残量やAC電源/バッテリの切り替えなど、電源の状態が変わった際に通知されるイベントです。これを利用することにより、バッテリが満充電になった際にメッセージを表示するなどの機能が可能となります。

補足 Edit

  • バッテリがない機械では一切通知されません。
    Windows NT4ではサポートされていません。

    電源状態が変化した際以外に、ゴースト起動時にNOTIFY(喋らない)で別途通知されます。ゴーストの内部状態を初期化する時などに使うと良いでしょう。

パラメータ Edit

Reference0バッテリ残量の割合(%) 検出できなかった場合は-1
Reference1バッテリ切れまでの残り時間(秒) 検出できなかった場合は-1
Reference2電源状態 offline=バッテリ online=AC電源 backup=UPSなどのバックアップ電源

サンプル Edit



OnNotifyUserInfo Edit

ssp
ユーザ情報通知

解説 Edit

ゴーストが起動した際、またはユーザ情報が変更された際に、ユーザ情報を通知します。

補足 Edit

  • このイベントはNotifyイベントです。
    スクリプトを返しても再生されません。

パラメータ Edit

Reference0呼び方(ニックネーム)
Reference1フルネーム
Reference2誕生日 カンマ区切りで 年,月,日 のように

サンプル Edit



OnInitialize Edit

ssp
ゴースト起動

解説 Edit

SHIORIが読み込まれた直後に通知されます。
このイベント内でゴースト内部の処理の初期化を行うとよいでしょう。

補足 Edit

  • このイベントはNotifyイベントです。
    スクリプトを返しても再生されません。

サンプル Edit



OnDestroy Edit

ssp
ゴースト終了

解説 Edit

SHIORIが開放される直前に通知されます。
このイベント内でゴースト内部の処理の後始末を行うとよいでしょう。

補足 Edit

  • このイベントはNotifyイベントです。
    スクリプトを返しても再生されません。

サンプル Edit



OnNotifyOSInfo Edit

ssp
OS情報の通知

解説 Edit

現在ゴーストが動作しているOSの情報を通知します。
読み込み時のタイミングに一度だけ通知されますので、後で利用したい場合はどこかにこの情報を保持しておく必要があります。

パラメータ Edit

Reference0システム,バージョン (例:WindowsNT,5.00)
Reference1CPUタイプ,クロックMHz,その他の追加情報 (例:GenuineIntel,2550,3.15.2.7,ffffffff)
Reference2物理,仮想メモリ の空き容量(KB)
Reference3システム起動からの経過時間

サンプル Edit



OnDressupChanged Edit

ssp
着せ替え変更通知

解説 Edit

着せ替え設定が変更されたことを通知します。

補足 Edit

  • このイベントは切り替え時に複数Notifyされる可能性があります。
    先に着せ替えグループなどの関係で自動的にON/OFFされる通知が入った後に、最後にユーザが操作したものが通知されます。

パラメータ Edit

Reference0キャラクターウィンドウID (0=Sakura 1=Kero 2...)
Reference1着せ替え要素定義の名前
Reference20=OFF 1=ON

サンプル Edit



OnURLQuery Edit

ssp
URL D&D時の通知

解説 Edit

URLがキャラクターウィンドウにドラッグ&ドロップされた際に通知されます。
これに対してスクリプトを返す(200)と、OnURLDropping -> Droppedという通常のダウンロード処理がキャンセルされます。ゴースト側でURLを独自に処理したい場合のみスクリプトを返してください。

パラメータ Edit

Reference0URL
Reference1キャラクターウィンドウID (Sakura=0 Kero=1 2...)
Reference2ダウンロードするファイルのMIME

サンプル Edit



OnBalloonChange Edit

ssp
バルーン切替

解説 Edit

バルーンが切替られたときに発生するイベントです。
バルーンの切替は瞬時に処理されるので、Changing/Changedの2段構えではなく、OnBalloonChangeという名前となっています。

補足 Edit

  • 1.10.04からの実装です。
    ※その前から試験実装されていましたが、Reference1のパスは通知していません。

パラメータ Edit

Reference0バルーンの名前
Reference1バルーンのパス (相対パスか絶対パスかは処理系依存 SSPは絶対パス)

サンプル Edit



SSTPイベント Edit

OnMusicPlay Edit

sspmateria
音楽演奏反応

解説 Edit

SSTPプロトコル NOTIFY/1.1 仕様に従って、「Event:OnMusicPlay」が本体に送信された時に、発生するイベントです。

補足 Edit

  •  現在、この仕様によってSSTP送信するアプリケーションは、Winamp2用プラグインである「YunaSexyFont Plug-in 2000」(Version 7.9b21)のみです。
     また、このプラグインでは、Reference0に、演奏開始した曲のタイトル(Winamp上での表記、デフォルトでは「(アーティスト名) - (曲名)」)が代入されてリクエストされます。

パラメータ Edit

Reference0曲のデータ(タイトル)

サンプル Edit



インストールイベント Edit

OnInstallBegin Edit

crowsspmateria
インストール開始

解説 Edit

アーカイブがドラッグ&ドロップされインストールが開始した時に発生します。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnInstallBegin
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]インストール開始。\e

OnInstallComplete Edit

crowsspmateria
インストール完了

解説 Edit

インストールがエラーを起こさずに完了した場合に発生するイベントです。

SSPでは、OnInstallCompleteEx -> OnInstallComplete の順で発生します。
OnInstallCompleteEx でスクリプトを返した場合、こちらは発生しません。

補足 Edit

  • 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に対応してください。

パラメータ Edit

Reference0インストールした物の種別
Reference1インストールした物の名前
Reference2"with balloon" など複数インストールする場合、2つめのインストールした物の名前

サンプル Edit

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

OnInstallFailure Edit

crowsspmateria
インストール失敗

解説 Edit

インストールが何らかの理由で失敗した場合に発生するイベントです。
失敗した場合、Reference0に失敗の理由が入ります。
unlha32 unlha32ロード失敗
extraction 解凍失敗(アーカイブが破損)
invalid type install.txtが不正
artificial ユーザが手動中断
unsupported その他サポートしていないアーカイブをインストールしようとした

補足 Edit

  • MATERIAでは、Reference0には何も返りません。
    SSPのみ中断時にReference0でartificialの通知を返します。

パラメータ Edit

Reference0失敗の理由(unlha32/extraction/invalid type/artificial/unsupported)

サンプル Edit

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

OnInstallRefuse Edit

crowsspmateria
インストール拒否

解説 Edit

インストールしようとしたアーカイブが、ドロップされたゴーストと別のゴーストを指名していた場合に発生するイベントです。

パラメータ Edit

Reference0指名されているゴーストの名前

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnInstallRefuse
Reference0: さくら
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]このゴーストにはインストールできません。\e

OnInstallCompleteEx Edit

ssp
インストール完了(拡張)

解説 Edit

インストールがエラーを起こさずに完了した場合に発生するイベントです。
互換を確保するため、このイベントを無視してスクリプトを返さない(200 OK以外)場合、続けてOnInstallCompleteが発生します。

補足 Edit

  • Reference0にはインストールした物の種別が入りますが、現在のところ以下のとおりです。
    install.txtに書かれる識別子と同じものが入るとは限りません。特にwith balloonなどの場合は、サンプルにあるようにghost[1]balloonなどというふうにバイト値1区切りで渡されます。

    shell:シェル
    ghost:ゴースト
    supplement:ゴースト用追加ファイル
    balloon:バルーン
    plugin:プラグイン
    headline:ヘッドラインセンサ
    calendar skin:カレンダースキン [SSPのみ]
    calendar plugin:スケジュールセンサ [SSPのみ]

パラメータ Edit

Reference0インストールした物の種別(複数ある場合はバイト値1区切り)
Reference1インストールした物の名前(複数ある場合はバイト値1区切り)
Reference2インストールした場所(複数ある場合はバイト値1区切り)

サンプル Edit

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

キーボードイベント Edit

OnKeyPress Edit

crowsspmateria
キーを押した

解説 Edit

キーボードのキーが押された時に発生します。

補足 Edit

  • 特殊キーの識別子一覧です。
    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

パラメータ Edit

Reference0押されたキーの識別子
Reference1キーコード

サンプル Edit

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]Aが押されました。\e


サーフィスイベント Edit

OnSurfaceChange Edit

crowssp
サーフィス変化

解説 Edit

サーフィスが変化したときに呼ばれるイベントです。
変化したサーフィス番号が渡されます。
表示されていなければ、-1が入ります。

補足 Edit

  • サイレントイベントなので、応答は無視されます。
    また、SSPではNOTIFYイベントとして発生します。

    SSPではReference2に、\p[2]以降用対応のための拡張情報が入ります。
    Reference3,4...と増えていくのではなく、ID,サーフィス番号,幅,高さ という形式でReference2のみ追加される点に注意してください。
    この拡張情報は0番(メイン側)、1番(サブ側)が切り替わった場合でも常に通知されますので、Reference2が存在すればその情報を常に利用すると良いでしょう。

パラメータ Edit

Reference0メイン側キャラのサーフィス番号
Reference1サブ側キャラのサーフィス番号
Reference2キャラID,サーフィス番号,サーフィス幅,サーフィス高さ [SSP]

サンプル Edit

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

OnSurfaceRestore Edit

crowsspmateria
サーフィス復帰指示

解説 Edit

サーフィスが変化した後、一定時間で呼び出されるイベントです。
このイベントに応答することにより、初期サーフィスに戻すことができますが、
戻すかどうかは各ゴーストに任されています。

また、このイベントはメイン側がサーフィス0でサブ側がサーフィス10の場合は発生しません。
それ以外に変化したときのみ呼ばれます。

補足 Edit

  • CROWでは、変化後50秒経過後に呼ばれます。

パラメータ Edit

Reference0メイン側キャラのサーフィス番号
Reference1サブ側キャラのサーフィス番号

サンプル Edit

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

その他のイベント Edit

OnRecommendsiteChoice Edit

crowsspmateria
おすすめメニューのサイトクリック

解説 Edit

右クリックメニューで現れる、「おすすめ」「ポータル」メニューの中からサイトを選んでクリックすると発生するイベントです。

パラメータ Edit

Reference0選択されたサイトの名称
Reference1選択されたサイトのURL

サンプル Edit

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

OnNetworkHeavy Edit

crowsspmateria
サーバの応答無し

解説 Edit

ドロップイベント(「OnURL~」)、ネットワーク更新イベント、ヘッドラインセンスイベント、メールチェックイベント等で、サーバからデータをダウンロードする際に、一定時間相手サーバからの応答が無い時に発生します。

補足 Edit

  •  SSPでは、Reference0に、このままサーバからの応答が無い場合にタイムアウトエラーになるまでの時間(単位:秒)が入ります。

パラメータ Edit

Reference0タイムアウトエラーまでの時間(単位:秒)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnNetworkHeavy
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]サーバーの応答がありません。\e

OnSSTPBreak Edit

sspmateria
SSTP受信中断

解説 Edit

SSTPプロトコルのSENDによって受信したメッセージを読み上げている時に、バルーンをダブルクリックして、読み上げの中止を指示した時に発生するイベントです。

補足 Edit

  • Reference1の送信はSSP 1.11系からです。

パラメータ Edit

Reference0受信を中断されたスクリプト
Reference1どちら側のバルーンからブレーク操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...)

サンプル Edit



OnSSTPBlacklisting Edit

materia
SSTPの特定IPからの受信禁止処理

解説 Edit

ネットワークからのSSTPプロトコルSENDリクエストに対し、「ブラックリスティング」を指示した時に、このイベントが発生します。
このイベントが発生すると、最後にSENDリクエストを送信したIPアドレスがブラックリストファイルに記録され、以後、そのIPアドレスからのSENDリクエストが無視(読み上げられなくなる)されます。

パラメータ Edit

Reference0最後に送信されたSSTP送信元の IP アドレス

サンプル Edit



OnTranslate Edit

crowsspmateria
トランスレートイベント

解説 Edit

このイベントは特殊で、各リクエストのあと実行すべきスクリプトがあった場合必ず発生します。
Reference0には直前のスクリプトが入ります。
もし、このスクリプトを変更する必要があった場合に変更して返すと、
そのスクリプトが実際に使われます。

補足 Edit

  • MATERIAではバグで、\xタグを実行するともう一度このイベントが発生します。
    MATERIAで\xタグを使う場合、トランスレートを複数回実行しても大丈夫なように作る必要があります。

パラメータ Edit

Reference0処理するべきスクリプト。

サンプル Edit

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


この場合、直前の何らかのイベントで”トランスレートします。”と返しています。
このイベントでトランスレートされるため、実際には”トランスレートしました。”と表示されます。

ドロップイベント Edit

OnURLDropping Edit

crowsspmateria
URLドロップ開始

解説 Edit

 ブラウザ等からアーカイブのURLをドラッグ&ドロップされた時に発生します。

補足 Edit

  •  イベントが発生するのは、URLがローカル(file://~)でなく、インストール可能なアーカイブ(拡張子がNAR・ZIP・LZH)の時のみです。

パラメータ Edit

Reference0ドロップされたURL

サンプル Edit

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


OnFileDropEx Edit

ssp
ファイルドロップ開始

解説 Edit

ファイルがドラッグ&ドロップされた際に発生するイベントです。
複数のファイルが同時にドロップされた場合は、バイト値 1 でセパレートされます。

*補足
 ドロップされたファイルがアーカイブ(NAR、ZIP、LZH)の場合、このイベントは発生せず、インストールイベントが発生します。

パラメータ Edit

Reference0ドロップされたファイル

サンプル Edit



OnFileDrop2 Edit

crowsspmateria
ファイル・フォルダドロップ開始

解説 Edit

ファイルやフォルダがドラッグ&ドロップされた際に発生するイベントです。
複数のファイルやフォルダが同時にドロップされた場合は、バイト値 1 でセパレートされます。
Reference1にどのキャラにドラッグされたという情報が入ります。

補足 Edit

  •  このイベントをエラーで返さない(「200 OK」とし、Valueを返した)場合、SHIORIモジュール側で判断・処理したものとみなし、以後の処理(現時点で該当するのはマスタイベント)を行ないません。
    MATERIA,CROWでは現在サブキャラ側にドラッグされてもイベントは発生しません。

パラメータ Edit

Reference0ドロップされたファイル又はドロップされたフォルダ
Reference1メインキャラ側なら0、サブキャラ側なら1

サンプル Edit

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が同時にドラッグ&ドロップされています。

OnURLDropped Edit

sspmateria
URLドロップ完了

解説 Edit

「OnURLDropping」により発生したファイルのダウンロードが完了した時に発生します。

補足 Edit

  •  現在の MATERIA phase583 では、イベントは発生していますが、返した Value は処理されず破棄されているようです。(OnTrancelateが発生しないため、処理されない)
     また、このイベントの後、強制的に一連のインストールイベントに移行します。

パラメータ Edit

Reference0ダウンロードしたファイルのローカルマシン上での絶対パス

サンプル Edit

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

OnURLDropFailure Edit

sspmateria
URLドロップ失敗

解説 Edit

OnURLDroppingによって開始されたダウンロードが失敗した、もしくはユーザーがダウンロード中にバルーンをダブルクリックする事で中断を指示した場合に発生します。
このイベントが発生した場合、Reference0 はダウンロードされる予定だったファイルのローカルマシン上での絶対パス、Reference1 には、そのエラーの内容が入ります。

現在起こるエラーは
artifical ユーザーによる中断
timeout ファイルのダウンロード失敗

補足 Edit

  • ダウンロードが失敗(もしくは中断)した時には、Reference0 で示されるパス上には、ファイルは存在しません(イベント発生時に削除される)。

パラメータ Edit

Reference0ダウンロードされる筈だったファイル(ローカルマシン上での絶対パス)
Reference1失敗の理由(artificial/timeout)

サンプル Edit

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

OnUpdatedataCreating Edit

crowsspmateria
アップデート情報作成開始

解説 Edit

ゴーストに「updates2.dau」ファイル(空のテキストファイル)及び、アップデート対象とするファイルを含むフォルダをドラッグ&ドロップした時に、発生するイベントです。
この後、「updates2.dau」にアップデートファイルのMD5情報が作成されてから、「OnUpdatedataCreated」イベントが呼ばれます。

補足 Edit

  •  MATERIAでは、ファイルがドロップされるとまず「OnFileDrop2」イベントが呼ばれ、そのイベントに対してエラーで返されると、このイベントを呼ぶかを判断しています。
    (参照:「OnFileDrop2」イベント)
     CROWでは、updates2.dauを含んでいれば、OnFileDrop2が発生せずにこのイベントが発生します。

パラメータ Edit

Reference0今起動しているゴーストのメインキャラ側の名称

サンプル Edit

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

OnUpdatedataCreated Edit

crowsspmateria
アップデート情報作成完成

解説 Edit

「OnUpdatedataCreating」イベントによる「updates2.dau」ファイルへのアップデート情報の作成が完了すると、このイベントが発生します。

パラメータ Edit

Reference0今起動しているゴーストのメインキャラ側の名称

サンプル Edit

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

OnNarCreating Edit

crowsspmateria
NARファイル作成開始

解説 Edit

ゴーストにインストール情報を記述したテキストファイル「install.txt」を含むフォルダをドラッグ&ドロップした時に発生するイベントです。
この後、「install.txt」の情報を元に、NARファイルが作成され、「OnNarCreated」イベントが呼ばれます。

補足 Edit

  • 生成するnarのファイル名はドラッグしたフォルダの拡張子をnarに変更したものになります。
    ドラッグしたフォルダの直下にinstall.txtがある必要があります。

パラメータ Edit

Reference0install.txtに記述されたnameの値
Reference1生成するnarのファイル名
Reference2install.txtに記述された種別

サンプル Edit

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
です。


OnNarCreated Edit

crowsspmateria
NARファイル作成完了

解説 Edit

「OnNarCreating」イベントによるNARファイルの作成が完了すると、このイベントが発生します。
Reference2 には、NARファイル化されたデータの種類として、
 ghost ゴースト
 shell シェル
 balloon バルーン
 plugin プラグイン
…が入ります。

パラメータ Edit

Reference0install.txtに記述されたnameの値
Reference1生成したnarのファイル名
Reference2install.txtに記述された種別

サンプル Edit

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
です。

ネットワーク更新イベント Edit

OnUpdateBegin Edit

crowsspmateria
ネットワーク更新開始

解説 Edit

ネットワーク更新が指示された直後に発生するイベントです。
この後、更新情報の取得を行います。

補足 Edit

  • Reference3はCROW / SSP 2.0以降の実装です。

    Reference0,1はSSP 2.0以降の実装です。

パラメータ Edit

Reference0名前(descriptのnameエントリ)
Reference1更新対象のディレクトリへのパス
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnUpdateBegin
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]ネットワーク更新開始。\e

OnUpdateReady Edit

crowsspmateria
ネットワーク更新準備完了

解説 Edit

ネットワーク更新を開始し、実際に更新するファイルがあった場合に発生するイベントです。
更新するファイルがなかった場合はこのイベントは発生せず、OnUpdateCompleteが発生します。

補足 Edit

  • Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0更新を行うファイルの数-1
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

OnUpdateComplete Edit

crowsspmateria
ネットワーク更新完了

解説 Edit

ネットワーク更新で、すべてのファイルをダウンしインストールが完了された後に呼び出されるイベントです。
何らかの理由で失敗した場合は、このイベントは呼ばれず、OnUpdateFailureが呼ばれます。
更新するファイルがなかった場合は、Reference0にnoneが返ります。

補足 Edit

  • Materia仕様書にはnoneのみ規定されているので、もし更新の有無で喋り内容を変えたい場合は、Reference0がnoneかnoneでないかを判別するように処理することをおすすめします。

    Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0状態(changed/none)
Reference1カンマで区切られた更新ファイル名のリスト
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

更新ファイルがなかった場合
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]ネットワーク更新完了。

OnUpdateFailure Edit

crowsspmateria
ネットワーク更新失敗

解説 Edit

何らかの理由でネットワーク更新が失敗した場合に発生するイベントです。
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。
現在起こるエラーは

404    そのステータスコードで失敗。404以外の数値もあり。
timeout  転送タイムアウト
md5 miss  MD5不一致
too slow 転送タイムアウト(MATERIA)
artificial バルーンダブルクリックでの手動中断
fileio   ディスク容量不足等ファイルの書き込みに失敗(SSP)
readonly  ゴーストディレクトリが書き込み禁止のため更新できない(SSP)

です。

補足 Edit

  • MATERIAでは、このイベントが2回発生することがあるようです。
    その場合、2度目のReference0には200という値が入ることがあります。

    Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0エラー内容(timeout/md5 miss/404等)
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

OnUpdate.OnDownloadBegin Edit

crowsspmateria
ファイルダウンロード開始

解説 Edit

ネットワーク更新中に、ファイルのダウンロードを開始する時に発生するイベントです。

補足 Edit

  • Reference1と2は0から開始され、5個のファイルがあり、最初のファイルをダウンするときは
    Reference1は0、Reference2は4となります。

    Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0ファイル名
Reference1今のファイルが全体の何番目か(0始まり)
Reference2更新するファイルの総数-1
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

OnUpdate.OnMD5CompareBegin Edit

crowsspmateria
MD5の照合開始

解説 Edit

ファイルをダウンロードした後、MD5を照合する前に発生するイベントです。
この後、MD5が一致すれば、OnUpdate.OnMD5CompareComplete
一致しなければ、OnUpdate.OnMD5CompareFailureが発生します。

補足 Edit

  • Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0ファイル名
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

OnUpdate.OnMD5CompareComplete Edit

crowsspmateria
MD5一致

解説 Edit

ダウンロードしたファイルのMD5が一致した時に発生するイベントです。

補足 Edit

  • Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0ファイル名
Reference1正しいMD5
Reference2ダウンロードしたファイルのMD5
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

OnUpdate.OnMD5CompareFailure Edit

crowsspmateria
MD5不一致

解説 Edit

ダウンロードしたファイルのMD5が一致しなかった時に発生するイベントです。

補足 Edit

  • Reference3はCROW / SSP 2.0以降の実装です。

パラメータ Edit

Reference0ファイル名
Reference1正しいMD5
Reference2ダウンロードしたファイルのMD5
Reference3タイプ (shell,ghost,balloon,headline,plugin,basewareのいずれか)

サンプル Edit

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

ヘッドラインセンスイベント Edit

OnHeadlinesenseBegin Edit

crowsspmateria
ヘッドラインセンス開始

解説 Edit

ヘッドラインセンスが指示された直後に発生するイベントです。
この後、サイト情報の取得・分析を行います。

補足 Edit

  •  MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、その時点で「200 OK」としてValue(内容は問わない)を返さないと、このゴーストにおいてヘッドラインセンス機能は使用不能と判断し、メニューから選択できなくなり、また、自動チェックも行われません。

パラメータ Edit

Reference0対象サイト名
Reference1対象URL

サンプル Edit

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

OnHeadlinesense.OnFind Edit

crowsspmateria
ヘッドラインセンス結果の読み上げ

解説 Edit

ヘッドラインセンスにより情報が収拾・分析され、その結果が更新されていた場合、このイベントが発生します。

Reference2 にセットされるデータ(OnFind フェーズ)は、
「First」: 1ページ目(次ページが存在する)
「First and Last」:1ページ目(次ページは無く、この1ページのみの場合)
「Last」: 最終ページ
「Next」: 上記3項目に該当しないページ
 となる。

また、このイベントが発生した後、空の識別子を選択(例「 \q[次のページへ,] 」)を指示すると、改ページが指定したものとみなされ、次ページのヘッドラインデータをもった「OnHeadlinesense.OnFind」イベントが発生する。

補足 Edit

  •  ヘッドラインデータは、さくらスクリプト形式であるが、MATERIA Phase583においては、
    データ中に「\-」(終了指示タグ)などが含まれてる事がある(データの抽出での問題)ため、そのままValueとして返すと、問題が発生する場合がある。
     そのため、特に制御を意図するタグとして解釈・誤動作しないように整形する処理を施す必要がある。

パラメータ Edit

Reference0対象サイト名
Reference1対象URL
Reference2OnFind フェーズ
Reference3ヘッドラインデータ本体(さくらスクリプト断片)

サンプル Edit

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

OnHeadlinesenseComplete Edit

crowsspmateria
ヘッドラインセンス成功(更新無し)

解説 Edit

ヘッドラインセンスは正常終了したが、更新が無かった場合に発生する。
そのため、Reference0 は、必ず「no update」(更新無し)がセットされる。

パラメータ Edit

Reference0成功事由 ( 「no update」固定)

サンプル Edit

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

OnHeadlinesenseFailure Edit

crowsspmateria
ヘッドラインセンス失敗

解説 Edit

何らかの理由でヘッドラインセンスが失敗した場合に発生するイベントです。
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。

現在起こるエラーは

can't download : ファイルが取れなかった~
can't analyze  : 有効なヘッドライン情報を解析・取得できなかった~

 の2つです。

パラメータ Edit

Reference0失敗事由 (説明参照)

サンプル Edit

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

マウスイベント Edit

OnMouseMove Edit

crowsspmateria
マウス移動

解説 Edit

サーフィス上で、マウスが移動した時に発生するイベントです。

パラメータ Edit

Reference0マウスカーソルの x 座標(ローカル座標)
Reference1マウスカーソルの y 座標(ローカル座標)
Reference2常に0
Reference3スコープ番号
Reference4当たり判定識別子

サンプル Edit

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

OnMouseClick Edit

crowsspmateria
マウスクリック

解説 Edit

マウスがクリックされた時に発生するイベントです。

補足 Edit

  •  SHIORI/3.0仕様より Reference5 が加わり、右クリックを行なった場合もこのイベントが発生します。
     なお、右クリックでイベントが発生した時に、エラーで返さない(「200 OK」とし、Valueを返した)場合、メニュー表示(及びその動作に起因するイベント)が発生しません。

パラメータ Edit

Reference0マウスカーソルの x 座標(ローカル座標)
Reference1マウスカーソルの y 座標(ローカル座標)
Reference2常に0
Reference3スコープ番号
Reference4当たり判定識別子
Reference5クリックされたボタン(0またはなし:左 / 1:右 / 2:中(Windowsやマウス依存))

サンプル Edit

判定のない場所を右クリックした例
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

OnMouseDoubleClick Edit

crowsspmateria
マウス左ボタンダブルクリック

解説 Edit

マウスの左ボタンをダブルクリックした時に発生するイベントです。

補足 Edit

  • Reference5が来ない場合も考慮して処理してください。

パラメータ Edit

Reference0マウスカーソルの x 座標(ローカル座標)
Reference1マウスカーソルの y 座標(ローカル座標)
Reference2常に0
Reference3スコープ番号
Reference4当たり判定識別子
Reference5クリックされたボタン(0またはなし:左 / 1:右 / 2:中(Windowsやマウス依存))

サンプル Edit

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

OnMouseWheel Edit

crowsspmateria
マウスホイール回転

解説 Edit

マウスのホイールが回転した時に発生するイベントです。

パラメータ Edit

Reference0マウスカーソルの x 座標(ローカル座標)
Reference1マウスカーソルの y 座標(ローカル座標)
Reference2マウスホイールの回転量および回転方向
Reference3スコープ番号
Reference4当たり判定識別子

サンプル Edit

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

メールチェックイベント Edit

OnBIFFBegin Edit

crowsspmateria
メールチェック開始

解説 Edit

メールチェックイベントが指示された直後に発生するイベントです。
この後、メールサーバから情報の取得を行います。

補足 Edit

  •  MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、その時点で「200 OK」としてValue(内容は問わない)を返さないと、このゴーストにおいてメールチェック機能は使用不能と判断し、メニューから選択できなくなり、また、自動でのメールチェックも行われません。
     (但し、MATERIA 583 においては、このチェックリクエストは発生していません)

パラメータ Edit

Reference2チェックするサーバ名(SSP,CROWでは、アカウント名)

サンプル Edit

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 Edit

crowsspmateria
メールチェック成功

解説 Edit

メールチェックが成功した時に、呼び出されるイベントです。

Reference4 は、個々のメールのヘッダ部分が、改行をバイト値 1、メールの区切りをバイト値2で区切った形式で送られてきます。
Reference5 は、個々のメールのサイズが、「(メールの通数目) (サイズ)」をバイト値1で区切った形式で送られてきます。
Reference6 は、個々のメールのuidl(個々のメールを識別するID)が、バイト値1で区切った形式で送られてきます。

[SSP拡張]
Reference7に、個々のメールの概要が、バイト値1で区切った形式で送られてきます。
今のところ送信者とタイトルをつなげたものですが、今後変更される、またユーザーの設定で変更できるようにする可能性があります。

補足 Edit

  • 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は送られてこない場合があります。

パラメータ Edit

Reference0スプールされているメールの通数
Reference1スプールされているメールのバイト数
Reference2チェックするサーバ名(SSP,CROWでは、アカウント名)
Reference3前回チェック時より増加したメールの通数(SSPのみ)
Reference4個々のメールのヘッダー部分
Reference5個々のメールのサイズ
Reference6個々のメールのuidl
Reference7[SSP]個々のメールの概要

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnBIFFComplete
Reference0: 1
Reference1: 1004
Reference2: mail1
Reference3: 1
Reference4: Return-Path: <xxxx@xxxx.jp>Received: from xxx.xxxx.ne.jp (以下ヘッダがバイト値1区切りですべて続く)
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

OnBIFF2Complete Edit

materia
新着メール通知

解説 Edit

MATERIAの設定で「新着のみ通知」とした時に、メールチェックが終了した時に発生するイベントです。
なお、このイベントは、自動でメールチェックを行なった時に新着メールがない時には発生しません。
また、このイベントに対してエラーで返した場合、「OnBIFFComplete」イベントが発生します。

補足 Edit

  • MATERIA Phase583では、Reference5・6は送られてきません。
    また、Reference3は、前回チェック時とのメール総数の増減を示すため、例えば、
    メールチェックで2通を確認(2通)→メール受信(0通)→新着メール到着(1通)
    という状態でこのイベントが発生すると、-1となります。

    また、本体側の設定により、Reference4~6は送られてこない場合があります。

パラメータ Edit

Reference0スプールされているメールの通数
Reference1スプールされているメールのバイト数
Reference2チェックするサーバ名
Reference3前回チェック時より増減したメールの通数
Reference4個々のメールのヘッダー部分
Reference5個々のメールのサイズ
Reference6個々のメールのuidl

サンプル Edit



OnBIFFFailure Edit

crowsspmateria
メールチェック失敗

解説 Edit

何らかの理由でメールチェックが失敗した場合に発生するイベントです。
このイベントが発生した場合、Reference0にそのエラーの内容が入ります。

現在起こるエラーは
 timeout:メールサーバから一定時間応答がない
 kick :メールサーバで認証に失敗した
 defect :本体でのメール設定の情報が不足している
です。

パラメータ Edit

Reference0エラー内容(timeout/kick/defect)
Reference2チェックするサーバ名(SSP,CROWでは、アカウント名)

サンプル Edit

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

外部アプリイベント Edit

OnApplicationBoot Edit

sspmateria
外部アプリケーションが起動した際に発生。

解説 Edit

外部アプリケーションが起動した際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1アプリケーションの情報。

サンプル Edit



OnApplicationClose Edit

sspmateria
外部アプリケーションが終了した際に発生。

解説 Edit

外部アプリケーションが終了した際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1アプリケーションの情報。

サンプル Edit



OnApplicationExist Edit

sspmateria
外部アプリケーションの存在を通知された際に発生。

解説 Edit

外部アプリケーションの存在を通知された際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1アプリケーションの情報。

サンプル Edit



OnApplicationVersion Edit

sspmateria
外部アプリケーションのバージョン情報を通知された際に発生。

解説 Edit

外部アプリケーションのバージョン情報を通知された際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1アプリケーションの情報。
Reference2バージョン番号。
Reference3著作権。
Reference4開発元のURL。

サンプル Edit



OnApplicationOperationFinish Edit

sspmateria
外部アプリケーションか何らかの処理が完了した際に発生。

解説 Edit

外部アプリケーションか何らかの処理が完了した際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1処理の内容。
Reference2処理の対象。

サンプル Edit



OnApplicationFileOpen Edit

sspmateria
外部アプリケーションがドキュメントファイルを開いた際に発生。

解説 Edit

外部アプリケーションがドキュメントファイルを開いた際に発生。

パラメータ Edit

Reference0アプリケーション名。
Reference1ファイルのフルパス。

サンプル Edit



OnWebsiteUpdateNotify Edit

sspmateria
ウェブサイトの更新・新着情報を通知された際に発生。

解説 Edit

ウェブサイトの更新・新着情報を通知された際に発生。

パラメータ Edit

Reference0ウェブサイト名。
Reference1最終更新日時。
Reference2更新内容。

サンプル Edit



外部アプリ-きのこイベント Edit

OnKinokoObjectCreate Edit

sspmateria
きのこスキンが頭に生えた際に発生。

解説 Edit

きのこスキンが頭に生えた際に発生。

パラメータ Edit

Reference0そのきのこの情報。
Reference1そのきのこの情報。
Reference2そのきのこの情報。

サンプル Edit



OnKinokoObjectDestroy Edit

sspmateria
きのこスキンが頭から消えた際に発生。Reference0

解説 Edit

きのこスキンが頭から消えた際に発生。Reference0

パラメータ Edit

Reference1そのきのこの情報。
Reference2そのきのこの情報。

サンプル Edit



OnKinokoObjectChanging Edit

sspmateria
きのこスキンを切り替えようとしている際に発生。

解説 Edit

きのこスキンを切り替えようとしている際に発生。

パラメータ Edit

Reference0切り替える直前のきのこの情報。
Reference1切り替える直前のきのこの情報。
Reference2切り替える直前のきのこの情報。

サンプル Edit



OnKinokoObjectChanged Edit

sspmateria
きのこスキンを切り替えた際に発生。

解説 Edit

きのこスキンを切り替えた際に発生。

パラメータ Edit

Reference0切り替えた後のきのこの情報。
Reference1切り替えた後のきのこの情報。
Reference2切り替えた後のきのこの情報。

サンプル Edit



OnKinokoObjectInstalled Edit

sspmateria
きのこスキンをドロップでインストールした際に発生。

解説 Edit

きのこスキンをドロップでインストールした際に発生。

パラメータ Edit

Reference0インストールされたきのこの情報。
Reference1インストールされたきのこの情報。
Reference2インストールされたきのこの情報。

サンプル Edit



OnSysResourceLow Edit

sspmateria
システムリソースが40%を切った際に発生。

解説 Edit

システムリソースが40%を切った際に発生。

サンプル Edit



OnSysResourceCritical Edit

sspmateria
システムリソースが20%を切った際に発生。

解説 Edit

システムリソースが20%を切った際に発生。

サンプル Edit



外部アプリ-猫どりふイベント Edit

OnNekodorifObjectDodge Edit

sspmateria
ヒットしなかった落下物が可視領域内から消滅した際に発生。

解説 Edit

ヒットしなかった落下物が可視領域内から消滅した際に発生。

パラメータ Edit

Reference0落下物の名前。
Reference1落下物の対象ゴースト名。
Reference2落下物のカテゴリ名。
Reference3きのこフラグ。きのこにあった場合は1、そうでなければ0。
Reference4落下物のターゲット名。

サンプル Edit



OnNekodorifObjectEmerge Edit

sspmateria
落下物が可視領域内に出現した際に発生。

解説 Edit

落下物が可視領域内に出現した際に発生。

パラメータ Edit

Reference0落下物の名前。
Reference1落下物の対象ゴースト名。
Reference2落下物のカテゴリ名。
Reference3きのこフラグ。きのこにあった場合は1、そうでなければ0。
Reference4落下物のターゲット名。

サンプル Edit



OnNekodorifObjectHit Edit

sspmateria
落下物がヒットした際に発生。

解説 Edit

落下物がヒットした際に発生。

パラメータ Edit

Reference0落下物の名前。
Reference1落下物の対象ゴースト名。
Reference2落下物のカテゴリ名。
Reference3きのこフラグ。きのこにあった場合は1、そうでなければ0。
Reference4落下物のターゲット名。

サンプル Edit



OnNekodorifObjectDrop Edit

sspmateria
落下物を再投下する際に発生。

解説 Edit

落下物を再投下する際に発生。

パラメータ Edit

Reference0落下物の名前。
Reference1落下物の対象ゴースト名。
Reference2落下物のカテゴリ名。
Reference3きのこフラグ。きのこにあった場合は1、そうでなければ0。
Reference4落下物のターゲット名。

サンプル Edit



OnNekodorifObjectVanish Edit

sspmateria
ヒットした落下物が可視領域内から消滅した際に発生。

解説 Edit

ヒットした落下物が可視領域内から消滅した際に発生。

パラメータ Edit

Reference0落下物の名前。
Reference1落下物の対象ゴースト名。
Reference2落下物のカテゴリ名。
Reference3きのこフラグ。きのこにあった場合は1、そうでなければ0。
Reference4落下物のターゲット名。

サンプル Edit



時間イベント Edit

OnSecondChange Edit

crowsspmateria
秒変化

解説 Edit

現在時刻の秒の単位が変更された時に呼ばれるイベントです。

パラメータ Edit

Reference0連続起動時間(単位:時間)
Reference1見切れフラグ(1-見切れ中、0-通常)
Reference2重なりフラグ(1-重なり中、0-通常)
Reference3cantalkフラグ(1-実際に再生される、0-再生されない)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnSecondChange
Reference0: 2
Reference1: 0
Reference2: 0
Reference3: 1
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 204 No Content

OnMinuteChange Edit

crowsspmateria
分変化

解説 Edit

現在時刻の分の単位が変更された時に呼ばれるイベントです。

パラメータ Edit

Reference0連続起動時間(単位:時間)
Reference1見切れフラグ(1-見切れ中、0-通常)
Reference2重なりフラグ(1-重なり中、0-通常)
Reference3cantalkフラグ(1-実際に再生される、0-再生されない)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnMinuteChange
Reference0: 3
Reference1: 0
Reference2: 0
Reference3: 1
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 204 No Content

時計合わせイベント Edit

OnSNTPBegin Edit

crowsspmateria
時計合わせ開始

解説 Edit

時計合わせイベントが指示された直後に発生するイベントです。
この後、SNTPサーバから情報の取得を行います。

補足 Edit

  •  MATERIAの場合、このイベントは、ゴーストの起動時にも呼ばれ、その時点で「200 OK」としてValue(内容は問わない)を返さないと、このゴーストにおいて時計合わせ機能は使用不能と判断し、メニューから選択できなくなります。
     (但し、MATERIA 583 においては、このチェックリクエストは発生していません)

パラメータ Edit

Reference0接続先のSNTPサーバ

サンプル Edit

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 Edit

crowsspmateria
時計合わせ情報取得

解説 Edit

SNTPサーバより情報の取得に成功した時に、呼び出されるイベントです。
Reference1,2 には、それぞれSNTPサーバとローカルマシンの時刻が、次の順番に、半角カンマで区切られて代入されます。
 (年),(月),(日),(時),(分),(秒),

補足 Edit

  •  SSPでは、代入される時刻に、ミリ秒単位の項目が追加されて、
     (年),(月),(日),(時),(分),(秒),(ミリ秒)
    …と送られてきます。

パラメータ Edit

Reference0接続先のSNTPサーバ名
Reference1カンマでセパレートされた正確な(SNTP サーバ側の)時刻
Reference2カンマでセパレートされた現在の(自分のマシン側の)時刻
Reference3SNTPサーバと自分のマシンとの時刻のずれ(秒,常に正)

サンプル Edit

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

OnSNTPFailure Edit

sspmateria
時計合わせ情報取得失敗

解説 Edit

何らかの理由でSNTPサーバから情報が得られなかった場合に発生するイベントです。

パラメータ Edit

Reference0接続先のSNTPサーバ名

サンプル Edit



OnSNTPCorrect Edit

ssp
時計合わせ完了

解説 Edit

さくらスクリプトの「\6」タグ処理により、時計合わせが実際に行われた直後に呼び出されるイベントです。

補足 Edit

  •  MATERIA 583 では、このイベントは発生しません。
     また、Reference1はSSPのみ発生し、それぞれSNTPサーバとローカルマシンの時刻が、次の順番に、半角カンマで区切られて代入されます。
     (年),(月),(日),(時),(分),(秒),(ミリ秒)

パラメータ Edit

Reference0接続先のSNTPサーバ名
Reference1カンマでセパレートされた正確な(SNTP サーバ側の)時刻(SSPのみ)

サンプル Edit



消滅イベント Edit

OnVanishSelecting Edit

crowsspmateria
消滅が指示された

解説 Edit

ポップアップメニュー等から「消滅指示」が指示された直後に発生するイベントです。
この後「消滅を実行しますか?」と確認のダイアログ・ボックスが出ます。

補足 Edit

  •  さくらスクリプト/2.0 の「 \![vanishbymyself] 」タグ実行時には、このイベントは発生せず、その瞬間に消滅処理が実行されます。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnVanishSelecting
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示を実行しますか?\e

OnVanishSelected Edit

crowsspmateria
消滅指示実行

解説 Edit

「OnVanishSelecting」イベントで表示された指示確認のダイアログボックスで「消滅」する旨の選択が行なわれた時に発生します。
このイベントで本体に返したスクリプトを実行し終えた瞬間に、消滅処理が行なわれ、既にインストールされているゴーストに切り替わります。

補足 Edit

  • MATERIAにおいては「デフォルトであるさくらは消滅出来ない(指示しても拒否する)」つまり「必ず切り替わる相手(さくら)がいる」ため、必ず消滅処理は行なわれます。(仮に「first」フォルダをあらかじめ削除し、1体しかインストールされていない状況でも、データは削除されてしまう)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnVanishSelected
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示を実行します。

OnVanishCancel Edit

crowsspmateria
消滅指示取り消し

解説 Edit

「OnVanishSelecting」イベントで表示された指示確認のダイアログボックスで「指示を取り消す」旨の選択が行なわれた時に発生します。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnVanishCancel
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示が取り消されました。\e

OnVanishButtonHold Edit

crowsspmateria
消滅指示後のキャンセル

解説 Edit

「OnVanishSelected」イベントにより本体へ送られたさくらスクリプトを再生中に、バルーンをダブルクリックすると、消滅指示をキャンセルした(引きとめられた)ものとみなし、このイベントが発生します。

補足 Edit

  • 「OnVanishSelecting」イベント中に、本体をダブルクリックした際にも発生し、そのときはこのイベントと同時に消滅確認ダイアログが表示されます。
    ここで「はい」を選ぶと「OnVanishSelected」イベントが発生し、その最中に本体をダブルクリックすると「OnMouseDoubleClick」が発生し消滅は取り消されます。

    Reference0,1の送信はSSP 1.11系からです。

パラメータ Edit

Reference0中断されたスクリプト(存在すれば)
Reference1どちら側のバルーンから中断操作が行われたか (\0 = 0 \1 = 1 \p[2] = 2 ...)

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnVanishButtonHold
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]消滅指示が、ダブルクリックにより中断されました。\e

OnVanished Edit

crowsspmateria
ゴースト切り替え(前ゴースト消滅時)

解説 Edit

前のゴーストが、消滅指示イベント(または「 \![vanishbymyself] 」タグ実行)によって消滅した後に、自分に切り替えられ、切り替え処理が完了後、「OnGhostChanged」の代わりに一番最初に呼ばれるイベントです。

補足 Edit

  • このイベントに返答しない(204またはエラーを返した)場合、「OnGhostChanged」が発生します。

    また、MATERIA Phase583 では、Reference0 は空データが送られてきます。

    Reference1,2,7はSSP(1.10以降)でのみ利用できます。

パラメータ Edit

Reference0消されたゴーストの\0名(sakuraname)
Reference1消されたゴーストのOnVanishSelectedイベントで喋ったスクリプト [SSP]
Reference2消されたゴーストのフル名称(name) [SSP]
Reference7シェルの名前 [SSP]

サンプル Edit



OnOtherGhostVanished Edit

ssp
他のゴーストが消えた

解説 Edit

前のゴーストが、消滅指示イベント(または「 \![vanishbymyself] 」タグ実行)によって消滅した後に、何か別のゴーストに切り替えられた際に、その時に同時起動していたほかのゴーストに通知されるイベントです。Vanishして切り替えられた先にはOnVanishedイベントが通知されます。

パラメータ Edit

Reference0消されたゴーストの\0名(sakuraname)
Reference1消されたゴーストのOnVanishSelectedイベントで喋ったスクリプト
Reference2消されたゴーストのフル名称(name)

サンプル Edit



情報通知イベント Edit

OnNotifySelfInfo Edit

crowssp
ゴースト自身の情報通知

解説 Edit

ゴーストが起動した際に、そのゴースト自身の情報がまとめて通知されます。

補足 Edit

  • このイベントはNotifyイベントです。
    スクリプトを返しても再生されません。

    Reference5、Reference6はSSP 1.10.04以降での追加です。

パラメータ Edit

Reference0ゴースト名
Reference1Sakura名
Reference2Kero名
Reference3起動時のシェル名
Reference4起動時のシェルのパス (例: shell/master/) 絶対パスか相対パスかは処理系依存
Reference5起動時のバルーン名
Reference6起動時のバルーンのパス (例: balloon/master/) 絶対パスか相対パスかは処理系依存

サンプル Edit



basewareversion Edit

crowssp
実行環境のバージョン通知

解説 Edit

今現在ゴーストを実行中の環境のバージョンを通知します。
例:
Reference0: 0.4.11
Reference1: CROW

Reference0: 1.10.17[B]
Reference1: SSP
Reference2: 1.10.17.3001

補足 Edit

  • SHIORI読み込み後に、その他の情報通知イベントと共に常時通知されます。

パラメータ Edit

Reference0バージョン情報
Reference1本体識別文字列 (SSP・CROWなど)
Reference2数値のみ4ブロックのバージョン情報 (SSPのみ)

サンプル Edit



rateofusegraph Edit

ssp
使ってるぞグラフの内容表示

解説 Edit

使ってるぞグラフの情報をそのまま通知します。
起動中何度も通知される可能性があります。

補足 Edit

  • Reference0以降には以下のフォーマットで情報が入ります。
    なお、[1]はバイト値1です。

    名前(name)[1]sakura名[1]kero名[1]起動回数[1]起動時間(分)[1]起動時間%[1](boot|install|vanish)

    bootは起動中、installはインストールされている、vanishはログのみに情報が残存を示します。

パラメータ Edit

Reference0(補足参照)

サンプル Edit



状態変更イベント Edit

OnBoot Edit

crowsspmateria
通常起動

解説 Edit

本体起動時に発生するイベントです。

補足 Edit

  • インストール後初めての起動の場合は、このイベントは呼ばれず、OnFirstBootが発生します。

    Reference6,7はMATERIA,SSPのみのサポートとなります。
    また、異常終了時は常に通知されるとは限りません。

    Reference7は\0側名、descript.txtのsakuranameエントリが入ります。
    ※SSPの1.09.17以前では実装ミスによりnameエントリが入っています。

パラメータ Edit

Reference0起動時のシェルの名称
Reference6前回の起動時に異常終了した際に"halt"が入る
Reference7前回の起動時に異常終了した際に、その時起動していたゴーストの\0名(sakuraname)が入る

サンプル Edit

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

OnClose Edit

crowsspmateria
終了指示

解説 Edit

本体終了が指示された時に発生するイベントです。
通常は、本体終了タグ(\-)を含んだ応答を返す必要があります。
本体終了タグが含まれていないと、終了しません。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnClose
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]終了\-\e

OnFirstBoot Edit

crowsspmateria
初回起動

解説 Edit

ゴーストインストール後の一番最初の起動において、
OnBootや、OnGhostChangedイベントの替わりにに呼び出されるイベントです。

補足 Edit

  • そのゴーストが、今までに消滅指示を受けたことがあれば、
    その通産回数がReference0に入ります。
    その本体で、最初の起動ならばReference0は0が入ります。

パラメータ Edit

Reference0そのゴーストが Vanish された通算回数
Reference7起動時のシェルの名称

サンプル Edit

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

OnWindowStateMinimize Edit

crowsspmateria
最小化

解説 Edit

アイコン化を選んだときに発生するイベントです。
サイレントイベントのため、応答があっても無視されます。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnWindowStateMinimize
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 204 No Content
Charset: Shift_JIS

OnWindowStateRestore Edit

crowsspmateria
最小化復帰

解説 Edit

アイコン化解除が指示された時に発生するイベントです。
実際にアイコン化解除処理が行われたあとに、この応答が処理されます。

補足 Edit

  • このイベントが応答を返さないと、何も表示されない状態になります。
    必ず、サーフィスを表示するタグを応答に含めてください。
    なお、CROWでは問題ありません。

サンプル Edit

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

OnDisplayChange Edit

ssp
デスクトップ変化

解説 Edit

デスクトップの解像度や色深度が変化した時に発生します。

補足 Edit

  • ゴーストの起動時にも、その時点でのデスクトップの状態を送る目的で発生します。
    +(Notifyイベント)+

パラメータ Edit

Reference0画面の色深度(bit)
Reference1画面の解像度(縦方向ドット数)
Reference2画面の解像度(横方向ドット数)

サンプル Edit



OnShellScaling Edit

ssp
シェル拡大/縮小率変更

解説 Edit

シェル拡大/縮小率が変更されたときに通知されます。

パラメータ Edit

Reference0新しい拡大率ヨコ(X)
Reference1元の旧い拡大率ヨコ(X)
Reference2新しい拡大率タテ(Y)
Reference3元の旧い拡大率タテ(Y)

サンプル Edit



切り替えイベント Edit

OnGhostChanging Edit

crowsspmateria
ゴースト切り替え指示

解説 Edit

別のゴーストへの切り替えが指示された時に発生するイベントです。
自分自身へ切り替えたときにも発生します。

補足 Edit

  • メニューから切り替えた際にはReference1にはmanualが入ります。
    本体に自動切換えの設定を行い、自動で切り替わった場合Reference1にはautomaticが入ります。

    SSP,CROWの場合のみReference2が通知されます。

パラメータ Edit

Reference0次のゴーストの\0側の名前
Reference1切り替えメソッド(manual/automatic)
Reference2次のゴーストのフルネーム(nameエントリ) [SSP/CROW]

サンプル Edit

手動切り替え時
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

OnGhostChanged Edit

crowsspmateria
ゴースト切り替え完了

解説 Edit

ゴースト切り替え完了後に、最初に呼ばれるイベントです。

補足 Edit

  • 切り替えた先のゴーストがインストール後初の呼び出しだった場合、
    このイベントは発生せず、OnFirstBootが発生します。

    Reference2はSSP,CROWの時のみ通知されます。
    Reference7はSSPのみ通知されます。

パラメータ Edit

Reference0直前のゴーストの\0側の名前
Reference1直前のゴーストの最後のスクリプト
Reference2直前のゴーストのフルネーム(nameエントリ) [SSP/CROW]
Reference7シェルの名前 [SSP]

サンプル Edit

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

OnShellChanging Edit

crowsspmateria
シェル切り替え指示

解説 Edit

別のシェルへの切り替えが指示された時に発生するイベントです。

補足 Edit

  • シェルインストールにより切り替わった場合は、このイベントは発生しません。

    Reference2の情報は、CROWとSSPのみです。Materiaでは通知されません。

パラメータ Edit

Reference0選択されたシェルの名称
Reference2選択されたシェルのパス (例:shell/master/)

サンプル Edit

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

OnShellChanged Edit

crowsspmateria
シェル切り替え完了

解説 Edit

別のシェルへの切り替えが指示された時に発生するイベントです。
今までと同じシェルへ切り替えたときにも発生します。

補足 Edit

  • Reference1に入る内容は、Reference0と同一です。

    Reference2の情報は、CROWとSSPのみです。Materiaでは通知されません。

パラメータ Edit

Reference0選択されたシェルの名称
Reference1選択されたシェルの名称
Reference2選択されたシェルのパス (例:shell/master/)

サンプル Edit

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

OnGhostCalling Edit

ssp
ゴースト呼び出し中

解説 Edit

複数ゴースト起動機能において、ゴーストの呼び出し開始時に呼び出し操作を行ったゴーストに通知されます。

補足 Edit

  • SSP 1.09.18より仮実装、1.10以降より正式に利用可能。
    呼び出しメソッドのautomaticは現在のところ利用されていません。

パラメータ Edit

Reference0次のゴーストの\0側の名前
Reference1呼び出しメソッド(manual/automatic)
Reference2次のゴーストのフルネーム(nameエントリ)

サンプル Edit



OnGhostCalled Edit

ssp
ゴースト呼び出し完了

解説 Edit

複数ゴースト起動機能において、ゴーストの呼び出し機能でゴーストが起動された場合に通知されます。
このイベントを無視した場合(204、その他エラー、または空スクリプトを返した場合)、通常のOnBootが再度通知されます。

補足 Edit

  • SSP 1.09.18より仮実装、1.10以降より正式に利用可能。

パラメータ Edit

Reference0呼び出し元ゴーストの\0側の名前
Reference1呼び出し元ゴーストのOnGhostCalling反応スクリプトもしくは\![call,ghost]を含むスクリプト
Reference2呼び出し元ゴーストのフルネーム(nameエントリ)
Reference7シェルの名前

サンプル Edit



OnGhostCallComplete Edit

ssp
ゴースト呼び出し完了(呼び出し元)

解説 Edit

複数ゴースト起動機能において、ゴーストの呼び出し機能でのゴーストが起動が完了して、起動スクリプトを喋り終わったタイミングで、呼び出し元(呼び出し操作を実行したゴースト)に通知されます。

補足 Edit

  • SSP 1.10.16より実装。
    通知される「起動スクリプト」は、OnGhostCalledの反応とは限りません。

パラメータ Edit

Reference0呼び出し先ゴーストの\0側の名前
Reference1呼び出し先ゴーストの起動スクリプト
Reference2呼び出し先ゴーストのフルネーム(nameエントリ)
Reference7呼び出し先ゴーストの起動時のシェル

サンプル Edit



OnOtherGhostClosed Edit

ssp
同時起動中のほかのゴーストが終了した

解説 Edit

同時起動中のほかのゴーストが終了した後に、呼ばれるイベントです。
具体的には、\-が実行された時点で他に通知されます。

補足 Edit

  • OnGhostChangedなどと同じ書式です。

    SSP 1.10.24から実装されています。

パラメータ Edit

Reference0終了したゴーストの\0側の名前
Reference1終了したゴーストの最後のスクリプト
Reference2終了したゴーストのフルネーム(nameエントリ) [SSP/CROW]

サンプル Edit



選択肢イベント Edit

OnChoiceSelect Edit

crowsspmateria
選択肢クリック

解説 Edit

選択肢をクリックした時に発生するイベントです。

パラメータ Edit

Reference0選択された選択肢が持つ識別子

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnChoiceSelect
Reference0: select1
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]選択肢がクリックされました。\e

OnChoiceTimeout Edit

crowsspmateria
選択肢タイムアウト

解説 Edit

選択肢がタイムアウトしたときに発生するイベントです。
Reference0には、この選択肢を出したスクリプトが入ります。

補足 Edit

  • [MATERIA] タイムアウト時間はは約15秒です。
    [SSP] タイムアウト時間はユーザ側で設定できます。

パラメータ Edit

Reference0この選択肢を出したスクリプト

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnChoiceTimeout
Reference0: \0\s[0]\q[選択肢1,sel1,expand]\q[選択肢2,sel2]\e
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\s[0]選択肢がタイムアウトしました。\e

OnAnchorSelect Edit

crowsspmateria
アンカークリック

解説 Edit

アンカーをクリックしたときに発生するイベントです。

補足 Edit

  • アンカーがクリックされても、このイベントに応答を返さなければバルーンは閉じず、
    そのままの状態を維持します。

パラメータ Edit

Reference0選択されたアンカーが持つ識別子

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnAnchorSelect
Reference0: anchor1
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 200 OK
Value: \0\\s[0]アンカー1が選ばれました。\e

OnChoiceEnter Edit

crowsspmateria
選択肢フォーカス変化

解説 Edit

アンカー以外の選択肢の上にカーソルが乗った瞬間および外れた瞬間に発生するイベントです。
外れた際はReference0とReference1には空文字列が入ります。
サイレントイベントのため、応答があっても無視されます。

補足 Edit

  • 選択肢を決定する直前にも発生します。
    その場合、応答はReference0のみで空文字列が入ります。

パラメータ Edit

Reference0選択肢のタイトル
Reference1ジャンプラベル
Reference2以下拡張情報

サンプル Edit

選択肢にフォーカスが移った場合
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

入力ボックスイベント Edit

OnCommunicate Edit

crowsspmateria
コミュニケート

解説 Edit

外部から話し掛けられた瞬間に発生するイベントです。
ユーザから話し掛けられた場合、Reference0はuserという文字列が入り、
ゴーストから話し掛けられた場合は、そのゴーストの名前が入ります。

パラメータ Edit

Reference0送り元の名前(user/ゴースト名)
Reference1スクリプト
Reference2以下拡張情報

サンプル Edit

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

OnTeachStart Edit

crowsspmateria
TeachBoxオープン

解説 Edit

TeachBoxがオープンした際に発生するイベントです。

サンプル Edit

GET SHIORI/3.0
Sender: crow
ID: OnTeachStart
SecurityLevel: local
Charset: Shift_JIS

SHIORI/3.0 204 No Content
Charset: Shift_JIS

OnUserInput Edit

crowsspmateria
InputBoxクローズ

解説 Edit

InputBoxが閉じた際に発生するイベントです。
ユーザーが値を入力してリターンを押した場合と、タイムアウトした場合があります。
タイムアウトした場合は、入力値の代わりにtimeoutという文字列が返ります。

補足 Edit

  • InputBoxを閉じた際には必ずこのイベントが発生するとは限りません。
    InputBoxを開くタグの第3引数の頭にOnがついていない場合のみこのイベントが発生します。

    第3引数の頭にOnがついていると、このイベントは発生せず、第3引数で指定したイベントが発生します。その際にはReference0で入力した文字列もしくはtimeoutが渡されます。

パラメータ Edit

Reference0\![open,inputbox]で指定した識別子
Reference1入力した文字列か、timeout

サンプル Edit

入力が決定した場合
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


このページの最終更新日: 2012/10/01 16:10:00 JST (1638d)
このページのトラックバックURL: http://ukiya.sakura.ne.jp/index.php?tb_id=4078aada2537a453734cd1b074bd1a9e