LaunchBoxContributors
On this page

IGameMenuItemPlugin7.10

Interface in Unbroken.LaunchBox.Plugins

C#
public interface IGameMenuItemPlugin
Implement this interface in order to add a game-specific menu item to the right-click menu in LaunchBox and/or the game details menu in Big Box.

Properties

  • CaptionGets a value specifying the text to show on the menu item.
  • IconImageGets a value specifying the icon image to use for the menu item in LaunchBox. This property is not used in Big Box.
  • ShowInBigBoxGets a value specifying whether to show the menu item in the Big Box game details menu.
  • ShowInLaunchBoxGets a value specifying whether to show the menu item in the LaunchBox right-click menu.
  • SupportsMultipleGamesGets a value specifying whether the menu item should be accessible when multiple games are selected at once.

Caption

C#
string Caption { get; }
Gets a value specifying the text to show on the menu item.

IconImage

C#
Image IconImage { get; }
Gets a value specifying the icon image to use for the menu item in LaunchBox. This property is not used in Big Box.

ShowInBigBox

C#
bool ShowInBigBox { get; }
Gets a value specifying whether to show the menu item in the Big Box game details menu.

ShowInLaunchBox

C#
bool ShowInLaunchBox { get; }
Gets a value specifying whether to show the menu item in the LaunchBox right-click menu.

SupportsMultipleGames

C#
bool SupportsMultipleGames { get; }
Gets a value specifying whether the menu item should be accessible when multiple games are selected at once.

Methods

  • GetIsValidForGameUsed to determine whether the menu item is valid for the selected game. If not valid, the menu item will be disabled in LaunchBox or hidden in Big Box.
  • GetIsValidForGamesUsed to determine whether the menu item is valid for the selected games when multiple games are selected. If not valid, the menu item will be disabled in LaunchBox. Multiple selections are currently not used in Big Box.
  • OnSelected(IGame)Called when the menu item is clicked or selected for a particular game.
  • OnSelected(IGame[])Called when the menu item is clicked or selected for multiple games.

GetIsValidForGame

C#
bool GetIsValidForGame(IGame selectedGame)
Used to determine whether the menu item is valid for the selected game. If not valid, the menu item will be disabled in LaunchBox or hidden in Big Box.
selectedGame
The game that is currently selected.

Returns

A value specifying whether the menu item is valid for the selected game.

GetIsValidForGames

C#
bool GetIsValidForGames(IGame[] selectedGames)
Used to determine whether the menu item is valid for the selected games when multiple games are selected. If not valid, the menu item will be disabled in LaunchBox. Multiple selections are currently not used in Big Box.
selectedGames
An array of games that represent all the currently selected games.

Returns

A value specifying whether the menu item is valid for the selected games.

OnSelected(IGame)

C#
void OnSelected(IGame selectedGame)
Called when the menu item is clicked or selected for a particular game.
selectedGame
The currently-selected game that the menu item was called for.

OnSelected(IGame[])

C#
void OnSelected(IGame[] selectedGames)
Called when the menu item is clicked or selected for multiple games.
selectedGames
An array of games that represent the currently-selected games that the menu item was called for.