14.1 Beta 1 SDK

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

Unbroken.LaunchBox.Plugins

Classes

AddSaveArgs 13.16

Supplies the save to add and an optional overwrite decision callback.

AddSaveResponse 13.16

Reports the result of adding a save to an emulator.

AutomaticPlaylist 13.16

Describes a plugin-supplied playlist whose games are selected by criteria.

BooleanEmulatorImportAction 13.15

Describes an import action that the user enables or disables.

EmulatorActionArgs 13.13

Interface used for passing additional information to action related functionality

EmulatorBiosFile 13.13

BIOS file information for a given emulator

EmulatorBiosGroup 13.13

Groups BIOS files and specifies whether the group and all of its files are required.

EmulatorControllerAction 13.13

An action this controller can take

EmulatorControllerOption 13.13

An option this emulator can have set

EmulatorControllerVersion 13.13

Version of the emulator. Typically used to determine which versions can be installed

EmulatorImportAction 13.15

Describes an emulator-specific action offered during game import.

EmulatorInstallResponse 13.13

Reports whether an emulator installation succeeded and identifies the installed emulator.

EmulatorOptionArgs 13.13

Interface used for passing additional information to options related functionality

EmulatorPlugin 13.15

Provides the schema version 1 base class for emulator integrations.

EmulatorSupportResponse 13.13

Reports whether an emulator supports a platform and is recommended for it.

GetSavesArgs 13.16

Specifies the emulator, games, and additional applications to scan for saves.

GetSavesResponse 13.16

Reports the saves discovered by an emulator plugin.

ImportActionArgs 13.15

Supplies the chosen emulator import action, imported games, and progress callbacks.

InjectRetroAchievementsCredentialsArgs 13.22

Supplies RetroAchievements credentials and optional setting changes for an emulator.

InstallEmulatorArgs 13.13

Arguments passed to provide context to the installation request

ManualPlaylist 13.16

Describes a plugin-supplied playlist whose game entries are listed explicitly.

PlaylistBase 13.16

Provides common identity, presentation, and ordering settings for a plugin-supplied playlist.

PlaylistCriteria 13.16

Describes a field comparison used to select games for a plugin-supplied playlist.

PlaylistItem 13.16

List of items manually placed in a playlist. Will attempt to match a game to the item in priority order of: LaunchBox Games Database Id, Platform/GameTitle, Filename

PlaylistProviderPlugin 13.16

Plugin that can create playlists for use in LaunchBox or Big Box

PluginDataStoreGetArgs 14.1 Beta

Identifies a value to retrieve from a plugin data store.

PluginDataStoreRemoveArgs 14.1 Beta

Identifies a value to remove from a plugin data store.

PluginDataStoreSetArgs 14.1 Beta

Describes a value to store in a plugin data store.

PluginHelper 7.10

Used to provide logic, state information, and data to LaunchBox and Big Box plugins.

PluginResponse 13.13

Response class used to give feedback on plugin functionality

PluginSecretStoreGetArgs 14.1 Beta

Identifies a protected value to retrieve from a plugin secret store.

PluginSecretStoreRemoveArgs 14.1 Beta

Identifies a protected value to remove from a plugin secret store.

PluginSecretStoreSetArgs 14.1 Beta

Describes a protected value to store in a plugin secret store.

PluginText 14.1 Beta

Describes plugin-supplied text that LaunchBox can localize and format for the current user.

PrepareForLaunchArgs 13.22

Describes the emulator, game, and arguments for an upcoming launch.

PrepareForLaunchResponse 13.22

Reports whether launch may continue and any replacement command line.

ProvideResponse 13.16

Contains the outcome and lazy playlist sequence returned by a playlist provider.

RetroAchievementSupportResponse 13.22

Reports an emulator's RetroAchievements support and current configuration.

Structs

RetroAchievementCredentials 13.22

Contains the RetroAchievements username and authentication token supplied for an emulator.

Interfaces

IBigBoxThemeElementPlugin 7.10

Implement this interface in order to add an element/control to a Big Box theme, access the data, and accept user input.

IEmulatorWithCores 13.18

Provides the schema version 1 contract for emulator core selection.

IGameConfiguringPlugin 11.0

Implement this interface in order to handle specific game configuration events in LaunchBox and Big Box. Added in LaunchBox and Big Box 11.0-beta-3.

IGameLaunchingPlugin 9.2

Implement this interface in order to handle specific game launching events in LaunchBox and Big Box. Added in LaunchBox and Big Box 9.2-beta-3.

IGameMenuItemPlugin 7.10

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.

IGameMultiMenuItemPlugin 13.3

This plugin is similar to IGameMenuItemPlugin. The primary exceptions being that this interface allows you to create multiple menu items, and supports menu nesting

IPluginComponentMetadata 14.1 Beta

Supplies common metadata for a schema version 2 managed component.

IPluginDataStore 14.1 Beta

Provides persistent, non-secret storage scoped to the requesting plugin.

IPluginFileSystemStore 14.1 Beta

Provides a persistent file-system directory scoped to the requesting plugin.

IPluginLogger 14.1 Beta

Writes plugin diagnostics to the host's local debug log. Available through constructor injection.

Provides the file-system locations assigned to a plugin by LaunchBox or Big Box. A plugin can request these paths by declaring a public constructor with an Unbroken.LaunchBox.Plugins.IPluginPaths parameter.

IPluginSecretStore 14.1 Beta

Provides protected persistent storage scoped to the requesting plugin and current machine.

ISystemEventsPlugin 7.10

Implement this interface in order to handle system-wide events in LaunchBox and Big Box.

ISystemMenuItemPlugin 7.10

Implement this interface in order to add a non-game-specific menu item to the Tools menu in LaunchBox and/or the System menu in Big Box.

Enums

EmulatorControllerOptionTypes 13.13

Identifies the value type of a legacy emulator configuration option.