Translated Document
- This document has been translated from the original Japanese by members of the Ukagaka Dream Team community.
- To see the original document, click here.
- To submit corrections/updates, see our repository to open an issue or find where to contact us.
This page summarizes the events that are notified to plugins by the baseware.
For more information on the PLUGIN/2.0 communication specification itself, see the PLUGIN/2.0 page.
Events marked with [NOTIFY] are always notified using the NOTIFY command.
Even if you return a script to an event notified by the NOTIFY command, it will be completely ignored.
Events not specifically indicated may be notified by NOTIFY or GET, depending on the circumstances.
PLUGIN Event
- version
-
Occurs immedaitely after the plugin is loaded.
The plugin returns the plugin version information in the Value header for this event.
If a character encoding is specified in the Charset header, the character encoding to be used for subsequent requests can be specified (the default value is Shift_JIS).
Note that the response format is different from other events.
- installedplugin
-
Enumerate and notify installed plugins. [NOTIFY]
- Reference*
- Plugin name, plugin ID, separated by 1 byte value.
- ghostpathlist
-
The path of the ghost folder being read. [NOTIFY]
- Reference*
- The full path of the ghost folder being read.
If multiple folders are specified, they may be listed in Reference1, etc.
- balloonpathlist
-
Path of the balloon folder being read. [NOTIFY]
- Reference0
- The full path of the balloon folder being read.
- headlinepathlist
-
Path of the headline folder being read. [NOTIFY]
- Reference*
- The full path of the headline folder being read.
- pluginpathlist
-
Path of the plugin folder being read. [NOTIFY]
- Reference*
- The full path of the loaded plugin folder.
- OnSecondChange
-
Occurs after a second has elapsed.
The number of seconds between notifications can be set by secondchangeinterval, in descript.txt.
- OnOtherGhostTalk
-
Occurs when a ghost speaks.
Can be set by otherghosttalk in descript.txt.- Reference0
- Ghost name.
- Reference1
- Ghost main side name.
- Reference2
- break if the talk is interrupted.
communicate for communications.
sstp-send for SSTP SEND.
owned for Owned SSTP.
remote for non-local SSTP.
notranslate if no translate is specified.
plugin-script for scripts from plugins.
plugin-event for an event response from a plugin.
The corresponding items are returned separated by commas. - Reference3
- Event ID that the ghost responded to.
- Reference4
- Script of what the ghost talked about.
- Reference5
- References passed to the ghost, delimited by byte value 1.
- OnGhostBoot
-
Occurs when a ghost starts.
- Reference0
- HWND of each character window after \0 of the launched ghost, separated by byte value 1.
0 may be included if it has not yet been constructed. - Reference1
- Name of the launched ghost.
- Reference2
- Current shell name of the launched ghost.
- Reference3
- ID of the launched ghost (same as sent by Owned SSTP).
- Reference4
- Full path of the launched ghost.
- OnGhostExit
-
Occurs when a ghost closes. [NOTIFY]
- Reference0
- HWND of each character window after \0 of the closed ghost, separated by byte value 1.
0 may be included if it has not yet been constructed. - Reference1
- Closed ghost name.
- Reference2
- Current shell name of the closed ghost.
- Reference3
- Closed ghost ID (same as sent by Owned SSTP).
- Reference4
- Full path of the closed ghost.
- OnGhostInfoUpdate
-
Occurs when ghost information is changed.
Can also occur during loading. [NOTIFY]- Reference0
- HWND of each character window after \0 of the ghost that has changes, separated by byte value 1.
0 may be included if it has not yet been constructed. - Reference1
- Name of the ghost that has changes.
- Reference2
- Current shell name of the ghost that has changes.
- Reference3
- ID of the ghost that has changes (same as sent by Owned SSTP).
- Reference4
- Full path of the ghost that has changes.
- OnMenuExec
-
Occurs when a plugin is executed from the owner draw menu.
Some kind of reaction is recommended.- Reference0
- HWND of each character window after \0 of the ghost that called the plugin, separated by byte value 1.
0 may be included if it has not yet been constructed. - Reference1
- Name of the ghost that called the plugin.
- Reference2
- Current shell name of the ghost that called the plugin.
- Reference3
- ID of the ghost that called the plugin (same as sent by Owned SSTP).
- Reference4
- Full path of the ghost that called the plugin.
- OnInstallComplete
-
Occurs when installation of something is completed.
- Reference0
- Installation type, separated by a byte 1 value.
- Reference1
- The name of what was installed, separated by a byte 1 value.
- Reference2
- Full path of what was installed, separated by a byte 1 value.
- OnChoiceSelect(Ex)/OnAnchorSelect(Ex)/Arbitrary event name specified in \q
-
Plugin side hook for SHIORI event that occurs when a choice or anchor is selected.
If a script sent by a plugin to a ghost, or a script sent back from a ghost in response to an event notified to a ghost by a plugin contains a choice/anchor SakuraScript tag, the choice/anchor tag is sent only once. The same event that is notified to the SHIORI side when an anchor is selected is also notified to the plugin side.- Reference*
- Reference of the choice/anchor SHIORI event that occured.
- Arbitrary event name specified in \![raiseplugin] and \![notifyplugin]
-
Occurs when executing \![raiseplugin] and \![notifyplugin].
[NOTIFY] for \![notifyplugin].- Reference*
- Any arguments specified.