SHIORI Event List

Translated Document

About the formatting of this page

This page describes the IDs for each SHIORI Event issued in SHIORI/3.0 and 3.1 (SSP extended definition).
For events not listed here, please check SHIORI Resource or External SHIORI Event. You may find it there.

If you need a description of the SHIORI Event itself, please refer to the "Supplement: What is a SHIORI Event?" page.

About reference list

For each SHIORI Event that has a Reference, a list of References is provided.
If the number part of the Reference is "*", it means that it is an indefinite Reference.
In other words, the Reference has an indefinite number because it deals with different numbers depending on the operating environment, and that the indefinite number of References are all of the same form.
In this case, the principle that references are given serial numbers starting from 0 remains the same. So for example, if the list of references has only *, there will be a sequence of references in the same form (as many as are appropriate for the environment) from 0 to an undefined number. If the list contains references up to and including 2, and the next line is Reference*, then the list will contain references in the same format from 3 to an undefined number.

About events with [NOTIFY]

SHIORI events with [NOTIFY] in the explanation text are usually raised with NOTIFY commands.
Otherwise, they are usually raised with GET commands.

Booting, Closing, and Changing Events

OnFirstBoot

Occurs when a ghost is booted for the first time.
In SSP, if no script is returned for the event (204), OnBoot will occur afterwards.

Reference0
The number of times the ghost has been vanished (uninstalled).
  • Materia
  • SSP
  • CROW
OnBoot

Occurs when a ghost is booted.
In SSP, if no script is returned for OnGhostChanged, OnGhostCalled, OnFirstBoot, or OnVanished (204), this event will occur afterwards.

Reference0
The name of the current shell.
Reference6
※MATERIA, SSP only: "halt" if the last closing was due to a crash.
Reference7
※MATERIA, SSP only: The name of the ghost that crashed.
  • Materia
  • SSP
  • CROW
OnClose

Occurs when instructed to close.
In SSP, if no script is returned for OnGhostChanging or OnCloseAll (204), this event will occur afterwards.

Reference0
※SSP only: The reason for closing.
Returns "user" if closed by the user,
"system" if closed by a shutdown.
Reference1
※SSP only: The scope number of the character whose menu was used for the closing operation. Affected by popupmenu.type. (0 for the main character, 1 for the side character...)
Reference2
※SSP only: The scope number of the character whose window was closed. Not affected by popupmenu.type. (0 for the main character, 1 for the side character...)
  • Materia
  • SSP
  • CROW
OnCloseAll

Occurs when SSP itself is closed.
Also occurs when "Quit" is selected in the right-click menu, when "Close" is selected if only one ghost is open, or when SSP closes due to the OS shutting down.

Reference0
※SSP only: The reason for closing.
Returns "user" if closed by the user,
"system" if closed by a shutdown.
Reference1
※SSP only: The scope number of the character whose menu was used for the closing operation. Affected by popupmenu.type. (0 for the main character, 1 for the side character...)
Reference2
※SSP only: The scope number of the character whose window was closed. Not affected by popupmenu.type. (0 for the main character, 1 for the side character...)
  • SSP
OnGhostChanged

Occurs when changed to from another ghost.
In SSP, if no script is returned for the event (204), OnBoot will occur afterwards.

Reference0
The main character name of the previous ghost.
Reference1
The script of the previous ghost when changing.
Reference2
※SSP only: The name of the previous ghost.
Reference3
※SSP only: The path (file location) of the previous ghost.
Reference7
※SSP only: The shell name of the ghost that has been changed to.
  • Materia
  • SSP
  • CROW
OnGhostChanging

Occurs when instructed to change to another ghost.
In SSP, if no script is returned for the event (204), OnClose will occur afterwards.

Reference0
The main character name of the ghost to be changed to.
Reference1
Returns "manual" if changed manually,
"automatic" if changed by the system.
Reference2
※SSP only: The name of the ghost to be changed to.
Reference3
※SSP only: The path of the ghost to be changed to.
  • Materia
  • SSP
  • CROW
OnGhostCalled

Occurs when the ghost is called by another ghost.
In SSP, if no script is returned for the event (204), OnBoot will occur afterwards.

Reference0
The main character name of the ghost that called the current ghost.
Reference1
The script of the ghost that called the current ghost.
Reference2
The name of the ghost that called the current ghost.
Reference3
The path of the ghost that called the current ghost.
Reference7
The shell name of the ghost that was called.
  • SSP
OnGhostCalling

Occurs when instructed to call another ghost.

Reference0
The main character name of the ghost that is being called.
Reference1
Returns "manual" if changed manually,
"automatic" if changed by the system.
Reference2
The name of the ghost that is being called.
Reference3
The path of the ghost that is being called.
  • SSP
OnGhostCallComplete

Occurs after another ghost has been called and finishes the booting script.

Reference0
The main character name of the ghost that was called.
Reference1
The booting script of the ghost that was called.
Reference2
The name of the ghost that was called.
Reference7
The shell name of the ghost that was called.
  • SSP
OnOtherGhostBooted

Occurs when a separate ghost, called by another, finishes booting.
In other words, this event occurs in an unrelated ghost at the same timing as when OnGhostCallComplete occurs in the ghost that did the calling.

Reference0
The main character name of the ghost that was booted.
Reference1
The booting script of the ghost that was booted.
Reference2
The name of the ghost that was booted.
Reference7
The shell name of the ghost that was booted.
  • SSP
OnOtherGhostChanged

Occurs when a separate ghost changes to another.

Reference0
The main character name of the previous ghost.
Reference1
The main character name of the ghost that has been changed to.
Reference2
The changing script of the previous ghost when changing.
Reference3
The changing script of the ghost that has been changed to.
Reference4
The name of the previous ghost.
Reference5
The name of the ghost that has been changed to.
Reference14
The shell name of the previous ghost.
Reference15
The shell name of the ghost that has been changed to.
  • SSP
OnOtherGhostClosed

Occurs when another ghost is closed while multiple ghosts are open.

Reference0
The main character name of the ghost that was closed.
Reference1
The last script of the ghost that was closed.
Reference2
The name of the ghost that was closed.
Reference7
The shell name of the ghost that was closed.
  • SSP
OnShellChanged

Occurs when the shell has been changed.

Reference0
The current shell's name.
Reference1
※CROW only: The same as Reference0.
※SSP only: The current ghost's name.
Reference2
※SSP only: The current shell's path.
  • Materia
  • SSP
  • CROW
OnShellChanging

Occurs when changing to another shell.

Reference0
The name of the shell to be changed to.
Reference1
※SSP only: The name of the shell before changing (the current shell).
Reference2
※SSP only: The path of the shell to be changed to.
  • Materia
  • SSP
  • CROW
OnDressupChanged

Occurs when a dressup has been changed.
When this event is notified multiple times, the very last OnDressupChanged uses [GET], and the others use [NOTIFY].
Refer to OnNotifyDressupInfo, which occurs after this event.

Reference0
The character ID of the dressup target.
Reference1
The part name.
Reference2
1 when valid, 0 when invalid.
Reference3
The part's category name.
Reference4
"script" if executed by a script, "user" if executed from the menu. [2.5.90~]
  • SSP
OnBalloonChange

Occurs when the balloon is changed.

Reference0
The name of the balloon that has been changed to.
Reference1
The path of the balloon that has been changed to.
  • SSP
OnWindowStateRestore

Occurs when the ghost is unminimized.

Reference0
※SSP only: The reason for minimization.
system: Minimization forced by the OS (includes being minimized from the taskbar)
script: Minimization from SakuraScript
sakuraapi: Minimization from the Sakura API
user: Minimization from the menu
  • Materia
  • SSP
  • CROW
OnWindowStateMinimize

Occurs when instructed to minimize.
※SSP only: Making the ghost talk is possible in the settings.

Reference0
※SSP only: The reason for minimization.
system: Minimization forced by the OS (includes being minimized from the taskbar)
script: Minimization from SakuraScript
sakuraapi: Minimization from the Sakura API
user: Minimization from the menu
  • Materia
  • SSP
  • CROW
OnFullScreenAppMinimize

Occurs when SSP is minimized from an application launching in full-screen display.
Overwritten by OnWindowStateMinimize, which occurs during normal minimization.

Reference0
※SSP only: The reason for minimization. Always "fullscreen."
  • SSP
OnFullScreenAppRestore

Occurs when SSP is unminimized from an application ending full-screen display.
Overwritten by OnWindowStateRestore, which occurs during normal unminimization.

Reference0
※SSP only: The reason for minimization. Always "fullscreen."
  • SSP
OnVirtualDesktopChanged

Occurs when the virtual desktop has changed.
Currently only works on Windows 10.
This is an experimental function, and as such there is a strong chance that the functioning will change in future.

Reference0
current: The current virtual desktop and the desktop on which the ghost is being displayed are the same
hidden: The virtual desktop has been changed and is not being displayed
minimize: The window has been minimized and it is unclear which desktop it belongs to
Reference1
The ID of the current virtual desktop.
  • SSP
OnCacheSuspend

Occurs when the ghost cache is suspended.

  • SSP
OnCacheRestore

Occurs when the ghost cache is restored.

  • SSP
OnInitialize

Occurs on booting. [NOTIFY]

Reference0
"reload" when reloaded, nothing otherwise (Reference0 will either contain an empty string or not exist at all).
  • SSP
OnDestroy

Occurs when instructed to close. [NOTIFY]

Reference0
"reload" when reloaded, nothing otherwise (Reference0 will either contain an empty string or not exist at all).
  • SSP
OnSysResume

Occurs when the system is resumed from sleep or hibernation.

Reference0
The reason for resumation. Usually "normal," "auto" if due to automatic resumation from the system schedule, "critical" if due to empty battery or emergency stop. (No longer works after Windows Vista.)
  • SSP
OnSysSuspend

Occurs when the system enters sleep or hibernation. [NOTIFY]

  • SSP
OnBasewareUpdating

Occurs when the baseware's file download has finished and before the update installation starts. If there is no reaction to this event, OnCloseAll and then OnClose will occur instead.

Reference0
The version number before updating. Ex: 2.3.58
Reference1
The version number as seen with the properties from Windows Explorer before updating. Ex: 2.3.58.3000
  • SSP
OnBasewareUpdated

Occurs when the ghost boots after the baseware has finished updating. If there is no reaction to this event, OnBoot will occur instead.

Reference0
The version number after updating. Ex: 2.3.59
Reference1
The version number as seen with the properties from Windows Explorer after updating. Ex: 2.3.59.3000
  • SSP

Input Box Events

OnTeachStart

Occurs when the TeachBox is opened.

  • Materia
  • SSP
OnTeachInputCancel

Occurs when the TeachBox is closed.

Reference0
(Empty string. A vacant spot to match the number of the Reference that returns "close" with OnUserInputCancel.)
Reference1
When closed, "cancel."
  • SSP
OnTeach

Occurs when something is input into the TeachBox.

Reference*
The history of input words. Reference0 holds the first, and the latest input goes into the final Reference (the nth input will be Reference(n - 1).
  • SSP
OnCommunicate

Occurs when a script is received from the CommunicateBox or from another ghost.

Reference0
"user" if from the Box, the main character name of the ghost that sent the script if from a ghost.
Reference1
The script contents.
Reference*
Extra information.
  • Materia
  • SSP
OnCommunicateInputCancel

Occurs when the CommunicateBox is closed.

Reference0
(Empty string. A vacant spot to match the number of the Reference that returns "close" with OnUserInputCancel.)
Reference1
When closed, "cancel."
  • SSP
OnUserInput

Occurs when something is input and confirmed in the InputBox.

Refer to InputBox IDs.

Reference0
The InputBox ID.
Reference1
The input content.
Reference2
The supplementary information. (Only sliderinput's minimum and maximum; others will be left blank.)
Reference3~
The additional information specified with --reference=.
  • Materia
  • SSP
  • CROW
OnUserInputCancel

Occurs when the InputBox is closed.

Reference0
The input event ID.
Reference1
"timeout" if the box timed out, "close" if it was closed.
Reference2
The supplementary information. (Only sliderinput's minimum and maximum; others will be left blank.)
Reference3+
The additional information specified with --reference=.
  • SSP
inputbox.autocomplete

Occurs when the box is opened. If a list of text separated by the 1-byte value is returned to this event, the autocomplete function will active in the InputBox.
(WinMe/2000 onwards)

Reference0
The type of box. Either inputbox, teachbox, or communicatebox.
Reference1
The identifier or name of the event that was run after input. Only applies to the InputBox.
  • SSP

Dialog Box Events

OnSystemDialog

Occurs when Save/OK buttons are pressed for dialog related to files.

Reference0
Either open, save, folder, or color.
Reference1
The event ID.
Reference2
Either the filepath or the RGB value separated by commas.
  • SSP
OnSystemDialogCancel

Occurs when the Cancel button is pressed for dialog related to files.

Reference0
Either open, save, folder, or color.
Reference1
The event ID.
  • SSP
OnConfigurationDialogHelp

Occurs when a page is clicked from the Preferences dialog's help button.

Reference0

The dialog ID. The correspondence between the type and the page is as below.

  • setup …… general
  • ghost …… ghost (1)
  • ghost2 …… ghost (2)
  • folder …… folder
  • display …… display
  • dictation …… voice synthesis/recognition
  • talk …… talk/balloon
  • network …… connection (1)
  • network2 …… connection (2)
  • biff …… email
  • application …… external applications
  • messenger …… IM
  • ipmessenger …… IPMessenger
  • international …… international compatibility
  • developer …… development/other
Reference1
The dialog title.
Reference2
Page type: page name.
Reference3
The page contents text.
  • SSP
OnGhostTermsAccept

Occurs when the ghost's terms of use are agreed to.
No event occurs if the terms of use are closed using the upper right button.

  • SSP 2.5.33
OnGhostTermsDecline

Occurs when the ghost's terms of use are declined.
No event occurs if the terms of use are closed using the upper right button.

  • SSP 2.5.33

Time Events

OnSecondChange

Occurs every second.

When talking is disabled, the event is notified with NOTIFY, and Reference3 is 0. The returned script will be ignored.

Reference0
The length of time the OS has been running (in hours).
Reference1
1 if offscreen, 0 otherwise.
Reference2
1 if overlapped, 0 otherwise.
Reference3
1 if talking is enabled, 0 otherwise.
Reference4
※SSP only: The length of time since the last user interaction (at the OS level). The unit is seconds.
  • Materia
  • SSP
  • CROW
OnMinuteChange

Occurs every minute.

When talking is disabled, the event is notified with NOTIFY, and Reference3 is 0. The returned script will be ignored.

Reference0
The length of time the OS has been running (in hours).
Reference1
1 if offscreen, 0 otherwise.
Reference2
1 if overlapped, 0 otherwise.
Reference3
1 if talking is enabled, 0 otherwise.
Reference4
※SSP only: The length of time since the last user interaction (at the OS level). The unit is seconds.
  • Materia
  • SSP
  • CROW
OnHourTimeSignal

The time signal event. Occurs at the start of every hour (around x:00:00).

When talking is disabled, this event waits until it is enabled. Due to that, this event will occasionally be notified at inaccurate times.

Reference0
The length of time the OS has been running (in hours).
Reference1
1 if offscreen, 0 otherwise.
Reference2
1 if overlapped, 0 otherwise.
Reference3
Always 1 (exists to wait until talking is enabled).
Reference4
※SSP only: The length of time since the last user interaction (at the OS level). The unit is seconds.
  • SSP

Uninstall Events

OnVanishSelecting

Occurs when instructed to uninstall.

  • Materia
  • SSP
  • CROW
OnVanishSelected

Occurs when "YES" is selected for the confirmation dialog.

  • Materia
  • SSP
  • CROW
OnVanishCancel

Occurs when "NO" is selected for the confirmation dialog.

  • Materia
  • SSP
  • CROW
OnVanishButtonHold

Occurs when the uninstall event is interrupted by double clicking.

Reference0
The script during which the interruption occurred.
Reference1
The scope number of the balloon that was clicked to cause the interruption. 0 for the main character, 1 for the side character, and so on.
Reference2
The interruption position. Expressed with the number of characters from the beginning of the script. The number includes SakuraScript tags.
Ex: \s[2]abcde
When interrupted at "a," the number will be 6.
  • Materia
  • SSP
  • CROW
OnVanished

Occurs when booted due to the previous ghost being uninstalled.
In SSP, if no script is returned for the event (204), OnBoot will occur afterwards.
Furthermore, in SSP, if another ghost that was open at the same time is uninstalled and no script is returned for OnOtherGhostVanished, this event will occur instead. In this situation, OnBoot is not used as a fallback.

Reference0
The main character name of the ghost that was uninstalled.
Reference1
※SSP only: The OnVanishSelected event script of the ghost that was uninstalled.
Reference2
※SSP only: The name of the ghost that was uninstalled.
Reference7
※SSP only: The shell name of the ghost that was changed to.
  • Materia
  • SSP
  • CROW
OnOtherGhostVanished

Occurs when another ghost is uninstalled while multiple ghosts are open.

Reference0
The main character name of the ghost that was uninstalled.
Reference1
The OnVanishSelected event script of the ghost that was uninstalled.
Reference2
The name of the ghost that was uninstalled.
Reference7
The shell name of the ghost that was changed to.
  • SSP

Choice Events

OnChoiceSelect

Occurs when a choice is selected.

Reference0
The ID of the choice that was selected.
Reference*
※CROW only: The additional IDs of the choice.
  • Materia
  • SSP
  • CROW
OnChoiceSelectEx

Occurs when a choice is selected.
Starts before OnChoiceSelect.

Reference0
The choice text (label).
Reference1
The choice ID.
Reference*
Additional information (from the third argument onwards in a \q tag).
  • SSP
OnChoiceEnter

Occurs when the cursor is hovered over and when moved away from a choice.
When the cursor is moved away, the event occurs with no References.
[NOTIFY]

Reference0
The choice text (label).
Reference1
The choice ID.
Reference*
Additional information (from the third argument onwards in a \q tag).
  • Materia
  • SSP
  • CROW
OnChoiceTimeout

Occurs when a choice times out.

Reference0
The script that timed out.
  • Materia
  • SSP
  • CROW
OnChoiceHover

Occurs when the cursor stops over a choice.

Reference0
The choice text (label).
Reference1
The choice ID.
Reference*
Additional information (from the third argument onwards in a \q tag).
  • SSP
OnAnchorSelect

Occurs the moment an anchor (\_a) is clicked.

Reference0
The ID of the anchor that was selected.
  • Materia
  • SSP
  • CROW
OnAnchorSelectEx

Occurs the moment an anchor (\_a) is clicked. Only if SHIORI returns nothing to this event will OnAnchorSelect occur afterwards.

Reference0
The text of the anchor that was selected.
Reference1
The ID of the anchor that was selected.
Reference*
Additional information (from the second argument onwards in an \_a tag).
  • SSP

Surface Events

OnSurfaceChange

Occurs when a surface changes.
[NOTIFY]

Reference0
The main character's current surface.
Reference1
The side character's current surface.
Reference2
※SSP only: Character ID, surface number, width, height.
  • SSP
  • CROW
OnSurfaceRestore

Occurs once a set interval of time has passed after talking.
In SSP, this event occurs after the timeout interval set in the baseware settings + 15 seconds (in other words, 15 seconds after the balloon closes).
※Only in the case that the timeout interval is set to 0, the balloon will continue to be displayed until OnSurfaceRestore occurs.

Reference0
The main character's current surface.
Reference1
The side character's current surface.
  • Materia
  • SSP
  • CROW
OnOtherSurfaceChange

Occurs when another ghost's surface changes.
In order to reduce lag, this event is usually invalid. To use it, \![set,othersurfacechange,true] must be run first.

Reference0
The ghost name.
Reference1
The ghost's main character name.
Reference2
The ID of the window that changed surfaces. (Sakura=0)
Reference3
The ID of the new surface.
Reference4
The ID of the old surface.
Reference5
The size of the new surface. (Coordinates: left, up, right, down)
  • SSP

Mouse Events

OnMouseClick

Occurs when the ghost is left, right, or middle button mouse clicked (the moment after releasing a pressed button) and OnMouseUp does not apply.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click, 2 if a middle click (for compatibility reasons, changing to OnMouseClickEx is recommended).
Reference6
※SSP only: From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • Materia
  • SSP
  • CROW
OnMouseClickEx

Occurs when the ghost is clicked by a mouse button that is not the left or right button (the moment after releasing a pressed button) and OnMouseUpEx does not apply.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
"middle" if a wheel click (or a middle click on a three-button mouse), "xbutton1" if the 4th button (usually functions as a back button), "xbutton2" if the 5th button (typically functions as a forward button).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseDoubleClick

Occurs when the ghost is double-clicked with either the left or right button.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click.
Reference6
※SSP only: From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • Materia
  • SSP
  • CROW
OnMouseDoubleClickEx

Occurs when the ghost is double-clicked with a button that is not the left or right button.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
"middle" if a wheel click (or a middle click on a three-button mouse), "xbutton1" if the 4th button (usually functions as a back button), "xbutton2" if the 5th button (typically functions as a forward button).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseMultipleClick

Occurs when the ghost is clicked 3 or more times in a row.
※When there is no SHIORI response to this event, it will default to OnMouseClick or OnMouseDoubleClick instead.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character, and 2~ after that.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
Reference7
The number of times clicked.
  • SSP
OnMouseMultipleClickEx

Occurs when the ghost is clicked 3 or more times in a row with a button that is not the left or right button.
※When there is no SHIORI response to this event, it will default to OnMouseClickEx or OnMouseDoubleClickEx instead.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character, and 2~ after that.
Reference4
The collision identifier name.
Reference5
"middle" if a wheel click (or a middle click on a three-button mouse), "xbutton1" if the 4th button (usually functions as a back button), "xbutton2" if the 5th button (typically functions as a forward button).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
Reference7
The number of times clicked.
  • SSP
OnMouseUp

Occurs when either the left or right mouse button is released.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click, 2 if a middle click (for compatibility reasons, changing to OnMouseClickEx is recommended).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseUpEx

Occurs when a button that is not the left or right button is released.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
"middle" if a wheel click (or a middle click on a three-button mouse), "xbutton1" if the 4th button (usually functions as a back button), "xbutton2" if the 5th button (typically functions as a forward button).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseDown

Occurs when either the left or right mouse button is pressed.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click, 2 if a middle click (for compatibility reasons, changing to OnMouseClickEx is recommended).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseDownEx

Occurs when a button that is not the left or right button is pressed.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
"middle" if a wheel click (or a middle click on a three-button mouse), "xbutton1" if the 4th button (usually functions as a back button), "xbutton2" if the 5th button (typically functions as a forward button).
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseMove

Occurs when the mouse is moved.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
The amount that the mouse wheel has been scrolled, and the direction it was scrolled in.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
※SSP only: Always 0.
Reference6
※SSP only: From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • Materia
  • SSP
  • CROW
OnMouseWheel

Occurs when the mouse wheel is scrolled.
From SSP 2.3.53 onwards, in a touch-panel environment, if SHIORI does not return anything when OnMouseGesture's Reference5 is "up" or "down" (returns 204 No Content), OnMouseWheel will occur as a replacement event. In that situation, the numerical value of Reference2 will be converted from the original scroll amount and up/down direction (positive number if up, negative number if down).

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
The amount that the mouse wheel has been scrolled, and the direction it was scrolled in.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
※SSP only: Always 0.
Reference6
※SSP only: From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • Materia
  • SSP
  • CROW
OnMouseEnterAll

Occurs when the mouse enters a character window.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
Always 0.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseLeaveAll

Occurs when the mouse leaves a character window.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
Always 0.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseEnter

Occurs when the mouse enters a collision area.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
Always 0.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseLeave

Occurs when the mouse leaves a collision area.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
Always 0.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseDragStart

Occurs when mouse dragging is started. However, this event is disabled during Passive Mode.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
The amount that the mouse wheel has been scrolled, and the direction it was scrolled in.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseDragEnd

Occurs when mouse dragging is ended. However, this event is disabled during Passive Mode.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
The amount that the mouse wheel has been scrolled, and the direction it was scrolled in.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
0 if a left click, 1 if a right click.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseHover

Occurs when the mouse is being hovered over the ghost.

Reference0
The mouse cursor x coordinate (local coordinates).
Reference1
The mouse cursor y coordinate (local coordinates).
Reference2
Always 0.
Reference3
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference4
The collision identifier name.
Reference5
Always 0.
Reference6
From Windows 7 onwards, "touch" if the input is from a touch panel in a multi-touch supported environment (excludes touch pads), or "mouse" if the input is from a mouse.
  • SSP
OnMouseGesture

Occurs on dragging with the right button or wheel.
Furthermore, from SSP 2.3.53 onwards, in a touch-panel environment, if SHIORI does not return anything when OnMouseGesture's Reference5 is "up" or "down" (returns 204 No Content), OnMouseWheel will occur as a replacement event. Refer to OnMouseWheel's entry for details.

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The mouse cursor x and y coordinates (delimited by a 1-byte value).
Reference2
The collision identifier name.
Reference3
The mouse cursor x and y coordinates (delimited by a 1-byte value) when right dragging was started.
Reference4
The identifier name of the collision in which right dragging was started.
Reference5
The gesture direction.
left_up (upper left); up (up); right_up (upper right)
left (left); right (right)
left_down (lower left); down (down); right_down (lower right)
circle.cw (clockwise rotation); circle.ccw (counter-clockwise rotation)
end (the right mouse button is released)
Reference6
The gesture movement degree.
0 at the right to 360, counter-clockwise.
  • SSP

Balloon Events

OnBalloonBreak

Occurs when a balloon is broken for a reason other than SSTP.

Reference0
The script during which the breaking occurred.
Reference1
The scope number of the balloon that was broken. 0 if main character, 1 if side character, and so on.
Reference2
The interruption position. Expressed with the number of characters from the beginning of the script. The number includes SakuraScript tags.
Ex: \s[2]abcde
When interrupted at "a," the number will be 6.
  • SSP
OnBalloonClose

Occurs when a balloon is closed.

Reference0
The script that was being displayed when the balloon was closed.
  • SSP
OnBalloonTimeout

Occurs when a balloon without choices times out.

Reference0
The script that was being displayed when the balloon timed out.
Reference1
The remaining time.
  • SSP

Tray Balloon Events

OnTrayBalloonClick

Occurs when the tray icon balloon is closed via clicking.

Reference0
The title string.
Reference1
The displayed text.
  • SSP
OnTrayBalloonTimeout

Occurs when the tray icon balloon is closed via timing out or with the close button.

Reference0
The title string.
Reference1
The displayed text.
  • SSP

Install Events

OnInstallBegin

Occurs when an archive install begins.

  • Materia
  • SSP
  • CROW
OnInstallComplete

Occurs when an install finishes with no problems.

Reference0
The ※identifier of the installed file.
Reference1
The name of the installed file (the name specified in install.txt).
Reference2
The second name of the installed file (e.g. the balloon name when a balloon is bundled with a ghost).
  • Materia
  • SSP
  • CROW
OnInstallCompleteEx

Occurs when an install finishes with no problems.
If this event does not exist, OnInstallComplete will occur instead.

Reference0
The ※identifier of the installed file. When there are multiple, they are delimited by a 1-byte value.
Reference1
The name of the installed file. When there are multiple, they are delimited by a 1-byte value.
Reference2
The location of installation. When there are multiple, they are delimited by a 1-byte value.
  • SSP
OnInstallFailure

Occurs when installation has failed.

Reference0
The ※installation failure reason.
  • Materia
  • SSP
  • CROW
OnInstallRefuse

Occurs when the file being installed is specified to be for another ghost.

Reference0
The main character name of the ghost that was specified (the accept specification in install.txt, in other words the intended recipient of the file).
Reference1
The ※identifier of the file that failed to install.
Reference2
The name of the file that failed to install.
  • Materia
  • SSP Ref1 and onwards are from 2.4.85
  • CROW
OnInstallReroute

Occurs when the file being installed is specified to be for another ghost, and that ghost is open at the same time. Install events following this will occur for the intended recipient ghost.

Reference0
The main character name of the ghost that was specified (the accept specification in install.txt, in other words the intended recipient of the file).
Reference1
The ※identifier of the installed file.
Reference2
The name of the installed file.
  • SSP 2.4 / Ref1 and onwards are from 2.4.85

Installation identifiers

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

OnInstallComplete / OnNarCreated only

  • ghost with balloon
  • shell with balloon

SSP only

  • calendar skin
  • calendar plugin
  • package
  • language

Installation failure reasons

unlha32
Failed to load the dll to decompress the lzh format file.
extraction
Failed to decompress the file (file corruption).
invalid type
The install.txt is incomplete.
artificial
The installation was interrupted by the user (※SSP only).
unsupported
The archive is not supported.
password
The password was entered incorrectly on a password-locked archive (from SSP 2.5.09 onwards).

File Drop Events

OnFileDropping

Occurs when the cursor goes over the ghost while dragging a file.

Reference0
The path of the file being dragged.
Reference1
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • SSP
  • CROW
OnFileDropped

[Old specification] Occurs when a file is drag-and-dropped.

Reference0
The path of the file that was dropped.
Reference1
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • SSP
  • CROW
OnOtherObjectDropping

Occurs when the cursor goes over the ghost with something that cannot be treated as a "file". Example: "My Computer" in Windows.

Reference0
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
Reference1
The name of the dropped item (affected by the OS language setting).
Delimited by a 1-byte value when there are multiple.
Reference2
A kind of ID that for the dropped item that is not affected by the OS language settings.
Delimited by a 1-byte value when there are multiple. The following is an example on Windows.
  • PC (My computer) = ::{20D04FE0-3AEA-1069-A2D8-08002B30309D}
  • Recycle bin = ::{645FF040-5081-101B-9F08-00AA002F954E}
  • (My) Network = ::{F02C1A0D-BE21-4350-88B0-7367FC96EF3C}
  • SSP 2.6.41
OnOtherObjectDropped

Occurs when something is drag-and-dropped that cannot be treated as a "file". Example: "My Computer" in Windows.
Reference is exactly the same as OnOtherObjectDropping.

  • SSP 2.6.41
OnDirectoryDrop

Occurs when a directory is drag-and-dropped.

Reference0
The path of the directory that was dropped.
Reference1
The scope number of the character that the directory was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • SSP
  • CROW
OnWallpaperChange

Occurs when the wallpaper is changed by drag-and-dropping an image file.

Reference0
The path of the file that was dropped.
  • Materia
  • SSP
  • CROW
OnFileDrop

[Old specification] Occurs when a file is drag-and-dropped.

Reference0
The path of the file that was dropped.
Reference1
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • SSP
  • CROW
OnFileDrop2

Occurs when a file is drag-and-dropped.

Reference0
The path of the file that was dropped (delimited by a 1-byte value when there are multiple).
Reference1
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • Materia
  • SSP
  • CROW
OnFileDropEx

Occurs when a file is drag-and-dropped.

Reference0
The path of the file that was dropped (delimited by a 1-byte value when there are multiple).
Reference1
The scope number of the character that the file was dropped on. 0 if the main character, 1 if the side character, 2 if a 3rd character and so on.
  • SSP
OnUpdatedataCreating

Occurs when a ghost folder is drag-and-dropped.

  • Materia
  • SSP
  • CROW
OnUpdatedataCreated

Occurs when an updates2.dau has been created.

  • Materia
  • SSP
  • CROW
OnNarCreating

Occurs when a ghost folder containing an install.txt is drag-and-dropped.

Reference0
The name of the object to be made into a nar.
Reference1
The filename and absolute file path of the nar to be created.
Reference2
The ※identifier. Refer to the installation identifiers.
  • Materia
  • SSP
  • CROW
OnNarCreated

Occurs when a nar file has been created.

Reference0
The name of the object made into a nar.
Reference1
The filename and absolute file path of the nar that was created.
Reference2
The ※identifier. Refer to the installation identifiers.
  • Materia
  • SSP
  • CROW

URL Drop Events

OnURLDragDropping

Occurs when the mouse cursor is hovered over the ghost while dragging a URL.
This event will occur with every URL that has the potential to be processed.

Reference0
The dropped URL.
Reference1
The scope number of the character that the URL was dropped onto. 0 if the main character, 1 if the side character, 2 and above for the 3rd character and onwards.
  • SSP 2.6.37
OnURLDropping

Occurs when a download starts after a URL is dropped.
This event occurs before the download process. It will not occur with homeurl installing or feed (RSS) installing.

Reference0
The dropped URL.
Reference1
The scope number of the character that the URL was dropped onto. 0 if the main character, 1 if the side character, 2 and above for the 3rd character and onwards.
  • Materia
  • SSP Ref1 is from version 2.6.36
  • CROW
OnURLDropped

Occurs when the dropped URL has finished being received.
This event occurs before installing a NAR, immediately after the download process has finished. It will not occur with homeurl installing or feed (RSS) installing.

Reference0
The local path of the file that has been downloaded.
Reference1
The dropped URL.
Reference2
The scope number of the character that the URL was dropped onto. 0 if the main character, 1 if the side character, 2 and above for the 3rd character and onwards.
  • Materia
  • SSP Ref1,2 are from version 2.6.36
  • CROW
OnURLDropFailure

Occurs when the dropped URL could not be received or the operation was canceled.
This event occurs when a NAR installation fails. It will not occur with homeurl installing or feed (RSS) installing.

Reference0
The local path of the part of the file that was downloaded.
Reference1
The ※failure reason.
Reference2
The dropped URL.
Reference3
The scope number of the character that the URL was dropped onto. 0 if the main character, 1 if the side character, 2 and above for the 3rd character and onwards.
  • Materia
  • SSP Ref2,3 are from version 2.6.36
  • CROW
OnURLQuery

Notified when a URL is drag-and-dropped onto a character window.
If a script is returned for this event, the regular download process will be canceled.
Only return a script if the URL needs to be processed individually on the ghost side.

Reference0
The URL path.
Reference1
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference2
The MIME type of the URL that was dropped.
Reference3
The process that SSP plans to take in case there is no response.
One of "feed", "nar", "homeurl", or "unknown".
When "unknown", the URL is one that cannot be processed, and the nothing can be done on the baseware side.
The others are passed to \![execute,install,url] and the process continues.
  • SSP Ref3 is 2.6.35
OnXUkagakaLinkOpen

Notified by the specified ghost when a web association in the below format is opened or dropped on the ghost.
x-ukagaka-link:type=event&ghost=(the "name" or "sakura.name" in descript.txt)&info=(the string to be stored in Reference0)
The character encoding is fixed to UTF-8 + URL encoded
Ex: x-ukagaka-link:type=event&ghost=Emily&info=sweet-potato-feeding
SecurityLevel is always "external."

Reference0
info=The specified string (URL decoded).
  • SSP

Network Update Events

OnUpdateProcessExec

Occurs when instructed to execute an update, such as from the menu.
The update process can be customized by returning a script to this event.
The standard update process will be started automatically if there is nothing returned to this event.

Reference0
manual: The update was executed from the menu.
auto: The update was started by a setting to check for updates automatically at intervals.
testonly: The Update Full Check was run from the Dev. Palette.
  • SSP 2.6.23
OnUpdateBegin

Occurs when instructed to begin the network update.

Reference0
The ghost name.
Reference1
The full path.
Reference3
CROW: "ghost" if updating the ghost, "baseware" if updating the baseware.
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdateReady

Occurs when update files have been checked.

Reference0
The total number of files to be updated minus 1 (serial number starting from 0).
Reference1
A list of the names of the files to be updated, separated by commas.
Reference3
The update target class.
(shell ghost balloon headline plugin)
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdateComplete

Occurs when the network update is completed successfully.

Reference0
The ※network update success reason.
Reference1
A list of the names of the updated files, separated by commas.
Reference3
CROW: "ghost" if updating the ghost, "baseware" if updating the baseware.
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdateFailure

Occurs when the network update has failed.

Reference0
The ※network failure reason.
Reference1
A list of the names of the files to be updated, separated by commas.
※SSP only: The files that could not be updated.
Reference3
CROW: "ghost" if updating the ghost, "baseware" if updating the baseware.
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdate.OnDownloadBegin

Occurs when the file download begins.

Reference0
The name of the file being downloaded.
Reference1
(Other than CROW) The number of the file being downloaded (serial number starting from 0).
Reference2
(Other than CROW) The total number of files to be updated minus 1 (serial number starting from 0).
Reference3
※SSP only: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdate.OnMD5CompareBegin

Occurs when the MD5 comparison begins.

Reference0
The name of the file being compared.
Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdate.OnMD5CompareComplete

Occurs when the MD5 values match.

Reference0
The name of the downloaded file.
Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdate.OnMD5CompareFailure

Occurs when the MD5 values do not match.

Reference0
The name of the downloaded file.
Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
SSP: The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • Materia
  • SSP
  • CROW
OnUpdateOtherBegin

Occurs when instructed to begin a network update for something other than the ghost.

Reference0
The ghost name.
Reference1
The full path.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOtherReady

Occurs when update files for something other than the ghost have been checked.

Reference0
The total number of files to be updated minus 1 (serial number starting from 0).
Reference1
A list of the names of the files to be updated, separated by commas.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOtherComplete

Occurs when the network update for something other than the ghost is completed successfully.

Reference0
The ※network update success reason.
Reference1
A list of the names of the updated files, separated by commas.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOtherFailure

Occurs when the network update for something other than the ghost has failed.

Reference0
The ※network failure reason.
Reference1
A list of the names of the files to be updated, separated by commas.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOther.OnDownloadBegin

Occurs when the file download for something other than the ghost begins.

Reference0
The name of the file being downloaded.
Reference1
The number of the file being downloaded (serial number starting from 0).
Reference2
The total number of files to be updated minus 1 (serial number starting from 0).
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOther.OnMD5CompareBegin

Occurs when the MD5 comparison for something other than the ghost begins.

Reference0
The name of the file being compared.
Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOther.OnMD5CompareComplete

Occurs when the MD5 values for something other than the ghost match.

Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateOther.OnMD5CompareFailure

Occurs when the MD5 values for something other than the ghost do not match.

Reference1
The correct MD5 value.
Reference2
The MD5 value of the downloaded file.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The ※network update reason.
  • SSP
OnUpdateCheckComplete

Occurs when the network update check is completed successfully.

Reference0
The ※network update success reason.
Reference1
A list of the names of the updated files, separated by commas.
Reference3
The ※network update target class.
Reference4
SSP 2.3: The network update reason. "script" only.
  • SSP
OnUpdateCheckFailure

Occurs when the network update check has failed.

Reference0
The ※network failure reason.
Reference4
SSP 2.3: The network update reason. "script" only.
  • SSP
OnUpdateResult

Occurs when a network update is performed, and notifies all update results at once, including the balloon and shell packaged update functions.

Reference*
The update results are stored in the below format, in the order of update (\1 is the 1-byte value)

(※1)[\1](※2)[\1](※3)[\1](※4)
or
(※1)[\1](※2)[\1](※3)

  • ※1……The network update target class.
  • ※2……"OK" on success, "NG" on failure
  • ※3……If the update was successful, the number of updated files (0 when no new files=none), or if the update failed, network failure reason.
  • ※4……If the update failed and the file that caused the failure can be identified, the name of that file.
  • SSP
OnUpdateResultEx

Occurs when a network update is performed, and notifies all update results at once, including the balloon and shell packaged update functions.

Reference*
The update results are stored in the below format, in the order of update (\1 is the 1-byte value)

(※1)[\1](※2)[\1](※3)[\1](※4)[\1](※5)
or
(※1)[\1](※2)[\1](※3)[\1](※4)

  • ※1……The name of the network update target.
  • ※2……The network update target class.
  • ※3……"OK" on success, "NG" on failure
  • ※4……If the update was successful, the number of updated files (0 when no new files=none), or if the update failed, network failure reason.
  • ※5……If the update failed and the file that caused the failure can be identified, the name of that file.
  • SSP
OnUpdateCheckResult

Occurs at the end when the check only update option is selected. The explorer version of OnUpdateResult.

Reference*
The same as OnUpdateResult.
  • SSP
OnUpdateCheckResultEx

Occurs at the end when the check only update option is selected. The explorer version of OnUpdateResultEx.

Reference*
The same as OnUpdateResultEx.
  • SSP
OnUpdateResultExplorer

Occurs when a network update is performed from the Ghost Explorer. The explorer version of OnUpdateResult.

Reference*
The same as OnUpdateResult.
  • SSP

Network update success reasons

none
There were no new files.
changed
The update was completed.

Network failure reasons

timeout
The connection timed out.
too slow
This error message is not used in SSP and instead defaults to "timeout." The connection was too slow.
md5 miss
The MD5 values did not match.
artificial
The user interrupted the update process.
404 etc.
Failed for the reason of the status code.
fileio
※SSP only: Failed to write to the update target due to a lack of space.
readonly
※SSP only: Failed to write to the update target due to a read-only flag. Occurs when there is a read-only flag on the file or folder.
virusdetect
※SSP only: A potential virus was detected in the data. [2.5.15]
toomanyredirect
※SSP only: The process was stopped due to too many redirects. [2.5.15]
executing
※SSP only: The update is already in progress, so the second attempt was stopped. [2.5.26]
paramerror
※SSP only: The update couldn't be performed due to a setting mistake in the update tags. [2.5.26]

Network update target classes

  • ghost
  • shell
  • balloon
  • plugin
  • headline
  • ※CROW only: baseware

Network update reasons

auto
Automatic update, e.g. due to SSP settings etc.
manual
Manual update, e.g. the user selecting an option in the right-click menu.
script
Update due to SakuraScript tags (e.g. \![updatebymyself]).

Clock Fixing Events

OnSNTPBegin

Occurs when instructed to start the clock correction.

Reference0
The name of the server being connected to.
  • Materia
  • SSP
  • CROW
OnSNTPCompareEx

Occurs when the connection to the server has been established. A script containing the \6 tag must be returned in order to perform the clock correction.

Reference0
The name of the connected server.
Reference1
The current time on the server side, separated by commas: Year,month,day,hour,minute,second,millisecond
Reference2
The current time on the local side, separated by commas: Year,month,day,hour,minute,second,millisecond
Reference3
The time difference between the server and local sides, in seconds with numbers after the decimal point. If a positive value, the local time is behind the server; if a negative value, the local time is ahead of the server.
Reference4
The time difference between the server and local sides, in milliseconds as a whole number.
  • SSP 2.5.66
OnSNTPCompare

Occurs when the connection to the server has been established. A script containing the \6 tag must be returned in order to perform the clock correction.

Reference0
The name of the connected server.
Reference1
The current time on the server side, separated by commas: Year,month,day,hour,minute,second (if the time difference is less than a second, the time will be treated as being the same)
Reference2
The current time on the local side, separated by commas: Year,month,day,hour,minute,second
Reference3
The time difference between the server and local sides. Always a positive integer, in seconds.
Reference4
※SSP only: The time difference between the server and local sides. Always a positive integer, in milliseconds.
  • Materia
  • SSP
  • CROW
OnSNTPCorrectEx

Occurs when the local time is corrected to match the server time using the \6 tag.

Reference0
The name of the connected server.
Reference1
The current time on the server side, separated by commas: Year,month,day,hour,minute,second,millisecond
Reference2
The current time on the local side, separated by commas: Year,month,day,hour,minute,second,millisecond
Reference3
The time difference between the server and local sides, in seconds with numbers after the decimal point. If a positive value, the local time is behind the server; if a negative value, the local time is ahead of the server.
Reference4
The time difference between the server and local sides. An integer in milliseconds. Positive and negative values are the same as in Reference3.
  • SSP 2.5.66
OnSNTPCorrect

Occurs when the local time is corrected to match the server time using the \6 tag.

Reference0
The name of the connected server.
Reference1
The current time on the server side, separated by commas: Year,month,day,hour,minute,second (if the time difference is less than a second, the time will be treated as being the same)
Reference2
The current time on the local side, separated by commas: Year,month,day,hour,minute,second
Reference3
The time difference between the server and local sides, in seconds as a whole number. If a positive value, the local time is behind the server; if a negative value, the local time is ahead of the server.
Reference4
※SSP only: The time difference between the server and local sides, in milliseconds as a whole number.
  • Materia
  • SSP
  • CROW
OnSNTPFailure

Occurs when the clock correction failed.

Reference0
The name of the connected server.
  • Materia
  • SSP
  • CROW

Mail Checking Events

OnBIFFBegin

Occurs when instructed to start the mail check.

Reference2
The name of the email server being checked (account name if SSP or CROW).
  • Materia
  • SSP
  • CROW
OnBIFFComplete

Occurs when the mail check is completed successfully.

Reference0
The number of spooled emails, starting from 1.
Reference1
The byte count of the spooled emails.
Reference2
The name of the server being checked.
Reference3
The difference in the number of new emails.
Reference4
The TopResult of all emails, and the list of all POP transmission headers. Each email is delimited by 2-byte values, and each header is delimited by 1-byte values (usually, the information from Reference7 should be used).
Reference5
ListResult. The email server ID. Equivalent to the results of the POP command "LIST."
Reference6
UidlResult. The ID for differentiating emails. Equivalent to the results of the POP command "UIDL."
Reference7
The senders and titles delimited by the 1-byte value.
  • Materia
  • SSP
  • CROW
OnBIFF2Complete

Occurs when the number of spooled emails has increased.
In SSP, only occurs when there was no script returned to OnBIFFComplete.

Reference0
The number of spooled emails, starting from 1.
Reference1
The byte count of the spooled emails.
Reference2
The name of the mail server being checked (account name if SSP or CROW).
Reference3
The TopResult of all emails.
  • Materia
  • SSP
OnBIFFFailure

Occurs when the mail check has failed.

Reference0
※The failure reason.
Reference2
The name of the mail server being checked (account name if SSP or CROW).
  • Materia
  • SSP
  • CROW

Headline/RSS Sense Events

OnHeadlinesenseBegin

Occurs when instructed to start the headline sensor.

Reference0
The name of the site to sense the headline of.
Reference1
The URL to sense the headline of.
  • Materia
  • SSP
OnHeadlinesense.OnFind

Occurs when a headline to read was found.

Reference0
The name of the site to sense the headline of.
Reference1
The URL to sense the headline of.
Reference2
The ※OnFind phase.
Reference3
The headline contents. Contents have been sanitized on the baseware side.
SakuraScript for control may be added on the baseware side.
  • Materia
  • SSP
OnHeadlinesenseComplete

Occurs when the headline sensor is completed successfully.
Headline sensor success indicates the start of reading the headline, so this event is only notified when acquiration succeeded but there were no new updates.

Reference0
The ※ending reason. Currently limited to "no update."
  • Materia
  • SSP
OnHeadlinesenseFailure

Occurs when the headline sensor has failed.

Reference0
The ※ending reason.
  • Materia
  • SSP
OnRSSBegin

Occurs when instructed to start the RSS sensor. If there is no response to this event, OnHeadlineSenseBegin is called.

Reference0
The name of the site to sense the RSS of.
Reference1
The URL to sense the RSS of.
  • SSP
OnRSSComplete

Occurs when the RSS sensor is completed successfully. If there is no response to this event, a script appropriate to display is generated and a headline sensor completion event is called.

Reference0
When there are no updates: "no update" ※Ending reason.
When there are no updates, Reference0 will be the only reference, and contain only "no update."
When there are updates: The name of the RSS transmission site.
Reference1
Only when there are updates: The name of the RSS transmission URL (the URL that points to the site, not the feed itself).
Reference2~
Only when there are updates: Title [\1] URL [\1] Time of update (year,month,day,hour,minute,second delimited by commas) [\1] Creator name [\1] Contents or summary
When there are updates, the references continue from 0,1,2~ according to the number of RSS elements.
[\1] is the 1-byte value.
  • SSP Creator name, contents are from 2.4.10~
OnRSSFailure

Occurs when the RSS sensor has failed. If there is no response to this event, OnHeadlineSenseFailure is called.

Reference0
The ※ending reason.
  • SSP

Headline sense OnFind phases

First
Page 1.
First and Last
Page 1 when there is no next page.
Last
The last page.
Next
A page that fits none of the above descriptions.

Headline sense ending reasons

no update
There were no new updates (currently only applicable to OnHeadlinesenseComplete).
can't download
The file could not be downloaded.
can't analyze
The file was downloadable, but there was no valid headline to acquire.

Calendar Events

OnSchedule5MinutesToGo

Occurs five minutes before a scheduled reminder registered in the baseware calendar.

Reference0
The schedule type.
Reference1
The schedule contents (caption).
Reference2
The additional data (subtitle).
Reference3
The script (script).
  • SSP
OnScheduleRead

Occurs when the cursor is stopped over the calendar icon, at the timing of the scheduled reminder being read.

Reference0
The schedule type.
Reference1
The schedule contents (caption).
Reference2
The additional data (subtitle).
Reference3
The script (script).
  • SSP
OnSchedulesenseBegin

Occurs when the schedule sensor begins to connect.

Reference0
The schedule sensor name.
  • SSP
OnSchedulesenseComplete

Occurs when the schedule sensor has finished processing.

Reference0
The schedule sensor name.
Reference1
The number of schedule data returned by the schedule sensor.
  • SSP
OnSchedulesenseFailure

Occurs when the schedule sensor processing has failed.

Reference0
The failure reason (shared with the headline sensor).
  • SSP
OnSchedulepostBegin

Occurs when the schedule sensor begins to connect in post mode.

Reference0
The schedule sensor name.
  • SSP
OnSchedulepostComplete

Occurs when the schedule sensor has finished the posting process.

Reference0
The schedule sensor name.
  • SSP

Schedule types

default
Unrecognized events
event
General events
meeting
Meetings
appointment
Appointments
reservation
Reservations such as hospital appointments
duedate
Deadlines
party
Parties and get-togethers
date
Dates
work
Work events
go
Outings
tv
Television programs
recording
Timer recording reservations
cd
CD release dates
game
Game release dates
video
Video media release dates
book
Book release dates
release
Miscellaneous release dates

SSTP Events

OnSSTPBreak

Occurs when the SSTP is broken.

Reference0
The script during which the breaking occurred.
Reference1
The scope number of the balloon to which the breaking occurred. 0 if main character, 1 if side character, and so on.
Reference2
The interruption position. Expressed with the number of characters from the beginning of the script. The number includes SakuraScript tags.
Ex:\s[2]abcde
When interrupted at "a," the number will be 6.
  • Materia
  • SSP
OnSSTPBlacklisting

Occurs when the blacklisting of the final client is instructed.

Reference0
The IP address of the final client.
  • Materia

Other Transmission Events

OnExecuteHTTPComplete

Occurs when acquisition with execute-http is completed successfully.

Reference0
One of post/get/head/put/delete.
Reference1
The string specified by the --sync and --async options.
Reference2
The URL of the target.
Reference3
The contents of the acquired data, if the --nofile option has been specified. However, newline codes will be replaced with the 1-byte value.
Otherwise, the full path of the acquired file.
Reference4
The acquisition result code. (timeout|fileio|200|204|403|404) etc. Refer to [network failure reason].
Reference5
The cookie string.
Reference6
All of the acquired response headers. Delimited by the one-byte value rather than line breaks. [2.6.40]
  • SSP
OnExecuteHTTPFailure

Occurs when an acquisition error is caused with execute-http. References are the same as Complete.

  • SSP
OnExecuteHTTPProgress

Occurs when --progress-notify is specified in execute-http. References are the same as Complete.

  • SSP [2.6.44]
OnExecuteHTTPSSLInfo

Notified despite acquisition failure (outside of HTTP response 200), when a connection is successfully made on the SSL/TLS level.

Reference0
async ID (empty if there is no ID)
Reference1
The acquired URL.
Reference2
The http response code (notified even if an error occurs).
Reference3
The transmission version. These days, mostly "TLSv1/SSLv3" (SSP internally prevents SSLv2, so in actuality these are the only working versions).
Reference4
The encryption method.
Ex: AES256-SHA
Reference5
The place being published to. To check the name, take the string after /O=.
For programmers: The string has the results from passing through OpenSSL's X509_NAME_oneline.
Ex: /1.3.6.1.4.1.311.60.2.1.3=US/1.3.6.1.4.1.311.60.2.1.2=Delaware/businessCategory=Private Organization/serialNumber=4337446/C=US/postalCode=94107/ST=California/L=San Francisco/street=795 Folsom St, Suite 600/O=Twitter, Inc./OU=Twitter Operations/CN=twitter.com
Reference6
The validity period starting date and time. Year,month,day,hour,minute,second
Ex: 2011,7,7,9,0,0
Reference7
The validity period expiration date and time. Year,month,day,hour,minute,second
Ex: 2012,7,28,8,59,59
Reference8
The publisher. To check the name, take the string after /O=.
For programmers: The string has the results from passing through OpenSSL's X509_NAME_oneline.
Ex: /C=US/O=VeriSign, Inc./OU=VeriSign Trust Network/OU=Terms of use at https://www.verisign.com/rpa (c)06/CN=VeriSign Class 3 Extended Validation SSL CA
Reference9 (2.4.51~)
The certificate chain. Displays CommonName(CN) in order delimited by commas.
  • SSP
OnExecuteRSSComplete

Occurs when acquisition with \![execute,rss-get/post] is completed successfully.

Reference0~
Title [\1] URL [\1] Time of update (comma-separated format: Year,month,day,hour,minute,second) [\1] Creator name [\1] Contents or summary
When there are updates, the references continue from 0,1,2~ according to the number of RSS elements.
[\1] is the 1-byte value.
  • SSP Creator name/Contents 2.4.10~
OnExecuteRSSFailure

Occurs when an acquisition error is caused with \![execute,rss-get/post].

Reference0~
When the analysis fails, Reference4=parse. Otherwise, the same as OnExecuteHTTPFailure.
  • SSP
OnExecuteRSS_SSLInfo

Notified despite acquisition failure (outside of HTTP response 200), when a connection is successfully made on the SSL/TLS level.

Reference0~
The same as OnExecuteHTTPSSLInfo.
  • SSP
OnPingComplete

Occurs when the number of pings specified in \![execute,ping] have been executed.

Reference0
The string specified with --event.
Reference1
The source address [\1] The total number of pings sent [\1] The number of successful pings [\1] The number of failed pings
[\1] is the 1-byte value.
Reference2
"OK" or error information [\1] The reply address [\1] RTT (response time in milliseconds)
[\1] is the 1-byte value.
From Reference2 onwards, the information of each individual sent ping is recorded. "Progress" indicates an incomplete status.
Refer to ICMP_ECHO_REPLY Structure Status Headers for details on error information.
  • SSP
OnPingProgress

Occurs while executing pings with \![execute,ping].

Reference0
The string specified with --event.
Reference1
The source address [\1] The total number of pings sent [\1] The number of successful pings [\1] The number of failed pings
[\1] is the 1-byte value.
Reference2
"OK" or error information [\1] The reply address [\1] RTT (response time in milliseconds)
[\1] is the 1-byte value.
From Reference2 onwards, the information of each individual sent ping is recorded. "Progress" indicates an incomplete status.
Refer to ICMP_ECHO_REPLY Structure Status Headers for details on error information.
  • SSP
OnNSLookupComplete

Occurs when \![execute,nslookup] is completed successfully.

Reference0
The string specified with --event.
Reference1
The string specified with --host.
Reference2
"lookup" when performing a DNS lookup, "reverse" when performing a reverse DNS lookup.
Reference3
The search results. IP if a DNS lookup, host name if a reverse DNS lookup.
  • SSP
OnNSLookupFailure

Occurs when \![execute,nslookup] has failed.

Reference0
The string specified with --event.
Reference1
The string specified with --host.
Reference2
"lookup" when performing a DNS lookup, "reverse" when performing a reverse DNS lookup.
  • SSP

Event Transmission Failure Events

OnRaisePluginFailure

Occurs when \![raiseplugin] has failed.

Reference0
"notfound" when the plugin was not found.
"disabled" when the plugin was set to disabled.
Otherwise, 204 or other execution errors.
Reference1
The plugin name or ID.
Reference2
The ID of the event that should have been executed.
Reference3~
The References of the event that should have been executed.
  • SSP
OnNotifyPluginFailure

Occurs when \![notifyplugin] has failed.

Reference0
"notfound" when the plugin was not found.
"disabled" when the plugin was set to disabled.
Otherwise, 204 or other execution errors.
Reference1
The plugin name or ID.
Reference2
The ID of the event that should have been executed.
Reference3~
The References of the event that should have been executed.
  • SSP
OnRaiseOtherFailure

Occurs when \![raiseother] has failed.

Reference0
"notfound" when not found.
"timecritical" when during \t.
"passivemode" when during passive mode.
"inductionmode" when during induction mode.
"minimized" when minimized.
Otherwise, 204 or other execution errors.
Sometimes in a list delimited by the 1-byte value, e.g. when using __SYSTEM_ALL_GHOST__.
Reference1
The ghost name or \0 name.
Sometimes in a list delimited by the 1-byte value, e.g. when using __SYSTEM_ALL_GHOST__.
Reference2
The ID of the event that should have been executed.
Reference3~
The References of the event that should have been executed.
  • SSP
OnNotifyOtherFailure

Occurs when \![notifyother] has failed.

Reference0
"notfound" when not found.
"timecritical" when during \t.
"passivemode" when during passive mode.
"inductionmode" when during induction mode.
"minimized" when minimized.
Otherwise, 204 or other execution errors.
Sometimes in a list delimited by the 1-byte value, e.g. when using __SYSTEM_ALL_GHOST__.
Reference1
The ghost name or \0 name.
Sometimes in a list delimited by the 1-byte value, e.g. when using __SYSTEM_ALL_GHOST__.
Reference2
The ID of the event that should have been executed.
Reference3~
The References of the event that should have been executed.
  • SSP

Offscreen, Overlap Events

OnOverlap

Occurs when the character windows (surfaces) overlap.
Notified every time the overlap status changes, so it can also be used to detect when the ghost stops overlapping with some extra thinking.

Reference0
ID-ID [\1] ID-ID [\1] ID-ID ...
[\1] is the 1-byte value.
Ex: 0-1 [\1] 0-2 in which window 0 is overlapped with window 1, and window 0 is overlapped with window 2.
Reference1
In the same format as Reference0, the overlap status before it was changed (the same as Reference0 from the previous time this event occurred).
  • SSP
OnOtherOverlap

Occurs when the character windows (surfaces) overlap, including all other currently open ghosts. The global version of OnOverlap.
Notified every time the overlap status changes, so it can also be used to detect when the ghost stops overlapping with some extra thinking.
The ghost's own information is also included, so some caution should be used.

Reference0
Sakura Name/ID-Sakura Name/ID [\1] Sakura Name/ID-Sakura Name/ID [\1] Sakura Name/ID-Sakura Name/ID ...
[\1] is the 1-byte value.
Ex: Emily/0-Mari/1 [\1] Mari/0-Shochoutan/1
Reference1
In the same format as Reference0, the overlap status before it was changed (the same as Reference0 from the previous time this event occurred).
  • SSP
OnOffscreen

Occurs when the character windows (surfaces) leave or come back from outside of the screen (display area). Offscreen event.
Notified every time the offscreen status changes, so it can also be used to detect when the ghost comes back onscreen with some extra thinking.

Reference0
ID [\1] ID [\1] ID ...
[\1] is the 1-byte value.
Ex: 1 [\1] 2 in which window 1 and window 2 are offscreen.
Reference1
In the same format as Reference0, the offscreen status before it was changed (the same as Reference0 from the previous time this event occurred).
  • SSP
OnOtherOffscreen

Occurs when the character windows (surfaces) leave or come back from outside of the screen (display area), including all other currently open ghosts. The global version of OnOffscreen.
Notified every time the offscreen status changes, so it can also be used to detect when the ghost comes back onscreen with some extra thinking.
The ghost's own information is also included, so some caution should be used.

Reference0
Sakura Name/ID [\1] Sakura Name/ID [\1] Sakura Name/ID ...
[\1] is the 1-byte value.
Ex: Emily/1 [\1] Shochoutan/0
Reference1
In the same format as Reference0, the offscreen status before it was changed (the same as Reference0 from the previous time this event occurred).
  • SSP

Network Status Events

OnNetworkHeavy

Occurs when the server does not respond after a certain amount of time.

Reference0
※SSP only: The time until the timeout happened (in seconds).
Reference1
※SSP only: The elapsed time up to now (in seconds). [2.6.42+]
  • Materia
  • SSP
  • CROW
OnNetworkStatusChange

Occurs when the network connection status changes.
Notified with NOTIFY only immediately after booting.

Reference0
"online" or "offline."
Reference1
The list of IP addresses assigned to the current machine, delimited by the 1-byte value.
Reference2
The connection type. [SSP 2.4.22]
cellular: Wi-Fi hotspot tethering or a regular PPP (excluding PPPoE)
ethernet: Ethernet (wired LAN)
none: Not connected
wifi: Wireless LAN
wimax: WiMAX
other: Other unspecified
unknown: Failed to detect
Reference3
The value showing the upper limit of the transmission speed on the download side of the connection. The unit is MBps. [SSP 2.4.22]
Reference4
The value showing the estimated effective transmission speed on the download side of the connection. The unit is MBps. [SSP 2.5.26]
When in an environment where the transmission statistics cannot be obtained or the values are inaccurate, the value will be the same as Reference3.
Reference5
Notifies whether or not the connection line is metered or not. [SSP 2.6.15]
unknown: Undefined/unclear.
unrestricted: Unrestricted usage.
fixed: There is an upper limit on the amount of data with a fixed price.
variable: The connection is metered.
If the Windows 10/11 setting is metered, the value will be "fixed".
  • SSP

OS Status Events

OnScreenSaverStart

Occurs when the screensaver starts. [NOTIFY]

Reference0
The screensaver name.
Reference1
The path of the screensaver execution file.
Reference2
The idle time until the screensaver started (in seconds).
  • SSP
OnScreenSaverEnd

Occurs when the screensaver ends.

Reference0
The screensaver name.
Reference1
The path of the screensaver execution file.
Reference2
The idle time until the screensaver started (in seconds).
  • SSP
OnSessionLock

Occurs when the computer goes to the lockscreen while still logged in. On Windows, this also applies to fast user switching.
This event does not use NOTIFY, but whatever is being executed is not visible to the user, so some caution should be used.

  • SSP 2.5.50
OnSessionUnlock

Occurs when the computer has been returned to the regular screen from the lockscreen. On Windows, this also applies to fast user switching.

  • SSP 2.5.50
OnSessionDisconnect

Occurs when fast user switching is used to switch to another user's account.
On Windows, this event is notified along with OnSessionLock, and due to being forced to minimize, OnWindowStateMinimize also occurs.
This behavior is specific to Windows, and may not work in the same way on another OS.

  • SSP 2.5.53
OnSessionReconnect

Occurs when fast user switching is used to return to the original user's account.
On Windows, this event is notified along with OnSessionUnlock, and due to having been forced to minimize, OnWindowStateRestore also occurs.
This behavior is specific to Windows, and may not work in the same way on another OS.

  • SSP 2.5.53
OnCPULoadHigh

Occurs when the load on the CPU is high. (Currently activates when the load has stayed around 80% for a while.)

Reference0
The current CPU load %.
  • SSP 2.5.56
OnCPULoadLow

Occurs when the load on the CPU goes down from a high state. (Currently activates when the load has come down to below 60% after being detected as High.)

Reference0
The current CPU load %.
  • SSP 2.5.56
OnMemoryLoadHigh

Occurs when the memory usage is high. (Currently activates when the usage has stayed around 80% for a while.)

Reference0
The current usage %.
  • SSP 2.5.56
OnMemoryLoadLow

Occurs when the memory usage goes down from a high state. (Currently activates when the load has come down to below 60% after being detected as High.)

Reference0
The current usage %.
  • SSP 2.5.56
OnDisplayChange

Occurs when the resolution or color depth of the desktop (primary screen) is changed.[NOTIFY on booting, otherwise GET]

Reference0
The color depth after the change. (bpp)
Reference1
The resolution after the change. (width)
Reference2
The resolution after the change. (height)
  • SSP
  • CROW
OnDisplayHandover

Occurs when a window is moved over screens.[NOTIFY or GET]

Reference0
"init" (when initialization of the position is complete) or "update" (when updated after initialization).
"init" is notified when the window position is first decided after booting, and does not necessarily mean before OnBoot.
Reference1
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference2
The position and other information before moving.
Left, up, right, down, bit depth, primary monitor or otherwise (0/1)
Blank when "init."
Ex: 0,0,1600,900,32,1
Reference3
The position and other information after moving.
Left, up, right, down, bit depth, primary monitor or otherwise (0/1)
  • SSP 2.4.09
OnDisplayChangeEx

Occurs when the resolution or color depth of a screen is changed. Applies to multiple monitors. [NOTIFY on booting, otherwise GET]

Reference0
"init" (a notification during booting) or "update" (an update after booting).
Reference1~
Left, up, right, down, bit depth, primary monitor or otherwise (0/1), the taskbar position (left,top,right,bottom,unknown), the coordinates of where the taskbar is separated from the rest of the screen
Ex: 0,0,1600,900,32,1,bottom,1560
  • SSP 2.4.09/taskbar is 2.6.35
OnDisplayPowerStatus

Occurs when the monitor is turned on or off. Additionally occurs when a laptop is closed.

Reference0
1 = ON / 0 = OFF
  • SSP 2.4~
OnBatteryNotify

Notifies the remaining amount of battery. [NOTIFY on booting, otherwise GET]

Reference0
The remaining battery %.
Reference1
The remaining time. -1 when unknown.
Reference2
One of "offline" (running on battery power), "online" (currently charging), or "backup" (a backup power supply such as a UPS).
Reference3
Notifies a comma-delimited string containing the below statuses. Ex: low,charging
high: The remaining battery amount is 2/3 or higher
low: The remaining battery amount is 1/3 or lower (OnBatteryLow also occurs)
critical: The remaining battery amount is 5% or lower (OnBatteryCritical also occurs)
charging: The battery is being charged (OnBatteryChargingStart/Stop also occur)
no_battery: The battery has been removed
power_saving: Power saving mode is on (From SSP 2.3.94/From Windows 10)

On OSes earlier than Windows 7, the standards for high/low may differ.

  • SSP
OnBatteryLow

Occurs when the remaining battery amount has become low (when OnBatteryNotify's Reference3 is "low" or below).
The external application Kinoko has an event with the same name, so caution should be used.
This event has been implemented to be compatible with Kinoko.

Reference0~
The same as OnBatteryNotify. When Reference3 is "low," this event also occurs after OnBatteryNotify, so if an appropriate process is already defined for OnBatteryNotify in the ghost, nothing needs to be added for OnBatteryLow.
  • SSP
OnBatteryCritical

Occurs when the remaining battery amount has become critically low (when OnBatteryNotify's Reference3 is "critical" or below).
The external application Kinoko has an event with the same name, so caution should be used.
This event has been implemented to be compatible with Kinoko.

Reference0~
The same as OnBatteryNotify. When Reference3 is "critical," this event also occurs after OnBatteryNotify, so if an appropriate process is already defined for OnBatteryNotify in the ghost, nothing needs to be added for OnBatteryCritical.
  • SSP
OnBatteryChargingStart

Occurs when battery charging has been started.
A compatibility event for Ukagaka on Android.

Reference0~
The same as OnBatteryNotify.
  • SSP
OnBatteryChargingStop

Occurs when battery charging has been stopped. Whether the battery is full or not does not change this event.
A compatibility event for Ukagaka on Android.

Reference0~
The same as OnBatteryNotify.
  • SSP
OnDeviceArrival

Occurs when a device has been detected.

Reference*
The type, name, maker, and device file name in a list delimited by the 1-byte value.
  • SSP
OnDeviceRemove

Occurs when a device has been removed.

Reference*
The type, name, maker, and device file name in a list delimited by the 1-byte value.
  • SSP
OnTabletMode

Occurs when the OS is switched to an optimized state for functioning as a tablet.
Notified first immediately after booting using NOTIFY (cannot talk), and then using GET (can talk) when the state is changed.

Reference0
0 or 1: 1 when tablet mode, 0 when not tablet mode (when the OS is in an optimized state for functioning as a tablet).
  • SSP 2.5.02
OnDarkTheme

Occurs when the OS has been switched to the dark theme.
Notified first immediately after booting using NOTIFY (cannot talk), and then using GET (can talk) when the state is changed.

Reference0
0 or 1: 1 when using the dark theme setting for applications, 0 when using the default (light) theme for applications.
Reference1
0 or 1: 1 when using the dark theme setting for the system, 0 when using the default (light) theme for the system. (2.6.29)
  • SSP 2.5.02
OnOSUpdateInfo

Notifies the OS update check date, update execution date, and update history information.
Notified first immediately after booting using NOTIFY (cannot talk), and then using GET (can talk) a while after updating.

Reference0
The update check date in the format year,month,day,hour,minute,second, delimited by regular commas and using local time.
Reference1
The update execution date in the format year,month,day,hour,minute,second, delimited by regular commas and using local time.
Reference2~
The update history information in the below format. [\1] is the 1-byte value.
Status[\1]Error code[\1]Update time[\1]Update contents (title)
The status will be one of "not_started" (the update has not been started), "in_progress" (the update is in progress), "success" (the update was successful), "success_with_errors" (the update was successful with an error), "fail" (the update failed), "abort" (the update process was aborted), or "unknown" (the update status is unknown).
The error code will be 0 if no error occurred during the update, and will contain a non-0 error code otherwise. On Windows, the error code will be 8 digits in hexadecimal.
The update time will be in the format year,month,day,hour,minute,second, delimited by regular commas and using local time.
  • SSP 2.5.02
OnRecycleBinEmpty

Occurs when the Recycle Bin is emptied with \![execute,emptyrecyclebin].
OnRecycleBinEmptyFromOther is notified to all currently open ghosts, not only the ghost that ran the script.

Reference0
The number of files currently in the Recycle Bin (usually 0 as it was just emptied).
Reference1
The size of the files currently in the Recycle Bin in bytes (usually 0 as it was just emptied).
Reference2
The difference between the number of files currently in the Recycle Bin and the number before emptying (usually a negative value as it was just emptied).
Reference3
The difference between the size of files currently in the Recycle Bin and the size before emptying in bytes (usually a negative value as it was just emptied).
Reference4
1 if the Recycle Bin was emptied normally, 0 if an error occurred (including when it was empty to start with).
Reference5
The main character name of the ghost that ran the tag (sakuraname).
  • SSP 2.6.04/Ref4 is 2.6.35
OnRecycleBinEmptyFromOther

Sent to ghosts other than the one that emptied the Recycle Bin using \![execute,emptyrecyclebin].
The References are the same as OnRecycleBinEmpty.

  • SSP 2.6.35
OnRecycleBinStatusUpdate

Occurs when a file is thrown away into the Recycle Bin, or when the Recycle Bin is emptied manually using the Explorer, and is notified to all currently open ghosts.
Also notified when the ghost is first booted with [NOTIFY].

Reference0
The number of files currently in the Recycle Bin.
Reference1
The size of the files currently in the Recycle Bin in bytes.
Reference2
The difference between the number of files currently in the Recycle Bin and the number before the event occurred.
Reference3
The difference between the size of the files currently in the Recycle Bin and the size before the event occurred in bytes.
Reference4
Always 1 (a dummy Reference for compatibility with OnRecycleBinEmpty).
Reference5
Always empty (a dummy Reference for compatibility with OnRecycleBinEmpty).
  • SSP 2.6.04/Ref4 is 2.6.35

Selection Area Events

OnSelectModeBegin

Occurs when rectangle select mode has been entered after executing \![enter,selectrect].

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The select mode. Currently only "rect" is possible.
  • SSP
OnSelectModeCancel

Occurs when no selection was made or the selection area was empty after executing \![leave,selectrect].

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The select mode. Currently only "rect" is possible.
  • SSP
OnSelectModeComplete

Occurs when rectangle select mode is left by executing \![leave,selectrect].

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The select mode. Currently only "rect" is possible.
Reference2
The selection results (rectangular) in left, top, right, and bottom coordinates, delimited by commas.
  • SSP
OnSelectModeMouseDown

Occurs when the mouse button is pressed during select mode.

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The select mode. Currently only "rect" is possible.
Reference2
The mouse position in X (horizontal axis) and Y (vertical axis) coordinates, delimited by commas.
  • SSP
OnSelectModeMouseUp

Occurs when the mouse button is released during select mode.

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The select mode. Currently only "rect" is possible.
Reference2
The mouse position in X (horizontal axis) and Y (vertical axis) coordinates, delimited by commas.
  • SSP

Voice Recognition, Synthesis Events

OnSpeechSynthesisStatus

Occurs on booting and when the voice synthesis function is turned on or off.[NOTIFY/GET]

Reference0
0/1 (invalid/valid)
  • SSP 2.4.01
OnVoiceRecognitionStatus

Occurs on booting and when the voice recognition function is turned on or off.[NOTIFY/GET]

Reference0
0/1 (invalid/valid)
  • SSP 2.4.01
OnVoiceRecognitionWord

Occurs when a word is recognised with the voice recognition function.

Reference0
0 if the main character, 1 if the side character. SSP and CROW also handle 2 and onwards.
Reference1
The word that was recognized. The first time a name is spoken, it will be the character name, and it is preferable that this is used to open the menu.
  • SSP 2.4

Regarding the voice recognition and synthesis functions

When making use of the voice recognition and synthesis functions, refer to the SakuraScript specifications such as the \__v tag.

Other Events

OnKeyPress

Occurs when a key is pressed while the ghost is selected.

Reference0
The key that was pressed (the character that is written on the keyboard).
Reference1
The key that was pressed (Win32 virtual-key codes).
Reference2
※SSP only: The counter for long key presses.
Reference3
※SSP only: The ID of the character window that the key event was activated for.
Reference4
※SSP only: The additional keys, listed and delimited by commas. Ex: "ctrl,alt"
  • Materia
  • SSP
  • CROW
OnRecommendsiteChoice

Occurs when a link to a site is selected in the menu.

Reference0
The name of the site that was selected.
Reference1
The URL of the site that was selected.
Reference2
※SSP only: The URL/path to the thumbnail image displayed when the cursor is hovered over the option
Reference3
※SSP only: "recommend" or "portal"
Reference4
※SSP only: 0 or 1 (0=sakura, 1=kero)
Reference5
※SSP only: A value displaying how far down from the top the selected link's position is. (Be aware of the fact that this starts from 0 and not 1.)
  • Materia
  • SSP
  • CROW
OnTranslate

An event made to allow SHIORI to double as a translator function for MAKOTO.
Mainly sent as a response when a script is returned to the baseware as a result of a SHIORI Event using the GET command.
From the SHIORI Event that triggered OnTranslate, the script returned to the baseware through SHIORI internal operations is sent back to SHIORI once more, after baseware processes such as expanding environment variables. SHIORI can process a script a second time before returning it to the baseware again as the final script.
However, OnTranslate itself will not occur twice.

Reference0
The original script.
Reference1
※SSP only: "communicate" when using communicate.
"sstp-send" when SSTP SEND.
"owned" when Owned SSTP.
"remote" when non-local SSTP.
"notranslate" when specified not to translate.
"plugin-script" when a script from a plugin.
"plugin-event" when a response to an event from a plugin.
The applicable information is returned delimited by commas. ※When no information is applicable, this value is empty.
Reference2
※SSP only: The ID of the event that triggered the script. Empty when an event was not the source.
Reference3
※SSP only: The References of the above event, delimited by the one-byte value. Empty when an event was not the source.
  • Materia
  • SSP
  • CROW
OnAITalk

Occurs when random talk is requested, such as with the \a tag.

  • SSP
OnOtherGhostTalk

Occurs when another ghost talks. Needs to be turned on with \![set,otherghosttalk,true].

Reference0
The ghost name.
Reference1
The name of the ghost's main character.
Reference2
"break" if the talk was interrupted.
"communicate" when using communicate.
"sstp-send" when SSTP SEND.
"owned" when Owned SSTP.
"remote" when non-local SSTP.
"notranslate" when specified not to translate.
"plugin-script" when a script from a plugin.
"plugin-event" when a response to an event from a plugin.
The applicable information is returned delimited by commas.
Reference3
The ID of the event that caused the other ghost to talk.
Reference4
The contents of the script from the other ghost.
Reference5
The References that were passed to the other ghost, delimited by the one-byte value.
  • SSP
OnEmbryoExist

Occurs when materia.exe was already running when SSP booted.

  • SSP
OnNekodorifExist

Occurs when Nekodorif was already running when SSP booted.

  • SSP
OnSoundStop

Occurs when a sound has stopped playing.

Reference0
The name of the file that was played.
  • SSP
OnSoundError

Occurs when a sound process has failed.

Reference0
The command that played the sound that caused an error. "play" is currently the only possible value.
Reference1
The internal error code of the sound engine (a number).
Reference2
The name of the file that was played.
Reference3
The error message that the sound engine output.
  • SSP
OnTextDrop

Occurs when text data was drag-and-dropped.

Reference0
The text contents. (Line breaks are represented by the one-byte value.)
Reference1
The ID of the character that the text was drag-and-dropped onto.
  • SSP
OnShellScaling

Occurs when the shell scaling is changed.

Reference0
The horizontal scaling of the shell after the change (in percentage).
Reference1
The horizontal scaling of the shell before the change (in percentage).
Reference2
The vertical scaling of the shell after the change (in percentage).
Reference3
The vertical scaling of the shell before the change (in percentage).
  • SSP
OnBalloonScaling

Occurs when the balloon scaling is changed.

Reference0
The horizontal scaling of the balloon after the change (in percentage).
Reference1
The horizontal scaling of the balloon before the change (in percentage).
Reference2
The vertical scaling of the balloon after the change (in percentage).
Reference3
The vertical scaling of the balloon before the change (in percentage).
  • SSP 2.5
OnLanguageChange

Notified when the language setting has been changed, and immediately after booting.
When this event is notified directly after booting, it will always use NOTIFY, and cannot prompt talking in response.

Reference0
The language name (name).
Reference1
The language ID (langid).
Reference2
The full path of the folder containing the language setting files.
Reference3
The URL that the help information is listed on.
  • SSP 2.5

Notify Events

basewareversion

Notifies the baseware information. [NOTIFY]

Reference0
The version number.
Reference1
The baseware identification.
Reference2
※SSP only: The detailed version number.
  • SSP
  • CROW
hwnd

Notifies the hwnd. [NOTIFY]

Reference0
The ghost hwnd. Each scope is listed, delimited by the one-byte value.
Reference1
The balloon hwnd. Each scope is listed, delimited by the one-byte value.
  • Materia
  • SSP
uniqueid

Notifies the unique ID. [NOTIFY]

Reference0
The ghost's unique ID. Used when sending a particular SSTP.
  • Materia
  • SSP
capability

Notifies the state of the SHIORI capability extensions. [NOTIFY]

Reference*

Depending on the level of implementation, the below information is sent in individual References.
Note that header names are converted to lowercase when notified. Ex: SecurityLevel→securitylevel
Refer to the SHIORI/3.0 specifications.

request. (header name in lowercase)
The status of the SHIORI request. Ex: request.status
response.(header name in lowercase)
The status of the SHIORI response. Ex: response.marker
  • SSP
ownerghostname

Notifies the current ghost name. [NOTIFY]

Reference0
The current ghost name.
  • Materia
  • SSP
  • CROW
otherghostname

Notifies the main character names of the other currently open ghosts. [NOTIFY]

Reference*
The other open ghosts' main character names, main character surface number, and side character surface number, delimited by the one-byte value.
  • Materia
  • SSP
  • CROW
installedsakuraname

Notifies the sakura.name of currently installed ghosts. [NOTIFY]
It is always notified before the installedghostname.
It is also guaranteed that the Reference numbers in the installedsakuraname/installedkeroname/installedghostname, indicating the same ghost, will match.

Reference*
The sakura.name of the currently installed ghosts.
  • SSP 2.6.47
installedkeroname

Notifies the kero.name of currently installed ghosts. [NOTIFY]
It is always notified before the installedghostname.
It is also guaranteed that the Reference numbers in the installedsakuraname/installedkeroname/installedghostname, indicating the same ghost, will match.

Reference*
The kero.name of the currently installed ghosts.
  • SSP 2.6.47
installedghostname

Notifies the currently installed ghosts. [NOTIFY]

Reference*
The names of the currently installed ghosts.
  • Materia
  • SSP
  • CROW
installedshellname

Notifies the currently installed shells. [NOTIFY]

Reference*
The names of the currently installed shells.
  • SSP
  • CROW
installedballoonname

Notifies the currently installed balloons. [NOTIFY]

Reference*
The names of the currently installed balloons.
  • SSP
  • CROW
installedheadlinename

Notifies the currently installed RSS/headlines. [NOTIFY]

Reference*
The names of the currently installed RSS/headlines.
  • SSP
installedplugin

Notifies the currently installed plugins. [NOTIFY]

Reference*
The names and IDs of the currently installed plugins, delimited by the one-byte value.
  • SSP
configuredbiffname

Notifies a list of the configured email check accounts. Can be used with \![biff,(account name)]. [NOTIFY]

Reference*
The email account names.
  • SSP 2.5
ghostpathlist

Notifies the path to the ghost storage folder (the Ghost setting in SSP Preferences -> Folder). [NOTIFY]

Reference*
The absolute path to the ghost storage folder.
  • SSP
balloonpathlist

Notifies the path to the balloon storage folder (the Balloon setting in SSP Preferences -> Folder). [NOTIFY]

Reference*
The absolute path to the balloon storage folder.
  • SSP
headlinepathlist

Notifies the path to the headline storage folder (the Headline setting in SSP Preferences -> Folder). [NOTIFY]

Reference*
The absolute path to the headline storage folder.
  • SSP
pluginpathlist

Notifies the path to the plugin storage folder (the Plugin setting in SSP Preferences -> Folder). [NOTIFY]

Reference*
The absolute path to the plugin storage folder.
  • SSP
calendarskinpathlist

Notifies the path to the calendar skin storage folder. [NOTIFY]

Reference*
The absolute path to the calendar skin storage folder.
  • SSP
calendarpluginpathlist

Notifies the path to the calendar schedule sensor storage folder. [NOTIFY]

Reference*
The absolute path to the calendar schedule sensor storage folder.
  • SSP
rateofusegraph

Notifies the information from the rate of use graph. [NOTIFY]

Reference*

The following delimited by the one-byte value: the Sakura name, Kero name, boot count, boot time (minutes), boot time (percentage), (boot install vanish).

boot
When the ghost is currently opened.
install
When the ghost is installed.
vanish
When the information is left over from an uninstalled ghost.
  • SSP
enable_log

The ON/OFF state of the Dev. Palette's "Enable SHIORI Internal Log" option. [NOTIFY]
Refer to SHIORI Resource : log_path.

Reference0
1 if ON, 0 if OFF.
  • SSP
enable_debug

The ON/OFF state of the Dev. Palette's "Enable SHIORI Debug Mode" option. [NOTIFY]

Reference0
1 if ON, 0 if OFF.
  • SSP
OnNotifySelfInfo

Notifies the ghost's own information. [NOTIFY]

Reference0
The ghost name.
Reference1
The main character's name.
Reference2
The side character's name.
Reference3
The name of the current shell.
Reference4
The absolute path to the current shell.
Reference5
The name of the current balloon.
Reference6
The absolute path to the current balloon.
  • SSP
  • CROW
OnNotifyBalloonInfo

Notifies the information on the balloon currently being used. [NOTIFY]

Reference0
The name of the currently selected balloon.
Reference1
The full path of the currently selected balloon.
Reference2
The surface number list. [character ID + colon + list delimited by commas + space] Ex: 0:0,1,2,3 1:0,1
  • SSP
OnNotifyShellInfo

Notifies the information on the shell currently being used. [NOTIFY]

Reference0
The name of the currently selected shell.
Reference1
The full path of the currently selected shell.
Reference2
The surface number list. [comma delimited] Ex: 0,1,2,3,4,5,6,7,8,10,11
  • SSP
OnNotifyDressupInfo

Notifies the dressup information.
[NOTIFY] only on booting, and sent with [GET] upon user or menu operation.
Refer to OnDressupChanged, the event that occurs before this event.

Reference*
The following information, delimited by the one-byte value: [character ID, category name, part name, option, on-1/off-0, thumbnail path]
There are cases where multiple options are added, separated by commas.
Occurs as many times as there are dressup definitions.
What was changed can be detected by processing the difference between this and the previous notification's on/off status.
  • SSP
OnNotifyUserInfo

Notifies the user input information. Notified on boot and when the information is updated. [NOTIFY]

Reference0
The nickname.
Reference1
The name.
Reference2
The birth date (delimited by commas as the following: 2003,5,5).
Reference3
The gender. "male" (male), "female" (female), or "undef" (undefined).
  • SSP
OnNotifyOSInfo

Notifies the OS information. [NOTIFY]

Reference0
The OS, version, and display name. [delimited by commas]
Reference1
The CPU type, clock MHz, and additional information. [delimited by commas]
Reference2
The physical and virtual memory (KB). [delimited by commas]
Reference3
The uptime since the system was booted.
  • SSP
OnNotifyFontInfo

Notifies the fonts installed to the system. [NOTIFY]

Reference*
The font names.
  • SSP
OnNotifyInternationalInfo

Notifies the system's time zone, locale (language) name, and other internationalization-related information. [NOTIFY]

Reference0
Time offset from UTC. Unit is minutes. Negative value = early, positive value = late
For example, in the case of Japan Standard Time, it is 9 hours earlier, so it will be -540
Reference1
Whether Daylight Saving Time is in effect or not. Enabled = 1, Disabled = 0
Reference2
ISO3166 compliant 2-letter country name.
Reference3
ISO639 compliant 2-letter language name.
  • SSP