Shiny Language Reference

Language Reference > Handler Reference

---

The Shiny Handler Reference

A guide to the use of the event handlers available to SSE plugins.

Note: the user input handlers are not currently listed here as they are self-explanatory. You may view a list of all available handlers by using the SSEdit Handler Wizardbar.

PreRegRead - Called to indicate the registry profile is about to be loaded

FirstLaunch - Called when Brass loads the plugin for the first time

RegRead - Called to load the registry profile, registry functions are valid here

PostRegRead - Indicates registry profile loading has completed

PostRegReadFail - Indicates a critical error ocurred during profile load

Init - Called when the plugin starts up for one time initialization

Render - Called to instruct the plugin to draw it's display, drawing functions are valid here.

PostRender - Indicates a Render cycle has completed. Drawing is not valid here.

PreDisplayConfig - Indicates the user is about to open the plugin config dialog

DisplayConfigOK - Indicates the user clicked OK to dismiss the plugin config dialog

DisplayConfigCancel - Indicates the user clicked Cancel to dismiss the plugin config dialog

PostDisplayConfig - Called after the config dialog has been destroyed, regardless of whether OK or Cancel was used

OnHotkey - Called when the user presses the system-global hotkey configured for the plugin

FinishDrag - Called after the user has dragged the display panel to a new position

FinishResize - Called after the user has resized the display panel

OnTrayMenu - Called when the user selects an item from the plugin tray menu

Update - Called constantly during the life of the plugin, perform asynchronous (multithreaded) operations here

Shutdown - Indicates the plugin is about to be unloaded

PreRegWrite - Called to indicate the registry profile is about to be saved

RegWrite - Called to write the registry profile, registry functions are valid here

PostRegWrite - Indicates registry profile saving has completed

PostRegWriteFail - Indicates a critical error ocurred during profile writing

ShutdownEnd - The last handler called for any final cleanup, the plugin is unloaded immediately after this handler returns