起動・終了・切り替えイベント

OnFirstBoot

初回起動した際に発生。
SSPでは、このイベントにスクリプトが返されなかった（204）場合、続けてOnBootが発生する。

Reference0: vanishされた回数。

OnBoot

起動した際に発生。
SSPでは、OnGhostChanged、OnGhostCalled、OnFirstBoot、OnVanishedに対してスクリプトが返されなかった（204）場合、続けてこのイベントが発生する。

Reference0: 起動時のシェル名。
Reference6: ※MATERIA、SSPのみ　前回の処理中で落ちた時にhalt。
Reference7: ※MATERIA、SSPのみ　前回の処理中で落ちたゴースト名。

OnClose

終了が指示された際に発生。
SSPでは、OnGhostChanging、OnCloseAllに対してスクリプトが返されなかった（204）場合、続けてこのイベントが発生する。

Reference0: ※SSPのみ　終了理由。
ユーザーが終了した場合、user
シャットダウンした場合、systemが返される。
Reference1: ※SSPのみ　終了操作したメニューが属するキャラクターのスコープ番号。popupmenu.typeに影響される。(本体側0,相方1...)
Reference2: ※SSPのみ　終了操作したウインドウのキャラクターのスコープ番号。popupmenu.typeに影響されない。(本体側0,相方1...)

OnCloseAll

SSP自体が終了する際に発生。
オーナードローメニューの「すべて終了」が指示された場合の他、唯一起動中のゴーストにおいて「終了」が指示された場合、およびOSのシャットダウンに伴いSSPが終了する場合にも発生する。

Reference0: ※SSPのみ　終了理由。
ユーザーが終了した場合、user
シャットダウンした場合、systemが返される。
Reference1: ※SSPのみ　終了操作したメニューが属するキャラクターのスコープ番号。popupmenu.typeに影響される。(本体側0,相方1...)
Reference2: ※SSPのみ　終了操作したウインドウのキャラクターのスコープ番号。popupmenu.typeに影響されない。(本体側0,相方1...)

OnGhostChanged

他のゴーストから自ゴーストに切り替えられた際に発生。
SSPでは、このイベントにスクリプトが返されなかった（204）場合、続けてOnBootが発生する。

Reference0: 直前のゴーストの本体側の名前。
Reference1: 直前のゴーストの切り替え時のスクリプト。
Reference2: 直前のゴーストの名前。 [SSPのみ]
Reference3: 直前のゴーストのパス（ファイルの場所）。 [SSPのみ]
Reference7: 切り替わったゴーストのシェル名。 [SSPのみ]

OnGhostChanging

他のゴーストへの切り替え指示があった際に発生。
SSPでは、このイベントにスクリプトが返されなかった（204）場合、続けてOnCloseが発生する。

Reference0: 切り替わるゴーストの本体側の名前。
Reference1: 手動で切り替えた場合、manual
システムにより切り替えられた場合、automatic
が返される。
Reference2: 切り替わるゴーストの名前。[SSPのみ]
Reference3: 切り替わるゴーストのパス。[SSPのみ]

OnGhostCalled

他のゴーストから呼び出された際に発生。
SSPでは、このイベントにスクリプトが返されなかった（204）場合、続けてOnBootが発生する。

Reference0: 呼び出したゴーストの本体側の名前。
Reference1: 呼び出したゴーストの呼び出し時のスクリプト。
Reference2: 呼び出したゴーストの名前。
Reference3: 呼び出したゴーストのパス。
Reference7: 呼び出されたゴーストのシェル名。

OnGhostCalling

他のゴーストの呼び出しが指示された際に発生。

Reference0: 呼び出すゴーストの本体側の名前。
Reference1: 手動で切り替えた場合、manual
システムにより切り替えられた場合、automatic
が返される。
Reference2: 呼び出すゴーストの名前。
Reference3: 呼び出すゴーストのパス。

OnGhostCallComplete

他のゴーストを呼び出し、そのゴーストが起動スクリプトを完了後発生。

Reference0: 呼び出したゴーストの本体側の名前。
Reference1: 呼び出したゴーストの起動時のスクリプト。
Reference2: 呼び出したゴーストの名前。
Reference7: 呼び出したゴーストのシェル名。

OnOtherGhostBooted

他のゴーストに呼び出された、他のゴーストが起動した際に発生。
言い換えると、呼び出したゴーストにOnGhostCallCompleteが発生するタイミングで、無関係なゴーストに発生。

Reference0: 起動したゴーストの本体側名。
Reference1: 起動したゴーストの起動時のスクリプト。
Reference2: 起動したゴースト名。
Reference7: 起動したゴーストのシェル名。

OnOtherGhostChanged

他のゴースト間で切り替わった際に発生。

Reference0: 直前のゴーストの本体側の名前。
Reference1: 切り替わったゴーストの本体側の名前。
Reference2: 直前のゴーストの切り替え時のスクリプト。
Reference3: 切り替わったゴーストの切り替わり時のスクリプト。
Reference4: 直前のゴースト名。
Reference5: 切り替わったゴースト名。
Reference14: 直前のゴーストのシェル名。
Reference15: 切り替わったゴーストのシェル名。

OnOtherGhostClosed

複数起動中、他のゴーストが終了された際に発生。

Reference0: 終了したゴーストの本体側の名前。
Reference1: 終了したゴーストの最後のスクリプト。
Reference2: 終了したゴースト名。
Reference7: 終了したゴーストのシェル名。

OnShellChanged

他のシェルから切り替わった際に発生。

Reference0: 現在のシェル名。
Reference1: （CROWのみ）Reference0と同じ。（SSPのみ）現在のゴースト名。
Reference2: （SSPのみ）現在のシェルのパス。

OnShellChanging

他のシェルへ切り替えた際に発生。

Reference0: 切り替わるシェル名。
Reference1: （SSPのみ）切り替わる前（現在）のシェル名。
Reference2: （SSPのみ）切り替わるシェルのパス。

OnDressupChanged

着せ替えが切替えられた際に発生する。
複数回通知される場合があり、その場合は一番最後のOnDressupChangedが[GET]、それ以外が[NOTIFY]となる。
このイベントの後に発生するOnNotifyDressupInfoも参照すること。

Reference0: 着せ替え対象のキャラクターID。
Reference1: パーツの名称。
Reference2: 有効になった時に1、無効になった時に0。
Reference3: パーツのカテゴリ名。
Reference4: スクリプトから実行された時はscript、メニューから実行された時はuser [2.5.90～]

OnBalloonChange

他のバルーンから切り替わった際に発生。

Reference0: 切り替わったバルーン名。
Reference1: 切り替わったバルーンのパス。

OnWindowStateRestore

最小化が解除された際に発生。

Reference0: （SSPのみ）最小化された理由。
system : OSからの強制的な最小化操作（タスクバーから最小化された場合を含む）
script : SakuraScriptから
sakuraapi : Sakura APIから
user : メニュー操作

OnWindowStateMinimize

最小化が指示された際に発生。
※SSPのみ設定で喋らせることが可能。

Reference0: （SSPのみ）最小化された理由。
system : OSからの強制的な最小化操作（タスクバーから最小化された場合を含む）
script : SakuraScriptから
sakuraapi : Sakura APIから
user : メニュー操作

OnFullScreenAppMinimize

全画面表示のアプリ起動に対するSSP最小化の際に発生。
通常の最小化時に発生するOnWindowStateMinimizeに上書きされる。

Reference0: （SSPのみ）最小化された理由。常に fullscreen になる。

OnFullScreenAppRestore

全画面表示のアプリ終了に対するSSP最小化復帰の際に発生。
通常の最小化復帰時に発生するOnWindowStateRestoreに上書きされる。

Reference0: （SSPのみ）最小化された理由。常に fullscreen になる。

OnVirtualDesktopChanged

仮想デスクトップが切り替わった際に発生。
現状Windows 10上でのみ有効。
実験的機能のため今後仕様が変わる可能性がある。

Reference0: current：現在の仮想デスクトップとゴースト表示中のデスクトップが同じ
hidden：仮想デスクトップが切り替えられ、非表示状態
minimize：ウインドウが最小化されておりどの仮想デスクトップに属するかわからない
Reference1: 現在の仮想デスクトップID。

OnCacheSuspend

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

OnCacheRestore

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

OnInitialize

起動した際に発生。[NOTIFY]

Reference0: リロード時にreload、それ以外は無し（空文字列またはReference0自体が来ない）

OnDestroy

終了が指示された際に発生。[NOTIFY]

Reference0: リロード時にreload、それ以外は無し（空文字列またはReference0自体が来ない）

OnSysResume

サスペンド（スリープ・休止状態（ハイバネーション）両方）解除の際に発生。

Reference0: 解除理由。通常normal、システムのスケジュールによる自動解除時auto、バッテリー切れで非常停止した場合critical（Windows Vista以降廃止）

OnSysSuspend

サスペンド（スリープ・休止状態（ハイバネーション）両方）開始の際に発生。[NOTIFY]

OnBasewareUpdating

本体更新時、ダウンロードが終わりファイル更新を開始する前に発生。このイベントに反応がない場合はOnCloseAll、OnCloseの順に発生する。

Reference0: 更新前のバージョン番号　例：2.3.58
Reference1: 更新前のWindowsエクスプローラで見られるプロパティと同じバージョン番号　例：2.3.58.3000

OnBasewareUpdated

本体更新終了後、ゴーストが起動する時に発生。このイベントに反応がない場合はOnBootが発生する。

Reference0: 更新後のバージョン番号　例：2.3.59
Reference1: 更新後のWindowsエクスプローラで見られるプロパティと同じバージョン番号　例：2.3.59.3000

入力ボックスイベント

OnTeachStart

TeachBoxがオープンした際に発生。

OnTeachInputCancel

TeachBoxが閉じられた際に発生。

Reference0: (空文字列。OnUserInputCancelとReferenceの番号をあわせるための空席。)
Reference1: 閉じられた場合、cancel。

OnTeach

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

Reference*: 入力された言葉の履歴。Reference0が1回目～最新の入力が末尾(n回目の入力がReference[n-1])

OnCommunicate

CommunicateBox、または他ゴーストからスクリプトを渡された際に発生。

Reference0: Boxからはuser、ゴーストからはゴーストの本体側名。
Reference1: スクリプトの内容。
Reference*: 拡張情報。

OnCommunicateInputCancel

CommunicateBoxが閉じられた際に発生。

Reference0: (空文字列。OnUserInputCancelとReferenceの番号をあわせるための空席。)
Reference1: 閉じられた場合、cancel。

OnUserInput

InputBoxに入力され決定された際に発生。

InputBoxのIDも参照のこと。

Reference0: InputBoxのID。
Reference1: 入力された内容。
Reference2: 入力内容補足(sliderinputのみ、最小,最大。ほかは空欄)
Reference3～: --reference=で指定した追加情報

OnUserInputCancel

InputBoxが閉じられた際に発生。

Reference0: 入力のイベントID。
Reference1: タイムアウトした場合、timeout。閉じられた場合、close。
Reference2: 入力内容補足(sliderinputのみ、最小,最大。ほかは空欄)
Reference3～: --reference=で指定した追加情報

inputbox.autocomplete

ボックス展開時に発生。このイベントにバイト値1区切りでテキストのリストを返すと、入力ボックスでオートコンプリート機能が動作。
(WinMe/2000以降)

Reference0: 入力ボックスの種類。inputbox・teachbox・communicateboxのいずれか。
Reference1: inputboxの場合のみ、入力完了時に起きるイベント名／識別子。

ダイアログボックスイベント

OnSystemDialog

ファイル関連のダイアログで保存/OKが押された際に発生。

Reference0: open・save・folder・colorのいずれか。
Reference1: イベントID。
Reference2: ファイルのパスまたはカンマ区切りのRGB値。

OnSystemDialogCancel

ファイル関連のダイアログでキャンセルが押された際に発生。

Reference0: open・save・folder・colorのいずれか。
Reference1: イベントID。

OnConfigurationDialogHelp

設定ダイアログのヘルプボタンで項目をクリックした際に発生。

Reference0

ダイアログID。種類とページとの対応は以下。

setup …… 一般
ghost …… ゴースト(1)
ghost2 …… ゴースト(2)
folder …… フォルダ
display …… 表示
dictation …… 音声合成/認識
talk …… 喋り/バルーン
network …… 接続(1)
network2 …… 接続(2)
biff …… メール
application …… 外部アプリ
messenger …… IM
ipmessenger …… IPMessenger
international …… 国際化
developer …… 開発/その他

Reference1

ダイアログタイトル。

Reference2

項目タイプ:項目名。

Reference3

項目内容テキスト。

OnGhostTermsAccept

利用条件ダイアログで受諾が押された際に発生。
右上の閉じるボタンでは何もイベントは発生しない。

2.5.33

OnGhostTermsDecline

利用条件ダイアログで拒否が押された際に発生。
右上の閉じるボタンでは何もイベントは発生しない。

2.5.33

時間イベント

OnSecondChange

1秒ごとに発生。

トーク再生不能な時は、Reference3が0になった上でNOTIFYでイベント通知される。返されたスクリプトは無視される。

Reference0: OSの連続起動時間（hour）
Reference1: 見切れ時に1、それ以外は0。
Reference2: 重なり時に1、それ以外は0。
Reference3: トーク再生可能なときに1、それ以外は0。
Reference4: ※SSPのみ　(OSレベルで)何も操作せず放置されている時間。秒単位。

OnMinuteChange

1分ごとに発生。

トーク再生不能な時は、Reference3が0になった上でNOTIFYでイベント通知される。返されたスクリプトは無視される。

Reference0: OSの連続起動時間（hour）
Reference1: 見切れ時に1、それ以外は0。
Reference2: 重なり時に1、それ以外は0。
Reference3: トーク再生可能なときに1、それ以外は0。
Reference4: ※SSPのみ　(OSレベルで)何も操作せず放置されている時間。秒単位。

OnHourTimeSignal

時報イベント。毎正時(?時0分0秒近く)に発生。

トーク再生不能な時はトークできるようになるまで待つ。そのため少しずれた時間に通知されることがある。

Reference0: OSの連続起動時間（hour）
Reference1: 見切れ時に1、それ以外は0。
Reference2: 重なり時に1、それ以外は0。
Reference3: 常に1。(トーク再生可能になるまで待つため)
Reference4: ※SSPのみ　(OSレベルで)何も操作せず放置されている時間。秒単位。

消滅イベント

OnVanishSelecting

消滅が指示された際に発生。

OnVanishSelected

確認ダイアログでYESが選択された際に発生。

OnVanishCancel

確認ダイアログでNOが選択された際に発生。

OnVanishButtonHold

消滅イベント中ダブルクリックでキャンセルされた際に発生。

Reference0: 中断の操作が起きたスクリプト。
Reference1: 中断の操作が起きたバルーンのスコープ番号。本体側0、相方側1、それ以降も。
Reference2: 中断位置。スクリプト先頭からの文字数で表現。文字数はさくらスクリプトのタグも含めたもの。
例）\s[2]あいうえお　の「あ」までで中断された場合、6

OnVanished

直前のゴーストの消滅により自分に切り替わった際に発生。
SSPでは、このイベントにスクリプトが返されなかった（204）場合、続けてOnBootが発生する。
またSSPでは同時起動中の他のゴーストが消滅した際に、OnOtherGhostVanishedへスクリプトが返却されなかった際にも発生するため注意。この場合OnBootへのフォールバックはない。

Reference0: 消滅したゴーストの本体側の名前。
Reference1: ※SSPのみ　消滅したゴーストのOnVanishSelectedイベントのスクリプト。
Reference2: ※SSPのみ　消滅したゴースト名。
Reference7: ※SSPのみ　切り替わったゴーストのシェル名。

OnOtherGhostVanished

複数起動中、他のゴーストが消滅した際に発生。

Reference0: 消滅したゴーストの本体側の名前。
Reference1: 消滅したゴーストのOnVanishSelectedイベントのスクリプト。
Reference2: 消滅したゴースト名。
Reference7: 切り替わったゴーストのシェル名。

選択肢イベント

OnChoiceSelect

選択肢が選択された際に発生。

Reference0: 選択された選択肢のID。
Reference*: ※CROWのみ　選択肢の２番目以降のID。

OnChoiceSelectEx

選択肢が選択された際に発生。
OnChoiceSelectよりも先に開始。

Reference0: 選択肢のテキスト（ラベル）。
Reference1: 選択肢のID。
Reference*: 拡張情報(\qタグ内の3番目以降の引数)。

OnChoiceEnter

選択肢上にカーソルが乗った際と外れた際に発生。
選択肢から外れた際のOnChoiceEnterはReferenceなしで発生する。
[NOTIFY]

Reference0: 選択肢のテキスト（ラベル）。
Reference1: 選択肢のID。
Reference*: 拡張情報(\qタグ内の3番目以降の引数)。

OnChoiceTimeout

選択肢待ち時間がタイムアウトした際に発生。

Reference0: タイムアウトしたスクリプト。

OnChoiceHover

選択肢上で静止された際に発生。

Reference0: 選択肢のテキスト（ラベル）。
Reference1: 選択肢のID。
Reference*: 拡張情報(\qタグ内の3番目以降の引数)。

OnAnchorSelect

\_aジャンパがクリックされた瞬間に発生。

Reference0: 選択されたジャンパのID。

OnAnchorSelectEx

\_aジャンパがクリックされた瞬間に発生。このイベントにSHIORIが何も返さなかった場合にのみ、続けてOnAnchorSelectが発生する。

Reference0: 選択されたジャンパのテキスト。
Reference1: 選択されたジャンパのID。
Reference*: 拡張情報(\_aタグ内の2番目以降の引数)。

OnAnchorEnter

\_aジャンパ上にカーソルが乗った際と外れた際に発生。

Reference0: ジャンパのテキスト。
Reference1: ジャンパのID。
Reference*: 拡張情報(\_aタグ内の2番目以降の引数)。

OnAnchorHover

\_aジャンパ上で静止された際に発生。

Reference0: ジャンパのテキスト。
Reference1: ジャンパのID。
Reference*: 拡張情報(\_aタグ内の2番目以降の引数)。

サーフェスイベント

OnSurfaceChange

サーフェスが変わった際に発生。
[NOTIFY]

Reference0: 本体側の現在サーフェス。
Reference1: 相方側の現在サーフェス。
Reference2: ※SSPのみ　キャラID,サーフェス番号,幅,高さ

OnSurfaceRestore

トーク後一定時間経過後に一度発生。
SSPの場合は本体設定の喋りタイムアウトで設定された秒数+１５秒後に発生（つまりバルーンが閉じてから１５秒後）。
※喋りタイムアウト設定が０のときだけOnSurfaceRestoreが発生するまでバルーンが表示され続ける。

Reference0: 本体側の現在サーフェス。
Reference1: 相方側の現在サーフェス。

OnOtherSurfaceChange

（自分以外の）他のゴーストのサーフェス（表情）が変わった際に通知されます。
負荷対策のため、標準では無効のイベントです。このイベントを使用するためには、事前に \![set,othersurfacechange,true] で有効化する必要があります。

Reference0: ゴースト名
Reference1: ゴーストSakura名
Reference2: サーフェスが切り替わったウインドウID(Sakura=0)
Reference3: 新サーフェスID
Reference4: 旧サーフェスID
Reference5: 新しいサーフェスの大きさ(座標：左,上,右,下)

マウスイベント

OnMouseClick

左・右ボタン（＋中ボタン）でマウスクリックされた時(マウスボタンを1回押して放された瞬間)に、OnMouseUpに反応しない場合に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1、中クリックは2(互換仕様：OnMouseClickExへの移行を推奨)。
Reference6: ※SSPのみ　windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseClickEx

左・右ボタン以外でマウスクリックされた時(マウスボタンを1回押して放された瞬間)に、OnMouseUpExに反応しない場合に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ホイールクリック(または3ボタンマウスの中ボタン)はmiddle、拡張ボタン1(通常「戻る」に割当)はxbutton1、拡張ボタン2(通常「進む」に割当)はxbutton2。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDoubleClick

左・右ボタンでダブルクリックされた際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1。
Reference6: ※SSPのみ　windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDoubleClickEx

左・右ボタン以外でダブルクリックされた際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ホイールクリック(または3ボタンマウスの中ボタン)はmiddle、拡張ボタン1(通常「戻る」に割当)はxbutton1、拡張ボタン2(通常「進む」に割当)はxbutton2。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseMultipleClick

3回以上連続でクリックされた際に発生。
※SHIORIから同イベントに応答が無い場合、通常通りOnMouseClickとOnMouseDoubleClickの流れに戻る。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。それ以降2～
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse
Reference7: 連続クリック回数

OnMouseMultipleClickEx

左・右ボタン以外で3回以上連続でクリックされた際に発生。
※SHIORIから同イベントに応答が無い場合、通常通りOnMouseClickExとOnMouseDoubleClickExの流れに戻る。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。それ以降2～
Reference4: 当たり判定の識別子。
Reference5: ホイールクリック(または3ボタンマウスの中ボタン)はmiddle、拡張ボタン1(通常「戻る」に割当)はxbutton1、拡張ボタン2(通常「進む」に割当)はxbutton2。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse
Reference7: 連続クリック回数

OnMouseUp

左・右のマウスボタンが放された際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1、中クリックは2(互換仕様：OnMouseClickExへの移行を推奨)。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseUpEx

左・右以外のマウスボタンが放された際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ホイールクリック(または3ボタンマウスの中ボタン)はmiddle、拡張ボタン1(通常「戻る」に割当)はxbutton1、拡張ボタン2(通常「進む」に割当)はxbutton2。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDown

左・右のマウスボタンが押された際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1、中クリックは2(互換仕様：OnMouseClickExへの移行を推奨)。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDownEx

左・右以外のマウスボタンが押された際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ホイールクリック(または3ボタンマウスの中ボタン)はmiddle、拡張ボタン1(通常「戻る」に割当)はxbutton1、拡張ボタン2(通常「進む」に割当)はxbutton2。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseMove

マウスが移動した際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: マウスホイールの回転量および回転方向。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ※SSPのみ　常に0。
Reference6: ※SSPのみ　windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseWheel

マウスホイールが回転した際に発生。
SSP2.3.53以降、タッチパネル環境であった場合に、OnMouseGestureのReference5がupまたはdownであるようなものに対してSHIORIが何も返さなかった（204 No Contentが返された）時にも代替イベントとしてOnMouseWheelが発生する。その場合Reference2の数値は元々のOnMouseGestureの移動量とup・downの方向から変換される（upなら正数、downなら負数）。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: マウスホイールの回転量および回転方向。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: ※SSPのみ　常に0。
Reference6: ※SSPのみ　windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseEnterAll

マウスがキャラクターウインドウに入った際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 常に0。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseLeaveAll

マウスがキャラクターウインドウから出た際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 常に0。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseEnter

マウスが当たり判定に入った際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 常に0。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseLeave

マウスが当たり判定から出た際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 常に0。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDragStart

マウスをドラッグし始めた際に発生。ただしパッシブモードでは抑制される。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: マウスホイールの回転量および回転方向。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseDragEnd

マウスをドラッグし終えた際に発生。ただしパッシブモードでは抑制される。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: マウスホイールの回転量および回転方向。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 左クリックは0、右クリックは1。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseHover

マウスが静止している際に発生。

Reference0: マウスカーソルの x 座標（ローカル座標）
Reference1: マウスカーソルの y 座標（ローカル座標）
Reference2: 常に0。
Reference3: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference4: 当たり判定の識別子。
Reference5: 常に0。
Reference6: windows7以降、マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、マウスなどからの入力でmouse

OnMouseGesture

マウスを右ドラッグまたはホイールをドラッグした際に発生。
なおSSP2.3.53以降、タッチパネル環境でOnMouseGestureのReference5がupまたはdownであるようなものに対してSHIORIが何も返さなかった（204 No Contentが返された）場合、代替イベントとしてOnMouseWheelが発生する。詳細はOnMouseWheelの節を参照。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: マウスカーソルの xy 座標（バイト値1区切り）
Reference2: 当たり判定の識別子。
Reference3: 右ドラッグを開始したマウスカーソルの xy 座標（バイト値1区切り）
Reference4: 右ドラッグを開始した当たり判定の識別子。
Reference5: ジェスチャー方向。
left_up(左上) up(上) right_up(右上)
left(左) right(右)
left_down(左下) down(下) right_down(右下)
circle.cw(時計回り) circle.ccw(反時計回り)
end(右ボタンをはなした)
Reference6: ジェスチャー移動角度。
右0度から反時計回りに360度。

バルーンイベント

OnBalloonBreak

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

Reference0: 中断の操作が起きたスクリプト。
Reference1: 中断の操作が起きたバルーンのスコープ番号。本体側0、相方側1、それ以降も。
Reference2: 中断位置。スクリプト先頭からの文字数で表現。文字数はさくらスクリプトのタグも含めたもの。
例）\s[2]あいうえお　の「あ」までで中断された場合、6

OnBalloonClose

バルーンを閉じた際に発生。

Reference0: 閉じる際に表示されていたスクリプト。

OnBalloonTimeout

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

Reference0: タイムアウトした際に表示されていたスクリプト。
Reference1: 残り時間。

トレイバルーンイベント

OnTrayBalloonClick

トレイアイコンのバルーンをクリックして消した際に発生。

Reference0: タイトル文字列。
Reference1: 表示テキスト。

OnTrayBalloonTimeout

トレイアイコンのバルーンをタイムアウトや閉じるボタンで消した際に発生。

Reference0: タイトル文字列。
Reference1: 表示テキスト。

インストールイベント

OnInstallBegin

アーカイブのインストール開始の際に発生。

OnInstallComplete

インストールが正常終了した際に発生。

Reference0: インストールした物の※識別子。
Reference1: インストールした物の名前（install.txtのname指定）。
Reference2: インストールした物の名前2（ghost with balloonなどの場合のballoon側の名前）。

OnInstallCompleteEx

インストールが正常終了した際に発生。
このイベントが無かった場合OnInstallCompleteが発生。

Reference0: インストールした物の※識別子。複数の場合はバイト値1区切り。
Reference1: インストールした物の名前。複数の場合はバイト値1区切り。
Reference2: インストールした場所。複数の場合はバイト値1区切り。

OnInstallFailure

インストールに失敗した際に発生。

Reference0: ※失敗理由。

OnInstallRefuse

インストールするファイルが他のゴーストを指名していた際に発生。

Reference0: 指定されたゴーストの本体側名（install.txtのaccept指定、つまり本来渡すべき相手）。
Reference1: インストールしようとした物の※識別子。
Reference2: インストールしようとした物の名前。

Ref1以降は2.4.85

OnInstallReroute

インストールするファイルが他のゴーストを指名していた際、かつ、指名対象ゴーストが一緒に起動していた時に発生。以降のインストールイベントは指名対象ゴースト側に発生する。

Reference0: 指定されたゴーストの本体側名（install.txtのaccept指定、つまり本来渡すべき相手）。
Reference1: インストールした物の※識別子。
Reference2: インストールした物の名前。

2.4 / Ref1以降は2.4.85

インストールの識別子

shell
ghost
balloon
plugin
headline
rss
supplement

以下はOnInstallComplete / OnNarCreatedのみ

ghost with balloon
shell with balloon

以下はSSP専用

calendar skin
calendar plugin
package
language

インストールの失敗理由

unlha32: lzh形式ファイルを展開するdllのロードに失敗した
extraction: 解凍失敗（ファイル破損）
invalid type: install.txtに不備がある
artificial: ユーザがインストールを中断した（※SSPのみ）
unsupported: その他サポートしていないアーカイブ
password: パスワードつきアーカイブでパスワード誤りがあった(SSP 2.5.09以降)

ファイルドロップイベント

OnFileDropping

ファイルをドラッグしたままのカーソルがゴースト上に乗った際に発生。

Reference0: ドラッグしているファイルパス。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnFileDropped

[旧仕様]ファイルがDnDされた際に発生。

Reference0: ドロップされたファイルパス。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnOtherObjectDropping

「ファイル」として扱えないもののカーソルがゴースト上に乗った際に発生。例：Windowsの「マイコンピュータ」など

Reference0

ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

Reference1

ドロップされたものの名前(OSの言語設定に影響される)。
複数ある場合はバイト値1区切り。

Reference2

ドロップされたもののOSの言語設定に識別されないIDのようなもの。
複数ある場合はバイト値1区切り。以下はWindows上の例。

PC(マイコンピュータ) = ::{20D04FE0-3AEA-1069-A2D8-08002B30309D}
ゴミ箱 = ::{645FF040-5081-101B-9F08-00AA002F954E}
(マイ)ネットワーク = ::{F02C1A0D-BE21-4350-88B0-7367FC96EF3C}

2.6.41

OnOtherObjectDropped

「ファイル」として扱えないものをゴースト上にドロップした際に発生。例：Windowsの「マイコンピュータ」など。
Referenceは OnOtherObjectDropping とまったく同じ。

2.6.41

OnDirectoryDrop

ディレクトリがDnD された際に発生。

Reference0: ドロップされたディレクトリのパス。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnWallpaperChange

画像ファイルのDnDによって壁紙が変更された際に発生。

Reference0: ドロップされたファイルパス。

OnFileDrop

[旧仕様]ファイルがDnDされた際に発生。

Reference0: ドロップされたファイルパス。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnFileDrop2

ファイルがDnDされた際に発生。

Reference0: ドロップされたファイルパスを（複数あればbyte値1で区切って）返す。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnFileDropEx

ファイルがDnDされた際に発生。

Reference0: ドロップされたファイルパスを（複数あればbyte値1で区切って）返す。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

OnUpdatedataCreating

ゴーストフォルダがDnDされた際に発生。

OnUpdatedataCreated

updates2.dauが作成された際に発生。

OnNarCreating

install.txtの入ったゴーストフォルダがDnDされた際に発生。

Reference0: narにするオブジェクト名。
Reference1: 作成されるnarのファイル名と絶対パス。
Reference2: ※識別子。インストールの識別子参照。

OnNarCreated

narファイルが作成された際に発生。

Reference0: narにするオブジェクト名。
Reference1: 作成されたnarのファイル名と絶対パス。
Reference2: ※識別子。インストールの識別子参照。

URLドロップイベント

OnURLDragDropping

URLがドロップされようとして、マウスカーソルが重なった際に発生。
このイベントは受け入れ可能なすべてのURLで発生する。

Reference0: ドロップされたURL。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

2.6.37

OnURLDropping

URLがドロップされた後で、ダウンロードを開始する時に発生。
このイベントはダウンロード処理前に発生する。他(homeurlインストールやfeed(RSS)インストール)では発生しない。

Reference0: ドロップされたURL。
Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

Ref1は2.6.36

OnURLDropped

ドロップされたURLを受領し終わった際に発生。
このイベントはNARインストールの直前、ダウンロード処理完了直後に発生する。他(homeurlインストールやfeed(RSS)インストール)では発生しない。

Reference0: ダウンロードし終わったファイルのローカルパス。
Reference1: ドロップされたURL。
Reference2: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

Ref1,2は2.6.36

OnURLDropFailure

ドロップされたURLの受領に失敗したかキャンセルされた際に発生。
このイベントはNARインストールを試行しようとして失敗した際に発生する。他(homeurlインストールやfeed(RSS)インストール)では発生しない。

Reference0: ダウンロードし終わった分のファイルのローカルパス。
Reference1: ※失敗理由
Reference2: ドロップされたURL。
Reference3: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。

Ref2,3は2.6.36

OnURLQuery

URLがキャラクターウィンドウにドラッグ＆ドロップされた際に通知される。
これに対してスクリプトを返すと、通常のダウンロード処理がキャンセルされる。
ゴースト側でURLを独自に処理したい場合のみスクリプトを返すこと。

Reference0: URLパス。
Reference1: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference2: ドロップされたURLのMIMEタイプ
Reference3: 反応しなかった場合にSSPがこの後実行予定の処理。
feed・nar・homeurl・unknownのいずれか。
unknownの場合は本体が処理に対応できないURLであり、本体側ではこれ以上の処理ができないことを示す。
それ以外はそのまま \![execute,install,url] に渡すと処理の続きが行われる。

Ref3は2.6.35

OnXUkagakaLinkOpen

下記形式のWeb関連づけを開いた、またはドロップした場合に、指定したゴーストに通知される。
x-ukagaka-link:type=event&ghost=(descript.txtの"name"か"sakura.name")&info=(Reference0に入る文字列)
文字コードはUTF-8固定＋URLエンコード済
サンプル：x-ukagaka-link:type=event&ghost=Emily&info=sweet-potato-feeding
SecurityLevelは必ずexternalになる。

Reference0: info=以降に指定した文字列(URLデコード済)

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

OnUpdateProcessExec

メニューなどから更新を実行する指示がなされた場合に発生する。
このイベントに対して何かスクリプトを返すと、更新処理をカスタマイズできる。
イベントを無視した場合は標準の更新処理に自動的に移行する。

Reference0: manual : メニューから更新の操作をした。
auto : あらかじめ設定した定期自動更新処理が動いた。
testonly : 開発用パレットのUpdate Full Checkを実行した。

2.6.23

OnUpdateBegin

ネットワーク更新開始が指示された際に発生。

Reference0: ゴースト名。
Reference1: フルパス。
Reference3: CROW：ゴースト更新の際はghost・本体更新の際はbaseware
SSP：※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateReady

更新ファイルが確認された際に発生。

Reference0: 更新を行うファイルの総数から1引かれたもの（0から始まる連番）。
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: 更新対象種別。
(shell ghost balloon headline plugin)
Reference4: SSP 2.3：※更新実行理由。

OnUpdateComplete

ネットワーク更新が成功し完了した際に発生。

Reference0: ※成功理由
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: CROW：ゴースト更新の際はghost本体更新の際はbaseware。
SSP：※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateFailure

ネットワーク更新に失敗した際に発生。

Reference0: ※失敗理由
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
※SSPのみ　失敗したファイル名。
Reference3: CROW：ゴースト更新の際はghost本体更新の際はbaseware。
SSP：※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdate.OnDownloadBegin

ファイルダウンロード開始の際に発生。

Reference0: ダウンロードするファイル名。
Reference1: （CROW以外）ダウンロード中の更新ファイルの番号（0から始まる連番）。
Reference2: （CROW以外）更新を行うファイルの総数から1引かれたもの（0から始まる連番）。
Reference3: （SSPのみ）※更新対象種別。
Reference4: SSP 2.3：※更新実行理由。

OnUpdate.OnMD5CompareBegin

MD5の照合開始の際に発生。

Reference0: 比較するファイル名。
Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: SSP　※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdate.OnMD5CompareComplete

MD5が一致した際に発生。

Reference0: 落としたファイル名。
Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: SSP　※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdate.OnMD5CompareFailure

MD5が一致しなかった際に発生。

Reference0: 落としたファイル名。
Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: SSP　※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOtherBegin

ゴースト以外のネットワーク更新開始が指示された際に発生。

Reference0: ゴースト名。
Reference1: フルパス。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOtherReady

ゴースト以外の更新ファイルが確認された際に発生。

Reference0: 更新を行うファイルの総数から1引かれたもの（0から始まる連番）。
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOtherComplete

ゴースト以外のネットワーク更新が成功し完了した際に発生。

Reference0: ※成功理由
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOtherFailure

ゴースト以外のネットワーク更新に失敗した際に発生。

Reference0: ※失敗理由
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOther.OnDownloadBegin

ゴースト以外のファイルダウンロード開始の際に発生。

Reference0: ダウンロードするファイル名。
Reference1: ダウンロード中の更新ファイルの番号（0から始まる連番）。
Reference2: 更新を行うファイルの総数から1引かれたもの（0から始まる連番）。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOther.OnMD5CompareBegin

ゴースト以外のMD5の照合開始の際に発生。

Reference0: 比較するファイル名。
Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOther.OnMD5CompareComplete

ゴースト以外のMD5が一致した際に発生。

Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateOther.OnMD5CompareFailure

ゴースト以外のMD5が一致しなかった際に発生。

Reference1: 正しいMD5値。
Reference2: 落としたファイルのMD5値。
Reference3: ※更新対象種別
Reference4: SSP 2.3：※更新実行理由。

OnUpdateCheckComplete

ネットワーク更新のチェックに成功した際に発生。

Reference0: ※成功理由
Reference1: カンマでセパレートされた更新されたファイル名のリスト。
Reference3: ※更新対象種別
Reference4: SSP 2.3：更新実行理由。scriptのみ。

OnUpdateCheckFailure

ネットワーク更新のチェックに失敗した際に発生。

Reference0: ※失敗理由
Reference4: SSP 2.3：更新実行理由。scriptのみ。

OnUpdateResult

ネットワーク更新を実行した際に発生し、バルーン・シェル一括更新機能も含めてすべての更新結果を一括で通知する。

Reference*

更新を実行した順に、更新結果が以下のフォーマットで入っている（\1はバイト値1）

(※1)[\1](※2)[\1](※3)[\1](※4)
または
(※1)[\1](※2)[\1](※3)

※1……ネットワーク更新対象の種別
※2……成功時「OK」　失敗時「NG」
※3……成功した場合は更新ファイル数(更新ファイルなし=noneの場合0)、失敗した場合は失敗理由。
※4……失敗して、かつ失敗原因のファイルがわかる場合、そのファイル名。

OnUpdateResultEx

ネットワーク更新を実行した際に発生し、バルーン・シェル一括更新機能も含めてすべての更新結果を一括で通知する。

Reference*

更新を実行した順に、更新結果が以下のフォーマットで入っている（\1はバイト値1）

(※1)[\1](※2)[\1](※3)[\1](※4)[\1](※5)
または
(※1)[\1](※2)[\1](※3)[\1](※4)

※1……ネットワーク更新対象の名前
※2……ネットワーク更新対象の種別
※3……成功時「OK」　失敗時「NG」
※4……成功した場合は更新ファイル数(更新ファイルなし=noneの場合0)、失敗した場合は失敗理由。
※5……失敗して、かつ失敗原因のファイルがわかる場合、そのファイル名。

OnUpdateCheckResult

更新チェックのみオプションをつけた時に最後に発生。OnUpdateResultのエクスプローラ版。

Reference*: OnUpdateResultと同じ

OnUpdateCheckResultEx

更新チェックのみオプションをつけた時に最後に発生。OnUpdateResultExのエクスプローラ版。

Reference*: OnUpdateResultExと同じ

OnUpdateResultExplorer

ゴーストエクスプローラからネットワーク更新を実行した際に発生。OnUpdateResultのエクスプローラ版。

Reference*: OnUpdateResultと同じ

ネットワーク更新成功理由

none: 更新するファイルが無かった。
changed: 更新された。

ネットワーク失敗理由

timeout: タイムアウトした。
too slow: SSPではtimeoutになるため不出。回線が非常に重い。
md5 miss: MD5が一致しなかった。
artificial: ユーザ操作による更新中断。
404 等: そのステータスコードでの失敗。
fileio: ※SSPのみ。容量不足による更新対象への書き込み失敗。
readonly: ※SSPのみ。読み取り専用フラグによる更新対象への書き込み失敗。ファイルやフォルダに読み取り専用フラグがついていると発生。
virusdetect: ※SSPのみ。データ内にウイルスを検出した可能性がある。 [2.5.15]
toomanyredirect: ※SSPのみ。リダイレクトが発生しすぎたので処理を中止した。 [2.5.15]
executing: ※SSPのみ。すでに更新を実行中のため、二重起動を阻止した。 [2.5.26]
paramerror: ※SSPのみ。更新実行タグの設定ミスにより更新を実行できなかった。 [2.5.26]

ネットワーク更新対象の種別

ghost
shell
balloon
plugin
headline
baseware　※CROWのみ

ネットワーク更新理由

auto: SSPの設定などによる自動更新。
manual: オーナードローメニューからの選択などによる手動実行。
script: さくらスクリプトタグ（\![updatebymyself]など）による更新。

時計合わせイベント

OnSNTPBegin

時計合わせが開始が指示された際に発生。

Reference0: 接続先サーバ名。

OnSNTPCompareEx

サーバに接続が確立された際に発生。修正を実行したい場合は\6タグを含むスクリプトを返すこと。

Reference0: 接続先サーバ名。
Reference1: カンマでセパレートされたサーバ側の現時刻 : 年,月,日,時,分,秒,ミリ秒
Reference2: カンマでセパレートされたローカル側の現時刻 : 年,月,日,時,分,秒,ミリ秒
Reference3: サーバとローカルの時刻のずれ。秒単位かつ小数点以下あり。正の値がローカル時刻遅れ、負の値がローカル時刻進み状態。
Reference4: サーバとローカルの時刻のずれ。ミリ秒単位の整数。

2.5.66

OnSNTPCompare

サーバに接続が確立された際に発生。修正を実行したい場合は\6タグを含むスクリプトを返すこと。

Reference0: 接続先サーバ名。
Reference1: カンマでセパレートされたサーバ側の現時刻 : 年,月,日,時,分,秒 (差が1秒未満はローカル時刻と同じ)
Reference2: カンマでセパレートされたローカル側の現時刻 : 年,月,日,時,分,秒
Reference3: サーバとローカルの時刻のずれ。秒単位の常に正の整数。
Reference4: ※SSPのみ　サーバとローカルの時刻のずれ。ミリ秒単位の常に正の整数。

OnSNTPCorrectEx

\6タグでローカル時刻をサーバ時刻に修正した際に発生。

Reference0: 接続先サーバ名。
Reference1: カンマでセパレートされたサーバ側の現時刻 : 年,月,日,時,分,秒,ミリ秒
Reference2: カンマでセパレートされたローカル側の現時刻 : 年,月,日,時,分,秒,ミリ秒
Reference3: サーバとローカルの時刻のずれ。秒単位かつ小数点以下あり。正の値がローカル時刻がサーバ時刻より遅れ、負の値がローカル時刻がサーバより進んだ状態。
Reference4: サーバとローカルの時刻のずれ。ミリ秒単位の整数。正負はReference3と同様。

2.5.66

OnSNTPCorrect

\6タグでローカル時刻をサーバ時刻に修正した際に発生。

Reference0: 接続先サーバ名。
Reference1: カンマでセパレートされたサーバ側の現時刻 : 年,月,日,時,分,秒 (差が1秒未満はローカル時刻と同じ)
Reference2: カンマでセパレートされたローカル側の現時刻 : 年,月,日,時,分,秒
Reference3: サーバとローカルの時刻のずれ。秒単位の整数。正の値がローカル時刻遅れ、負の値がローカル時刻進み状態。
Reference4: ※SSPのみ　サーバとローカルの時刻のずれ。ミリ秒単位の整数。

OnSNTPFailure

時計合わせに失敗した際に発生。

Reference0: 接続先サーバ名。

メールチェックイベント

OnBIFFBegin

メールチェック開始が指示された際に発生。

Reference2: チェックするメールサーバ名、SSP、CROWはアカウント名。

OnBIFFComplete

メールチェックが成功した際に発生。

Reference0: スプールされているメールの通数、１オリジン表記。
Reference1: スプールされているメールのバイト数。
Reference2: チェックするメールサーバ名。
Reference3: メールの新着差分。
Reference4: 全メールのTopResult。POP通信全ヘッダリスト。メールごとバイト値2区切りの、ヘッダごとバイト値1区切り（通常はReference7の情報を利用すればよい）。
Reference5: ListResult。メールサーバ上のID。POPコマンドの「LIST」の結果に相当する内容。
Reference6: UidlResult。メールを区別するためのID。POPコマンドの「UIDL」の結果に相当する内容。
Reference7: バイト値1区切りの送信者とタイトル。

OnBIFF2Complete

メールスプール数が増加した際に発生。
SSPではOnBIFFCompleteにスクリプトを返さなかった場合にのみ発生。

Reference0: スプールされているメールの通数、１オリジン表記。
Reference1: スプールされているメールのバイト数。
Reference2: チェックするメールサーバ名、SSP、CROWはアカウント名。
Reference3: 全メールのTopResult。

OnBIFFFailure

メールチェックに失敗した際に発生。

Reference0: ※失敗理由
Reference2: チェックするメールサーバ名、SSP、CROWはアカウント名。

ヘッドライン/RSSセンスイベント

OnHeadlinesenseBegin

ヘッドラインセンス開始が指示された際に発生。

Reference0: ヘッドラインセンスするサイト名。
Reference1: ヘッドラインセンスするURL。

OnHeadlinesense.OnFind

読み上げるべきヘッドラインセンスがあった際に発生。

Reference0: ヘッドラインセンスするサイト名。
Reference1: ヘッドラインセンスするURL。
Reference2: ※OnFind フェーズ
Reference3: ヘッドラインの内容。内容はベースウェア側でサニタイズ済み。
ベースウェア側で制御用のSakuraScriptが追加されている場合がある。

OnHeadlinesenseComplete

ヘッドラインセンスが正常に終了した際に発生。
現状ヘッドラインセンスの成功は読み上げの開始を意味するので、このイベントは取得に成功したが更新が無かった場合のみ通知。

Reference0: ※終了理由　現状「no update」固定。

OnHeadlinesenseFailure

ヘッドラインセンスに失敗した際に発生。

Reference0: ※終了理由

OnRSSBegin

RSSセンス開始が指示された際に発生。本イベントに反応しない場合は、OnHeadlineSenseBeginが呼び出される。

Reference0: RSSセンスするサイト名。
Reference1: RSSセンスするURL。

OnRSSComplete

ヘッドラインセンスが正常に終了した際に発生。本イベントに反応しない場合は、表示に適切なスクリプトを生成しヘッドライン完了系イベントが呼び出される。

Reference0: 更新が無い時：no update　※終了理由
更新が無い時はReference0のみでかつ"no update"という文字列のみ
更新が有る時：RSS配信サイト名。
Reference1: 更新が有る時のみ：RSSの配信元URL(フィードそのものではなく配信サイトを指すもの)
Reference2～: 更新が有る時のみ：タイトル [\1] URL [\1] 更新日時（フォーマットはカンマ区切り：年,月,日,時,分,秒）[\1] 作者名 [\1] 内容または要約
更新がある時はRSSの要素数分Reference0,1,2～と続く
[\1]はバイト値1

作者名・内容 2.4.10～

OnRSSFailure

RSSセンスに失敗した際に発生。本イベントに反応しない場合は、OnHeadlineSenseFailureが呼び出される。

Reference0: ※終了理由

ヘッドラインセンスOnFindフェーズ

First: 1ページ目
First and Last: 1ページ目で次がない
Last: 最後のページ
Next: いずれでもないページ

ヘッドラインセンス終了理由

no update: （現状OnHeadlinesenseCompleteのみ）更新がなかった
can't download: ファイルが取れなかった
can't analyze: ファイルは取れたが、有効なヘッドラインを取得できなかった

カレンダーイベント

OnSchedule5MinutesToGo

本体カレンダー機能に登録されているスケジュールの時間の5分前に発生。

Reference0: イベントのタイプ
Reference1: イベントの内容(caption)
Reference2: 追加データ(subtitle)
Reference3: スクリプト(script)

OnScheduleRead

カレンダーアイコン上でマウスが静止し、そのスケジュールが読まれるタイミングで発生。

Reference0: イベントのタイプ。
Reference1: イベントの内容(caption)
Reference2: 追加データ(subtitle)
Reference3: スクリプト(script)

OnSchedulesenseBegin

スケジュールセンサが接続開始する際に発生。

Reference0: スケジュールセンサの名前

OnSchedulesenseComplete

スケジュールセンサの処理が完了した際に発生。

Reference0: スケジュールセンサの名前
Reference1: スケジュールセンサの返したスケジュールデータの数

OnSchedulesenseFailure

スケジュールセンサの処理に失敗した場合に発生。

Reference0: 失敗した理由（ヘッドラインセンサのものと共通）

OnSchedulepostBegin

スケジュールセンサが投稿モードで接続開始する際に発生。

Reference0: スケジュールセンサの名前

OnSchedulepostComplete

スケジュールセンサが投稿処理を完了した際に発生。

Reference0: スケジュールセンサの名前

スケジュールタイプ

default: 認識できないタイプ
event: 汎用
meeting: 会議
appointment: アポイントメント
reservation: 病院などの予約
duedate: しめきり
party: パーティー・飲み会
date: デート
work: 仕事
go: お出かけ
tv: テレビ番組
recording: 録画予約
cd: CD発売日
game: ゲーム発売日
video: 映像メディアの発売日
book: 書籍発売日
release: その他発売日

SSTPイベント

OnSSTPBreak

SSTPがブレイクされた際に発生。

Reference0: 中断の操作が起きたスクリプト。
Reference1: 中断の操作が起きたバルーンのスコープ番号。本体側0、相方側1、それ以降も。
Reference2: 中断位置。スクリプト先頭からの文字数で表現。文字数はさくらスクリプトのタグも含めたもの。
例）\s[2]あいうえお　の「あ」までで中断された場合、6

OnSSTPBlacklisting

最終クライアントのブラックリスト行きが指示された際に発生。

Reference0: 最終クライアントのIPアドレス。

その他通信イベント

OnExecuteHTTPComplete

execute-httpで正常に取得完了した際に発生。

Reference0: post/get/head/put/delete のいずれか
Reference1: --sync・--asyncオプションで指定した文字列。
Reference2: 対象のURL。
Reference3: --nofileオプションがある場合、取得したデータの中身。ただし改行コードはバイト値1に置き換えられている。
そうでない場合は取得したファイルのフルパス。
Reference4: 取得結果コード。(timeout|fileio|200|204|403|404)等。[失敗理由]も参照。
Reference5: Cookieの文字列。
Reference6: 受け取ったすべてのレスポンスヘッダ。改行の代わりにバイト値1で区切られている。 [2.6.40]

OnExecuteHTTPFailure

execute-httpで取得エラーした際に発生。ReferenceはCompleteと同じ。

OnExecuteHTTPProgress

execute-httpで--progress-notifyを指定した際に発生。ReferenceはCompleteと同じ。

[2.6.44]

OnExecuteHTTPSSLInfo

取得失敗(HTTPレスポンスが200以外)でも、SSL/TLSレベルでは接続に成功しているので通知される。

Reference0: async ID (無ければからっぽ)
Reference1: 取得URL
Reference2: httpレスポンスコード (エラーでも通知される)
Reference3: 通信バージョン今時はだいたい "TLSv1/SSLv3" (SSP内部でSSLv2は蹴るので実はこれだけしか来ない)
Reference4: 暗号化方法
例：AES256-SHA
Reference5: 発行先名前を確認したい場合は、/O=の後に続く文字列を抜き出すと良い
プログラマさん向け：OpenSSLのX509_NAME_onelineに通した結果が入る
例：/1.3.6.1.4.1.311.60.2.1.3=US/1.3.6.1.4.1.311.60.2.1.2=Delaware/businessCategory=Private Organization/serialNumber=4337446/C=US/postalCode=94107/ST=California/L=San Francisco/street=795 Folsom St, Suite 600/O=Twitter, Inc./OU=Twitter Operations/CN=twitter.com
Reference6: 有効期限開始日時年,月,日,時,分,秒
例：2011,7,7,9,0,0
Reference7: 有効期限終了日時年,月,日,時,分,秒
例：2012,7,28,8,59,59
Reference8: 発行者名前を確認したい場合は、/O=の後に続く文字列を抜き出すと良い
プログラマさん向け：OpenSSLのX509_NAME_onelineに通した結果が入る
例：/C=US/O=VeriSign, Inc./OU=VeriSign Trust Network/OU=Terms of use at https://www.verisign.com/rpa (c)06/CN=VeriSign Class 3 Extended Validation SSL CA
Reference9 (2.4.51～): 証明書チェーン CommonName(CN)をカンマ区切りで順番に列挙

OnExecuteRSSComplete

\![execute,rss-get/post]で正常に取得完了した際に発生。

Reference0～: タイトル [\1] URL [\1] 更新日時（フォーマットはカンマ区切り：年,月,日,時,分,秒）[\1] 作者名 [\1] 内容または要約
更新がある時はRSSの要素数分Reference0,1,2～と続く
[\1]はバイト値1

作者名・内容 2.4.10～

OnExecuteRSSFailure

\![execute,rss-get/post]で取得エラーした際に発生。

Reference0～: 解析失敗時はReference4=parse。他はOnExecuteHTTPFailureと同じ

OnExecuteRSS_SSLInfo

取得失敗(HTTPレスポンスが200以外)でも、SSL/TLSレベルでは接続に成功しているので通知される。

Reference0～: OnExecuteHTTPSSLInfoと同じ

OnPingComplete

\![execute,ping]で指定回数のping実行完了時に発生。

Reference0: --eventで指定した文字列そのもの
Reference1: 送信元アドレス [\1] 全送信回数 [\1] 成功回数 [\1] 失敗回数 [\1]はバイト値1
Reference2: 「OK」またはエラー情報 [\1] 返答元アドレス [\1] RTT(往復にかかった時間ms) [\1]はバイト値1
Reference2以降、送信済みのPingの1回ごとの情報が記録される。Progressの場合は不完全。
エラー情報はICMP_ECHO_REPLY Structure の Statusヘッダを参照。

OnPingProgress

\![execute,ping]でping実行中に発生。

Reference0: --eventで指定した文字列そのもの
Reference1: 送信元アドレス [\1] 全送信回数 [\1] 成功回数 [\1] 失敗回数 [\1]はバイト値1
Reference2: 「OK」またはエラー情報 [\1] 返答元アドレス [\1] RTT(往復にかかった時間ms) [\1]はバイト値1
Reference2以降、送信済みのPingの1回ごとの情報が記録される。Progressの場合は不完全。
エラー情報はICMP_ECHO_REPLY Structure の Statusヘッダを参照。

OnNSLookupComplete

\![execute,nslookup]で成功時に発生。

Reference0: --eventで指定した文字列そのもの
Reference1: --hostで指定した文字列そのもの
Reference2: 正引きでlookup、逆引きでreverse
Reference3: 実行結果。正引きでIP、逆引きでホスト名。

OnNSLookupFailure

\![execute,nslookup]で失敗時に発生。

Reference0: --eventで指定した文字列そのもの
Reference1: --hostで指定した文字列そのもの
Reference2: 正引きでlookup、逆引きでreverse

イベント送信失敗イベント

OnRaisePluginFailure

\![raiseplugin]が失敗した際に発生。

Reference0: 見つからなかった場合、notfound。
無効設定だった場合、disabled。
他、204など実行結果。
Reference1: プラグインの名前またはID。
Reference2: 実行しようとしたイベントID。
Reference3～: 実行しようとしたイベントのReference。

OnNotifyPluginFailure

\![notifyplugin]が失敗した際に発生。

Reference0: 見つからなかった場合、notfound。
無効設定だった場合、disabled。
他、204など実行結果。
Reference1: プラグインの名前またはID。
Reference2: 実行しようとしたイベントID。
Reference3～: 実行しようとしたイベントのReference。

OnRaiseOtherFailure

\![raiseother]が失敗した際に発生。

Reference0: 見つからなかった場合、notfound。
\t中だった場合、timecritical。
パッシブモードだった場合、passivemode。
インダクションモードだった場合、inductionmode。
最小化中だった場合、minimized。
他、204など実行結果。
__SYSTEM_ALL_GHOST__などの場合バイト値1区切りのリスト。
Reference1: ゴースト名または\0名。
__SYSTEM_ALL_GHOST__などの場合バイト値1区切りのリスト。
Reference2: 実行しようとしたイベントID。
Reference3～: 実行しようとしたイベントのReference。

OnNotifyOtherFailure

\![notifyother]が失敗した際に発生。

Reference0: 見つからなかった場合、notfound。
\t中だった場合、timecritical。
パッシブモードだった場合、passivemode。
インダクションモードだった場合、inductionmode。
最小化中だった場合、minimized。
他、204など実行結果。
__SYSTEM_ALL_GHOST__などの場合バイト値1区切りのリスト。
Reference1: ゴースト名または\0名。
__SYSTEM_ALL_GHOST__などの場合バイト値1区切りのリスト。
Reference2: 実行しようとしたイベントID。
Reference3～: 実行しようとしたイベントのReference。

見切れ・重なりイベント

OnOverlap

キャラクター（サーフェス）のウインドウが重なった時に発生。
重なり状態が変わった際に逐次通知されるので、「重ならなくなった」も工夫すれば検出できる。

Reference0: ID-ID [\1] ID-ID [\1] ID-ID ...
[\1] はバイト値1
例：0-1 [\1] 0-2 で、0番ウインドウと1番ウインドウ、0番ウインドウと2番ウインドウが重なっていることを示す。
Reference1: Reference0と同じフォーマットで、状態が変わる前（＝1回前のイベント発生時のReference0）が通知される。

OnOtherOverlap

他も含めて全起動中のキャラクター（サーフェス）のウインドウが重なった時に発生。OnOverlapのグローバル版。
重なり状態が変わった際に逐次通知されるので、「重ならなくなった」も工夫すれば検出できる。
自分自身の情報も一緒に通知されるので注意。

Reference0: Sakura名/ID-Sakura名/ID [\1] Sakura名/ID-Sakura名/ID [\1] Sakura名/ID-Sakura名/ID ...
[\1] はバイト値1
例：Emily/0-マリ/1 [\1] マリ/0-所長たん/1
Reference1: Reference0と同じフォーマットで、状態が変わる前（＝1回前のイベント発生時のReference0）が通知される。

OnOffscreen

キャラクター（サーフェス）のウインドウがモニタ（作業領域）外にひっかかった、あるいは出た時に発生。見切れ。
見切れ状態が変わった際に逐次通知されるので、「見切れなくなった」も工夫すれば検出できる。

Reference0: ID [\1] ID [\1] ID ...
[\1] はバイト値1
例：1 [\1] 2 で、1番ウインドウと2番ウインドウが見切れていることを示す。
Reference1: Reference0と同じフォーマットで、状態が変わる前（＝1回前のイベント発生時のReference0）が通知される。

OnOtherOffscreen

他を含めてキャラクター（サーフェス）のウインドウがモニタ（作業領域）外にひっかかった、あるいは出た時に発生。見切れ。OnOffscreenのグローバル版。
見切れ状態が変わった際に逐次通知されるので、「見切れなくなった」も工夫すれば検出できる。
自分自身の情報も一緒に通知されるので注意。

Reference0: Sakura名/ID [\1] Sakura名/ID [\1] Sakura名/ID ...
[\1] はバイト値1
例：Emily/1 [\1] 所長たん/0
Reference1: Reference0と同じフォーマットで、状態が変わる前（＝1回前のイベント発生時のReference0）が通知される。

OS状態イベント

OnNetworkHeavy

相手サーバが時間内に応答しなかった際に発生。

Reference0: ※SSPのみ　タイムアウトするまでの時間。(秒単位)
Reference1: ※SSPのみ　今までの経過時間。(秒単位) [2.6.42～]

OnNetworkStatusChange

ネットワーク接続状態が変わった際に発生。
起動直後のみNOTIFYで通知。

Reference0: onlineまたはoffline。
Reference1: 現在居るマシンに割り当てられているIPアドレスのバイト値1区切りリスト。
Reference2: 接続の種類。 [SSP 2.4.22]
cellular : 携帯回線もしくは通常のPPP(PPPoE等除く)
ethernet : Ethernet (有線LAN)
none : 接続なし
wifi : 無線LAN
wimax : WiMAX
other : その他不明
unknown : 検出に失敗
Reference3: 接続回線のダウンロード側の最大通信速度を示す数値。単位はMBps。 [SSP 2.4.22]
Reference4: 接続回線のダウンロード側の推定有効通信速度を示す数値。単位はMBps。 [SSP 2.5.26]
通信統計が取得できない環境や、統計値が不正確な状態ではReference3と同じ値となる。
Reference5: 接続回線が従量課金回線かどうかを通知する。 [SSP 2.6.15]
unknown : 未設定/不明
unrestricted : 完全使い放題
fixed : データ量の上限がある定額制
variable : 従量課金
Windwos 10/11で「従量制課金接続」を設定するとfixedになる。

OnScreenSaverStart

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

Reference0: スクリーンセーバ名
Reference1: スクリーンセーバ実行ファイルのパス
Reference2: スクリーンセーバ実行までの待ち時間(秒)

OnScreenSaverEnd

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

Reference0: スクリーンセーバ名
Reference1: スクリーンセーバ実行ファイルのパス
Reference2: スクリーンセーバ実行までの待ち時間(秒)

OnSessionLock

ログイン状態のままロック画面に戻った際に発生。Windowsの場合は簡易ユーザー切り替えでも発生する。
本イベントはNOTIFYではないが、当然何を実行してもユーザーには見えないので注意。

2.5.50

OnSessionUnlock

ロック画面から通常の操作に戻った際に発生。Windowsの場合は簡易ユーザー切り替えでも発生する。

2.5.50

OnSessionDisconnect

簡易ユーザー切り替えで他のユーザーアカウントへの切り替え操作を行った時に発生する。
Windows上ではOnSessionLockとセットで通知され、さらに強制最小化されるためOnWindowStateMinimizeも発生する。
この挙動はWindows特有の制約であり、他のOS上で同様の動きになるとは限らない点に注意。

2.5.53

OnSessionReconnect

簡易ユーザー切り替えで実行中のユーザーアカウントに戻ってきた時に発生する。
Windows上ではOnSessionUnlockとセットで通知され、さらに強制最小化されたのが解除されるためOnWindowStateRestoreも発生する。
この挙動はWindows特有の制約であり、他のOS上で同様の動きになるとは限らない点に注意。

2.5.53

OnCPULoadHigh

CPU負荷が高い時に発生する。(今のところおおよそ80％ぐらいが少し続いたら発動)

Reference0: 現在の負荷率％

2.5.56

OnCPULoadLow

CPU負荷が高い状態から低く戻った時に発動する。(今のところHigh発動後60％を下回った時)

Reference0: 現在の負荷率％

2.5.56

OnMemoryLoadHigh

メモリ使用量が高い時に発生する。(今のところおおよそ80％ぐらいが少し続いたら発動)

Reference0: 現在の使用量％

2.5.56

OnMemoryLoadLow

メモリ使用量が高い状態から低く戻った時に発動する。(今のところHigh発動後60％を下回った時)

Reference0: 現在の使用量％

2.5.56

OnDisplayChange

デスクトップ（プライマリスクリーン）の解像度／色深度が変更された際に発生。[起動時NOTIFY/他GET]

Reference0: 変化後の色深度（bpp）
Reference1: 変化後の解像度（width）
Reference2: 変化後の解像度（height）

OnDisplayHandover

スクリーン間を跨いでウインドウを移動させた際に発生。[NOTIFY/他GET]

Reference0: init (位置初期化完了時) か update (初期化後の更新) 。
initは起動後ウインドウの位置が決定した際に通知され、OnBootより前とは限らない。
Reference1: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference2: 移動前　左,上,右,下,ビット深度,プライマリモニタかどうか(0/1)　init時は空欄
例： 0,0,1600,900,32,1
Reference3: 移動後　左,上,右,下,ビット深度,プライマリモニタかどうか(0/1)

2.4.09

OnDisplayChangeEx

スクリーンの解像度／色深度が変更された際に発生。マルチモニタ対応。[起動時NOTIFY/他GET]

Reference0: init (起動時通知) か update (起動後の更新)
Reference1～: 左,上,右,下,ビット深度,プライマリモニタかどうか(0/1),タスクバーの位置(left,top,right,bottom,unknown),タスクバーと作業領域の区切り座標
例： 0,0,1600,900,32,1,bottom,1560

2.4.09/タスクバーは2.6.35

OnDisplayPowerStatus

モニタの電源がON/OFFされた時に発生する。単純にON/OFFされた時だけでなく、ノート型で蓋を閉じた時も対象となる。

Reference0: 1 = ON / 0 = OFF

2.4以降

OnBatteryNotify

残りバッテリー量を通知。起動時のみ[NOTIFY]で通知され、他はGET。

Reference0: 残りバッテリー％。
Reference1: 残り時間。不明の場合は-1。
Reference2: offline(バッテリー駆動)・online(電源供給中)・backup(UPSなど補助電源)　のいずれか。
Reference3: 以下の状態を示す文字列をカンマ区切りで通知。例： low,charging
high：バッテリー残量が2/3以上
low：バッテリー残量が1/3以下 (OnBatteryLowも発生)
critical：バッテリー残量が5％以下 (OnBatteryCriticalも発生)
charging：バッテリーが充電中（OnBatteryChargingStart/Stopも発生）
no_battery：バッテリーが取り外されている
power_saving：バッテリー節約機能がON (SSP 2.3.94以降/Windows 10以降)

Windows 7より前のOSでは、high/lowの基準が異なることがある。

OnBatteryLow

バッテリー残量が少なめ(OnBatteryNotify Reference3がlow以下)になった際に発生する。
外部アプリ「きのこ」が通知するイベントに同名の物があるので注意。
「きのこ」との互換用イベントとして実装されている。

Reference0～: OnBatteryNotifyと同じ。Reference3がlow以下になった場合、OnBatteryNotifyが発生後に本イベントも発生するので、OnBatteryNotifyに適切な処理を実装している場合こちらの対応は不要。

OnBatteryCritical

バッテリー残量が極端に少なく(OnBatteryNotify Reference3がcritical以下)になった際に発生する。
外部アプリ「きのこ」が通知するイベントに同名の物があるので注意。
「きのこ」との互換用イベントとして実装されている。

Reference0～: OnBatteryNotifyと同じ。Reference3がcriticalになった場合、OnBatteryNotifyが発生後に本イベントも発生するので、OnBatteryNotifyに適切な処理を実装している場合こちらの対応は不要。

OnBatteryChargingStart

バッテリーの充電を開始した場合に発生する。
「Androidの伺か」互換イベント。

Reference0～: OnBatteryNotifyと同じ。

OnBatteryChargingStop

バッテリーの充電を停止した場合に発生する。満充電になった時とは限らない。
「Androidの伺か」互換イベント。

Reference0～: OnBatteryNotifyと同じ。

OnDeviceArrival

デバイスを検出された際に発生。

Reference*: タイプ、名前、製造者名、デバイスファイル名がバイト値1区切りで返る。

OnDeviceRemove

デバイスを削除された際に発生。

Reference*: タイプ、名前、製造者名、デバイスファイル名がバイト値1区切りで返る。

OnTabletMode

OSがタブレット機の操作に最適化された状態に切り替えられた際に発生。
起動直後にNOTIFY(喋れない)で通知され、切り替わった時にGET(喋れる)で通知される。

Reference0: 0/1：1がタブレットモード(OSがタブレット機の操作に最適化された状態)、0がモードOFF

2.5.02

OnDarkTheme

OSがダークテーマ(暗めの表示)に切り替えられた際に発生。
起動直後にNOTIFY(喋れない)で通知され、切り替わった時にGET(喋れる)で通知される。

Reference0: 0/1：アプリ設定 1がダークテーマ、0が通常（明るい）テーマ
Reference1: 0/1：システム設定 1がダークテーマ、0が通常（明るい）テーマ (2.6.29)

2.5.02

OnOSUpdateInfo

OSの更新確認日時・更新実行日時と、履歴情報の通知。
起動直後にNOTIFY(喋れない)で通知され、更新が実行された時に少し遅れてGET(喋れる)で通知される。

Reference0: 確認日時年,月,日,時,分,秒半角カンマ区切りローカル時刻
Reference1: 実行日時年,月,日,時,分,秒半角カンマ区切りローカル時刻
Reference2～: 以下のフォーマットで更新履歴情報が後ろに続く。[\1]はバイト値1。
状態[\1]エラーコード[\1]更新時刻[\1]更新内容(タイトル)
状態：not_started(未実行)・in_progress(更新中)・success(成功)・success_with_errors(一応成功したがエラーあり)・fail(失敗)・abort(中断)・unknown(不明)のいずれか
エラーコード：更新時にエラーがあれば非0、なければ0。Windowsの場合は16進8桁。
更新時刻：年,月,日,時,分,秒半角カンマ区切りローカル時刻

2.5.02

OnRecycleBinEmpty

\![execute,emptyrecyclebin]でゴミ箱を空にした時に発生する。
スクリプトを実行したゴーストだけでなく、起動中の全ゴーストにもOnRecycleBinEmptyFromOtherが通知される。

Reference0: 現在ゴミ箱に入っているファイルの数(空にした直後なのでふつうは0)
Reference1: 現在ゴミ箱に入っているファイルのサイズ(空にした直後なのでふつうは0) 単位バイト
Reference2: 現在ゴミ箱に入っているファイルの数の直前との差(空にした直後なのでふつうは負の値)
Reference3: 現在ゴミ箱に入っているファイルのサイズの直前との差(空にした直後なのでふつうは負の値) 単位バイト
Reference4: 正常に空にできたら1、何かエラーが起きたら0(もとから空っぽでも0)
Reference5: タグを実行したゴーストの本体側の名前(sakuraname)。

2.6.04/Ref4は2.6.35

OnRecycleBinEmptyFromOther

\![execute,emptyrecyclebin]でゴミ箱を空にする指示を出したゴースト以外に送られる。
ReferenceはOnRecycleBinEmptyと同じ。

2.6.35

OnRecycleBinStatusUpdate

ゴミ箱にファイルが投げ込まれた時や、エクスプローラ上でゴミ箱を空にした時に発生し、起動中の全ゴーストに通知される。
また、ゴースト起動時に[NOTIFY]で通知される。

Reference0: 現在ゴミ箱に入っているファイルの数
Reference1: 現在ゴミ箱に入っているファイルのサイズ単位バイト
Reference2: 現在ゴミ箱に入っているファイルの数の直前との差
Reference3: 現在ゴミ箱に入っているファイルのサイズの直前との差単位バイト
Reference4: 常に1 (OnRecycleBinEmptyとの互換用のダミー)
Reference5: 常に空 (OnRecycleBinEmptyとの互換用のダミー)

2.6.04/Ref4は2.6.35

選択領域モードイベント

OnSelectModeBegin

\![enter,selectrect]を実行後に矩形選択モードに入った際に発生。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 選択モード。今のところ "rect" のみ。

OnSelectModeCancel

\![leave,selectrect]を実行後に、選択していなかった場合や、空の選択領域になっていた場合に発生します。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 選択モード。今のところ "rect" のみ。

OnSelectModeComplete

\![leave,selectrect]を実行後に矩形選択モードが解除された際に発生。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 選択モード。今のところ "rect" のみ。
Reference2: 選択結果（長方形枠）。カンマ区切りで、左,上,右,下の座標。

OnSelectModeMouseDown

矩形選択モード中にマウスボタンが押された際に発生。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 選択モード。今のところ "rect" のみ。
Reference2: マウスの位置。カンマ区切りで、X(横),Y(縦)座標。

OnSelectModeMouseUp

矩形選択モード中にマウスボタンが離された際に発生。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 選択モード。今のところ "rect" のみ。
Reference2: マウスの位置。カンマ区切りで、X(横),Y(縦)座標。

音声認識・合成イベント

OnSpeechSynthesisStatus

起動時と音声合成機能がON/OFFされた時に発生。[NOTIFY/他GET]

Reference0: 0/1 (無効/有効)

2.4.01

OnVoiceRecognitionStatus

起動時と音声認識機能がON/OFFされた時に発生。[NOTIFY/他GET]

Reference0: 0/1 (無効/有効)

2.4.01

OnVoiceRecognitionWord

音声認識で単語が認識された際に発生。

Reference0: 本体の場合は0、相方の場合は1。SSP/CROWでは2以降もある。
Reference1: 認識した単語。最初の名前呼びかけの時はキャラ名そのものになり、その際はメニューを表示するのが望ましい。

2.4

音声認識・合成機能について

音声認識・合成機能については、 \__vタグなどSakuraScriptの仕様も参照すること。

その他イベント

OnKeyPress

本体がアクティブな状態でキーが入力された際に発生。

Reference0: 入力されたキー。(キートップに書かれた文字)
Reference1: 入力されたキー。(Win32仮想キーコード)
Reference2: ※SSPのみ　キーの押しっぱなしカウント。
Reference3: ※SSPのみ　キーイベントが来たキャラクターウインドウID。
Reference4: ※SSPのみ　修飾キーがカンマ区切りで列挙される。例："ctrl,alt"

OnRecommendsiteChoice

メニューからサイトのリンクが選択された際に発生。

Reference0: 選択されたサイト名。
Reference1: 選択されたサイトのURL。
Reference2: ※SSPのみ　重ねた時に表示されるサムネイル画像のURL/パス
Reference3: ※SSPのみ　recommendかportal
Reference4: ※SSPのみ　0か1 (0=sakuraか1=keroか)
Reference5: ※SSPのみ　数値メニューの上から何番目か (0からはじまる点に注意)

OnTranslate

SHIORIがMAKOTOのトランスレート機能を兼任するためのイベント。
主に、GETコマンドのSHIORI Eventに対してベースウェアへスクリプトが返却された場合に、それに応じて発行される。
OnTranslateの元となったSHIORI Eventに対して、SHIORI内部での操作を経てベースウェアへ返却されたスクリプトが、ベースウェアによる環境変数の展開などの後に再びSHIORIに送られる。SHIORIはこのスクリプトに対して再度何らかの処理を行ってベースウェアに最終的なスクリプトとして返却できる。
なおOnTranslate自身では再度発生しない。

Reference0: 元のスクリプト。
Reference1: ※SSPのみ　コミュニケートの場合、communicate。
SSTP SENDの場合、sstp-send。
Owned SSTPの場合、owned。
非ローカルSSTPの場合、remote。
トランスレートしない指定の場合、notranslate。
プラグインからのスクリプトの場合、plugin-script
プラグインからのイベント反応の場合、plugin-event
該当するものがカンマ区切りで返る。※該当がない場合欠番となる。
Reference2: ※SSPのみ　このスクリプトが発生したイベントID 。イベントが原因ではない場合欠番。
Reference3: ※SSPのみ　バイト値1区切りの上記イベントのReference 。イベントが原因ではない場合欠番。

OnAITalk

\aタグ実行などにより、ランダムトーク発話を求められた際に発生。

OnOtherGhostTalk

他のゴーストが話した際に発生。\![set,otherghosttalk,true]で有効に。

Reference0: ゴースト名。
Reference1: ゴーストの本体側名。
Reference2: トークを中断した場合、break。
コミュニケートの場合、communicate。
SSTP SENDの場合、sstp-send。
Owned SSTPの場合、owned。
非ローカルSSTPの場合、remote。
トランスレートしない指定の場合、notranslate
プラグインからのスクリプトの場合、plugin-script
プラグインからのイベント反応の場合、plugin-event
該当するものがカンマ区切りで返る。
Reference3: 他ゴーストの話したイベントID。
Reference4: 他ゴーストの話した内容のスクリプト。
Reference5: バイト値1区切りの他ゴーストに渡されたReference。

OnEmbryoExist

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

OnNekodorifExist

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

OnSoundStop

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

Reference0: 再生ファイル名。

OnSoundError

サウンド処理に失敗した際に発生。

Reference0: エラーを起こした再生コマンド。現在のところplay固定。
Reference1: サウンド再生エンジン内部のエラーコード(数値)。
Reference2: 再生ファイル名。
Reference3: サウンド再生エンジンから出力されたエラーメッセージ。

OnTextDrop

テキストデータがDnDされた際に発生。

Reference0: テキスト内容。(改行はバイト値1)
Reference1: DnDされたキャラクターのID。

OnShellScaling

シェル倍率が変更された際に発生。

Reference0: 横方向の変更された後の倍率。（パーセント）
Reference1: 横方向の変更される前の倍率。（パーセント）
Reference2: 縦方向の変更された後の倍率。（パーセント）
Reference3: 縦方向の変更される前の倍率。（パーセント）

OnBalloonScaling

バルーン倍率が変更された際に発生。

Reference0: 横方向の変更された後の倍率。（パーセント）
Reference1: 横方向の変更される前の倍率。（パーセント）
Reference2: 縦方向の変更された後の倍率。（パーセント）
Reference3: 縦方向の変更される前の倍率。（パーセント）

2.5

OnLanguageChange

言語設定が変更された際と、起動直後に通知される。
起動直後に通知される場合は必ずNOTIFYとなり、イベントに応答してしゃべることはできない。

Reference0: 言語名(name)
Reference1: 言語ID(langid)
Reference2: 言語設定ファイル群を格納したフォルダのフルパス
Reference3: ヘルプが記載されているURL

2.5

Notifyイベント

basewareversion

ベースウェアの情報を通知。[NOTIFY]

Reference0: バージョン番号。
Reference1: 本体の識別。
Reference2: ※SSPのみ　バージョン情報の詳細な数値。

hwnd

hwndを通知。[NOTIFY]

Reference0: ゴーストのhwnd。バイト値１区切りで各スコープ。
Reference1: バルーンのhwnd。バイト値１区切りで各スコープ。

uniqueid

unique IDを通知。[NOTIFY]

Reference0: ゴーストのユニークID。特殊なSSTPを送信する際に使用する。

capability

SHIORI拡張実装状態を通知。[NOTIFY]

Reference*

実装レベルに応じて下記がReferenceに1つずつ送られる。
ヘッダ名を小文字に直したものが通知される点に注意。例：SecurityLevel→securitylevel
SHIORI/3.0仕様書も参照。

request.(ヘッダ名小文字): SHIORIリクエストの対応状況。例：request.status
response.(ヘッダ名小文字): SHIORIレスポンスの対応状況。例：response.marker

ownerghostname

現在のゴースト名を通知。[NOTIFY]

Reference0: 現在のゴースト名。

otherghostname

他に起動しているゴーストの本体側名を通知。[NOTIFY]

Reference*: バイト値1区切りにされた、他に起動しているゴーストの本体側名、本体側サーフェス番号、相方側サーフェス番号。

installedsakuraname

インストールされているゴーストのsakura.nameを通知。[NOTIFY]
必ずinstalledghostnameの前に通知される。
また、同じゴーストを示す、installedsakuraname/installedkeroname/installedghostnameのReferenceの番号は一致することが保証される。

Reference*: インストールされているゴーストのsakura.name。

2.6.47

installedkeroname

インストールされているゴーストのkero.nameを通知。[NOTIFY]
必ずinstalledghostnameの前に通知される。
また、同じゴーストを示す、installedsakuraname/installedkeroname/installedghostnameのReferenceの番号は一致することが保証される。

Reference*: インストールされているゴーストのkero.name。

2.6.47

installedghostname

インストールされているゴーストを通知。[NOTIFY]

Reference*: インストールされているゴースト名。

installedshellname

インストールされているシェルを通知。[NOTIFY]

Reference*: インストールされているシェル名。

installedballoonname

インストールされているバルーンを通知。[NOTIFY]

Reference*: インストールされているバルーン名。

installedheadlinename

インストールされているRSS/ヘッドラインを通知。[NOTIFY]

Reference*: インストールされているRSS/ヘッドライン名。

installedplugin

インストールされているプラグインを通知。[NOTIFY]

Reference*: バイト値1区切りで、インストールされているプラグイン名,プラグインID

configuredbiffname

設定済みメールチェックアカウントのリストを通知する。\![biff,アカウント名]で利用できる。[NOTIFY]

Reference*: メールアカウント名

2.5

ghostpathlist

ゴースト格納フォルダ（SSPの本体設定->フォルダ　のゴーストの設定）のパスを通知。[NOTIFY]

Reference*: ゴースト格納フォルダの絶対パス

balloonpathlist

バルーン格納フォルダ（SSPの本体設定->フォルダ　のバルーンの設定）のパスを通知。[NOTIFY]

Reference*: バルーン格納フォルダの絶対パス

headlinepathlist

ヘッドライン格納フォルダ（SSPの本体設定->フォルダ　のヘッドラインの設定）のパスを通知。[NOTIFY]

Reference*: ヘッドライン格納フォルダの絶対パス

pluginpathlist

プラグイン格納フォルダ（SSPの本体設定->フォルダ　のプラグインの設定）のパスを通知。[NOTIFY]

Reference*: プラグイン格納フォルダの絶対パス

calendarskinpathlist

カレンダースキン格納フォルダのパスを通知。[NOTIFY]

Reference*: カレンダースキン格納フォルダの絶対パス

calendarpluginpathlist

カレンダーのスケジュールセンサ格納フォルダのパスを通知。[NOTIFY]

Reference*: カレンダーのスケジュールセンサ格納フォルダの絶対パス

rateofusegraph

使ってるぞグラフの情報を通知。[NOTIFY]

Reference*

バイト値1区切りにされたゴースト名、sakura名、kero名、起動回数、起動時間(分)、起動時間％、(boot install vanish)。

boot: 起動中の時。
install: インストールされている時。
vanish: アンインストールした情報が残ってる時。

enable_log

開発用パレットの「SHIORI内部ログ機能有効」のON/OFF。[NOTIFY]
SHIORI Resource : log_path も参照。

Reference0: ONなら1、OFFなら0

enable_debug

開発用パレットの「SHIORIデバッグモード有効」のON/OFF。[NOTIFY]

Reference0: ONなら1、OFFなら0

OnNotifySelfInfo

ゴースト自身の情報を通知。[NOTIFY]

Reference0: ゴースト名。
Reference1: 本体側の名前。
Reference2: 相方側の名前。
Reference3: 現在のシェル名。
Reference4: 現在のシェルへの絶対パス。
Reference5: 現在のバルーン名。
Reference6: 現在のバルーンへの絶対パス。

OnNotifyBalloonInfo

現在使用中のバルーン情報を通知。[NOTIFY]

Reference0: 選択しているバルーンの名前
Reference1: 選択しているバルーンのフルパス
Reference2: サーフェス番号リスト [キャラID＋コロン＋カンマ区切り＋スペース] 例：0:0,1,2,3 1:0,1

OnNotifyShellInfo

現在使用中のシェル情報を通知。[NOTIFY]

Reference0: 選択しているシェルの名前
Reference1: 選択しているシェルのフルパス
Reference2: サーフェス番号リスト [カンマ区切り] 例：0,1,2,3,4,5,6,7,8,10,11

OnNotifyDressupInfo

着せ替えの情報を通知。
起動時のみ[NOTIFY]で、メニューから切替などユーザーによる操作なら[GET]で送られる。
このイベントの前に発生するOnDressupChangedも参照すること。

Reference*: バイト値1区切りにされた以下の情報：[キャラクターID、カテゴリー名、パーツ名、オプション、有効1/無効0、サムネイルパス]
オプションはカンマ区切りでいくつも追加されている場合もある。
着せ替え定義の数だけ繰り返される。
ゴースト側で前回の通知からの有効/無効の差分を処理すると、何が変わったかを把握できる。

OnNotifyUserInfo

ユーザーの入力情報を通知。起動時＋情報が更新された際に通知。[NOTIFY]

Reference0: 呼び方。
Reference1: フルネーム。
Reference2: 誕生日。(2003,5,5のようにカンマ区切りで)
Reference3: 性別。male(男),female(女),undef(未定義)のいずれか。

OnNotifyOSInfo

OS情報を通知。[NOTIFY]

Reference0: OSのシステム,バージョン,表示用の名前 [カンマ区切り]
Reference1: CPUタイプ,クロックMHz,追加情報 [カンマ区切り]
Reference2: 物理,仮想メモリ(KB) [カンマ区切り]
Reference3: システム起動からの経過分。

OnNotifyFontInfo

システムにインストールされているフォントを通知。[NOTIFY]

Reference*: フォント名。

OnNotifyInternationalInfo

タイムゾーン、ロケール(言語)名など、国際化関連の情報を通知する。[NOTIFY]

Reference0: UTCからの時刻のずれ。単位は分。負の値＝早い　正の値＝遅い
たとえば、日本標準時の場合、9時間早いので、-540になる。
Reference1: 夏時間が有効か否か。有効=1 無効=0
Reference2: ISO3166準拠の2文字国名。
Reference3: ISO639準拠の2文字言語名。

トップページへ戻る	INDEX
設定ファイル	Ghost	descript.txt
	Shell	descript.txt surfaces.txt surfacetable.txt
	Balloon	descript.txt balloon(s/k)*s.txt
	Plugin	descript.txt
	Headline	descript.txt
	Install	install.txt delete.txt developer_options.txt
さくらスクリプト	Sakura Script Property System
イベント	SHIORI	SHIORI Event SHIORI Event（外部） SHIORI Resource
イベント	PLUGIN	PLUGIN Event
規格	SHIORI/3.0 SSTP/1.x SAORI/1.0（外部サイト） PLUGIN/2.0 HEADLINE/2.0 DLL FMO/MUTEX Web関連

SHIORI Eventリスト

SHIORI Event

Ghost Status

起動・終了・切り替えイベント

入力ボックスイベント

ダイアログボックスイベント

時間イベント

消滅イベント

選択肢イベント

サーフェスイベント

マウスイベント

バルーンイベント

トレイバルーンイベント

インストールイベント

ファイルドロップイベント

URLドロップイベント

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

時計合わせイベント

メールチェックイベント

ヘッドライン/RSSセンスイベント

カレンダーイベント

SSTPイベント

その他通信イベント

イベント送信失敗イベント

見切れ・重なりイベント

ネットワーク状態イベント

OS状態イベント

選択領域モードイベント

音声認識・合成イベント

その他イベント

Notifyイベント

このページの書式について

Reference一覧について

[NOTIFY]表示について

起動・終了・切り替えイベント

入力ボックスイベント

ダイアログボックスイベント

時間イベント

消滅イベント

選択肢イベント

サーフェスイベント

マウスイベント

バルーンイベント

トレイバルーンイベント

インストールイベント

インストールの識別子

インストールの失敗理由

ファイルドロップイベント

URLドロップイベント

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

ネットワーク更新成功理由

ネットワーク失敗理由

ネットワーク更新対象の種別

ネットワーク更新理由

時計合わせイベント

メールチェックイベント

ヘッドライン/RSSセンスイベント

ヘッドラインセンスOnFindフェーズ

ヘッドラインセンス終了理由

カレンダーイベント

スケジュールタイプ

SSTPイベント

その他通信イベント

イベント送信失敗イベント

見切れ・重なりイベント

OS状態イベント

選択領域モードイベント

音声認識・合成イベント

音声認識・合成機能について

その他イベント

Notifyイベント