IBigBoxThemeElementPlugin7.10
Interface in Unbroken.LaunchBox.Plugins
public interface IBigBoxThemeElementPlugin
Implement this interface in order to add an element/control to a Big Box theme, access the data, and accept user input.
Methods
OnDownCalled whenever Down is pressed via the keyboard or controller.OnEnterCalled whenever Enter is pressed via the keyboard or controller.OnEscapeCalled whenever Escape is pressed via the keyboard or controller.OnLeftCalled whenever Left is pressed via the keyboard or controller.OnPageDownCalled whenever Page Down is pressed via the keyboard or controller.OnPageUpCalled whenever Page Up is pressed via the keyboard or controller.OnRightCalled whenever Right is pressed via the keyboard or controller.OnSelectionChangedCalled whenever a new platform, platform category, playlist, or game is selected in the Big Box interface.OnUpCalled whenever Up is pressed via the keyboard or controller.
OnDown
bool OnDown(bool held)
Called whenever Down is pressed via the keyboard or controller.
held- A value specifying whether the key or button was held down or not.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnEnter
bool OnEnter()
Called whenever Enter is pressed via the keyboard or controller.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnEscape
bool OnEscape()
Called whenever Escape is pressed via the keyboard or controller.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnLeft
bool OnLeft(bool held)
Called whenever Left is pressed via the keyboard or controller.
held- A value specifying whether the key or button was held down or not.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnPageDown
bool OnPageDown()
Called whenever Page Down is pressed via the keyboard or controller.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnPageUp
bool OnPageUp()
Called whenever Page Up is pressed via the keyboard or controller.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnRight
bool OnRight(bool held)
Called whenever Right is pressed via the keyboard or controller.
held- A value specifying whether the key or button was held down or not.
Returns
A value specifying whether input was handled or not. If true is returned, the input will not be sent back to Big Box.OnSelectionChanged
void OnSelectionChanged(
FilterType filterType,
string filterValue,
IPlatform platform,
IPlatformCategory category,
IPlaylist playlist,
IGame game
)
Called whenever a new platform, platform category, playlist, or game is selected in the Big Box interface.
filterType- The current filter type.
filterValue- The current filter value. May be null if no filter value is selected.
platform- The currently selected platform. May be null if no platform is selected.
category- The currently selected platform category. May be null if no platform category is selected.
playlist- The currently selected playlist. May be null if no playlist is selected.
game- The currently selected game. May be null if no game is selected.
OnUp
bool OnUp(bool held)
Called whenever Up is pressed via the keyboard or controller.
held- A value specifying whether the key or button was held down or not.