14.1 Beta 1 SDK

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

ILaunchBoxMainViewModel9.2

public interface Unbroken.LaunchBox.Plugins.Data.ILaunchBoxMainViewModel

Provides plugin access to the LaunchBox interface. Added in LaunchBox and Big Box 9.2-beta-3.

Properties

string ArrangeBy { get; set; }
double BoxSize { get; set; }
object ContentBackgroundView { get; }
object ContentView { get; }
double ControlsBarHeight { get; set; }
object GameDetailsView { get; }
double GameDetailsWidth { get; set; }
string ImageGroup { get; }
bool ListView { get; }
double SideBarWidth { get; set; }

ArrangeBy 9.2

string ArrangeBy { get; set; }

Gets or sets the current arrange by value for the LaunchBox side bar.

BoxSize 9.2

double BoxSize { get; set; }

Gets or sets the current box size in the LaunchBox boxes view.

ContentBackgroundView 9.2

object ContentBackgroundView { get; }

Gets the current content background UI element.

ContentView 9.2

object ContentView { get; }

Gets the current content UI element.

ControlsBarHeight 9.2

double ControlsBarHeight { get; set; }

Gets or sets the height of the controls bar.

GameDetailsView 9.2

object GameDetailsView { get; }

Gets the current game details UI element.

GameDetailsWidth 9.2

double GameDetailsWidth { get; set; }

Gets or sets the width of the game details.

ImageGroup 9.2

string ImageGroup { get; }

Gets the current active image group that is in use in the LaunchBox boxes view.

ListView 9.2

bool ListView { get; }

Gets a value specifying whether or not the list view is active in LaunchBox.

SideBarWidth 9.2

double SideBarWidth { get; set; }

Gets or sets the width of the side bar.

Methods

void Close()
void EnterImagesView()
void EnterListView()
void Maximize()
void Minimize()
void PlayGame(Unbroken.LaunchBox.Plugins.Data.IGame game, Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication app, Unbroken.LaunchBox.Plugins.Data.IEmulator emulator, string overrideCommandLine)
void RefreshData()
void Restore()

Close 9.2

void Close()

Exits LaunchBox.

EnterImagesView 13.3

void EnterImagesView()

Sets the view to Images View if it isn't already.

EnterListView 13.3

void EnterListView()

Sets the view to List View if it isn't already.

Maximize 9.2

void Maximize()

Maximizes the LaunchBox window.

Minimize 9.2

void Minimize()

Minimizes the LaunchBox window.

PlayGame 9.2

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.

RefreshData 10.7

void RefreshData()

Refreshes and repopulates all data displayed in LaunchBox.

Restore 9.2

void Restore()

Restores the LaunchBox window if it has been maximized or minimized.