SHIORI Eventリスト¶

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

このページでは、SHIORI/3.0および3.1（SSP拡張定義）において発行されるSHIORI Eventの各IDについての解説しています。
ここに載っていないイベントについては、SHIORI Resourceまたは外部からのSHIORI Eventのページにある可能性があります。

SHIORI Event自体についての解説が必要な場合は、「補足: SHIORI Eventとは」のページを参考にしてください。

Reference一覧について¶

ReferenceがあるSHIORI Eventについては、それぞれReferenceの一覧が設けられています。
もしReferenceの番号部分が「*」となっている場合、それは不定数のReferenceである事を意味します。
すなわち、そのReferenceは動作環境によって数が異なるものを扱っているために番号が不定であり、またその不定数のReferenceは全て同じ形式の内容だということです。
この場合でもReferenceには0から始まる通し番号が与えられる原則は変わらないので、例えばReference一覧に番号が*のものしかない場合は、0から不定の番号まで同じ形式のReferenceが（その環境に応じた数だけ）並び、もし一覧にReference2までがあってその次の行がReference*ならば、3から不定の番号まで同じ形式のReferenceが並びます。

[NOTIFY]表示について¶

説明文中に[NOTIFY]と記載があるSHIORI Eventは、普通NOTIFYコマンドで発行されます。
何も記載がない場合は普通GETコマンドで発行されます。

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

OnFirstBoot¶

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

• Reference0: vanishされた回数。

対応: Materia / SSP / CROW / Ninix

OnBoot¶

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

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

対応: Materia / SSP / CROW / Ninix

OnClose¶

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

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

対応: Materia / SSP / CROW / Ninix

OnCloseAll¶

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

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

対応: SSP / Ninix

OnGhostChanged¶

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

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

対応: Materia / SSP / CROW / Ninix

OnGhostChanging¶

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

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

対応: Materia / SSP / CROW / Ninix

OnGhostCalled¶

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

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

対応: SSP

OnGhostCalling¶

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

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

対応: SSP / Ninix

OnGhostCallComplete¶

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

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

対応: SSP

OnOtherGhostBooted¶

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

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

対応: SSP / Ninix

OnOtherGhostChanged¶

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

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

対応: SSP / Ninix

OnOtherGhostClosed¶

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

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

対応: SSP / Ninix

OnShellChanged¶

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

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

対応: Materia / SSP / CROW / Ninix

OnShellChanging¶

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

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

対応: Materia / SSP / CROW / Ninix

OnDressupChanged¶

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

着せ替えフラグ変更差分が大量になった場合(今のところ100要素)この通知はスキップされる。大量変更の受け取りはOnNotifyDressupInfoを利用すること。

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

対応: SSP / Ninix

OnBalloonChange¶

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

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

対応: SSP / Ninix

OnWindowStateRestore¶

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

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

対応: Materia / SSP / CROW / Ninix

OnWindowStateMinimize¶

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

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

対応: Materia / SSP / CROW / Ninix

OnFullScreenAppMinimize¶

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

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

対応: SSP

OnFullScreenAppRestore¶

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

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

対応: SSP

OnVirtualDesktopChanged¶

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

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

対応: SSP

OnCacheSuspend¶

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

対応: SSP

OnCacheRestore¶

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

対応: SSP

OnInitialize¶

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

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

対応: SSP

OnDestroy¶

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

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

対応: SSP / Ninix

OnSysResume¶

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

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

対応: SSP

OnSysSuspend¶

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

対応: SSP

OnBasewareUpdating¶

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

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

対応: SSP

OnBasewareUpdated¶

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

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

対応: SSP

入力ボックスイベント¶

OnTeachStart¶

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

対応: Materia / SSP / Ninix

OnTeachInputCancel¶

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

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

対応: SSP / Ninix

OnTeach¶

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

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

対応: SSP / Ninix

OnCommunicate¶

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

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

対応: Materia / SSP / Ninix

OnCommunicateInputCancel¶

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

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

対応: SSP / Ninix

OnUserInput¶

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

InputBoxのIDも参照のこと。

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

対応: Materia / SSP / CROW / Ninix

OnUserInputCancel¶

InputBoxが閉じられた際に発生。
タイムアウトした場合、かつこのイベントに反応がない場合は、互換性確保のため、OnUserInput Reference1=timeout が送られる。

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

対応: SSP / Ninix

OnTextAreaInput¶

複数行入力ボックス(textareabox)に入力され決定された際に発生。
IDが「On」で始まる場合はこのイベントの代わりにID名のイベントが発生し、Reference0に入力内容が入る(以降は1つずつ前へずれる)。InputBoxのIDと同じ規則。

• Reference0: textareaboxのID。
• Reference1: 入力された内容。改行はバイト値1の文字(\1)で区切られる。
• Reference2: 空欄(OnUserInputとReferenceの位置を揃えるため)
• Reference3～: --reference=で指定した追加情報

対応: SSP 2.9.10

OnTextAreaInputCancel¶

複数行入力ボックス(textareabox)が閉じられた際に発生。
IDにかかわらずこのイベントが発生する。OnUserInputCancelと違い、タイムアウト時に入力決定のイベントへ投げ直すことはない。

• Reference0: textareaboxのID。
• Reference1: タイムアウトした場合、timeout。閉じられた場合、close。
• Reference2: 閉じるまでに入力されていた内容。改行はバイト値1の文字(\1)で区切られる。
• Reference3～: --reference=で指定した追加情報

対応: SSP 2.9.10

inputbox.autocomplete¶

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

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

対応: SSP

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

OnSystemDialog¶

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

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

対応: SSP

OnSystemDialogCancel¶

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

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

対応: SSP

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: 項目内容テキスト。

対応: SSP

OnGhostTermsAccept¶

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

対応: SSP 2.5.33

OnGhostTermsDecline¶

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

対応: SSP 2.5.33

時間イベント¶

OnSecondChange¶

1秒ごとに発生。

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

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

対応: Materia / SSP / CROW / Ninix

OnMinuteChange¶

1分ごとに発生。

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

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

対応: Materia / SSP / CROW / Ninix

OnHourTimeSignal¶

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

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

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

対応: SSP

消滅イベント¶

OnVanishSelecting¶

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

対応: Materia / SSP / CROW / Ninix

OnVanishSelected¶

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

対応: Materia / SSP / CROW / Ninix

OnVanishCancel¶

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

対応: Materia / SSP / CROW / Ninix

OnVanishButtonHold¶

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

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

対応: Materia / SSP / CROW / Ninix

OnVanished¶

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

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

対応: Materia / SSP / CROW / Ninix

OnOtherGhostVanished¶

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

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

対応: SSP

選択肢イベント¶

OnChoiceSelect¶

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

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

対応: Materia / SSP / CROW / Ninix

OnChoiceSelectEx¶

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

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

対応: SSP

OnChoiceEnter¶

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

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

対応: Materia / SSP / CROW / Ninix

OnChoiceTimeout¶

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

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

対応: Materia / SSP / CROW / Ninix

OnChoiceHover¶

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

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

対応: SSP

OnAnchorSelect¶

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

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

対応: Materia / SSP / CROW / Ninix

OnAnchorSelectEx¶

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

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

対応: SSP

OnAnchorEnter¶

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

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

対応: SSP

OnAnchorHover¶

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

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

対応: SSP

サーフェスイベント¶

OnSurfaceChange¶

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

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

対応: SSP / CROW / Ninix

OnSurfaceRestore¶

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

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

対応: Materia / SSP / CROW / Ninix

OnOtherSurfaceChange¶

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

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

対応: SSP / Ninix

マウスイベント¶

OnMouseClick¶

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

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

対応: Materia / SSP / CROW / Ninix

OnMouseClickEx¶

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

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

対応: SSP / Ninix

OnMouseDoubleClick¶

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

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

対応: Materia / SSP / CROW / Ninix

OnMouseDoubleClickEx¶

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

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

対応: SSP / Ninix

OnMouseMultipleClick¶

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

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

対応: SSP

OnMouseMultipleClickEx¶

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

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

対応: SSP

OnMouseUp¶

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

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

対応: SSP / Ninix

OnMouseUpEx¶

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

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

対応: SSP / Ninix

OnMouseDown¶

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

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

対応: SSP / Ninix

OnMouseDownEx¶

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

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

対応: SSP / Ninix

OnMouseMove¶

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

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

対応: Materia / SSP / CROW / Ninix

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/NINIXのみ　常に0。
• Reference6: ※SSP/NINIXのみ　マルチタッチ対応環境のタッチパネル（※タッチパッド不可）からの入力でtouch、ペンタブレットでpen、ペンタブの消しゴム側でeraser、マウスなどからの入力でmouse

対応: Materia / SSP / CROW / Ninix

OnMouseEnterAll¶

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

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

対応: SSP / Ninix

OnMouseLeaveAll¶

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

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

対応: SSP / Ninix

OnMouseEnter¶

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

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

対応: SSP / Ninix

OnMouseLeave¶

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

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

対応: SSP / Ninix

OnMouseDragStart¶

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

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

対応: SSP / Ninix

OnMouseDragEnd¶

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

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

対応: SSP / Ninix

OnMouseHover¶

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

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

対応: SSP

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度。

対応: SSP

ゲームパッドイベント¶

OnGamepadButtonDown¶

ゲームパッドのボタンが押された瞬間に発生。
ボタンを押し続けている間は発生しない（押した瞬間のみ）。
複数のボタンが同時に変化した場合、ボタンごとに個別のイベントが発生する。
イベントは起動中の全ゴーストに同時にブロードキャストされる。

• Reference0: パッドインデックス。
• Reference1: ボタン名。

対応: SSP 2.7.54

OnGamepadButtonUp¶

ゲームパッドのボタンが離された瞬間に発生。
複数のボタンが同時に変化した場合、ボタンごとに個別のイベントが発生する。
イベントは起動中の全ゴーストに同時にブロードキャストされる。

• Reference0: パッドインデックス。
• Reference1: ボタン名。

対応: SSP 2.7.54

OnGamepadAxisMove¶

ゲームパッドのアナログスティックやトリガーの値が前回通知時から大きく変化した場合に発生。
微小な揺れではイベントは発生しない。スティック中央付近やトリガーの遊び部分（デッドゾーン）の値は自動的に0に丸められる。
スティックやトリガーが中央位置（ニュートラル）に戻った場合は、変化量に関わらず必ず発生する。
イベントは起動中の全ゴーストに同時にブロードキャストされる。
軸イベントはスティック操作中に高頻度で発生する可能性があるため、重い処理を行う場合はゴースト側で頻度制御を検討すること。

• Reference0: パッドインデックス。
• Reference1: 軸名。
• Reference2: 生値（整数）。範囲はベースウェアの実装に依存する。
• Reference3: 正規化値（小数）。スティックは-1.0～1.0、トリガーは0.0～1.0の範囲。通常はこちらを使用する。

対応: SSP 2.7.54

OnGamepadConnected¶

ゲームパッドが接続された際に発生。SSP起動時に既に接続されていた場合も発生する。
イベントは起動中の全ゴーストに同時にブロードキャストされる。

• Reference0: パッドインデックス。

対応: SSP 2.7.54

OnGamepadDisconnected¶

ゲームパッドが切断された際に発生。
イベントは起動中の全ゴーストに同時にブロードキャストされる。

• Reference0: パッドインデックス。

対応: SSP 2.7.54

ボタン名一覧¶

• A: フェイスボタン下
• B: フェイスボタン右
• X: フェイスボタン左
• Y: フェイスボタン上
• LB: 左バンパー（L1相当）
• RB: 右バンパー（R1相当）
• LSB: 左スティック押込み（L3相当）
• RSB: 右スティック押込み（R3相当）
• Start: スタートボタン
• Back: バック / セレクトボタン
• DPadUp: 十字キー上
• DPadDown: 十字キー下
• DPadLeft: 十字キー左
• DPadRight: 十字キー右

十字キーの斜め入力は、2つのボタンイベントとして個別に発生する（例：右上ならDPadUpとDPadRight）。

軸名一覧¶

• LeftStickX: 左スティック水平（右が正、左が負）。正規化値の範囲は-1.0～1.0。
• LeftStickY: 左スティック垂直（上が正、下が負）。正規化値の範囲は-1.0～1.0。
• RightStickX: 右スティック水平（右が正、左が負）。正規化値の範囲は-1.0～1.0。
• RightStickY: 右スティック垂直（上が正、下が負）。正規化値の範囲は-1.0～1.0。
• LeftTrigger: 左トリガー（引くほど大きい）。正規化値の範囲は0.0～1.0。
• RightTrigger: 右トリガー（引くほど大きい）。正規化値の範囲は0.0～1.0。

パッドインデックスについて¶

全イベントのReference0にはパッドインデックスが渡される。
ゲームパッド1台のみを想定する場合、Reference0は無視して構わない（通常は0である）。

Windows上のSSPにおけるXInput固有の仕様¶

Windows上のSSPではXInput APIを使用してゲームパッド入力を取得している。そのため以下の制約がある。

• 対応コントローラ: XInput対応ゲームパッド（Xbox系コントローラ等）のみ。DirectInput専用のコントローラは認識されない。
• 同時接続数: 最大4台。パッドインデックスは0～3の範囲。
• OnGamepadAxisMoveのReference2（生値）の範囲: スティックは-32768～32767、トリガーは0～255。

バルーンイベント¶

OnBalloonBreak¶

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

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

対応: SSP / Ninix

OnBalloonClose¶

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

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

対応: SSP / Ninix

OnBalloonTimeout¶

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

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

対応: SSP / Ninix

トレイバルーンイベント¶

OnTrayBalloonClick¶

トレイアイコンのバルーンをクリックして消した際に発生。
バルーンの代わりにトースト通知で表示した場合(\![set,trayballoon]参照)は、トーストをクリックした際に発生。通知センターに移った後のクリックでは発生しない。[2.9.14]

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

対応: SSP

OnTrayBalloonTimeout¶

トレイアイコンのバルーンをタイムアウトや閉じるボタンで消した際に発生。
バルーンの代わりにトースト通知で表示した場合(\![set,trayballoon]参照)は、トーストを閉じるボタンで閉じた際や、時間切れで通知センターに移った際に発生。[2.9.14]

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

対応: SSP

インストールイベント¶

OnInstallBegin¶

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

対応: Materia / SSP / CROW

OnInstallComplete¶

インストールが正常終了した際に発生。
このイベントは旧仕様のため、1回のインストールで同時に入った物のうち先頭の2件しか通知されない。
同梱によって3件以上が同時にインストールされうる場合は、OnInstallCompleteExを使う事。

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

対応: Materia / SSP / CROW / Ninix

OnInstallCompleteEx¶

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

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

対応: SSP / Ninix

OnInstallCompleteAll¶

複数のnarをD&Dした時などに、インストールがすべて正常終了した際に、OnInstallComplete/同Exの後に、最後に発生。
SSPでは2.9.00より前のバージョンに実装漏れがあり、実際には発生しない。

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

対応: SSP 2.9.00 / Ninix

OnInstallFailure¶

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

• Reference0: ※失敗理由。

対応: Materia / SSP / CROW / Ninix

OnInstallRefuse¶

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

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

対応: Materia / SSP Ref1以降は2.4.85 / CROW / Ninix

OnInstallReroute¶

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

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

対応: SSP 2.4 / Ref1以降は2.4.85

インストールの識別子¶

• shell
• ghost
• balloon
• plugin
• headline
• rss
• supplement

以下はOnInstallComplete / OnNarCreatedのみ
SSPでは廃止されており、ゴーストとバルーンがそれぞれ別の識別子として通知される。

• ghost with balloon
• shell with balloon

以下はSSP専用

• calendar skin
• calendar plugin
• package
• language

SSPで同時インストールされた物の識別子は、install.txtでの指定と同じくドット区切りの calendar.skin / calendar.plugin になる。
アーカイブ本体側の識別子はinstall.txtのtypeの表記のままなので、空白区切りの calendar skin / calendar plugin になる。

インストールの失敗理由¶

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

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

OnFileDropping¶

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

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

対応: SSP / CROW

OnFileDropped¶

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

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

対応: SSP / CROW

OnFileDrop¶

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

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

対応: SSP / CROW

OnFileDropEx¶

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

• Reference0: ドロップされたファイルパス。複数ファイル/ディレクトリがあればbyte値1で区切る。
• Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。
• Reference2: ドロップされたファイルのMIMEタイプ(SSP 2.7.98以降)。複数ファイル/ディレクトリがあればbyte値1で区切る。

対応: SSP

OnFileDrop2¶

ファイルがDnDされた際に発生。このイベントが現時点での最新仕様となる。
このイベントに応答すると、本体の既定の処理(画像ビューアー・メディアプレーヤー・アーカイブビューアーで開く)は行われない。応答したうえで既定の処理も行わせたい場合は、\![execute,dropdefault,file]を使う。[2.9.10]

• Reference0: ドロップされたファイルパス。複数ファイル/ディレクトリがあればbyte値1で区切る。
• Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。
• Reference2: ドロップされたファイルのMIMEタイプ(SSP 2.7.98以降)。複数ファイル/ディレクトリがあればbyte値1で区切る。

対応: Materia / SSP / CROW / Ninix

OnMediaPlayerOpen¶

ファイルがDnDされて、OnFileDrop2にゴーストが応答せず(または\![execute,dropdefault,file]を実行して[2.9.10])、かつメディアプレーヤーが開かれた際に発生。ReferenceはOnFileDrop2と同一。

• Reference0: ドロップされたファイルパス。複数ファイル/ディレクトリがあればbyte値1で区切る。
• Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。
• Reference2: ドロップされたファイルのMIMEタイプ。複数ファイル/ディレクトリがあればbyte値1で区切る。

対応: SSP 2.8.51

OnPictureViewerOpen¶

ファイルがDnDされて、OnFileDrop2にゴーストが応答せず(または\![execute,dropdefault,file]を実行して[2.9.10])、かつ画像ビューアーが開かれた際に発生。ReferenceはOnFileDrop2と同一。

• Reference0: ドロップされたファイルパス。複数ファイル/ディレクトリがあればbyte値1で区切る。
• Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。
• Reference2: ドロップされたファイルのMIMEタイプ。複数ファイル/ディレクトリがあればbyte値1で区切る。

対応: SSP 2.8.51

OnArchiveViewerOpen¶

ファイルがDnDされて、OnFileDrop2にゴーストが応答せず(または\![execute,dropdefault,file]を実行して[2.9.10])、かつアーカイブビューアーが開かれた際に発生。ReferenceはOnFileDrop2と同一。

• Reference0: ドロップされたファイルパス。複数ファイル/ディレクトリがあればbyte値1で区切る。
• Reference1: ドロップされたキャラクターのスコープ番号。本体側0、相方1、3人目以降は2以降。
• Reference2: ドロップされたファイルのMIMEタイプ。複数ファイル/ディレクトリがあればbyte値1で区切る。

対応: SSP 2.8.57

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}

対応: SSP 2.6.41

OnOtherObjectDropped¶

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

対応: SSP 2.6.41

OnDirectoryDrop¶

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

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

対応: SSP / CROW

OnWallpaperChange¶

画像ファイルのDnDによって壁紙が変更された際に発生。
OS側で壁紙が変更されたことの通知はOnDesktopWallpaperChange。

• Reference0: ドロップされたファイルパス。
• Reference1: ※SSPのみ　ドロップされたキャラクターのスコープ番号。(本体側0,相方1...)

対応: Materia / SSP / CROW

OnUpdatedataCreating¶

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

対応: Materia / SSP / CROW

OnUpdatedataCreated¶

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

対応: Materia / SSP / CROW

OnNarCreating¶

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

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

対応: Materia / SSP / CROW

OnNarCreated¶

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

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

対応: Materia / SSP / CROW

URLドロップイベント¶

OnURLDragDropping¶

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

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

対応: SSP 2.6.37

OnURLDropping¶

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

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

対応: Materia / SSP Ref1は2.6.36 / CROW

OnURLDropped¶

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

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

対応: Materia / SSP Ref1,2は2.6.36 / CROW

OnURLDropFailure¶

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

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

対応: Materia / SSP Ref2,3は2.6.36 / CROW

OnURLQuery¶

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

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

対応: SSP 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デコード済)

対応: SSP

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

OnUpdateProcessExec¶

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

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

対応: SSP 2.6.23

OnUpdateBegin¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdateReady¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdateComplete¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdateFailure¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdate.OnDownloadBegin¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdate.OnMD5CompareBegin¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdate.OnMD5CompareComplete¶

MD5が一致した際に発生。

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

対応: Materia / SSP / CROW / Ninix

OnUpdate.OnMD5CompareFailure¶

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

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

対応: Materia / SSP / CROW / Ninix

OnUpdateOtherBegin¶

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

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

対応: SSP

OnUpdateOtherReady¶

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

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

対応: SSP

OnUpdateOtherComplete¶

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

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

対応: SSP

OnUpdateOtherFailure¶

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

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

対応: SSP

OnUpdateOther.OnDownloadBegin¶

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

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

対応: SSP

OnUpdateOther.OnMD5CompareBegin¶

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

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

対応: SSP

OnUpdateOther.OnMD5CompareComplete¶

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

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

対応: SSP

OnUpdateOther.OnMD5CompareFailure¶

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

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

対応: SSP

OnUpdateCheckComplete¶

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

• Reference0: 更新ファイルがあった場合は、更新を行うファイルの総数（OnUpdateReady と異なり、1は引かれない）。
  更新ファイルが無かった場合は none。
• Reference1: カンマでセパレートされた更新されたファイル名のリスト。
• Reference3: ※更新対象種別
• Reference4: SSP 2.3：更新実行理由。scriptのみ。

対応: SSP

OnUpdateCheckFailure¶

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

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

対応: SSP

OnUpdateResult¶

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

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

  (※1)[\1](network-update/※2)[\1](network-update/※3)[\1](network-update/※4)
  または
  (※1)[\1](network-update/※2)[\1](network-update/※3)

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

対応: SSP

OnUpdateResultEx¶

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

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

  (※1)[\1](network-update/※2)[\1](network-update/※3)[\1](network-update/※4)[\1](network-update/※5)
  または
  (※1)[\1](network-update/※2)[\1](network-update/※3)[\1](network-update/※4)

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

対応: SSP

OnUpdateCheckResult¶

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

• Reference*: OnUpdateResultと同じ

対応: SSP

OnUpdateCheckResultEx¶

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

• Reference*: OnUpdateResultExと同じ

対応: SSP

OnUpdateResultExplorer¶

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

• Reference*: OnUpdateResultと同じ

対応: SSP

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

• 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]
• parse: ※SSPのみ。取得はできたが、内容の解析に失敗した。rss-get/rss-post・ical-get/ical-postで発生する。
• downloading: ※SSPのみ。同じURLの取得がすでに進行中のため、二重取得を阻止した。execute-http/rss/icalで発生する。 [2.8.90]
• paramerror: ※SSPのみ。更新実行タグの設定ミスにより更新を実行できなかった。 [2.5.26]

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

• ghost
• shell
• balloon
• plugin
• headline
• baseware　※CROWのみ

ネットワーク更新理由¶

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

ネットワーク更新イベントの発生順序¶

SSPの通常のネットワーク更新（ゴースト更新）でのイベント発生順序は以下の通り。

1. OnUpdateProcessExec　※メニューなどからの実行時のみ。スクリプトを返した場合、以降の標準の更新処理は行われない。

2. OnUpdateBegin

3. OnUpdateReady　※更新ファイルがあった場合のみ。更新ファイルが無い場合は、以降のイベントは飛ばして OnUpdateComplete（Reference0 が none）が発生する。

4. 更新ファイル1つごとに、以下を繰り返す。

   1. OnUpdate.OnDownloadBegin
   2. OnUpdate.OnMD5CompareBegin
   3. OnUpdate.OnMD5CompareComplete または OnUpdate.OnMD5CompareFailure
      MD5が一致しなかった場合は、同じファイルについて OnUpdate.OnDownloadBegin からやり直す。リトライ回数を超えても一致しなかった場合は、OnUpdateFailure（md5 miss）となり、以降のファイルは処理されない。

5. 全ファイルの取得後、更新ファイルの置き換えとSHIORI・シェルなどの再読み込みを行ってから、OnUpdateComplete が発生する。したがって、OnUpdateComplete は再読み込み後のゴーストが受け取る。

• 途中で失敗（中断を含む）した場合は、その時点で OnUpdateFailure が発生して終了する。同じ更新で OnUpdateFailure と OnUpdateComplete の両方が発生することはない。
• OnUpdateReady・各ファイルの処理の後・置き換え前には、それまでに発生したイベントのスクリプトの再生が終わるまで待ってから次へ進む。そのため、これらのイベントでスクリプトを返すと、その再生が終わるまで更新は次の段階に進まない。
• OnUpdateReady のスクリプトの再生が終わり、ファイルの取得を始める時点で早送りキー（SSPの設定「早送りキーを有効にする」で指定したキー。標準では Ctrl）が押されていた場合、その更新では全てのファイルについて OnUpdate.OnDownloadBegin・OnUpdate.OnMD5Compare* が発生しない（ファイルの取得とMD5の照合そのものは行われる）。OnUpdateBegin・OnUpdateReady・OnUpdateComplete・OnUpdateFailure は通常通り発生する。
• 自動更新（更新理由が auto）の場合、OnUpdateBegin は更新ファイルの有無が確認できた時点、つまり OnUpdateReady の直前に発生する。更新ファイルが無い場合と、更新ファイルの確認前に失敗した場合は、OnUpdateBegin・OnUpdateComplete・OnUpdateFailure のいずれも発生しない。
• 更新チェックのみ（ゴーストエクスプローラなどからのチェック）の場合、OnUpdateBegin・OnUpdateReady・OnUpdate.OnDownloadBegin・OnUpdate.OnMD5Compare*・OnUpdateComplete・OnUpdateFailure は発生せず、代わりに OnUpdateCheckComplete または OnUpdateCheckFailure が発生する。
• ゴースト以外（シェル・バルーンなど）の更新では、上記のイベント名が OnUpdateOther〜（OnUpdateOtherBegin、OnUpdateOther.OnDownloadBegin など）に置き換わる。発生順序は同じ。

ゴースト本体・シェル・バルーンをまとめて更新する場合は、ゴースト → シェル → バルーン（→ 推奨バルーン）の順に、それぞれ上記の一連のイベントが発生する。全ての更新が終わった後に、最後に一度だけ OnUpdateResultEx が発生する。OnUpdateResultEx がスクリプトを返さなかった場合に限り、続けて OnUpdateResult が発生する。更新チェックのみの場合は、それぞれ OnUpdateCheckResultEx・OnUpdateCheckResult となる。

時計合わせイベント¶

OnSNTPBegin¶

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

• Reference0: 接続先サーバ名。

対応: Materia / SSP / CROW

OnSNTPCompareEx¶

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

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

対応: SSP 2.5.66

OnSNTPCompare¶

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

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

対応: Materia / SSP / CROW

OnSNTPCorrectEx¶

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

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

対応: SSP 2.5.66

OnSNTPCorrect¶

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

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

対応: Materia / SSP / CROW

OnSNTPFailure¶

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

• Reference0: 接続先サーバ名。

対応: Materia / SSP / CROW

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

OnBIFFBegin¶

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

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

対応: Materia / 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区切りの送信者とタイトル。

対応: Materia / SSP / CROW

OnBIFF2Complete¶

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

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

対応: Materia / SSP

OnBIFFFailure¶

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

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

対応: Materia / SSP / CROW

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

OnHeadlinesenseBegin¶

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

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

対応: Materia / SSP

OnHeadlinesense.OnFind¶

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

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

対応: Materia / SSP

OnHeadlinesenseComplete¶

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

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

対応: Materia / SSP

OnHeadlinesenseFailure¶

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

• Reference0: ※終了理由

対応: Materia / SSP

OnRSSBegin¶

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

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

対応: SSP

OnRSSComplete¶

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

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

対応: SSP 作者名・内容 2.4.10～

OnRSSFailure¶

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

• Reference0: ※終了理由

対応: SSP

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

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

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

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

カレンダーイベント¶

OnScheduleTodayNotify¶

本体カレンダー機能の「今日の予定」の内容が変化した際に発生。[NOTIFY]
日付が変わった時、予定を追加・削除した時、スケジュールセンサの取得結果が変わった時など。変化が無ければ発生しない。
特定のゴーストではなく起動中の全ゴーストに通知される。

Reference0以降が更新後の「今日の予定」1件ずつ。各Referenceの中はバイト値1（以下[\1]）で区切られている。
予定が1件も無くなった場合はReferenceが1つも無い状態で発生する。

• Reference0～: イベントのタイプ [\1] イベントの内容(caption) [\1] 追加データ(subtitle) [\1] スクリプト(script) [\1] 開始日時 [\1] 終了日時 [\1]
  予定の数だけReference0,1,2～と続く。末尾にも区切りの[\1]が付く点に注意。
  開始日時・終了日時はカンマ区切りの「年,月,日,時,分,秒」形式。時刻を設定していない予定は時・分・秒が空になり「2026,9,10,,,」のようになる。
  終了日時は終了時刻を設定した予定にのみ入る。設定が無ければ空。
  caption・subtitle・scriptは本体カレンダーに登録された文字列そのままで、さくらスクリプト用のエスケープは行われない。

対応: SSP 2.8.90

OnSchedule5MinutesToGo¶

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

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

対応: SSP

OnScheduleRead¶

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

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

対応: SSP

OnSchedulesenseBegin¶

スケジュールセンサが接続開始する際に発生。
特定のゴーストではなく起動中の全ゴーストに通知される。

手動更新（カレンダーのメニューからセンサを選んで更新した場合）でのみ発生する。定期チェックでは後述の通り発生しない。

• Reference0: スケジュールセンサの名前
• Reference1: スケジュールセンサの購読URL

対応: SSP

OnSchedulesenseComplete¶

スケジュールセンサの処理が完了した際に発生。
特定のゴーストではなく起動中の全ゴーストに通知される。

手動更新でのみ発生する。定期チェックでは後述の通り発生しない。
取得はできたが更新が無かった場合（304 Not Modifiedや内容が同一だった場合）も、成功として本イベントが発生する。

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

対応: SSP

OnSchedulesenseFailure¶

スケジュールセンサの処理に失敗した場合に発生。
特定のゴーストではなく起動中の全ゴーストに通知される。

Begin/Completeと違い、定期チェックでも発生する。

• Reference0: 失敗した理由（ヘッドラインセンサのものと共通）。取得できなかった場合can't download、取得はできたがiCalとして解析できなかった場合can't analyze。
• Reference1: スケジュールセンサの名前。定期チェックではBeginが無いため、これが無いとどのセンサが失敗したのか分からない

対応: SSP

OnSchedulepostBegin¶

[旧仕様]スケジュールセンサが投稿モードで接続開始する際に発生。
投稿機能自体が廃止されているため、現在のSSPでは発生しない。

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

対応: SSP

OnSchedulepostComplete¶

[旧仕様]スケジュールセンサが投稿処理を完了した際に発生。
投稿機能自体が廃止されているため、現在のSSPでは発生しない。

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

対応: SSP

スケジュールセンサの更新タイミングとイベント¶

• 手動更新: カレンダーのメニューからセンサを選んで更新した場合。Begin→Complete（または Failure）が全て発生する。
• 定期チェック: SSPが30分おきに全センサを自動で巡回する場合。OnSchedulesenseFailureのみ発生する。
  全センサぶんのBegin/Completeが定期的に流れるとゴーストが喋りすぎるため、異常時だけ通知される。

スケジュールタイプ¶

• 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

対応: Materia / SSP

OnSSTPBlacklisting¶

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

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

対応: Materia

その他通信イベント¶

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]

対応: SSP / Ninix

OnExecuteHTTPFailure¶

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

[2.8.90] 同じURLの取得がすでに進行中の場合、後から出したリクエストは実行されずこのイベント(Reference4=downloading)が発生する。それ以前はタグが黙って無視されていた。

対応: SSP / Ninix

OnExecuteHTTPProgress¶

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

対応: SSP [2.6.44]

OnExecuteHTTPStreaming¶

execute-httpで--streamingを指定した際に発生。Reference4以外はCompleteと同じ。

• Reference4: Streamingデータのうち、改行をバイト値1に置き換えたもの。

対応: SSP [2.8.14]

OnExecuteHTTPSSLInfo¶

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

--async・--syncでOnから始まるIDを指定した場合でも、イベント名は置き換わらず常に本イベントで通知される。どのリクエストのものかはReference0で判別すること。

• 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)をカンマ区切りで順番に列挙

対応: SSP

OnExecuteICalComplete¶

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

Reference0がカレンダー全体の情報、Reference1以降が予定1件ずつ。各Referenceの中はバイト値1（以下[\1]）で区切られている。
どの予定がいくつ並ぶかはiCal絞り込みオプションで決まる。

• Reference0: カレンダー名(X-WR-CALNAME) [\1] タイムゾーン(X-WR-TIMEZONE) [\1] 暦法(CALSCALE。通常はGREGORIAN) [\1] このイベントで返した予定の件数 [\1] ファイル中の予定の総数 [\1] 絞り込み期間の開始日 [\1] 絞り込み期間の終了日
  期間の開始日・終了日は「年,月,日,,,」形式。--from・--to・--expand・--limitをいずれも指定しなかった場合は空。
• Reference1～: UID [\1] 開始日時 [\1] 終了日時 [\1] タイトル(SUMMARY) [\1] 説明(DESCRIPTION) [\1] 場所(LOCATION) [\1] URL [\1] 状態(STATUS) [\1] 分類(CATEGORIES) [\1] 繰り返し規則(RRULEの原文) [\1] 終日フラグ [\1] 発生日
  予定の数だけReference1,2,3～と続く。
  開始日時・終了日時・発生日は、RSSと同じカンマ区切りの「年,月,日,時,分,秒」形式。終日予定は時・分・秒が空になり「2026,9,10,,,」のようになる。
  終了日時はその予定の最終日（DTENDの日付値は排他指定なので、1日戻した値が入る）。DTENDの代わりにDURATIONで長さを書いた予定は、開始日時に長さを足した値が入る（終日予定なら同様に1日戻す）。
  分類は複数ある場合カンマ区切り。分類名そのものに含まれるカンマと区切りのカンマは区別されない。
  終日フラグは終日予定なら1、時刻付きなら0。
  発生日は、--from・--to・--expandのいずれかを指定した場合のみ入る。--expandありなら展開した1回ぶんの発生日、--expandなしなら期間内で最初に発生する日。指定が無い場合は空。
  RRULEは原文のまま渡されるので、SSPの展開を使わず自前で解釈することもできる。
  タイトル・説明・場所・URL・分類・カレンダー名は、さくらスクリプトとして解釈されないようエスケープされている（\→\\、%→\%、改行とタブ→半角空白）。

対応: SSP 2.8.90

OnExecuteICalFailure¶

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

• Reference0～: 解析失敗時はReference4=parse。同じURLの取得がすでに進行中だった場合はReference4=downloading。他はOnExecuteHTTPFailureと同じ（Completeとは並びが違う点に注意）。

対応: SSP 2.8.90

OnExecuteICalProgress¶

\![execute,ical-get/ical-post]で--progress-notifyを指定した際に発生。解析前の通知なので、ReferenceはOnExecuteHTTPCompleteと同じ。

対応: SSP 2.8.90

OnExecuteICal_SSLInfo¶

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

--async・--syncでOnから始まるIDを指定した場合でも、イベント名は置き換わらず常に本イベントで通知される。

• Reference0～: OnExecuteHTTPSSLInfoと同じ

対応: SSP 2.8.90

OnExecuteRSSComplete¶

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

[2.8.92] どの項目がいくつ並ぶかはRSS絞り込みオプションで決まる。

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

対応: SSP 作者名・内容 2.4.10～

OnExecuteRSSFailure¶

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

• Reference0～: 解析失敗時はReference4=parse。同じURLの取得がすでに進行中だった場合はReference4=downloading [2.8.90]。他はOnExecuteHTTPFailureと同じ

対応: SSP

OnExecuteRSS_SSLInfo¶

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

--async・--syncでOnから始まるIDを指定した場合でも、イベント名は置き換わらず常に本イベントで通知される。

• Reference0～: OnExecuteHTTPSSLInfoと同じ

対応: SSP

OnExecuteScheduleComplete¶

\![execute,schedule-add]・\![execute,schedule-delete]で、ゴースト用の予定表への登録・削除が完了した際に発生。

--eventでOnから始まるIDを指定した場合は、そのIDがイベント名になる。

• Reference0: 操作の種類。add または delete
• Reference1: 対象の予定のUID。schedule-addでUIDを省略した場合は、SSPが割り当てたUIDが入る。

対応: SSP 2.8.91

OnExecuteScheduleFailure¶

\![execute,schedule-add/schedule-delete]が失敗した際に発生。

--eventでOnから始まるIDを指定した場合は、そのIDの後ろにFailureをつけたイベント名になる。

• Reference0: 操作の種類。add または delete
• Reference1: 失敗の理由
  notauthorized : SSTPなど外部から送られたスクリプトで登録・削除しようとした
  invalid : --summary・--startが無い、日時の書式が正しくない、UIDに使えない文字が含まれている、schedule-deleteでUIDが無い
  notfound : schedule-deleteで指定したUIDの予定が無い
  save : ファイルへの保存に失敗した（登録・削除自体は反映されている）
• Reference2: 指定されたUID（無ければ空）

対応: SSP 2.8.91

OnExecuteScheduleGetComplete¶

\![execute,schedule-get]で、ゴースト用の予定表を読み出した際に発生。

--eventでOnから始まるIDを指定した場合は、そのIDがイベント名になる。

• Reference0～: OnExecuteICalCompleteと同じ。
  対象はゴースト用の予定表だけで、ユーザーが登録した予定やスケジュールセンサの予定は含まれない。

対応: SSP 2.8.91

OnExecuteFileWatchChange¶

\![execute,filewatch]で監視しているファイルまたはディレクトリが変化した際に発生。

--asyncでOnから始まるIDを指定した場合は、そのIDがイベント名になる。

ファイルへの書き込みは短い間に何度も起きることがあるため、変化が止んでから--debounceで指定した時間（省略時は500ミリ秒）だけ待ち、まとめて1回発生する。それより長い間隔を空けて書き込まれた場合や、変化が止まないまま最初の変化から指定時間の3倍が経った場合は、1回の保存で複数回発生することがある。

• Reference0: --asyncで指定した文字列そのもの（無ければ空）
• Reference1: 指定したパスの文字列そのもの
• Reference2: 変化の種類
  ファイルの場合 : modified（更新）、created（作成）、deleted（削除）
  ディレクトリの場合 : changed（直下で作成・削除・名前変更・更新のいずれかがあった）、deleted（ディレクトリ自体が無くなった）
• Reference3: 監視しているファイルまたはディレクトリのフルパス

対応: SSP 2.8.91

OnExecuteFileWatchFailure¶

\![execute,filewatch]が失敗した際や、監視を続けられなくなった際に発生。この場合、その監視は解除される。

--asyncでOnから始まるIDを指定した場合は、そのIDの後ろにFailureをつけたイベント名になる。

• Reference0: --asyncで指定した文字列そのもの（無ければ空）
• Reference1: 指定したパスの文字列そのもの
• Reference2: 失敗の理由
  notauthorized : SSTPなど外部から送られたスクリプトで監視しようとした
  invalid : パスが指定されていない
  notfound : 監視先のディレクトリ（ファイルの場合はそのファイルを置くディレクトリ）が無い、監視を始められない、または監視中に無くなった
  limit : SSP全体で監視しているディレクトリの種類が上限（63）を超える

対応: SSP 2.8.91

OnExecuteWebSocketOpen¶

WebSocket接続確立時（HTTP 101 Upgrade成功後）に発生。初回接続のみ発火し、再接続成功時はOnExecuteWebSocketReconnectが発生する。
--asyncオプションで指定したeventIDが "On" で始まる場合はeventID+"Open" がイベント名となる。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1: 接続URL (ws:// または wss://)。
• Reference2: "200"（固定）。

対応: SSP 2.8.05

OnExecuteWebSocketReceive¶

WebSocket接続中にサーバーからデータフレームを受信するたびに発生。断片化フレームは自動的に再組み立てされてから発火する。Ping/Pong/Closeフレームでは発火しない。
--asyncオプションで指定したeventIDが "On" で始まる場合はeventIDそのままがイベント名となる。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1: 接続URL。
• Reference2: opcodeの種別。"1"=テキストフレーム (UTF-8)、"2"=バイナリフレーム。
• Reference3: 受信データ。テキストフレームの場合はUTF-8文字列そのまま(改行コードはバイト値1に変換)、バイナリフレームの場合はBase64エンコード文字列。

対応: SSP 2.8.05

OnExecuteWebSocketReconnect¶

エラー切断後の自動再接続が成功したときに発生。OnExecuteWebSocketOpenは発火せず、このイベントがOpenに相当する役割を担う。再接続後の受信は通常どおりOnExecuteWebSocketReceiveで通知される。
--asyncオプションで指定したeventIDが "On" で始まる場合はeventID+"Reconnect" がイベント名となる。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1: 接続URL。
• Reference2: "200"（固定）。

対応: SSP 2.8.05

OnExecuteWebSocketClose¶

WebSocket接続が最終的に切断されたときに発生。自動再接続を試みた場合はその後に発火する。Failure時は発火しない。
--asyncオプションで指定したeventIDが "On" で始まる場合はeventID+"Close" がイベント名となる。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1: 接続URL。
• Reference2: 切断要因コード。"1000"=正常切断（サーバーまたは\![close,websocket]による）、"userbreak"=\![cancel,websocket]またはゴースト終了による強制中断。

対応: SSP 2.8.05

OnExecuteWebSocketFailure¶

初回接続でHTTP 101 Upgradeに失敗したとき、または接続中にエラー切断が発生し自動再接続を5回試みてもすべて失敗したときに発生。
--asyncオプションで指定したeventIDが "On" で始まる場合はeventID+"Failure" がイベント名となる。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1: 接続URL。
• Reference2: エラー内容文字列。初回接続失敗時はSPHttpのエラーテキスト、自動再接続全失敗時は"reconnect failed"（固定）。

対応: SSP 2.8.05

OnExecuteWebSocket_SSLInfo¶

wss://接続時にSSL/TLS接続が確立したときに発生。初回接続時のみ発火し、Upgradeの成否にかかわらず発火する。イベント名は常に固定で--asyncオプションによる変更は不可。

• Reference0: Sakura Scriptの--asyncオプションで指定されたイベント識別子。
• Reference1～: OnExecuteHTTPSSLInfoのReference1以降と同じ。

対応: SSP 2.8.05

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ヘッダを参照。

対応: SSP

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ヘッダを参照。

対応: SSP

OnNSLookupComplete¶

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

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

対応: SSP

OnNSLookupFailure¶

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

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

対応: SSP

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

OnRaisePluginFailure¶

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

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

対応: SSP

OnNotifyPluginFailure¶

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

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

対応: SSP

OnRaiseOtherFailure¶

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

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

対応: SSP

OnNotifyOtherFailure¶

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

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

対応: SSP

見切れ・重なりイベント¶

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）が通知される。

対応: SSP / Ninix

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）が通知される。

対応: SSP / Ninix

OnOffscreen¶

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

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

対応: SSP / Ninix

OnOtherOffscreen¶

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

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

対応: SSP / Ninix

OS状態イベント¶

OnNetworkHeavy¶

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

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

対応: Materia / SSP / CROW

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になる。

対応: SSP

OnScreenSaverStart¶

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

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

対応: SSP

OnScreenSaverEnd¶

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

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

対応: SSP

OnSessionLock¶

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

対応: SSP 2.5.50

OnSessionUnlock¶

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

対応: SSP 2.5.50

OnSessionDisconnect¶

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

対応: SSP 2.5.53

OnSessionReconnect¶

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

対応: SSP 2.5.53

OnCPULoadHigh¶

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

• Reference0: 現在の負荷率％

対応: SSP 2.5.56

OnCPULoadLow¶

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

• Reference0: 現在の負荷率％

対応: SSP 2.5.56

OnMemoryLoadHigh¶

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

• Reference0: 現在の使用量％

対応: SSP 2.5.56

OnMemoryLoadLow¶

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

• Reference0: 現在の使用量％

対応: SSP 2.5.56

OnDisplayChange¶

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

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

対応: SSP / CROW / Ninix

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)

対応: SSP 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
  ウインドウモードでは、コンテナのクライアント領域を1枚の画面とした1件だけになる(例： 0,0,1280,720,32,1,unknown,0)。実モニタの変更では発生せず、コンテナのサイズ変更やウインドウモードの切り替えで発生する。

対応: SSP 2.4.09/タスクバーは2.6.35

OnDisplayPowerStatus¶

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

• Reference0: 1 = ON / 0 = OFF

対応: SSP 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の基準が異なることがある。

対応: SSP

OnBatteryLow¶

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

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

対応: SSP

OnBatteryCritical¶

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

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

対応: SSP

OnBatteryChargingStart¶

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

• Reference0～: OnBatteryNotifyと同じ。

対応: SSP

OnBatteryChargingStop¶

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

• Reference0～: OnBatteryNotifyと同じ。

対応: SSP

OnDeviceArrival¶

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

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

対応: SSP

OnDeviceRemove¶

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

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

対応: SSP

OnTabletMode¶

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

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

対応: SSP 2.5.02

OnDarkTheme¶

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

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

対応: SSP 2.5.02

OnDesktopWallpaperChange¶

OS側でデスクトップの壁紙が変更された際に発生。[起動時NOTIFY/他GET]
利用者が個人用設定などで壁紙を変えた場合のほか、スライドショーやWindowsスポットライトによる自動的な差し替え、テーマの切り替えでも発生する。
スライドショーとスポットライトは最短1分間隔で自動的に切り替わるため、この2つがきっかけの場合は起動後であってもNOTIFY(喋れない)で通知される。
画像ファイルのDnDによって壁紙を変更した際のOnWallpaperChangeとは別のイベントで、SSP自身が壁紙を変更した場合(Reference1がself)には両方が発生する。両方に反応する場合は二重にならないよう注意。
ウインドウモードでは、ゴーストにとっての壁紙はコンテナの背景になる。OS側で壁紙が変更されて発生するのはコンテナの背景が「デスクトップ」の場合だけで、白・灰・黒・画像の場合は発生しない。代わりに、コンテナの背景が切り替わった時(コンテナのメニュー、\![set,wallpaper]、\![restore,wallpaper])と、ウインドウモードの切り替えによってゴーストから見える背景が変わった時に発生する。同じ背景を選び直しただけでは発生しない。
perghost(ゴースト1体につき1枚のコンテナ)の場合は、自分が載っているコンテナの背景が変わった時だけ発生する。

• Reference0: init (起動時通知) か update (起動後の変更)
• Reference1: 変更のきっかけ。
  user：利用者が変更した
  slideshow：スライドショーの自動送り
  spotlight：Windowsスポットライトの自動更新
  theme：テーマの切り替えに伴うもの
  self：SSP自身が変更した(画像のDnD・プロファイルからの復元)
  unknown：変更されたことは確かだが、きっかけが判別できない
  ウインドウモードでは、コンテナのメニューやウインドウモードの切り替えによる変更はuser、\![set,wallpaper]・\![restore,wallpaper]による変更はselfになる。起動時通知(init)でコンテナの背景が「デスクトップ」以外の場合はunknown。
• Reference2: 現在の壁紙画像のフルパス。単色背景の場合や取得できなかった場合は空。
  Windowsの仕様上、利用者が選んだ元の画像ファイルではなく、OSが作成したキャッシュ(TranscodedWallpaperやスポットライトのキャッシュ)のパスになることがある。
  ウインドウモードでは、コンテナの背景が「デスクトップ」ならOS側の壁紙、画像ならその画像のフルパス、白・灰・黒や画像なしの色指定なら空。
• Reference3: 直前の壁紙画像のフルパス。Reference0がinitの場合は空。
• Reference4: 表示スタイル。center / tile / stretch / fit / fill / span のいずれか。
  ウインドウモードでコンテナの背景が画像の場合は stretch-x / stretch-y もあり得る。白・灰・黒の場合は center。
• Reference5: デスクトップの背景色。壁紙の余白に出る色。R,G,B の半角カンマ区切り。
  ウインドウモードでは、コンテナの背景が画像ならその地色(色の指定があればその色、無ければ画像から求めた色)、白・灰・黒ならその色。
• Reference6～: モニタごとの壁紙情報が以下のフォーマットでモニタの数だけ後ろに続く。[\1]はバイト値1。
  モニタ番号[\1]壁紙画像のフルパス[\1]表示スタイル
  モニタ番号はOnDisplayChangeExのReference1～の並び順と対応する(Reference1がモニタ番号0)。
  表示スタイルはOSがモニタごとに保持していないため、現状はすべて同じ値(Reference4と同一)になる。
  モニタごとの壁紙を扱えない環境(Windows 7以前)ではReference6以降は付かない。
  ウインドウモードでは、コンテナの背景の種類によらず、コンテナを1枚の画面とした1件(モニタ番号0)だけが付く。

対応: SSP 2.8.86

OnWindowModeChange¶

SSPのウインドウモードが切り替えられた際に発生。[起動時NOTIFY/他GET]
ウインドウモードは、ゴーストをデスクトップ上ではなくSSPが用意したウインドウ(コンテナ)の中に表示するモード。コンテナの内側がゴーストにとっての画面になる。
切り替えによってゴーストにとっての画面の大きさが変わるため、このイベントの後にOnDisplayChangeも発生する。
現在のモードはbaseware.windowmodeでも取得できる。

• Reference0: init (起動時通知) か update (起動後の切り替え)
• Reference1: 現在のモード。
  normal：通常モード(ゴーストをデスクトップ上に表示する)
  shared：ウインドウモード。全ゴーストで1枚のコンテナを共有する
  perghost：ウインドウモード。ゴースト1体につき1枚のコンテナを使う
• Reference2: 直前のモード。値の種類はReference1と同じ。Reference0がinitの場合は空。

対応: SSP 2.8.93

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桁。
  更新時刻：年,月,日,時,分,秒 半角カンマ区切り ローカル時刻

対応: SSP 2.5.02

OnRecycleBinEmpty¶

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

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

対応: SSP 2.6.04/Ref4は2.6.35

OnRecycleBinEmptyFromOther¶

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

対応: SSP 2.6.35

OnRecycleBinStatusUpdate¶

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

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

対応: SSP 2.6.04/Ref4は2.6.35

選択領域モードイベント¶

OnSelectModeBegin¶

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

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

対応: SSP

OnSelectModeCancel¶

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

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

対応: SSP

OnSelectModeComplete¶

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

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

対応: SSP

OnSelectModeMouseDown¶

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

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

対応: SSP

OnSelectModeMouseUp¶

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

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

対応: SSP

音声認識・合成イベント¶

OnSpeechSynthesisStatus¶

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

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

対応: SSP 2.4.01

OnVoiceRecognitionStatus¶

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

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

対応: SSP 2.4.01

OnVoiceRecognitionWord¶

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

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

対応: SSP 2.4

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

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

その他イベント¶

OnKeyPress¶

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

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

対応: Materia / SSP / CROW / Ninix

OnRecommendsiteChoice¶

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

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

対応: Materia / SSP / CROW / Ninix

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 。イベントが原因ではない場合欠番。

対応: Materia / SSP / CROW / Ninix

OnAITalk¶

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

対応: SSP

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。

対応: SSP / Ninix

OnEmbryoExist¶

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

対応: SSP

OnNekodorifExist¶

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

対応: SSP

OnSoundStop¶

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

• Reference0: 再生ファイル名。
• Reference1: 終了理由 end＝再生終了 close＝再生ウインドウを閉じた [SSP 2.6.65]

対応: SSP

OnSoundLoop¶

サウンドがループ再生中に、最後まで再生して次のループに入ろうとする際に発生。

• Reference0: 再生ファイル名。

対応: SSP 2.7.93

OnSoundSpectrum¶

--spectrum=を指定したサウンドの再生中に、一定間隔で発生。再生中の音のスペクトラム(チャンネルごとの全体の音量レベルと、低音から高音までの帯域ごとの音量レベル、およびそれぞれのピークホールド値)を通知する。スペクトラムアナライザなどの表示用。
解析するのは再生中の波形そのもので、--volumeや--balanceの設定を掛ける前の値になる。そのため音量を絞っても値は小さくならない。
一時停止中は発生しない。再生が停止・終了するとき、または--spectrum=0で通知を止めるときは、全てのレベルが0の通知を1回発生させる(停止・終了のときは、そのあとにOnSoundStopが発生する)。
MIDI・CDトラック・xWMAのwavのように、再生中の波形を取り出せないサウンドでは発生しない(再生自体は通常どおり行われる)。ただし--spectrum-bands=0のときは、波形を取り出せなくても発生する(Reference2・3は0になる)。
ADPCM(MS-ADPCM・IMA-ADPCM)のwavは、通知を始めたときに解析用として別に波形を展開する。展開後が64MBを超える長いファイル(44.1kHzステレオで約6分以上)では発生しない(--spectrum-bands=0のときを除く)。
[2.9.19] --spectrum-bands=0を指定すると、帯域ごとの解析を行わず、全体の音量レベルと再生位置(Reference6)だけを通知する。音量つきの経過時間通知として使える。

• Reference0: 再生ファイル名。
• Reference1: 帯域の数。--spectrum-bands=で指定した数(0・5・10・15・31のどれか、既定は10)。0は帯域なしで、Reference4・5は空になる。各帯域の周波数は帯域数ごとの固定の表で決まっており、ファイルの形式にかかわらず同じ。
• Reference2: [2.9.20] 全体の音量レベル(0～100)を、チャンネルごとにバイト値1(\1)区切りで並べたもの。モノラルなら1個、ステレオなら左・右の2個で、それ以上のチャンネルがある音はその分だけチャンネルの順に並ぶ(最大8個。9チャンネル目以降は含まれない)。並んだ個数がそのまま音のチャンネル数になる。チャンネルの順は、WAVE形式の標準の並び(前方左・前方右・中央・低音・後方左・後方右・側方左・側方右)に従う。
  そのため、2チャンネル以上の音なら、先頭の2個(1つめと2つめ)が左右の音量にあたり、5.1chなどでもそこだけを見ればステレオとほぼ同じように扱える(モノラルは1個だけなので、その値が左右共通の音量になる)。
  例：Reference2を\1で分けた配列は、ステレオなら[左, 右]の2個(例：[60, 55])、5.1chなら[前方左, 前方右, 中央, 低音, 後方左, 後方右]の6個(例：[60, 55, 70, 30, 20, 25])になる。どちらも先頭の2個が左右。
  波形を取り出せずに通知する場合(--spectrum-bands=0のとき)は、チャンネル数が分かっていればその数、分からなければ1個の0になる。
  2.9.19までは、全チャンネルをまとめた1個の値だった。
• Reference3: [2.9.20] 全体の音量レベル(Reference2)のピークホールド値(0～100)。Reference2と同じ並び・同じ個数。ホールド時間は--spectrum-hold=で指定する(既定は500ミリ秒)。
• Reference4: 帯域ごとの音量レベル(0～100)。低音の帯域から高音の帯域の順に、バイト値1(\1)区切りで並ぶ。個数はReference1と同じ(0なら空)。帯域は全チャンネルを平均した音から測る(チャンネルごとの帯域は通知しない)。
• Reference5: 帯域ごとのピークホールド値(0～100)。Reference4と同じ並び・同じ個数。ホールド時間はReference3と同じ。
• Reference6: [2.9.19] 再生位置(ミリ秒)。音量レベルを測った時点のメディア上の位置で、--seektime=と同じ尺度。動画なら動画の再生位置になり、ループ再生では繰り返しのたびに0へ戻る(OnSoundLoop)。
  再生・停止のときの全レベル0の通知では、最後に通知した位置になる。

対応: SSP 2.9.18

OnSoundError¶

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

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

対応: SSP

OnMusicPlayEx¶

Windows標準のメディアプレイヤーアプリなど、対応した音楽再生ソフトで再生中の曲情報をゴーストに通知する。
このイベントに反応しない場合はOnMusicPlayにフォールバックする。
ブラウザでの動画・音楽再生は全部OnVideoPlayEx扱いになるので注意。

• Reference0: 曲タイトル
• Reference1: アーティスト名
• Reference2以降: 拡張情報名[バイト値1]拡張情報の内容 OnMusicPlayExの拡張情報リスト

対応: SSP 2.7.55

OnVideoPlayEx¶

Windows標準のメディアプレイヤーアプリなど、対応した音楽再生ソフトで再生中の動画情報をゴーストに通知する。

• Reference0～: OnMusicPlayExと同じ

対応: SSP 2.7.59

OnMusicPlay¶

Windows標準のメディアプレイヤーアプリなど、対応した音楽再生ソフトで再生中の曲情報をゴーストに通知する。

• Reference0: 曲タイトル
• Reference1: アーティスト名

対応: SSP 2.7.55

OnMusicPlayExの拡張情報リスト¶

• album: アルバム名 iSing4U/SSP2.5.75
• albumartist: アルバム制作者名 SSP2.5.75
• subtitle: サブタイトル SSP2.5.75
• source: 再生アプリ情報 SSP2.5.75
• duration: 曲の長さ(秒) iSing4U/SSP2.5.75
• genre: ジャンル iSing4U/SSP2.5.75
• artwork: アルバムアートワークの画像ファイルパス SSP 2.5.75
• rating: レート（マイレート） iSing4U
• playcount: 再生回数 iSing4U
• composer: 作曲者名 iSing4U
• uniqueid: 曲のユニークID iSing4U
• playlist: プレイリスト情報 iSing4U

OnTextDrop¶

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

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

対応: SSP

OnShellScaling¶

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

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

対応: SSP

OnBalloonScaling¶

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

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

対応: SSP 2.5

OnLanguageChange¶

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

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

対応: SSP 2.5

OnResetWindowPos¶

シェル位置初期化メニューが選ばれた際に通知される。
反応しない場合はデフォルトのシェル位置初期化処理 ( \![execute,resetwindowpos] ) が行われる。

対応: SSP 2.7 RC1

OnExtractArchiveComplete¶

アーカイブの解凍が正常に完了した際に発生する。

\![execute,extractarchive]にて--eventオプションで指定した識別子がOnではじまる場合、その識別子のイベントが発生する。それ以外の場合は本イベントが発生する。

• Reference0: Sakura Scriptの--eventオプションで指定されたイベント識別子。
• Reference1: 解凍されたファイル数。
• Reference2: 圧縮サイズ（バイト）。
• Reference3: 非圧縮サイズ（バイト）。

対応: SSP 2.7.23

OnExtractArchiveFailure¶

アーカイブの解凍が失敗した際に発生する。

\![execute,extractarchive]にて--eventオプションで指定した識別子がOnではじまる場合、その識別子に「Failure」を付加したイベントが発生する。それ以外の場合は本イベントが発生する。

• Reference0: Sakura Scriptの--eventオプションで指定されたイベント識別子。
• Reference1: エラー内容。※エラーコード一覧を参照。

対応: SSP 2.7.23

OnCompressArchiveComplete¶

アーカイブの圧縮が正常に完了した際に発生する。

\![execute,compressarchive]にて--eventオプションで指定した識別子がOnではじまる場合、その識別子のイベントが発生する。それ以外の場合は本イベントが発生する。

• Reference0: Sakura Scriptの--eventオプションで指定されたイベント識別子。
• Reference1: 圧縮されたファイル数。
• Reference2: 圧縮サイズ（バイト）。
• Reference3: 非圧縮サイズ（バイト）。

対応: SSP 2.7.23

OnCompressArchiveFailure¶

アーカイブの圧縮が失敗した際に発生する。

\![execute,compressarchive]にて--eventオプションで指定した識別子がOnではじまる場合、その識別子に「Failure」を付加したイベントが発生する。それ以外の場合は本イベントが発生する。

• Reference0: Sakura Scriptの--eventオプションで指定されたイベント識別子。
• Reference1: エラー内容。※エラーコード一覧を参照。

対応: SSP 2.7.23

OnInternalSaoriComplete¶

SAORI over DirectSSTPで内蔵モジュールを--async=識別子付きで呼び出したとき、処理が成功すると送られる。識別子がOnで始まる場合は、このイベントの代わりに識別子と同じ名前のイベントが送られる。
詳しくは非同期の呼び出しを参照。

• Reference0: --async=で指定した識別子。
• Reference1: 結果。(同期の呼び出しの Result)
• Reference2: モジュール名。(internal_crypto など)
• Reference3: 関数名。(Digest など)
• Reference4以降: 複数の値を返す関数の値。(同期の呼び出しの Value0 以降)

対応: SSP 2.9.13

OnInternalSaoriFailure¶

SAORI over DirectSSTPで内蔵モジュールを--async=識別子付きで呼び出したとき、処理が失敗すると送られる。識別子がOnで始まる場合は、このイベントの代わりに「識別子＋Failure」という名前のイベントが送られる。
詳しくは非同期の呼び出しを参照。

• Reference0: --async=で指定した識別子。
• Reference1: 失敗理由。(同期の呼び出しの ErrorDescription と同じ。invalid encoding など)
• Reference2: モジュール名。
• Reference3: 関数名。

対応: SSP 2.9.13

property.get¶

activeghostlist(ゴースト名/パス/ID).extによる拡張プロパティ取得時に発生。
取得できたプロパティの値を返す。

• Reference0: 拡張プロパティの名前。

対応: SSP 2.7.85

property.set¶

activeghostlist(ゴースト名/パス/ID).extによる拡張プロパティ設定時に発生。
成功時204、失敗時適切なステータスコードを返す。

• Reference0: 拡張プロパティの名前。
• Reference1: 設定すべき値。

対応: SSP 2.7.85

アーカイブ操作エラーコード¶

• none: エラーなし（正常）
• invalid parameter: 無効なパラメータ
• file not found: ファイルが見つからない
• directory not found: ディレクトリが見つからない
• create directory failed: ディレクトリの作成に失敗
• open failed: ファイルを開くのに失敗
• getfileinfo failed: ファイル情報の取得に失敗
• goto failed: ファイル位置の移動に失敗
• corrupted: アーカイブが破損している
• crc: CRCエラー（データの整合性エラー）
• stream: ストリームエラー
• unknown method: 不明な圧縮方式
• password required: パスワードが必要
• password mismatch: パスワードが一致しない
• close failed: ファイルのクローズに失敗

Notifyイベント¶

basewareversion¶

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

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

対応: SSP / CROW / Ninix

hwnd¶

hwndを通知。[NOTIFY]

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

対応: Materia / SSP

uniqueid¶

unique IDを通知。[NOTIFY]

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

対応: Materia / SSP

capability¶

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

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

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

対応: SSP

ownerghostname¶

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

• Reference0: 現在のゴースト名。

対応: Materia / SSP / CROW

otherghostname¶

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

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

対応: Materia / SSP / CROW

installedsakuraname¶

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

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

対応: SSP 2.6.47

installedkeroname¶

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

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

対応: SSP 2.6.47

installedghostname¶

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

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

対応: Materia / SSP / CROW / Ninix

installedshellname¶

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

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

対応: SSP / CROW / Ninix

installedballoonname¶

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

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

対応: SSP / CROW / Ninix

installedheadlinename¶

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

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

対応: SSP

installedcalendarskinname¶

インストールされているカレンダースキンを通知。[NOTIFY]

\![change,calendarskin,カレンダースキン名]で利用できる。

• Reference*: インストールされているカレンダースキン名。

対応: SSP 2.8.93

installedcalendarpluginname¶

インストールされているカレンダープラグイン(スケジュールセンサ)を通知。[NOTIFY]

\![execute,calendarplugin,カレンダープラグイン名]で利用できる。

• Reference*: インストールされているカレンダープラグイン名。

対応: SSP 2.8.93

installedplugin¶

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

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

対応: SSP

configuredbiffname¶

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

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

対応: SSP 2.5

ghostpathlist¶

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

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

対応: SSP

balloonpathlist¶

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

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

対応: SSP

headlinepathlist¶

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

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

対応: SSP

pluginpathlist¶

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

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

対応: SSP

calendarskinpathlist¶

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

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

対応: SSP

calendarpluginpathlist¶

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

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

対応: SSP

rateofusegraph¶

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

• Reference*: バイト値1区切りにされた以下の情報。

• 1番目: ゴースト名。
• 2番目: sakura名。
• 3番目: kero名。
• 4番目: 起動回数。
• 5番目: 起動時間。(分)
• 6番目: 起動時間割合。(％)
• 7番目: 状態。
  boot(起動中)
  install(インストールされている)
  vanish(アンインストールした情報が残ってる)
  のいずれか。
• 8番目: 起動回数。(週報、今日から7日前までの集計) [以下SSP 2.8.54～]
• 9番目: 起動時間。(週報、分)
• 10番目: 起動時間割合。(週報、％)
• 11番目: 起動回数。(月報、今日から30日前までの集計)
• 12番目: 起動時間。(月報、分)
• 13番目: 起動時間割合。(月報、％)

対応: SSP

enable_log¶

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

• Reference0: ONなら1、OFFなら0

対応: SSP

enable_debug¶

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

• Reference0: ONなら1、OFFなら0

対応: SSP

OnNotifySelfInfo¶

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

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

対応: SSP / CROW

OnNotifyBalloonInfo¶

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

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

対応: SSP

OnNotifyShellInfo¶

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

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

対応: SSP

OnNotifyDressupInfo¶

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

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

対応: SSP

OnNotifyUserInfo¶

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

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

対応: SSP

OnNotifyHolidayInfo¶

今日の祝日名を通知。起動時、OnNotifyUserInfoの直後に送られる。[NOTIFY]
SSPの言語フォルダにある祝日表(holidays.txt、地域設定の国別の表があればholidays-XX.txt)から今日の祝日名が取れたときだけ送られ、祝日でない日や、名前の載っていない祝日表では送られない。
「今日」はSSPの「現在時刻の仮想的変更」(タイムマシン)の影響を受ける。

• Reference0: 祝日名。(元日、Christmas Day など。振替休日は「振替休日」や「Christmas Day (substitute day)」のようになる)
• Reference1: 日付。(2026,01,01のようにカンマ区切りで)
• Reference2: 読み込んだ祝日表の国コード(ISO 3166。holidays-GB.txtならGB)。国別でない既定の表(holidays.txt)なら空。

対応: SSP 2.9.11

OnNotifyOSInfo¶

OS情報を通知。[NOTIFY]

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

対応: SSP

OnNotifyFontInfo¶

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

• Reference*: フォント名。

対応: SSP

OnNotifyInternationalInfo¶

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

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

対応: SSP