IBigBoxMainViewModel7.10

Interface in Unbroken.LaunchBox.Plugins.Data

public interface IBigBoxMainViewModel

Provides plugin access to the Big Box interface.

Methods

PlayGame9.2Launches the specified game or additional application with the specified settings; uses the full game startup process including the startup screen if enabled.
Search11.3Performs a Big Box search and displays the games found.
ShowAllGamesDisplays the Big Box list of all games.
ShowDevelopersDisplays the Big Box developer browser.
ShowGameDisplays the selected game's details in the specified filter context.
ShowGames()Returns to the game list in the current navigation history.
ShowGames(FilterType, string)Displays a game list for the specified selection.
ShowGames(IPlatform)Displays a game list for the specified selection.
ShowGenresDisplays the Big Box genre browser.
ShowOnScreenKeyboardDisplays the on-screen keyboard and reports the entered text when editing finishes.
ShowOptionsDisplays the Big Box options menu.
ShowPlatformCategoriesDisplays the Big Box platform-category browser.
ShowPlatformsDisplays the Big Box platform browser.
ShowPlaylistsDisplays the Big Box playlist browser.
ShowPlayModesDisplays the Big Box play-mode browser.
ShowPublishersDisplays the Big Box publisher browser.
ShowRatingsDisplays the Big Box content-rating browser.
ShowRegionsDisplays the Big Box region browser.
ShowSeriesDisplays the Big Box series browser.
ShowSourcesDisplays the Big Box game-source browser.
ShowStatusesDisplays the Big Box game-status browser.
ShowSystemDisplays the Big Box system menu.

PlayGame 9.2

void PlayGame(
    IGame game,
    IAdditionalApplication app,
    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: The game to launch.

app: The game's additional application to launch. Leave null to launch the main game.

emulator: The specific emulator to use. Leave null to use the game's default emulator or no emulator at all.

overrideCommandLine: The overridden commandline parameters to use. Should be left null in most cases.

Search 11.3

void Search(string query)

Performs a Big Box search and displays the games found.

query: The string you are searching for

ShowAllGames

void ShowAllGames()

Displays the Big Box list of all games.

ShowDevelopers

void ShowDevelopers()

Displays the Big Box developer browser.

ShowGame

void ShowGame(IGame game, FilterType filterType)

Displays the selected game's details in the specified filter context.

game: The game to display.

filterType: The filter context used for navigation.

ShowGames()

void ShowGames()

Returns to the game list in the current navigation history.

ShowGames(FilterType, string)

void ShowGames(FilterType filterType, string filterValue)

Displays a game list for the specified selection.

filterType: The field used to group games.

filterValue: The field value to display.

ShowGames(IPlatform)

void ShowGames(IPlatform platform)

Displays a game list for the specified selection.

platform: The platform whose games are displayed.

ShowGenres

void ShowGenres()

Displays the Big Box genre browser.

ShowOnScreenKeyboard

void ShowOnScreenKeyboard(string text, Action<string> onFinished)

Displays the on-screen keyboard and reports the entered text when editing finishes.

text: The initial keyboard text.

onFinished: The callback that receives the resulting text.

ShowOptions

void ShowOptions()

Displays the Big Box options menu.

ShowPlatformCategories

void ShowPlatformCategories()

Displays the Big Box platform-category browser.

ShowPlatforms

void ShowPlatforms()

Displays the Big Box platform browser.

ShowPlaylists

void ShowPlaylists()

Displays the Big Box playlist browser.

ShowPlayModes

void ShowPlayModes()

Displays the Big Box play-mode browser.

ShowPublishers

void ShowPublishers()

Displays the Big Box publisher browser.

ShowRatings

void ShowRatings()

Displays the Big Box content-rating browser.

ShowRegions

void ShowRegions()

Displays the Big Box region browser.

ShowSeries

void ShowSeries()

Displays the Big Box series browser.

ShowSources

void ShowSources()

Displays the Big Box game-source browser.

ShowStatuses

void ShowStatuses()

Displays the Big Box game-status browser.

ShowSystem

void ShowSystem(bool rebuild)

Displays the Big Box system menu.

rebuild: Whether to rebuild the menu even if a system or options view is already active.