SHIORI Eventリスト(外部)

以下には、ベースウェア外部のアプリケーションがSSTPによって発信するものや、ゴーストやプラグインが他のゴーストに対して発行するものなど、発行者が外部にあるイベントおよび、それらのイベントの受信者が返却するイベントが含まれます。

そうしたイベントの発行者に対してこのページは非公式なドキュメントに過ぎず、記載後のそれぞれの更新などで、情報が不正確になっている場合があります。詳しくはそれぞれ公式の説明をあたるようにしてください。

未記載のイベントをご存知の方は是非ご報告ください。記載させていただきます。

[NOTIFY]の表示があるイベントは、必ずNOTIFYコマンドで通知されます。
NOTIFYコマンドで通知されたイベントにスクリプトを返却しても一切無視されます。

特に表示がないイベントは、状況によってNOTIFY、GETのいずれでも通知される可能性があります。

関連するさくらスクリプト

プラグイン「バーチャルビールかけ(BeerShower)」

OnBeerShower

プラグインが実行された際に発生。

プラグイン「バーチャル道頓堀(TOMBORI)」

OnDive

プラグインが実行された際に発生。

Reference0
飛び込む先(道頓堀)

プラグイン「実体化(HitThunder)」

OnHitThunder

プラグインが実行された際に発生。

プラグイン「スタンプ帳」

OnStampInfo

スタンプに関する情報を通知するイベント。
ゴースト起動時、プラグインのロード・アンロードおよびOnStampInfoCallを送信した任意のタイミングで発生。

Reference0
スタンプ総数。
Reference1
当該ゴーストのスタンプが存在するか否か。あれば1、なければ0。
複数ゴースト起動していると信用性が薄くなるので、確実に知りたい場合はOnStampInfoCallによって当イベントを能動的に発生させる事が推奨される。
Reference2
プラグインのパス。
Reference3
全スタンプ情報。ゴースト名・スタンプ画像ファイル名・スタンプのタイトル・スタンプのコメント・スタンプを押した時刻がバイト値1区切りで、それがスタンプの数だけ各セットバイト値2区切りで入っている。
Reference4
このプラグインが動いていれば1、さもなくば0。
OnStampAdd

スタンプを押すためにraisepluginでスタンプ帳へ送信するイベント。

Reference0
スタンプの画像ファイルのパス。
Reference1
スタンプのタイトル。
さくらスクリプトを含まない文字列(除去される)を指定。
省略可。
Reference2
スタンプのコメント。
さくらスクリプトを含まない文字列(除去される)を指定。
<br>(<BR>、<br>、<BR>)で改行可能。
省略可。
OnStampInfoCall

OnStampInfoをゴースト側から任意のタイミングで発生させたい場合に、raisepluginでスタンプ帳へ送信するイベント。

プラグイン「芋スコープ」

OnPotatoReturn

フォルダ指定が正常で、セーブファイルが無事に見つかった場合に発生。

Reference0
要求した変数名をカンマ区切りで繋いだもの(<変数1>,<変数2>...)
Reference*
1以降、各変数の値
OnPotatoFileNotFound

フォルダ指定は正常だがセーブファイルが見つからなかった場合に発生。

Reference0
要求した変数名をカンマ区切りで繋いだもの(<変数1>,<変数2>...)
OnPotatoError

フォルダ指定が間違っている、又は動作対象外のSHIORIだった場合に発生。

プラグイン「CrystalDiskInfo Event PLUGIN」

OnCrystalDiskInfoEvent

ゴースト起動時に情報がある場合/情報が更新されたに発生。

Reference0
ディスク群全体のステータス(=最も悪いものの情報)と、更新日付。
カンマ区切りで、「(Good|Caution|Bad|Unknown),YYYY,NN,DD,HH,MM,SS」のように入る。
Reference*
ディスク個別ステータス。
カンマ区切りで、マシン名,存在するディスク,全体のステータス,容量,摂氏温度,温度警告
OnCrystalDiskInfoClear

今まで情報があったのに消えてしまった場合に発生。
CrystalDiskInfoが終了した場合など。

SAORI「httpc.dll」

OnHttpcNotify

httpc.dllが提供する機能の非同期実行オプションでの実行後、同dllからDirectSSTPで送信される戻り値通知イベント。

Reference0
呼び出し時に引数1で渡した識別子。
Reference1
空文字列
Reference*
実行した機能の戻り値。

外部アプリ汎用イベント

OnApplicationBoot

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

Reference0
アプリケーション名。
Reference1
アプリケーションの情報。
  • Materia
  • SSP
  • CROW
OnApplicationClose

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

Reference0
アプリケーション名。
Reference1
アプリケーションの情報。
  • Materia
  • SSP
  • CROW
OnApplicationExist

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

Reference0
アプリケーション名。
Reference1
アプリケーションの情報。
  • Materia
  • SSP
  • CROW
OnApplicationVersion

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

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

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

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

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

Reference0
アプリケーション名。
Reference1
ファイルのフルパス。
  • Materia
  • SSP
  • CROW
OnWebsiteUpdateNotify

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

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

アプリ「きのこ」

OnKinokoObjectCreate

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

Reference0
そのきのこスキンの名前。
Reference1
そのきのこスキンが主に対象とするゴースト名。複数ある場合カンマ区切り。
Reference2
そのきのこスキンのカテゴリ。複数ある場合カンマ区切り。
OnKinokoObjectDestroy

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

Reference0
そのきのこスキンの名前。
Reference1
そのきのこスキンが主に対象とするゴースト名。複数ある場合カンマ区切り。
Reference2
そのきのこスキンのカテゴリ。複数ある場合カンマ区切り。
OnKinokoObjectChanging

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

Reference0
切り替える直前のきのこスキンの名前。
Reference1
切り替える直前のきのこスキンが主に対象とするゴースト名。複数ある場合カンマ区切り。
Reference2
切り替える直前のきのこスキンのカテゴリ。複数ある場合カンマ区切り。
OnKinokoObjectChanged

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

Reference0
切り替えた後のきのこスキンの名前。
Reference1
切り替えた後のきのこスキンが主に対象とするゴースト名。複数ある場合カンマ区切り。
Reference2
切り替えた後のきのこスキンのカテゴリ。複数ある場合カンマ区切り。
OnKinokoObjectInstalled

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

Reference0
インストールされたきのこスキンの名前。
Reference1
インストールされたきのこスキンが主に対象とするゴースト名。複数ある場合カンマ区切り。
Reference2
インストールされたきのこスキンのカテゴリ。複数ある場合カンマ区切り。
OnBatteryLow

バッテリ残量が40%を切った際に発生。
SSPが通知するイベントに同名の物があるので注意。

Reference0
パーセンテージの数値。
OnBatteryCritical

バッテリ残量が20%を切った際に発生。
SSPが通知するイベントに同名の物があるので注意。

Reference0
パーセンテージの数値。
OnSysResourceLow

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

Reference0
パーセンテージの数値。
OnSysResourceCritical

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

Reference0
パーセンテージの数値。

アプリ「猫どりふ」

OnNekodorifObjectEmerge

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

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

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

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

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

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

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

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

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

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

アプリ「YunaSoft SexyFont Plug-in」

OnMusicPlay

音楽を再生した際に発生。

Reference0
曲タイトル。

アプリ「艦隊時計」

OnFleetClockComplete

設定した予定のタイマーが0になった際に発生。

Reference0
カテゴリ名。
Reference1
メモの内容。

アプリ「Elona omake_MMA」

OnElonaOmakeMMAEventNewGame

新規ゲーム開始時に発生。

Reference0
ゲームバージョン。
Reference1
ゲーム内年
Reference2
ゲーム内月
Reference3
ゲーム内日
Reference4
ゲーム内時
Reference5
ゲーム内分
Reference6
ゲーム内秒
Reference7
ゲーム内天候
Reference8
マップ名
Reference9
エリア名
Reference10
ワールド名
Reference11
階層
Reference12
所属ギルド
Reference*
Reference13-19は未使用。予約。
Reference20
各イベントの対象キャラクター番号(0:PC、1~15:ペット、16~55:冒険者、56~:その他のNPC)
Reference21
PC:名前
Reference22
PC:通り名
Reference23
PC:種族
Reference24
PC:職業
Reference25
PC:信仰
Reference26
PC:キャラ種別名(PCの種別は無いので「バグ」が代入される)
Reference27
PC:性別
Reference28
PC:年齢
Reference29
PC:身長
Reference30
PC:体重
Reference31
PC:レベル
Reference32
PC:現在HP
Reference33
PC:最大HP
Reference34
PC:現在MP
Reference35
PC:最大MP
Reference36
PC:所持金
Reference37
PC:名声
Reference38
PC:カルマ
Reference39
PC:DV
Reference40
PC:PV
Reference41
PC:筋力
Reference42
PC:耐久
Reference43
PC:器用
Reference44
PC:感覚
Reference45
PC:習得
Reference46
PC:意思
Reference47
PC:魔力
Reference48
PC:魅力
Reference49
PC:速度
Reference50
PC:運勢
Reference*
Reference51-80には、PC情報+30の番号に同じ並び順でイベントの対象キャラクターのデータが入る。
OnElonaOmakeMMAEventGameLoad

ゲーム開始時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventGameQuit

ゲーム終了時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventHourPlayed

ゲーム開始から現実の1時間毎に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference82
Reference経過時間
OnElonaOmakeMMAEventMapChanged

別マップに移動した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventLevelUp

PCまたはペットのレベルが上がった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSkillUp

PCまたはペットのスキルレベルが上がった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
スキル名。
Reference82
スキルレベル。
OnElonaOmakeMMAEventSkillDown

PCまたはペットのスキルレベルが下がった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
スキル名。
Reference82
スキルレベル。
OnElonaOmakeMMAEventBelieveGod

PCが改宗した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventJoinParty

ペットが仲間に加わった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSleep

睡眠に入った時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
寝具名。
Reference82
遺伝子を残す場合は1。
OnElonaOmakeMMAEventAwake

睡眠から目覚めた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
寝具名。
Reference82
遺伝子を残す場合は1。
OnElonaOmakeMMAEventInvestNPC

NPCの調査をした時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventRandomEvent

ランダムイベント発生時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
イベント名。
OnElonaOmakeMMAEventAddNewsTopic

冒険者のニューストピックが追加された時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
ニュースタイトル。
OnElonaOmakeMMAEventWish

願いの入力ダイアログが表示された時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventWished

願いが入力された時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
願った内容。
OnElonaOmakeMMAEventDead

PC死亡時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventPetDead

ペット死亡時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventLastword

遺言入力後に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
遺言。
OnElonaOmakeMMAEventTravelGuide

ノルンの冒険ガイド表示時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference82
data\exhelp.txtに書かれたヘルプ番号(%nの数字)
OnElonaOmakeMMAEventAbandonPet

ペットと縁を切った時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSaleSlave

ペットを奴隷商人に売った時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference82
売値。
OnElonaOmakeMMAEventSaleWife

ラファエロに嫁を売った時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference82
嫁が人外の場合は1。
OnElonaOmakeMMAEventMarriage

結婚時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventRefuseMarriage

求婚を断られた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventJoinGuild

ギルド加入時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventMutation

変異発生時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
変異メッセージ。
Reference82
悪性変異は-1、良性変異は1。
OnElonaOmakeMMAEventMutationCured

変異治療時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
変異メッセージ。
Reference82
悪性変異は-1、良性変異は1。
OnElonaOmakeMMAEventEtherDisease

エーテル病発生時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
変異メッセージ。
OnElonaOmakeMMAEventEtherDiseaseCured

エーテル病治療時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
変異メッセージ。
OnElonaOmakeMMAEventAdventGod

神の降臨時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
神の名前。
OnElonaOmakeMMAEventMewmewmew

うみみゃぁ発動時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventBuyNuke

核爆弾購入時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSetNuke

核爆弾設置時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventNukeExploded

核爆弾爆発時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventLomiasInTheParty

パーティに異形の森の使者『ロミアス』が参加してる時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventLomiasKilled

異形の森の使者『ロミアス』殺害時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventZeomeKilled

偽りの預言者『ゼーム』撃破時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventConqueredLesimas

レシマス征服時に発生。

Reference81
コメント。
Reference82
スコア。
OnElonaOmakeMMAEventAtonement

カルマが上昇して犯罪者でなくなった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventBecomeCriminal

カルマが減少して犯罪者になった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventPerformance

PCが演奏を開始した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
楽器アイテム名。
Reference82
演奏スキル。
OnElonaOmakeMMAEventClothOut

PCが気持ちいいことのために服を脱ぎ始めた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventStealItem

アイテムを盗み終わった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
盗んだアイテム名。
Reference82
NPCの所持品は1、マップ上アイテムは0。
OnElonaOmakeMMAEventTreasureDigging

宝の地図の場所を掘り当てた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventReadTreasureMap

宝の地図を読んだ時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSkillLearned

トレーナーからスキルを習得した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
スキル名。
OnElonaOmakeMMAEventWeatherChanged

天候が変わった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
変わる前の天候。
OnElonaOmakeMMAEventRagnarok

終末の日が訪れた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventSisterRagnarok

妹の日が訪れた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventPray

神に祈った時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventOffer

祭壇にアイテムを捧げた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
捧げたアイテム。
OnElonaOmakeMMAEventPrayFailed

神に祈ったが無関心だった時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventPrayEyth

無信仰で神に祈ってみた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventAreaChanged*

別エリアに移動した時に発生(*はエリア番号)。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
移動前にいたエリア名。
Reference82
移動前にいたエリア番号。
OnElonaOmakeMMAEventPayTax

PCが請求書を納税箱に入れた時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
支払った税金額。
OnElonaOmakeMMAEventCooking

PCがアイテムを調理した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
料理アイテム名。
Reference82
料理アイテム識別子。
Reference83
食物種別(1:肉、2:野菜、3:果物、4:お菓子、5:麺、6:魚、7:パン、8:卵)。
Reference84
料理ランク(1~9)。
OnElonaOmakeMMAEventAreaChanged

不特定の別エリアに移動した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
Reference81
移動前にいたエリア名。
Reference82
移動前にいたエリア番号。
OnElonaOmakeMMAEventHour

ゲーム内時間で1時間が経過した時に発生。

Reference*
Reference0~80まで、※共通リファレンス
OnElonaOmakeMMAEventGrandmapocalypse

グランマ黙示録が訪れた時に発生。

Reference*
Reference0~80まで、※共通リファレンス

麻雀通信イベント

OnMahjong

ゲームの各タイミングで通知。後述の※サーバコマンド参照。

Reference0
バージョン(UKAJONG/0.2)
Reference1
※サーバコマンド
Reference*
※サーバコマンドに応じた追加情報

UKAJONG/0.2におけるサーバコマンドとその追加情報

Reference1
gamestart(ゲーム開始時)
Reference2
席(東|南|西|北)
Reference3
プレイヤー名1
Reference4
プレイヤー名2
Reference5
プレイヤー名3
Reference6
プレイヤー名4
Reference1
gameend(ゲーム終了時)
Reference2
プレイヤー名1(バイト値1)点数
Reference3
プレイヤー名2(バイト値1)点数
Reference4
プレイヤー名3(バイト値1)点数
Reference5
プレイヤー名4(バイト値1)点数
Reference1
kyokustart(一局開始時)
Reference2
場風(東|南|西|北)
Reference3
親プレイヤー名
Reference4
本場(例 1)
Reference5
供託(例 1000)
Reference1
kyokuend(一局終了時)
Reference1
point(プレイヤーの点数を通知)
Reference2
プレイヤー名
Reference3
(=|+|-) =は点数の直指定、+-は増減を意味する
Reference4
点数
Reference1
haipai(配牌を配る時)
Reference2
プレイヤー名
Reference3
配牌(例 1m2m3m4p5p6p7s8s9s1z5z6z7z)
Reference1
dora(ドラ表示牌を送る時)
Reference2
牌(例 7z)
Reference1
open(手牌を公開する時 チー、ポン、カン等)
Reference2
プレイヤー名
Reference3
牌(例 1p2p3p)
Reference1
tsumo(ツモの時)
Reference2
プレイヤー名(自分)
Reference3
残り枚数
Reference4
牌(例 7z)
Reference1
sutehai(捨牌時)
Reference2
プレイヤー名(自分)
Reference3
牌(例 7z)
Reference1
say(発声時)
Reference2
プレイヤー名
Reference3
発声内容(chi|pon|kan|ron|tsumo|richi|tenpai|noten)
Reference1
agari(あがりの時)
Reference2
プレイヤー名
Reference3
Reference4
役,ハン数
Reference5
以降、Reference4同様
Reference1
ryukyoku(流局時)

以下のコマンドは返信が要求されている。要求元がGHOSTである場合は\![raiseother]等で返信しても良いが、要求元が外部アプリでSSTPによる通知であった場合はX-SSTP-PassThru-*ヘッダを用いて返信する必要がある。

\![raiseother]で返信する場合はOnMahjongResponseイベントを返す。SHIORIレスポンスヘッダを用いる場合はX-SSTP-PassThru-ID: OnMahjongResponseとする。

要求された対象に空文字を設定した場合、サーバーに対応を委任したものとみなす。

Reference1
hello(接続確認)
Reference1
sutehai?(捨牌を尋ねる)
Reference1
naku?(牌を鳴くか尋ねる。クライアントが可能なコマンドも送る)
Reference2
(ron|kan|pon|chi)
Reference3
以降、Reference2同様
Reference1
tenpai?(テンパイを宣言するか尋ねる)
OnMahjongResponse

OnMahjongイベントに対する返信。後述の※クライアントコマンド参照。

Reference0
バージョン(UKAJONG/0.2)
Reference1
※クライアントコマンド
Reference*
※クライアントコマンドに応じた追加情報

UKAJONG/0.2におけるクライアントコマンドとその追加情報

Reference1
hello(接続確認の返信)
Reference2
ump=(UMPバージョン)※厳密にUMPに準拠しているわけではないので特に見てないです。ump=?でOK
Reference3
name=(プレイヤー名)※sakura.nameを指定してください。
Reference1
sutehai?(捨牌の返信)
Reference2
(sutehai|ankan|kakan|richi|tsumo)
Reference3
選択された牌(tsumoの時は空でよい)
Reference1
naku?(牌を鳴くかの返信)
Reference2
(no|ron|kan|pon|chi)
Reference3
選択された牌1(chiの時に必要。2mに対し1mと3mまたは3mと4mのように指定する。そのうちの1枚目)
Reference4
選択された牌2(上記の2枚目)
Reference1
tenpai?(テンパイを宣言するかの返信)
Reference2
(yes|no)

Nostr通知イベント

OnNostr

Nostr/0.4における通知情報

Reference0
バージョン(Nostr/0.4)
Reference1
Nostrイベントのkind(数値)(1:note, 7:reaction, ...)
Reference2
Nostrイベントのcontent
Reference3
Nostrイベント署名者のkind0のname
Reference4
Nostrイベント署名者のkind0のdisplay_name
Reference5
Nostrイベント署名者のkind0のpicture
Reference6
NostrイベントのidのNIP-19エンコード(note1...またはnevent1...)
Reference7
Nostrイベント署名者の公開鍵のNIP-19エンコード(npub1...)

アプリ「さとりすと」

OnSatolistBoot

さとりすとが起動した時に発生。

OnSatolistGhostOpened

さとりすとがゴーストを読み込んだ時に発生。

Reference0
本体側キャラクタ名。
Reference1
ゴースト名。
OnSatolistSaved

さとりすとでゴーストを保存した時に発生。

Reference0
さとりすと終了時に保存をした場合はclosing、それ以外はedit
OnSatolistClosed

さとりすとが終了しようとした時に発生。

OnSatolistEventAdded

さとりすとでイベントを作成した時に発生。

Reference0
追加した項目名。
Reference1
追加先のファイル名。
Reference2
項目の種別。
Reference3
項目の発生条件。
OnSatolistDictionaryFolderChanged

「辞書」で使用する辞書フォルダを変更した時に発生。

GoogleChrome拡張「とうらぶえくすてんしょん」

OnTourabuConquestStart

遠征が開始されたときに発生。

Reference0
部隊の番号(1~4の整数)。
Reference1
遠征が終わるまでのおよその時間。単位は分。
OnTourabuConquestEnd

遠征が終了したとき発生。
仕様上実際の遠征終了より通知が数秒早いことがある。

Reference0
部隊の番号(1~4の整数)。
OnTourabuDutyStart

内番が開始されたとき発生。

OnTourabuDutyEnd

内番が終了したとき発生。

ゴースト間汎用イベント

OnRequestValues

他ゴーストが任意に送信した際に発生。
このイベントが送られた時、\[raiseother]でOnGetValuesイベントを送信する必要がある。

Reference0
送信したゴースト名。
Reference1
要求する変数名(key)。Reference2以降も同様に要求する変数がある限り続く。
  • SSP
OnGetValues

OnRequestValuesを受けた際に返すべきイベント。

Reference0
送信するゴースト名。
Reference1
key=value(keyはOnRequestValuesで受け取った変数名、valueはその値)。Reference2以降も同様に要求された変数がある限り続く。存在しない変数は返さない。OnRequestValuesで送られた順序に依存しない。
  • SSP

要求されるプロパティ名一覧

  • キャラクター名
  • 世代
  • 年齢層
  • 性別
  • 種族
  • 種族タイプ
  • 行動タイプ
  • プロフィール
  • カード画像パス
  • LIFE
  • STR
  • DEX
  • AGL
  • MIN
  • INT
  • SEN
  • NOB

ゴースト「ぬるぽ いんたーはい」

OnTalkRequest

ぬるぽ いんたーはいからトークを求められた際に発生。

ゴースト「The Hand」

OnHandActivate

The Handが他ゴーストを触りに行くまたは触り終わった際に発生。
触っている間、Sender:The Handでゴーストに(OnMouseMove|OnMouseDoubleClick|OnMouseWheel)イベントを送る。

Reference0
通常触り開始:NormalStart
通常触り終了:NormalEnd
必殺技開始:SuperStart
必殺技途中:SuperContinue
必殺技終了:SuperEnd
必殺技途中でホーミング発動:SuperHoming
Reference1
当たり判定名。
停止された場合はescaped。
必殺技の場合は1~4。
Reference2
相手に起きるイベント。
通常時:(OnMouseMove|OnMouseDoubleClick|OnMouseWheel)
必殺技中:触った回数
必殺技終了時:(MAX触り回数|escaped|nocollision|attacked|deleted)
Reference3
触りに行く際のスクリプト。
必殺技中は当たり判定名。
Reference4
シェル番号。

ゴースト「ごーすとじてん」「きゅーぴっど」

OnJitenBattle

ゴーストが行う模擬戦の毎ターン発生。

Reference0
送信したゴーストの\0名。
Reference1
攻撃側キャラクタ名。
Reference2
防御側キャラクタ名。
Reference3
戦闘結果。
開始時:模擬戦闘開始
行動時:(物理攻撃成功|物理攻撃失敗|物理攻撃回避|物理攻撃ミス|精神攻撃成功|精神攻撃失敗|精神攻撃回避|精神攻撃ミス)
Reference4
ダメージ。
Reference5
攻撃側キャラクタLIFE。
Reference6
防御側キャラクタLIFE。
Reference7
Normal
OnJitenTagBattle

ゴーストが行う模擬戦の毎ターン発生。

Reference0
送信したゴーストの\0名。
Reference1
攻撃側キャラクタ名。
Reference2
防御側キャラクタ名。
Reference3
戦闘結果。
開始時:模擬戦闘開始
行動時:(物理攻撃成功|物理攻撃失敗|物理攻撃回避|物理攻撃ミス|精神攻撃成功|精神攻撃失敗|精神攻撃回避|精神攻撃ミス)
Reference4
ダメージ。
Reference5
攻撃側キャラクタLIFE。
Reference6
防御側キャラクタLIFE。
Reference7
Tag

ゴースト「マギルトリエ」

OnMglBattle

マギルトリエが行うバーチャルバトルの結果ごとに発生。

Reference0
バージョン情報。
Reference2
送信元ゴースト。
Reference3
Mglイベント名。
Reference*
Mglイベントに対する内容。

ゴースト「カレー家族/沙紀と右近」

Send60stair_Call

カレー家族/沙紀と右近が同時起動しているゴーストをゲームに誘う際に発生。

Send60stair_Start

カレー家族/沙紀と右近がゲームを開始する際に発生。

  • SSP
Send60stair_YourTurnStart

カレー家族/沙紀と右近が行うゲーム中に自ゴーストの順番が来た際に発生。

Reference0
現在位置。
Reference1
マーキング位置。
Send60stair_Marking

カレー家族/沙紀と右近が行うゲーム中にマーキングした際に発生。

Reference0
マーキング位置。
Send60stair_DiceRoll

カレー家族/沙紀と右近が行うゲーム中にゴーストがサイコロを振り、ドボンでない際に発生。

Reference0
第一サイコロの出目。
Reference1
第二サイコロの出目。
Send60stair_Dobon

カレー家族/沙紀と右近が行うゲーム中に参加ゴーストのいずれかがドボンした際に発生。

Reference0
ドボンしたゴースト名。
Reference1
ドボンしたゴーストの現在位置。
Reference2
ドボンしたゴーストのマーキング位置。
Reference3
サイコロの出目。
Send60stair_YourTurnEnd

カレー家族/沙紀と右近が行うゲーム中に自ゴーストのターンが終了した際に発生。

Reference0
現在位置。
Reference1
マーキング位置。
Send60stair_Goal

カレー家族/沙紀と右近が行うゲーム中にいずれかのゴーストがゴールした際に発生。

Reference0
優勝したゴースト名。
Reference1
順位。
Send60stair_GameEnd

カレー家族/沙紀と右近が行うゲーム終了時、順位を表示した後に発生。

Send60stair_GetStatus

\[raiseother]で沙紀に送信するべきイベント。

Reference0
送信するゴーストの\0名。
Reference1
大胆さ。(0~60)

ゴースト「奏でる日常の音色」

OnKanadeTeaPartyInfomationRequest

お茶会開始前に、奏でる日常の音色から各ゴーストに通知されるイベント。
お茶会に参加するゴーストはこのイベントで直ちに、
\![raiseother,かなで,返信イベント名,ゴーストの対応するお茶会バージョン番号,ゴーストの本体側名,※お茶会バージョンへの対応情報]
のさくらスクリプトを実行する必要がある。
イベント内での、このスクリプトの実行以外のトークは非推奨。

Reference0
お茶会バージョン番号。
Reference1
返信イベントの送信先ゴースト本体側名(「かなで」に固定)。
Reference2
返信イベント名。
可変名の返信イベント

OnKanadeTeaPartyInfomationRequestを受信したゴーストが、奏でる日常の音色に対してraiseotherで通知するイベント。
イベント名はOnKanadeTeaPartyInfomationRequestのreference2で通知されている。

Reference0
ゴーストの対応するお茶会バージョン番号
Reference1
ゴーストの本体側名
Reference2
※お茶会バージョンへの対応情報
OnKanadeTeaParty

お茶会本体イベント。お茶会開始時に通知される。

Reference0
Reference1以降の組み合わせが実装されたお茶会のバージョン。
Reference1
お飲み物。
Reference2
お菓子
Reference*
Reference3以降は拡張情報。
OnKanadeTeaPartyEnd

お茶会終了イベント。奏でる日常の音色が、お茶会終了トークをした後に通知される。

Reference0
実行されたお茶会のバージョン。

※お茶会バージョンへの対応情報

対応
「奏でる日常の音色」のバージョンよりもゴーストのバージョンが高いまたは同じなため、この「奏でる日常の音色」が提供するお茶会イベントに完全に対応しています。
非対応
「奏でる日常の音色」のバージョンよりもゴーストのバージョンが低いため、ゴーストのバージョンよりも高いバージョンのお茶会イベントは処理することができません。
自動対応
「奏でる日常の音色」のバージョンよりもゴーストのバージョンが低いですが、ゴーストのバージョンよりも高いバージョンのお茶会イベントについて、単語を当てはめたりなどトークの内容を変化させて自動的に対応することができます。
固定対応
「奏でる日常の音色」が提供するお茶会の内容によって対応は変化しません。返答イベントのReference0はゴーストの制作者が確認しているお茶会バージョンです。この対応情報を返送したゴーストについては、お茶会の内容選択を考慮しません。

ゴースト「卓上誘技」

OnPoker

応答が必要なイベント。応答方法はraiseotherかnotifyotherを使う。

Reference0
プロトコルバージョン(POKER/1.0)
Reference1
サーバーゴースト名
Reference2
サーバーのイベント名

POKER/1.0におけるReference3以降の追加情報

Reference3
hello(参加申請をする。断られることもある。)
Reference3
action(Reference4以降に使用可能なアクションが入っている。)
Reference*
使用可能なアクションはbet,raise,allin,check,call,foldの6つの内のいくつか。
返答しない場合は自動的にfoldになるので注意。
bet/raiseする場合はレイズ額も送る必要がある。
OnPokerNotify

応答する必要の無いイベント。

Reference0
プロトコルバージョン(POKER/1.0)

POKER/1.0におけるReference1以降の追加情報

Reference1
game_start
Reference*
参加できたゴースト名
Reference1
round_start
Reference2
ブラインドの金額
Reference*
ゴースト名(バイト値1)スタック
Reference1
hand
Reference2
配られたカードの情報
Reference3
配られたカードの情報
スートは頭文字(S,H,C,D)の4つのいずれか、その後に数字が続く。
例:
Reference2: S1
Reference3: H12
この形式はFLIPでも一緒。
Reference1
flip
Reference2
現在のポット
Reference*
コミュニティカードの情報
プリフロップならReference3以降は存在しない
Reference1
blind_bet
Reference2
強制ベットの金額
SBやBBでの強制ベットをしたことが通知される。
Reference1
bet(アクションを行ったプレイヤーとベット周りの情報。)
Reference2
現在のベット総額
Reference3
現在のベット額
Reference4
アクションを行ったプレイヤーのゴースト名
Reference5
行ったアクション
Reference1
show_down(ショーダウン時のカード情報が送られてくる。)
Reference*
ゴースト名(バイト値1)1枚目のカード(バイト値1)2枚目のカード
Reference1
round_result(そのラウンドの勝者、および参加者の残りスタックの情報。)
Reference2
現在のラウンドの勝者がバイト値1区切りで入っている。
Reference*
ゴースト名(バイト値1)スタック
基本的に勝者は1人だが2人以上になるケースもある。
また、スタックが0になったのはここでしか通知しないため注意。
Reference1
game_result
Reference2
ゲームの勝者のゴースト名

ゴースト「フォーリナー」サプリメント「march of phantasma」

OnMopClear

マップクリア時に通知。

Reference0
クリア時のメンバーをバイト値1区切り(固有ユニットのみ)。
Reference1
クリアしたマップ名。

ゴースト開発用の対話型exe「ゴースト・ターミナル」



開始、終了

ShioriEcho.Begin

このゴーストが起動したときのghost_terminalイベント

Reference0
ターミナルバージョン
Reference1
端末のセッションタイプ
端末が `-s` で始まる場合は `SakuraScript` となる。
端末が `-c` で始まる場合は `Command` となる。
端末が共通で起動する場合は `Common` となる。
戻り値:X-SSTP-PassThru-Tittle(オプション)
端末のタイトルを設定する
戻り値:X-SSTP-PassThru-Icon(オプション)
端末のアイコンを設定する
戻り値:X-SSTP-PassThru-SmallIcon(オプション)
端末の小さいアイコンを設定する
設定されていない場合、`X-SSTP-PassThru-Icon`と一致する
戻り値:X-SSTP-PassThru-CustomLoginInfo(オプション)
設定された場合、端末はデフォルトのログイン情報を表示せず、この
この戻り値は、単純にエスケープされます:
- `\n` は改行に変換されます。
- `\t` はタブに変換されます。
- `\\` は `\` に変換される。
ShioriEcho.End

通常のプログラム終了時に発生するghost_terminalイベント

ShioriEcho.GetName

ghost_terminalが名前を取得したときのイベント

戻り値:X-SSTP-PassThru-GhostName(オプション)
ゴーストの名前を表示する
戻り値:X-SSTP-PassThru-UserName(オプション)
ユーザー名を表示する


コマンドを実行する

ShioriEcho

コマンドが入力された後のイベント

Reference0
端末で収集したコマンド
戻り値
もし`ShioriEcho.GetResult`を定義していない場合、ここで`ShioriEcho.GetResult`でサポートされている任意の返値を返すことができます。これらの返値は、ターミナルによって正しく処理されます(ただし、戻り値3は、`ShioriEcho.GetResult`を定義せずに何も返さない場合、次のコマンド取得に入ります)。
`ShioriEcho.GetResult`を定義している場合、ここでの返値は無視されます(**ただし、sakura scriptは正常に実行される**)。
ShioriEcho.GetResult

バリューリザルトイベントのクエリ

返信可能ヘッダ 1:

戻り値:X-SSTP-PassThru-Result
コンテンツを表示し、次のコマンド取得に進む。
戻り値(オプション):X-SSTP-PassThru-Type
付加情報:値型

返信可能ヘッダ 2:

戻り値:X-SSTP-PassThru-Special
コンテンツを表示し、次のコマンド取得に進む。
この戻り値は、単純にエスケープされます:
- `\n` は改行に変換されます。
- `\t` はタブに変換されます。
- `\\` は `\` に変換される。

返信可能ヘッダ 3:エンプティ

1秒待ってShioriEcho.GetResultを再実行する。

その他

戻り値:X-SSTP-PassThru-State
この返り値は、上記の返り値に重ね合わせることができます
もし`End`であれば、端末は終了する。
`Continue`であれば、端末は何も表示せず、次のコマンドの取得に進みます。


その他

ShioriEcho.TabPress

コマンドは、タブでイベントを完了させます。

Reference0
端末で収集したコマンド。
Reference1
タブを押したときにカーソルがあったコマンドの最初の文字(開始値0)。
Reference2
ユーザーが最初に連続してタブを押した回数(開始値0)。
Reference3
この一連のタブ補完の中で、最初にタブを押したときにカーソルがあったコマンドの最初の文字(開始値0)。
戻り値(オプション):X-SSTP-PassThru-Command
コマンドをこの内容で置き換える。
戻り値(オプション):X-SSTP-PassThru-InsertIndex
カーソルをこの位置に移動させる(提供されない場合は変更しない)。
戻り値(オプション):X-SSTP-PassThru-OldInsertIndex
後続の `Reference3` をこの内容に更新し、この一連のタブコンプリートが終了するまで有効とする(提供されない場合は変更しない)。
ShioriEcho.CommandUpdate

コマンド更新時のイベント

Reference0
端末で収集したコマンド
戻り値(オプション):X-SSTP-PassThru-CommandForDisplay
表示されているコマンドをこの内容に置き換えます。
ゴーストはこのイベントを利用して、パスワード入力時のマスク、通常読み上げ時のシンタックスハイライトなどの機能を実装することができます。
ShioriEcho.CommandPrompt

コマンドプロンプトが更新されたときのイベント

戻り値(オプション):X-SSTP-PassThru-Prompt
表示されているコマンドプロンプトをこの内容で置き換える
ゴーストはこのイベントでコマンドプロンプトを動的に変更することができます。
ShioriEcho.CommandComplete

ユーザーがコマンドラインの右端にある `→` を押したときのイベント

Reference0
端末が収集したコマンド
Reference1
カーソルがある位置で `→` を押したときのコマンドの最初の文字(開始値は0)。
戻り値(オプション):X-SSTP-PassThru-Command
コマンドをこの内容で置き換える。
ゴーストは、このイベントでコマンドをオートコンプリートすることができます。
戻り値(オプション):X-SSTP-PassThru-InsertIndex
カーソルをこの位置に移動させる(提供されない場合はそのままにする)。


コマンド履歴

ShioriEcho.CommandHistory.New

コマンドヒストリーの末尾に空のコマンドが追加されたときのイベント

ShioriEcho.CommandHistory.Update

コマンドヒストリーが更新されたときのイベント

Reference0
historyコマンドの内容
Reference1
履歴コマンドのインデックス(逆順、開始値0)
ShioriEcho.CommandHistory.Get

コマンドヒストリーを取得したときのイベント

Reference0
履歴コマンドのインデックス(逆順、開始値0)
戻り値(オプション):X-SSTP-PassThru-Command
コマンドをこの内容で置き換える
ShioriEcho.CommandHistory.ForwardIndex

ユーザが `↑` を押したときにインデックスが更新されるときのイベント

Reference0
履歴コマンドのインデックス(逆順、開始値0)
Reference1
`index`の値上がりが予想される量。
戻り値(オプション):X-SSTP-PassThru-Index
インデックスをこの値に更新する

プラグイン「Weather Station」

OnWeatherStation.Weather

Sends information about the current weather conditions to all open ghosts. This event occurs every hour, every time another ghost boots, and any time any ghost requests it with \![raiseplugin].

Reference0
Weather condition. ※See below for a list of possible weather conditions.
Reference1
Weather condition icon filename. To be used with weatherapi's weather icon pack.
Reference2
Weather condition code. ※See below for a list of possible weather condition codes.
Reference3
If it is daytime or not. 1 if the sun is up, 0 if the sun is down.
Reference4
Temperature in Fahrenheit.
Reference5
Temperature in Celsius.
Reference6
"Feels like" temperature in Fahrenheit.
Reference7
"Feels like" temperature in Celsius.
Reference8
Humidity as a percentage.
Reference9
Wind speed in miles per hour.
Reference10
Wind speed in kilometers per hour.
Reference11
Wind direction as a 16 point compass. (e.g.: NNE for north/northeast.)
Reference12
Wind direction in degrees.
Reference13
Wind gust speed in miles per hour.
Reference14
Wind gust speed in kilometers per hour.
Reference15
Precipitation in inches.
Reference16
Precipitation in millimeters.
Reference17
Cloud cover as a percentage.
Reference18
"Will it rain today". 1 for yes, 0 for no. Same information as the "Will it rain today" in OnWeatherStation.Forecast.Day.
Reference19
Chance of rain today, as a percentage. Same information as the chance of rain in OnWeatherStation.Forecast.Day.
Reference20
"Will it snow today". 1 for yes, 0 for no. Same information as the "Will it snow today" in OnWeatherStation.Forecast.Day.
Reference21
Chance of snow today, as a percentage. Same information as the chance of snow in OnWeatherStation.Forecast.Day.
Reference22
Visibility in miles.
Reference23
Visibility in kilometers.
Reference24
Pressure in inches.
Reference25
Pressure in millibars.
Reference26
UV index.
Reference27
CO (Carbon Monoxide) in μg/m3 (Micrograms per cubic meter).
Reference28
O3 (Ozone) in μg/m3 (Micrograms per cubic meter).
Reference29
NO2 (Nitrogen Dioxide) in μg/m3 (Micrograms per cubic meter).
Reference30
SO2 (Sulfur Dioxide) in μg/m3 (Micrograms per cubic meter).
Reference31
PM2.5 (Particulate Matter smaller than 2.5 microns in diameter) in μg/m3 (Micrograms per cubic meter).
Reference32
PM10 (Particulate Matter smaller than 10 microns in diameter) in μg/m3 (Micrograms per cubic meter).
Reference33
US EPA index. 1 means Good, 2 means Moderate, 3 means Unhealthy for sensitive group, 4 means Unhealthy, 5 means Very unhealthy, 6 means Hazardous.
Reference34
UK Defra Index. ※See below for details.
Reference35
The user's choice of units (Imperial or Metric).
Reference36
The time the plugin last updated the weather data, in seconds since EPOCH (1970/1/1 00:00:00).
Reference37
The current version number of the plugin.
Reference38
The user's location name. Only available if the user has chosen to share their location data.
Reference39
The url for the user's location, to be used with the API. Only available if the user has chosen to share their location data.
Reference40
The user's latitude. Only available if the user has chosen to share their location data.
Reference41
The user's longitude. Only available if the user has chosen to share their location data.
OnWeatherStation.Astro

Sends information about the sun and moon to all open ghosts. Must be called with \![raiseplugin]. An additional argument can be sent to specify which day's data should be sent. 0 for today, 1 for tomorrow, 2 for the day after tomorrow. If no argument is given, it will default to today.

Reference0
The day the following information is for. 0 for today, 1 for tomorrow, 2 for the day after tomorrow.
Reference1
Sunrise time, given as 12 hour time with the format ##:## *M
Reference2
Sunset time, given as 12 hour time with the format ##:## *M
Reference3
Moonrise time, given as 12 hour time with the format ##:## *M
Reference4
Moonset time, given as 12 hour time with the format ##:## *M
Reference5
Sunrise time, given as 24 hour time with the format ##:##
Reference6
Sunset time, given as 24 hour time with the format ##:##
Reference7
Moonrise time, given as 24 hour time with the format ##:##
Reference8
Moonset time, given as 24 hour time with the format ##:##
Reference9
Moon phase as a string. Can be "New Moon", "Waxing Crescent". "First Quarter", "Waxing Gibbous", "Full Moon", "Waning Gibbous", "Last Quarter", or "Waning Crescent".
Reference10
Moon phase number. Numbers correspond to the following phases.
  • 0 - New Moon
  • 1 - Waxing Crescent
  • 2 - First Quarter
  • 3 - Waxing Gibbous
  • 4 - Full Moon
  • 5 - Waning Gibbous
  • 6 - Last Quarter
  • 7 - Waning Crescent
Reference11
Moon illumination as a percentage.
OnWeatherStation.Alerts

Sends information about weather alerts to all open ghosts. Must be called with \![raiseplugin]. Will return nothing if there are no alerts.

Reference*
An array containing information for a weather alert. Some elements may not be filled. Elements are separated by a 1 byte value.
  • [0] - Headline
  • [1] - Type of alert
  • [2] - Severity
  • [3] - Urgency
  • [4] - Areas covered
  • [5] - Category
  • [6] - Certainty
  • [7] - Event
  • [8] - Note
  • [9] - Effective time
  • [10] - Expires time
  • [11] - Description
  • [12] - Instructions
OnWeatherStation.Forecast.Day

Sends information about the overall forecast for a day to all open ghosts. Must be called with \![raiseplugin]. An additional argument can be sent to specify which day's data should be sent. 0 for today, 1 for tomorrow, 2 for the day after tomorrow. If no argument is given, it will default to today.

Reference0
The day the following information is for. 0 for today, 1 for tomorrow, 2 for the day after tomorrow.
Reference1
Maximum temperature for the day, in Fahrenheit.
Reference2
Maximum temperature for the day, in Celsius.
Reference3
Minimum temperature for the day, in Fahrenheit.
Reference4
Minimum temperature for the day, in Celsius.
Reference5
Average temperature for the day, in Fahrenheit.
Reference6
Average temperature for the day, in Celsius.
Reference7
Average humidity for the day, as a percentage.
Reference8
Maximum windspeed for the day, in mph.
Reference9
Maximum windspeed for the day, in kph.
Reference10
Total precipitation for the day, in inches.
Reference11
Total precipitation for the day, in millimeters.
Reference12
"Will it rain this day", 1 if yes, 0 if no.
Reference13
Chance that it will rain this day, as a percentage.
Reference14
"Will it snow this day", 1 if yes, 0 if no.
Reference15
Chance that it will snow this day, as a percentage.
Reference16
Average visiblity for the day, in miles.
Reference17
Average visiblity for the day, in kilometers.
OnWeatherStation.Forecast.Hourly

Sends information about the hour-by-hour forecast for a day to all open ghosts. Must be called with \![raiseplugin]. An additional argument can be sent to specify which day's data should be sent. 0 for today, 1 for tomorrow, 2 for the day after tomorrow. If no argument is given, it will default to today.

Reference0~23
A comma separated array containing forecast information. The number of the reference corresponds to the number of the hour the data is for, in 24 hour time (e.g.: reference0 is for 00:00/12AM, reference14 is for 14:00/2PM).
  • [0] - Date and time the information is for.
  • [1] - "Is it daytime". 1 if the sun is up, 0 if the sun is down.
  • [2] - Temperature in Fahrenheit.
  • [3] - Temperature in Celsius.
  • [4] - "Feels like" temperature in Fahrenheit.
  • [5] - "Feels like" temperature in Celsius.
  • [6] - Humidity as a percentage.
  • [7] - Wind speed in miles per hour.
  • [8] - Wind speed in kilometers per hour.
  • [9] - Wind direction as a 16 point compass (e.g.: NNW for north/northwest).
  • [10] - Wind direction in degrees.
  • [11] - Wind gusts in miles per hour.
  • [12] - Wind gusts in kilometers per hour.
  • [13] - Precipitation in inches.
  • [14] - Precipitation in millimeters.
  • [15] - Cloud cover as a percentage.
  • [16] - "Will it rain", 1 if yes, 0 if no.
  • [17] - Chance of rain as a percentage.
  • [18] - "Will it snow", 1 if yes, 0 if no.
  • [19] - Chance of snow as a percentage.
  • [20] - Visibility in miles.
  • [21] - Visibility in kilometers.
  • [22] - Wind chill in Fahrenheit.
  • [23] - Wind chill in Celsius.
  • [24] - Heat index in Fahrenheit.
  • [25] - Heat index in Celsius.
  • [26] - Dew point in Fahrenheit.
  • [27] - Dew point in Celsius.
  • [28] - Pressure in inches.
  • [29] - Pressure in millibars.
  • [30] - UV index.
Reference24
The day the preceding information is for. 0 for today, 1 for tomorrow, 2 for the day after tomorrow.
OnWeatherStation.Error

Sends error information to all open ghosts. This event is sent in place of the previous events if there is an error of any kind.

Reference0
The error message. ※See below for possible error messages.
Reference1
A more descriptive error message, provided by weatherapi.com. These error messages do not match the online documentation for weatherapi and should not be used for identifying errors.
Reference2
The error code, as listed on weatherapi.com's documentation.
Reference3
The time the plugin last attempted to update the weather data, in seconds since EPOCH (1970/1/1 00:00:00).
Reference4
The current version number of the plugin.
Reference5
1 if there is a plugin update available, 0 otherwise.

Weather Condition & Code List

A list of conditions can be downloaded from weatherapi's documentation page. This list is also available in other languages, but information from the plugin will always be sent in english.

1000
Sunny (If the sun is down, it will be "Clear" instead.)
1003
Partly cloudy
1006
Cloudy
1009
Overcast
1030
Mist
1063
Patchy rain possible
1066
Patchy snow possible
1069
Patchy sleet possible
1072
Patchy freezing drizzle possible
1087
Thundery outbreaks possible
1114
Blowing snow
1117
Blizzard
1135
Fog
1147
Freezing fog
1150
Patchy light drizzle
1153
Light drizzle
1168
Freezing drizzle
1171
Heavy freezing drizzle
1180
Patchy light rain
1183
Light rain
1186
Moderate rain at times
1189
Moderate rain
1192
Heavy rain at times
1195
Heavy rain
1198
Light freezing rain
1201
Moderate or heavy freezing rain
1204
Light sleet
1207
Moderate or heavy sleet
1210
Patchy light snow
1213
Light snow
1216
Patchy moderate snow
1219
Moderate snow
1222
Patchy heavy snow
1225
Heavy snow
1237
Ice pellets
1240
Light rain shower
1243
Moderate or heavy rain shower
1246
Torrential rain shower
1249
Light sleet showers
1252
Moderate or heavy sleet showers
1255
Light snow showers
1258
Moderate or heavy snow showers
1261
Light showers of ice pellets
1264
Moderate or heavy showers of ice pellets
1273
Patchy light rain with thunder
1276
Moderate or heavy rain with thunder
1279
Patchy light snow with thunder
1282
Moderate or heavy snow with thunder

UK Defra Index reference

Index 1 2 3 4 5 6 7 8 9 10
Band Low Low Low Moderate Moderate Moderate High High High Very High
µgm-3 0-11 12-23 24-35 36-41 42-47 48-53 54-58 59-64 65-70 71 or more

Reason for Error

no_location
The user has not added their location, or has removed it.
location_invalid
The user's location is invalid and data cannot be gathered.
api_quota_exceeded
The 1 million free API calls per month has been exceeded.
api_key_disabled
The API key has been disabled by the plugin developer. Please check if a plugin update is available to provide a new key.
api_internal_error
The API responded with an internal error.
no_api_response
The API did not respond, or the SAORI used by the plugin failed to work.
other
Any other error sent by the API. reference1 will have the error message provided by the API.

ゴースト「Needle」

OnNeedlePoke

Occurs when Needle "pokes" another ghost (by overlapping them). If Needle is overlapping multiple scopes simultaneously, the event will be sent once for each scope.

Reference0
The ID of the scope that was poked. 0 for the main character, 1 for the side character, 2 and onwards for additional characters.
Reference1
The name of the shell Needle is currently using.

UKADOC

OnUkadocScriptExample

UkadocのSakuraScript Listにあるサンプルスクリプトを実行した際に発生。
このイベントを実装する場合は、危険なSakuraScriptタグを自分でエスケープする必要があることに注意。

Reference0
実行するスクリプト。