LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

EmulatorLaunchPreparationRequest14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Emulators.EmulatorLaunchPreparationRequest
Provides the context for preparing an emulator immediately before launch.

Constructors

EmulatorLaunchPreparationRequest 14.1 Beta

C#
public EmulatorLaunchPreparationRequest(Unbroken.LaunchBox.Plugins.Data.IEmulator emulator, Unbroken.LaunchBox.Plugins.Data.IGame game, string commandLine, Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication? application = null, Unbroken.LaunchBox.Plugins.Emulators.EmulatorRetroAchievementsCredentials? retroAchievementsCredentials = null)
Initializes an emulator launch-preparation request.
emulator 14.1 Beta
The configured emulator being launched.
game 14.1 Beta
The game being launched.
commandLine 14.1 Beta
The current emulator command line.
application 14.1 Beta
The additional application being launched, when applicable.
retroAchievementsCredentials 14.1 Beta
The RetroAchievements launch credentials, when available.

EmulatorLaunchPreparationRequest 14.1 Beta

C#
public EmulatorLaunchPreparationRequest(Unbroken.LaunchBox.Plugins.Data.IEmulator emulator, Unbroken.LaunchBox.Plugins.Data.IGame game, string commandLine, Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication? application, Unbroken.LaunchBox.Plugins.Emulators.EmulatorRetroAchievementsCredentials? retroAchievementsCredentials, Unbroken.LaunchBox.Plugins.Forms.IPluginConfigurationValues? emulatorSettings)
Initializes an emulator launch-preparation request with settings.
emulator 14.1 Beta
The configured emulator being launched.
game 14.1 Beta
The game being launched.
commandLine 14.1 Beta
The current emulator command line.
application 14.1 Beta
The additional application being launched, when applicable.
retroAchievementsCredentials 14.1 Beta
The RetroAchievements launch credentials, when available.
emulatorSettings 14.1 Beta
The settings the user saved for this emulator, when LaunchBox has settings to supply.

Properties

AppBeingLaunched 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Data.IAdditionalApplication? AppBeingLaunched { get; }
Gets the additional application being launched, when applicable.

CurrentCommandLine 14.1 Beta

C#
public string CurrentCommandLine { get; }
Gets the current emulator command line.

EmulatorBeingLaunched 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Data.IEmulator EmulatorBeingLaunched { get; }
Gets the configured emulator being launched.

EmulatorSettings 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Forms.IPluginConfigurationValues? EmulatorSettings { get; }
Gets the settings the user saved for this emulator, or null when LaunchBox has none to supply.

Remarks

This is null whenever the integration does not implement Unbroken.LaunchBox.Plugins.Emulators.IEmulatorSettingsProvider, and whenever the user has left the page's master switch off, which is how an emulator configured by hand keeps launching exactly as it did before the page existed. Prepare the launch from Unbroken.LaunchBox.Plugins.Emulators.EmulatorLaunchPreparationRequest.CurrentCommandLine alone when it is null. The values cannot resolve a declared Unbroken.LaunchBox.Plugins.Forms.PluginFormField.DefaultValue, because the page is never built at launch, so pass the declared default at every read site.

GameBeingLaunched 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Data.IGame GameBeingLaunched { get; }
Gets the game being launched.

RetroAchievementCredentials 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Emulators.EmulatorRetroAchievementsCredentials? RetroAchievementCredentials { get; }
Gets the RetroAchievements launch credentials, when available.