Shiny Language Reference

Language Reference > Handler Reference


OnHotkey

 

 

Called when the user selects an option from the tray menu

All Brass SSE plugins are given a submenu in the Brass tray menu. When the user selects a non-default option (default options are "Configure" and "Unload Plugin") from the tray menu this handler is called. The text of the selected menu option is passed as the function parameter.

To add items to the tray menu, use the tray menu functions in the Init handler.

Note that access to the tray menu is only available in the registered version of Brass, therefore if you rely on a tray menu option for access to critical functionality in your plugin you should provide an alternative method of accessing the functionality.

 

Parameters

szItem

The text of the item selected. You should perform a comparison on this text to find out what option was selected.