SHIORI Event List (External)

Translated Document

Translator Note

The contents of this page are especially difficult to translate, and many of the translations are not accurate. If you have knowledge of the external plugins/programs/ghosts listed here and can provide a better translation, please do.
Some of the names on this page have been translated, if they had an English/romanized name listed, or such a name is commonly known for the item in question.
All translated entries have their original name listed in parenthesis, unless the original name was only listed in English.
Ghost names have not been translated at all.

The following includes events whose issuers are external—such as those originating from applications outside the baseware via SSTP, or those issued by ghosts or plugins to other ghosts—as well as events returned by the recipients of those events.

This page is only an unofficial document for the publishers of such events, and the information may be inaccurate due to subsequent updates. Please refer to the official description of each event for details.

If you know of an event that has not been listed, please report it to us. We will be happy to list them.

Events marked with [NOTIFY] are always notified with the NOTIFY command.
Any scripts returned to events notified with the NOTIFY command will be ignored.

Events not specifically indicated may be notified as either NOTIFY or GET, depending on the circumstances.

Related SakuraScripts

Plugin "Virtual Beer Shower" (バーチャルビールかけ)

OnBeerShower

Occurs when the plugin is executed.

Plugin "Virtual Dotonbori (TOMBORI)" (バーチャル道頓堀)

OnDive

Occurs when the plugin is executed.

Reference0
Where to dive in (Dotonbori)

Plugin "Materialize (HitThunder)" (実体化)

OnHitThunder

Occurs when the plugin is executed.

Plugin "Stamp Book" (スタンプ帳)

OnStampInfo

An event that notifies information about the stamp.
Occurs at ghost startup, plugin loading/unloading, and any time OnStampInfoCall is sent.

Reference0
Total number of stamps.
Reference1
Whether or not the stamp of the ghost in question exists. 1 if it exists, 0 otherwise.
Multiple ghosts running simultaneously make the event less reliable, so it is recommended that this event be actively triggered by OnStampInfoCall if you want to know for sure.
Reference2
Path of the plugin.
Reference3
All stamp information. Ghost name, stamp image file name, stamp title, stamp comment, and time stamped are separated by a byte 1 value, followed by the number of stamps in each set separated by two byte 1 values.
Reference4
1 if the plugin is running, 0 otherwise.
OnStampAdd

Event to be sent to the stamp book via raiseplugin, for stamping.

Reference0
Stamp image file path.
Reference1
Stamp title.
Specify a string that does not contain SakuraScript (it will be removed).
Optional.
Reference2
Stamp comments.
Specify a string that does not contain SakuraScript (it will be removed).
A line break can be made with <br> (<BR>, <br>,<BR>)
Optional.
OnStampInfoCall

Event sent to the stamp book via raiseplugin when you want OnStampInfo to occur at an arbitrary time from the ghost side.

Plugin "PotatoScope" (芋スコープ)

OnPotatoReturn

Occurs when the folder designation is normal and the save file is found successfully.

Reference0
The requested variable names, separated by commas (<variable1>,<variable2>...)
Reference*
1 and thereafter is the value of each variable.
OnPotatoFileNotFound

Occurs when the folder designation is normal but hte save file is not found.

Reference0
The requested variable names, separated by commas (<variable1>,<variable2>...)
OnPotatoError

Occurs when the folder designation is incorrect, or when SHIORI is not the target of the operation.

Plugin "CrystalDiskInfo Event PLUGIN"

OnCrystalDiskInfoEvent

Occurs when information is available at ghost startup/information has been updated.

Reference0
Status of the entire group of disks (i.e., information on the worst ones) and the date of the update.
It will be a comma separated list in the form "(Good|Caution|Bad|Unknown),YYYY,NN,DD,HH,MM,SS".
Reference*
Individual disk status.
Comma separated machine name, disks present, overall status, capacity, celsius, temperature warning.
OnCrystalDiskInfoClear

Occurs when information was previously available but has disappeared.
When CrystalDiskInfo is terminated, etc.

SAORI "httpc.dll"

OnHttpcNotify

A return notification event sent by httpc.dll, via DirectSSTP after execution of a function provided by httpc.dll with the asynchronous execution option.

Reference0
Identifier passed in argument 1 at the time of the call.
Reference1
Null string.
Reference*
Return value of the executed function.

Generic External Application Event

OnApplicationBoot

Occurs when an external application is launched.

Reference0
Application name.
Reference1
Application information.
  • Materia
  • SSP
  • CROW
OnApplicationClose

Occurs when an external application exits.

Reference0
Application name.
Reference1
Application information.
  • Materia
  • SSP
  • CROW
OnApplicationExist

Occurs when notified of the presence of an external application.

Reference0
Application name.
Reference1
Application information.
  • Materia
  • SSP
  • CROW
OnApplicationVersion

Occurs when notified of external application version information.

Reference0
Application name.
Reference1
Application information.
Reference2
Version number.
Reference3
Copyright.
Reference4
Developer's URL.
  • Materia
  • SSP
  • CROW
OnApplicationOperationFinish

Occurs when an external application completes some process.

Reference0
Application name.
Reference1
Description of process.
Reference2
Subject of processing.
  • Materia
  • SSP
  • CROW
OnApplicationFileOpen

Occurs when an external application opens a document file.

Reference0
Application name.
Reference1
Full path of the file.
  • Materia
  • SSP
  • CROW
OnWebsiteUpdateNotify

Occurs when notified of website updates/new information.

Reference0
Website name.
Reference1
Last update.
Reference2
Update details.
  • Materia
  • SSP
  • CROW

Application "Kinoko" (きのこ)

OnKinokoObjectCreate

Occurs when mushrooms grow on the head.

Reference0
Name of the skin of the mushroom.
Reference1
Ghost name(s) for which that mushroom skin is primarily intended. If there is more than one, they are separated by commas.
Reference2
Category of the mushroom skin. If there is more than one, they are separated by commas.
OnKinokoObjectDestroy

Occurs when the mushroom disappears from the head.

Reference0
Name of the skin of the mushroom.
Reference1
Ghost name(s) for which that mushroom skin is primarily intended. If there is more than one, they are separated by commas.
Reference2
Category of the mushroom skin. If there is more than one, they are separated by commas.
OnKinokoObjectChanging

Occurs when trying to switch mushroom skins.

Reference0
Name of the mushroom skin before switching.
Reference1
The name of the ghost that is primarily targeted by the mushroom skin that is being switched from. Separated by commas if there is more than one.
Reference2
The category of the mushroom skin that is being switched from. Separated by commas if there is more than one.
OnKinokoObjectChanged

Occurs when the mushroom skin is switched.

Reference0
The name of the mushroom skin that was switched to.
Reference1
The name of the ghost that is primarily targeted by the mushroom skin that was switched to. Separated by commas if there is more than one.
Reference2
The category of the mushroom skin that was switched to. Separated by commas if there is more than one.
OnKinokoObjectInstalled

Occurs when a mushroom skin is installed by drag and drop.

Reference0
Name of the installed mushroom skin.
Reference1
The name of the ghost(s) primarily targeted by the installed mushroom skin. Separated by commas if there is more than one.
Reference2
Category of the installed mushroom skin. Separated by commas if there is more than one.
OnBatteryLow

Occurs when the remaining battery charge is less than 40%.
Note that there is an event of the same name notified by SSP.

Reference0
Percentage value.
OnBatteryCritical

Occurs when the remaining battery charge is less than 20%.
Note that there is an event of the same name notified by SSP.

Reference0
Percentage value.
OnSysResourceLow

Occurs when system resources are below 50%.

Reference0
Percentage value.
OnSysResourceCritical

Occurs when system resources are below 30%.

Reference0
Percentage value.

Application "Nekodorif" (猫どりふ)

OnNekodorifObjectEmerge

Occurs when a falling object appears within the visible area.

Reference0
Name of the falling object.
Reference1
Name of the target ghost of the falling object.
Reference2
Category name of the falling object.
Reference3
Mushroom flag. 1 if a mushroom is found, 0 otherwise.
Reference4
Name of the target of the falling object.
OnNekodorifObjectHit

Occurs when a falling object hits.

Reference0
Name of the falling object.
Reference1
Name of the target ghost of the falling object.
Reference2
Category name of the falling object.
Reference3
Mushroom flag. 1 if a mushroom is found, 0 otherwise.
Reference4
Name of the target of the falling object.
OnNekodorifObjectDrop

Occurs when re-dropping dropped items.

Reference0
Name of the falling object.
Reference1
Name of the target ghost of the falling object.
Reference2
Category name of the falling object.
Reference3
Mushroom flag. 1 if a mushroom is found, 0 otherwise.
Reference4
Name of the target of the falling object.
OnNekodorifObjectVanish

Occurs when a falling object that hit disappears from the visible area.

Reference0
Name of the falling object.
Reference1
Name of the target ghost of the falling object.
Reference2
Category name of the falling object.
Reference3
Mushroom flag. 1 if a mushroom is found, 0 otherwise.
Reference4
Name of the target of the falling object.
OnNekodorifObjectDodge

Occurs when a falling object that did not hit disappears from the visible area.

Reference0
Name of the falling object.
Reference1
Name of the target ghost of the falling object.
Reference2
Category name of the falling object.
Reference3
Mushroom flag. 1 if a mushroom is found, 0 otherwise.
Reference4
Name of the target of the falling object.

Application "YunaSoft SexyFont Plug-in"

OnMusicPlay

Occurs when music is played.

Reference0
Song title.

Application "Fleet Clock" (艦隊時計)

OnFleetClockComplete

Occurs when the scheduled timer that was set reaches 0.

Reference0
Category name.
Reference1
Memo contents.

Application "Elona omake_MMA"

OnElonaOmakeMMAEventNewGame

Occurs at the start of a new game.

Reference0
Game version
Reference1
In-game year
Reference2
In-game month
Reference3
In-game day
Reference4
In-game hour
Reference5
In-game minute
Reference6
In-game second
Reference7
In-game weather
Reference8
Map name
Reference9
Area name
Reference10
World name
Reference11
Level
Reference12
Guild membership
Reference*
Reference13-19 not used. Reserved.
Reference20
Target character number for each event (0: PC, 1–15: Pet, 16–55: Adventurer, 56+: Other NPC)
Reference21
PC: Name
Reference22
PC: Street name
Reference23
PC: Tribe
Reference24
PC: Business
Reference25
PC: Faith
Reference26
PC: Character type name (there is no PC type, so "bug" is used.)
Reference27
PC: Gender
Reference28
PC: Age
Reference29
PC: Stature
Reference30
PC: Body weight
Reference31
PC: Level
Reference32
PC: Current HP
Reference33
PC: Maximum HP
Reference34
PC: Current MP
Reference35
PC: Maximum MP
Reference36
PC: Money in possession
Reference37
PC: Reputation
Reference38
PC: Karma
Reference39
PC: DV
Reference40
PC: PV
Reference41
PC: Physical strength
Reference42
PC: Endurance
Reference43
PC: Cleverness
Reference44
PC: Intuition
Reference45
PC: Learning
Reference46
PC: Will
Reference47
PC: Charm
Reference48
PC: Appeal
Reference49
PC: Speed
Reference50
PC: Fortune
Reference*
Reference51-80 will contain data on the target character for the event in the same order as the PC information, +30 numbers.
OnElonaOmakeMMAEventGameLoad

Occurs when the game is started.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventGameQuit

Occurs when the game ends.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventHourPlayed

Occurs every real-world hour from the start of the game.

Reference*
Reference0–80, ※common reference.
Reference82
Reference of elapsed time (hours).
OnElonaOmakeMMAEventMapChanged

Occurs when moving to a different map.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventLevelUp

Occurs when PC or pet level is raised.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSkillUp

Occurs when the skill level of the PC or pet is raised.

Reference*
Reference0–80, ※common reference.
Reference81
Skill name.
Reference82
Skill level.
OnElonaOmakeMMAEventSkillDown

Occurs when the PC or pet's skill level drops.

Reference*
Reference0–80, ※common reference.
Reference81
Skill name.
Reference82
Skill level.
OnElonaOmakeMMAEventBelieveGod

Occurs when a PC is converted.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventJoinParty

Occurs when a pet joins the group.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSleep

Occurs when going to sleep.

Reference*
Reference0–80, ※common reference.
Reference81
Bedding name.
Reference82
1 if the gene is to be retained.
OnElonaOmakeMMAEventAwake

Occurs when waking from sleep.

Reference*
Reference0–80, ※common reference.
Reference81
Bedding name.
Reference82
1 if the gene is to be retained.
OnElonaOmakeMMAEventInvestNPC

Occurs when NPCs are investigated.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventRandomEvent

Occurs when random events occur.

Reference*
Reference0–80, ※common reference.
Reference81
Event name.
OnElonaOmakeMMAEventAddNewsTopic

Occurs when an adventurer's news topic is added.

Reference*
Reference0–80, ※common reference.
Reference81
News title.
OnElonaOmakeMMAEventWish

Occurs when the wish input dialog is displayed.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventWished

Occurs when a wish is entered.

Reference*
Reference0–80, ※common reference.
Reference81
What was wished for.
OnElonaOmakeMMAEventDead

Occurs when the PC dies.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventPetDead

Occurs when a pet dies.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventLastword

Occurs after will entry.

Reference*
Reference0–80, ※common reference.
Reference81
Will.
OnElonaOmakeMMAEventTravelGuide

Occurs when Norn's Adventure Guide is displayed.

Reference*
Reference0–80, ※common reference.
Reference82
Help number (%n number) written in data\exhelp.txt.
OnElonaOmakeMMAEventAbandonPet

Occurs when you separate from your pet.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSaleSlave

Occurs when a pet is sold to a slaver.

Reference*
Reference0–80, ※common reference.
Reference82
Selling price.
OnElonaOmakeMMAEventSaleWife

Occurs when selling a wife to Raphael.

Reference*
Reference0–80, ※common reference.
Reference82
1 if the wife is not a human being.
OnElonaOmakeMMAEventMarriage

Occurs at marriage.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventRefuseMarriage

Occurs when a marriage proposal is rejected.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventJoinGuild

Occurs when joining a guild.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventMutation

Occurs when mutation happens.

Reference*
Reference0–80, ※common reference.
Reference81
Mutation message.
Reference82
-1 for malignant mutations, 1 for benign mutations.
OnElonaOmakeMMAEventMutationCured

Occurs during mutation treatment.

Reference*
Reference0–80, ※common reference.
Reference81
Mutation message.
Reference82
-1 for malignant mutations, 1 for benign mutations.
OnElonaOmakeMMAEventEtherDisease

Occurs during ether disease breakouts.

Reference*
Reference0–80, ※common reference.
Reference81
Mutation message.
OnElonaOmakeMMAEventEtherDiseaseCured

Occurs during ether disease treatment.

Reference*
Reference0–80, ※common reference.
Reference81
Mutation message.
OnElonaOmakeMMAEventAdventGod

Occurs at the time of God's descent.

Reference*
Reference0–80, ※common reference.
Reference81
Name of God.
OnElonaOmakeMMAEventMewmewmew

Occurs when Umimiah is activated.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventBuyNuke

Occurs when nuclear bombs are purchased.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSetNuke

Occurs when a nuclear bomb is placed.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventNukeExploded

Occurs when a nuclear bomb explodes.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventLomiasInTheParty

Occurs when "Lomias", an emissary of the deformed forest, joins the party.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventLomiasKilled

Occurs when "Lomias", an emissary of the deformed forest, is killed.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventZeomeKilled

Occurs when the false prophet "Zeome" is defeated.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventConqueredLesimas

Occurs when Lesimas is conquered.

Reference81
Comment.
Reference82
Score.
OnElonaOmakeMMAEventAtonement

Occurs when karma increases and you are no longer a criminal.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventBecomeCriminal

Occurs when karma decreases and you become a criminal.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventPerformance

Occurs when the PC starts to perform.

Reference*
Reference0–80, ※common reference.
Reference81
Instrument item name.
Reference82
Performance skill.
OnElonaOmakeMMAEventClothOut

Occurs when the PC begins to undress for pleasureable things.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventStealItem

Occurs when you finish stealing an item.

Reference*
Reference0–80, ※common reference.
Reference81
Name of stolen item.
Reference82
1 for NPC possessions, 0 for items on the map.
OnElonaOmakeMMAEventTreasureDigging

Occurs when the treasure map location is dug up.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventReadTreasureMap

Occurs when the treasure map is read.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSkillLearned

Occurs when a skill is learned from a trainer.

Reference*
Reference0–80, ※common reference.
Reference81
Skill name.
OnElonaOmakeMMAEventWeatherChanged

Occurs when the weather changes.

Reference*
Reference0–80, ※common reference.
Reference81
Weather before the change.
OnElonaOmakeMMAEventRagnarok

Occurs when doomsday arrives.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventSisterRagnarok

Occurs when the sister's day arrives.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventPray

Occurs when you pray to God.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventOffer

Occurs when an item is offered at the altar.

Reference*
Reference0–80, ※common reference.
Reference81
Item offered.
OnElonaOmakeMMAEventPrayFailed

Occurs when you pray to God but he is indifferent.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventPrayEyth

Occurs when you try to pray to God in unbelief.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventAreaChanged*

Occurs when moving to another area (* is the area number).

Reference*
Reference0–80, ※common reference.
Reference81
Name of the area you were in before moving.
Reference82
Number of the area you were in before moving.
OnElonaOmakeMMAEventPayTax

Occurs when the PC puts the invoice in the tax box.

Reference*
Reference0–80, ※common reference.
Reference81
Amount of taxes paid.
OnElonaOmakeMMAEventCooking

Occurs when a PC cooks an item.

Reference*
Reference0–80, ※common reference.
Reference81
Cooking item name.
Reference82
Cooking item identifier.
Reference83
Food type (1: meat, 2: vegetables, 3: fruits, 4: sweets, 5: noodles, 6: fish, 7: bread, 8: eggs).
Reference84
Cuisine rank (1–9).
OnElonaOmakeMMAEventAreaChanged

Occurs when moving to another unspecified area.

Reference*
Reference0–80, ※common reference.
Reference81
Name of the area you were in before moving.
Reference82
Number of the area you were in before moving.
OnElonaOmakeMMAEventHour

Occurs when one hour has elapsed in in-game time.

Reference*
Reference0–80, ※common reference.
OnElonaOmakeMMAEventGrandmapocalypse

Occurs when the grandmapocalypse happens.

Reference*
Reference0–80, ※common reference.

Mahjong Communication Events

OnMahjong

Notification at each game point. See ※Server Commands below.

Reference0
Version (UKAJONG/0.2)
Reference1
※Server Command
Reference*
Additional information according to ※Server Commands.

Server commands and additional information in UKAJONG/0.2.

Reference1
gamestart (at the start of a game)
Reference2
Seats (East|South|West|North)
Reference3
Player 1 name
Reference4
Player 2 name
Reference5
Player 3 name
Reference6
Player 4 name
Reference1
gameend(At the end of a game)
Reference2
Player 1 name(byte 1 value)Score
Reference3
Player 2 name(byte 1 value)Score
Reference4
Player 3 name(byte 1 value)Score
Reference5
Player 4 name(byte 1 value)Score
Reference1
kyokustart (At the start of a round)
Reference2
Wind (east|south|west|north)
Reference3
Parent player name
Reference4
Home (Example: 1)
Reference5
Trust (Example: 100)
Reference1
kyokuend (At the end of a round)
Reference1
point (notifies the player's score)
Reference2
Player name
Reference3
(=|+|-) = means direct specification of scores, + or - means increase or decrease.
Reference4
Score
Reference1
haipai (When dealing out tiles)
Reference2
Player name
Reference3
Matching cards (Example: 1m2m3m4p5p6p7s8s9s1z5z6z7z)
Reference1
dora (when sending a dora display tile)
Reference2
Tile (Example: 7z)
Reference1
open (When revealing a hand, such as Chi, Pon, Kan, etc.)
Reference2
Player name
Reference3
Tile (Example: 1p2p3p)
Reference1
tsumo (at tsumo)
Reference2
Player name (self)
Reference3
Number of tickets remaining
Reference4
Tile (Example: 7z)
Reference1
sutehai (When playing cards)
Reference2
Player name (self)
Reference3
Tile (Example: 7z)
Reference1
say (Vocalizing)
Reference2
Player name
Reference3
Speech contents (chi|pon|kan|ron|tsumo|richi|tenpai|noten)
Reference1
agari (Closing time)
Reference2
Player name
Reference3
Mark
Reference4
Role, Han number
Reference5
Same as Reference4
Reference1
ryukyoku (When the game is over)

The following commands require a reply. If the requester is GHOST, you can reply with \![raiseother], etc., but if the requester is an external application and the notification is by SSTP, it is necessary to reply using the X-SSTP-PassThru-* header.

When replying with \![raiseother], the OnMahjongResponse event is returned. When the SHIORI response header is used, X-SSTP-PassThru-ID: OnMahjongResponse is used.

If an empty character is set as the requested target, the server is considered to have delegated the response to the client.

Reference1
hello (Connection confirmation)
Reference1
sutehai? (Asks for discarded tiles)
Reference1
naku? (Asks if you want to ring a tile. The client also sends possible commands.)
Reference2
(ron|kan|pon|chi)
Reference3
Same as Reference2.
Reference1
tenpai? (Asks if you want to declare a tenpai)
OnMahjongResponse

Reply to the OnMahjong event. See ※Client Commands below.

Reference0
Version (UKAJONG/0.2)
Reference1
※Client Commands
Reference*
Additional information according to ※Client Commands

Client commands and additional information in UKAJONG/0.2

Reference1
hello (Connection confirmation reply)
Reference2
emp=(UMP version) ※Not strictly UMP compliant, so it is not looked at specifically. UMP=? is ok.
Reference3
name=(Player name) ※Specify sakura.name.
Reference1
sutehai? (Reply to discarded tiles)
Reference2
(sutehai|ankan|kakan|richi|tsumo)
Reference3
Selected tile (may be empty when tsumo)
Reference1
naku? (Reply to whether to play the tiles)
Reference2
(no|ron|kan|pon|chi)
Reference3
Selected tile 1 (Required for chi, designated as 1m and 3m or 3m and 4m against 2m. The first of them.)
Reference4
Selected tile 2 (The second one above.)
Reference1
tenpai? (Reply to whether to declare tenpai)
Reference2
(yes|no)

Nostr Notification Event

OnNostr

Notification information in Nostr/0.4

Reference0
Version (Nostr/0.4)
Reference1
Nostr event's kind (number) (1: note, 7: reaction, ...)
Reference2
Nostr event's content
Reference3
name of Nostr event signer's kind0
Reference4
display_name of Nostr event signer's kind0
Reference5
picture of Nostr event signer's kind0
Reference6
NIP-19 encoding of the ID of the Nostr event (note1... or nevent1...)
Reference7
NIP-19 encoding of the Nostr event signer's public key (npub1...)

Application "Satolist" (さとりすと)

OnSatolistBoot

Occurs when Satolist is started.

OnSatolistGhostOpened

Occurs when a ghost is read by Satolist.

Reference0
Main character name.
Reference1
Ghost name.
OnSatolistSaved

Occurs when a ghost is saved in Satolist.

Reference0
closing if saving because Satolist is closing, otherwise edit.
OnSatolistClosed

Occurs when Satolist is about to exit.

OnSatolistEventAdded

Occurs when an event is created in Satolist.

Reference0
Name of the added item.
Reference1
Name of the file to which the item is added.
Reference2
Item type.
Reference3
Item occurence conditions.
OnSatolistDictionaryFolderChanged

Occurs when the dictionary folder in "Dictionary" is changed.

Google Chrome Extension "Tourabu" (とうらぶえくすてんしょん)

OnTourabuConquestStart

Occurs when an expedition is started.

Reference0
Unit number (integer from 1-4).
Reference1
Approximate time until the end of the expedition. Unit is minutes.
OnTourabuConquestEnd

Occurs when the expedition is completed.
Notification may be a few seconds earlier than the actual end of the expedition due to specifications.

Reference0
Unit number (integer from 1-4).
OnTourabuDutyStart

Occurs when the inner guard is started.

OnTourabuDutyEnd

Occurs when the inner guard is finished.

Ghost-to-Ghost General Purpose Event

OnRequestValues

Occurs when other ghosts transmit arbitrarily.
When this event is sent, the OnGetValues event should be sent via \![raiseother].

Reference0
Name of the ghost that sent it.
Reference1
Name of the variable to request (key), followed by Reference2 and so on, as long as long as the variable is requested in the same way.
  • SSP
OnGetValues

Event to be returned when OnRequestValues is recieved.

Reference0
Name of the ghost that sent it.
Reference1
key=value (where key is the name of the variable received in OnRequestValues, and value is its value). Variables that do not exist are not returned, regardless of the order in which they were sent in OnRequestValues.
  • SSP

List of requested property names

  • Character name
  • Generation
  • Age group
  • Gender
  • Species
  • Species type
  • Behavior type
  • Profile
  • Card image path
  • LIFE
  • STR
  • DEX
  • AGL
  • MIN
  • INT
  • SEN
  • NOB

Ghost "ぬるぽ いんたーはい"

OnTalkRequest

Occurs when asked to talk by NullPointerHi. (Translator note: NullPointerHi is the romanized name of the ghost.)

Ghost "The Hand"

OnHandActivate

Occurs when the hand goes to touch or finishes touching another ghost.
While touching, sends (OnMouseMove|OnMouseDoubleClick|OnMouseWheel) events to the ghost with Sender:The Hand.

Reference0
Normal touch start: NormalStart
Normal touch end: NormalEnd
Special move start: SuperStart
Special move in progress: SuperContinue
Special move ends: SuperEnd
Homing activation in the middle of a special move: SuperHoming
Reference1
Name of the collision area.
If stopped, "escaped".
1-4 for special moves.
Reference2
An event that happens to a partner.
Normal: (OnMouseMove|OnMouseDoubleClick|OnMouseWheel)
During special moves: number of times touched.
When a special move is completed: (Max number of touches|escaped|nocollision|attacked|deleted)
Reference3
Scripts for touching.
During special moves, the name of the collision area.
Reference4
Shell number.

Ghost "ごーすとじてん」「きゅーぴっど"

OnJitenBattle

Occurs every turn of a mock battle conducted by the ghost.

Reference0
Sent ghost's \0 name.
Reference1
Attacker character name.
Reference2
Defender character name.
Reference3
Combat results.
Start: simulated battle begins
When acting: (physical attack success|physical attack failure|physical attack evasion|physical attack miss|mental attack success|mental attack failure|mental attack evasion|mental attack miss).
Reference4
Damage.
Reference5
Attacker character LIFE.
Reference6
Defender character LIFE.
Reference7
Normal
OnJitenTagBattle

Occurs every turn of a mock battle conducted by the ghost.

Reference0
Sent ghost's \0 name.
Reference1
Attacker character name.
Reference2
Defender character name.
Reference3
Combat results.
Start: simulated battle begins
When acting: (physical attack success|physical attack failure|physical attack evasion|physical attack miss|mental attack success|mental attack failure|mental attack evasion|mental attack miss).
Reference4
Damage.
Reference5
Attacker character LIFE.
Reference6
Defender character LIFE.
Reference7
Tag

Ghost "マギルトリエ"

OnMglBattle

Occurs for each result of a cirtual battle conducted by the magistrier.

Reference0
Version information.
Reference2
Sender ghost.
Reference3
Mgl Event Name.
Reference*
Content for Mgl events.

Ghost "カレー家族/沙紀と右近"

Send60stair_Call

Curry family / Occurs when Saki and Ukon invite other ghosts that are running to the game.

Send60stair_Start

Curry family / Occurs when Saki and Ukon start the game.

  • SSP
Send60stair_YourTurnStart

Curry family / Occurs when it is the turn of one's own ghost during a game played by Saki and Ukon.

Reference0
Current position.
Reference1
Marking position.
Send60stair_Marking

Curry family / Occurs when marking during a game played by Saki and Ukon.

Reference0
Marking position.
Send60stair_DiceRoll

Curry family / Occurs when the ghost rolls the dice during a game played by Saki and Ukon, and it is not Dobon.

Reference0
First dice roll.
Reference1
Second dice roll.
Send60stair_Dobon

Curry family / Occurs when one of the participating ghosts gets Dobon during a game played by Saki and Ukon.

Reference0
Dobon ghost name.
Reference1
Current location of the Dobon ghost.
Reference2
Marking position of Dobon ghost.
Reference3
Roll of the dice.
Send60stair_YourTurnEnd

Curry family / Occurs when your ghost's turn ends during a game played by Saki and Ukon.

Reference0
Current position.
Reference1
Marking position.
Send60stair_Goal

Curry family / Occurs when one of the ghosts scores a goal during a game played by Saki and Ukon.

Reference0
Name of the winning ghost.
Reference1
Order.
Send60stair_GameEnd

Curry family / Occurs at the end of the game played by Saki and Ukon, after the ranking is displayed.

Send60stair_GetStatus

Event that should be sent to Saki via \[raiseother].

Reference0
Name of the \0 character of the ghost to send.
Reference1
Boldness. (0-60)

Ghost "奏でる日常の音色"

OnKanadeTeaPartyInfomationRequest

An event notified to each ghost before the tea party begins, based on "奏でる日常の音色" (this ghost).
Ghost attending the tea party will immediately join this event,
\![raiseother,かなで,(Variable name reply event),(Ghost's corresponding tea party version number),(Ghost's sakura name),(※Information corresponding to the Tea Party version)]
You will need to execute the SakuraScript for the event.
Dialogue in the event other than execution of this script is deprecated.

Reference0
Tea party version number.
Reference1
Name of the main character of the ghost to which the event is sent (fixed to "かなで" (Kanade)).
Reference2
Reply event name.
Variable name reply event

An event in which a ghost that receives an OnKanadeTeaPartyInfomationRequest is notified via raiseother to "奏でる日常の音色" (this ghost).
The event name is notified in Reference2 of OnKanadeTeaPartyInfomationRequest.

Reference0
Ghost's corresponding tea party version number.
Reference1
Ghost main character name.
Reference2
※Information corresponding to the Tea Party version
OnKanadeTeaParty

Tea Party body event. Notified at the start of the tea party.

Reference0
The version of the Tea Party, in which the combinations after Reference1 are implemented.
Reference1
Beverages.
Reference2
Sweets.
Reference*
Extended information after Reference3.
OnKanadeTeaPartyEnd

Tea Party end event. "奏でる日常の音色" (this ghost) will be notified after the tea party end dialogue.

Reference0
Version of Tea Party performed.

※Information corresponding to the Tea Party version

Supported
If the version of the ghost is higher or the same as the version of "奏でる日常の音色" (this ghost), it is fully compatible with the tea party event offered by "奏でる日常の音色" (this ghost).
Incompatible
If the version of the ghost is lower than the version of "奏でる日常の音色" (this ghost), the tea party event cannot be processed with a version higher than the ghost's version.
Automatic response
You can automatically respond to a tea party event with a ghost that has a lower version than "奏でる日常の音色" (this ghost) by changing the content of the dialogue, such as by applying different words.
Fixed support
The response does not change depending on the tea party offered by "奏でる日常の音色" (this ghost). Reference0 of the returned event is the tea party version confirmed by the ghost's creator. For ghosts that return this response information, the tea party content selection is not considered.

Ghost "卓上誘技"

OnPoker

An event that requires a response. Use raiseother or notifyother as the response method.

Reference0
Protocol Version (POKER/1.0)
Reference1
Server Ghost Name
Reference2
Server Event Name

Additional information in Reference3 and later in POKER/1.0

Reference3
hello (Apply for participation. You may be turned down.)
Reference3
action (It contains actions that can be used from Reference4 onwards.)
Reference*
Some of the six available actions are bet, raise, allin, check, call, and fold.
Note that if you do not reply, it will automatically be "fold".
If you use bet/raise, you must also send the amount of the raise.
OnPokerNotify

Events that do not require a response.

Reference0
Protocol Version (POKER/1.0)

Additional information after Reference0 in POKER/1.0

Reference1
game_start
Reference*
Name of ghost that could participate.
Reference1
round_start
Reference2
Amount of blinds.
Reference*
Ghost name(byte value 1)Stack
Reference1
hand
Reference2
Information on the cards dealt.
Reference3
Information on the cards dealt.
Suit is one of four initials (S,H,C,D) followed by a number.
Example:
Reference2: S1
Reference3: H12
This format is the same for FLIP.
Reference1
flip
Reference2
Current Pot
Reference*
Community Card Information
If pre-flop, it doesn't exist after Reference3.
Reference1
blind_bet
Reference2
Amount of forced bet
You will be notified that you have made a forced bet on SB or BB.
Reference1
bet (Information about the player who performed the action and the betting surroundings.)
Reference2
Total current bets
Reference3
Current bet amount
Reference4
Ghost name of the player who performed the action
Reference5
Actions taken
Reference1
show_down (Card information will be sent to you at showdown.)
Reference*
Ghost name(Byte value 1)1st card(Byte value 1)2nd card
Reference1
round_result (Information on the winner of the round and the stacks remaining for the participants.)
Reference2
The winner of the current round is separated by a byte 1 value.
Reference*
Ghost name(Byte value 1)Stack
Usually, there's one winner, but in some cases there can be two or more.
Also note that the stack is only notified here when it reaches 0.
Reference1
game_result
Reference2
Ghost name of the game winner.

Ghost "フォーリナー" Supplement "march of phantasma"

OnMopClear

Notification when the map is cleared.

Reference0
Membets at the time of clearing, separated by a byte value 1 (unique units only).
Reference1
Name of the map that was cleared.

Ghost Terminal, an interactive exe for ghost development



Start, end.

ShioriEcho.Begin

The ghost_terminal event when this ghost is started.

Reference0
Terminal version
Reference1
Terminal session type
If the terminal starts with `-s`, it is `SakuraScript`.
If the terminal starts with `-c` it is `Command`.
`Common` if the terminal is activated by common means.
Return value: X-SSTP-PassThru-Tittle(Option)
Set the title of the terminal
Return value: X-SSTP-PassThru-Icon(Option)
Set the terminal icon
Return value: X-SSTP-PassThru-SmallIcon(Option)
Set a small icon on the terminal
If not set, matches `X-SSTP-PassThru-Icon`
Return value: X-SSTP-PassThru-CustomLoginInfo(Option)
If set, the terminal will not display the default login information,
and this return value is simply escaped
- `\n` converted to newline.
- `\t` converted to tab.
- `\\` is converted to `\`.
ShioriEcho.End

The ghost_terminal event generated when a normal program ends.

ShioriEcho.GetName

Event when ghost_terminal gets the name.

Return value: X-SSTP-PassThru-GhostName(Option)
Show ghost names
Return value: X-SSTP-PassThru-UserName(Option)
Display user name


Execute command

ShioriEcho

Event after command is entered

Reference0
Commands collected by the terminal
Return value
If you have not defined `ShioriEcho.GetResult`, you can return any return value supported by `ShioriEcho.GetResult` here. These return values will be correctly processed by the terminal (however, return value 3 will go into the next command acquisition if you do not define `ShioriEcho.GetResult` and return nothing).
If you have defined `ShioriEcho.GetResult`, the return value here is ignored (**but the sakura script is executed normally**).
ShioriEcho.GetResult

Value result event query

Replyable header 1:

Return value: X-SSTP-PassThru-Result
Display contents and proceed to the next command acquisition
Return value(Option):X-SSTP-PassThru-Type
Additional information: value type

Replyable header 2:

Return value: X-SSTP-PassThru-Special
Display the contents and proceed to the next command acquisition
This return value is escaped simply:
- `\n` is converted to a newline.
- `\t` is converted to a tab
- `\\` is converted to `\`.

Replyable header 3: Empty

Wait 1 second and rerun ShioriEcho.GetResult

Other

Return value: X-SSTP-PassThru-State
This return value can be superimposed on the above return value
If `End`, the terminal is terminated.
If `Continue`, the terminal does not display anything and proceeds to get the next command.


Other

ShioriEcho.TabPress

The command completes the event with a tab.

Reference0
Commands collected at the terminal.
Reference1
The first character of the command where the cursor was when tab was pressed (start value 0).
Reference2
Number of times the user pressed tab in succession (start value 0).
Reference3
The first character of the command where the cursor was when the tab was pressed in this series of tab presses (start value 0).
Return value(Option): X-SSTP-PassThru-Command
Replace the command with this content.
Return value(Option): X-SSTP-PassThru-InsertIndex
Move the cursor to this position (if not provided, do not change).
Return value(Option): X-SSTP-PassThru-OldInsertIndex
Subsequent `Reference3` will be updated to this content, effective until the end of this series of tab completions (if not provided, do not change).
ShioriEcho.CommandUpdate

Event when command is updated.

Reference0
Commands collected at the terminal.
Return value(Option): X-SSTP-PassThru-CommandForDisplay
Replace the displayed command with this content.
Ghost can use this event to implement features such as masking when entering passwords, syntax highlighting during normal reading, etc.
ShioriEcho.CommandPrompt

Event when the command prompt is updated.

Return value(Option): X-SSTP-PassThru-Prompt
Replace the displayed command prompt with this content.
Ghost can dynamically change the command prompt with this event.
ShioriEcho.CommandComplete

Event when the user presses `→` on the right end of the command line.

Reference0
Commands collected by the terminal.
Reference1
The first character of the command when `→` is pressed at the cursor position (starting value is 0).
Return value(Option): X-SSTP-PassThru-Command
Replace the command with this content.
Ghost can autocomplete commands with this event.
Return value(Option): X-SSTP-PassThru-InsertIndex
Move the cursor to this position (or leave it there if not provided).


Command history

ShioriEcho.CommandHistory.New

Event when an empty command is added to the end of the command history.

ShioriEcho.CommandHistory.Update

Event when the command history is updated.

Reference0
Contents of history command
Reference1
Index of history command (reverse order, start value 0)
ShioriEcho.CommandHistory.Get

Event when command history is retrieved.

Reference0
Index of history command (reverse order, start value 0)
Return value(Option): X-SSTP-PassThru-Command
Replace the command with this content
ShioriEcho.CommandHistory.ForwardIndex

Event when the user presses `↑` and the index is updated.

Reference0
Index of history command (reverse order, start value 0)
Reference1
Amount of `index` value increase expected.
Return value(Option): X-SSTP-PassThru-Index
Update the index to this value

Plugin "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 byte 1 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.

Ghost "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

Occurs when an example script from Ukadoc's SakuraScript List is run.
Note that if you implement this event, you will need to escape dangerous SakuraScript tags yourself.

Reference0
The script that was executed.