Shiny Language Reference
Language Reference > Handler Reference
OnHotkey
Called when the user presses the system-global hotkey
All Brass SSE plugins automatically have access to the standard configuration dialog that allows the user to configure the panel background, transparency, visibility etc. One of the options provided in the configuration dialog is the ability to configure a system-wide hotkey. In many plugins this hotkey is used to pop the display panel to the front of the screen when pressed.
When the user presses the system-wide hotkey for the plugin, this handler is called. You are responsible for providing all code to act on the hotkey press (to pop the panel to the front, use the panel functions). Note that there are a number of reasons this handler may not be called when the configured hotkey is pressed. Firstly the user may have disabled hotkey access to plugins in the Brass configuration settings. Second, if the user has tried to use a hotkey already registered by another application Brass will be unable to register the hotkey for the plugin. Therefore no hotkey message will be sent to Brass.
Parameters
None