LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

IBigBoxMainViewModel7.10

C#
public interface Unbroken.LaunchBox.Plugins.Data.IBigBoxMainViewModel
Provides plugin access to the Big Box interface.

Methods

PlayGame 9.2

C#
void PlayGame(Unbroken.LaunchBox.Plugins.Data.IGame game, Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication app, Unbroken.LaunchBox.Plugins.Data.IEmulator emulator, string overrideCommandLine)
Launches the specified game or additional application with the specified settings; uses the full game startup process including the startup screen if enabled.
game 9.2
The game to launch.
app 9.2
The game's additional application to launch. Leave null to launch the main game.
emulator 9.2
The specific emulator to use. Leave null to use the game's default emulator or no emulator at all.
overrideCommandLine 9.2
The overridden commandline parameters to use. Should be left null in most cases.

Search 11.3

C#
void Search(string query)
Performs a Big Box search and displays the games found.
query 11.3
The string you are searching for

ShowAllGames 7.10

C#
void ShowAllGames()
Displays the Big Box list of all games.

ShowDevelopers 7.10

C#
void ShowDevelopers()
Displays the Big Box developer browser.

ShowGame 7.10

C#
void ShowGame(Unbroken.LaunchBox.Plugins.Data.IGame game, Unbroken.LaunchBox.Plugins.Data.FilterType filterType)
Displays the selected game's details in the specified filter context.
game 7.10
The game to display.
filterType 7.10
The filter context used for navigation.

ShowGames 7.10

C#
void ShowGames()
Returns to the game list in the current navigation history.

ShowGames 7.10

C#
void ShowGames(Unbroken.LaunchBox.Plugins.Data.FilterType filterType, string filterValue)
Displays a game list for the specified selection.
filterType 7.10
The field used to group games.
filterValue 7.10
The field value to display.

ShowGames 7.10

C#
void ShowGames(Unbroken.LaunchBox.Plugins.Data.IPlatform platform)
Displays a game list for the specified selection.
platform 7.10
The platform whose games are displayed.

ShowGenres 7.10

C#
void ShowGenres()
Displays the Big Box genre browser.

ShowOnScreenKeyboard 7.10

C#
void ShowOnScreenKeyboard(string text, System.Action<string> onFinished)
Displays the on-screen keyboard and reports the entered text when editing finishes.
text 7.10
The initial keyboard text.
onFinished 7.10
The callback that receives the resulting text.

ShowOptions 7.10

C#
void ShowOptions()
Displays the Big Box options menu.

ShowPlatformCategories 7.10

C#
void ShowPlatformCategories()
Displays the Big Box platform-category browser.

ShowPlatforms 7.10

C#
void ShowPlatforms()
Displays the Big Box platform browser.

ShowPlaylists 7.10

C#
void ShowPlaylists()
Displays the Big Box playlist browser.

ShowPlayModes 7.10

C#
void ShowPlayModes()
Displays the Big Box play-mode browser.

ShowPublishers 7.10

C#
void ShowPublishers()
Displays the Big Box publisher browser.

ShowRatings 7.10

C#
void ShowRatings()
Displays the Big Box content-rating browser.

ShowRegions 7.10

C#
void ShowRegions()
Displays the Big Box region browser.

ShowSeries 7.10

C#
void ShowSeries()
Displays the Big Box series browser.

ShowSources 7.10

C#
void ShowSources()
Displays the Big Box game-source browser.

ShowStatuses 7.10

C#
void ShowStatuses()
Displays the Big Box game-status browser.

ShowSystem 7.10

C#
void ShowSystem(bool rebuild)
Displays the Big Box system menu.
rebuild 7.10
Whether to rebuild the menu even if a system or options view is already active.