LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

ImportActionArgs13.15

C#
public class Unbroken.LaunchBox.Plugins.ImportActionArgs
Supplies the chosen emulator import action, imported games, and progress callbacks.

Constructors

ImportActionArgs 13.15

C#
public ImportActionArgs(Unbroken.LaunchBox.Plugins.EmulatorImportAction action, System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IGame> games, System.Action<string, double?> reportProgress, System.Func<bool> isCancelled)
Initializes an emulator import action request.
action 13.15
The selected action.
games 13.15
The imported games on which to act.
reportProgress 13.15
The callback receiving status text and optional numeric progress.
isCancelled 13.15
The callback indicating whether cancellation was requested.

Properties

Action 13.15

C#
public Unbroken.LaunchBox.Plugins.EmulatorImportAction Action { get; }
Gets the import action selected by the user.

GamesImported 13.15

C#
public System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IGame> GamesImported { get; }
Gets the library games created by the import.

Methods

ReportActionProgress 13.15

C#
public void ReportActionProgress(string label, double? progress)
Forwards an import-action progress update to the host callback.
label 13.15
The status text to display.
progress 13.15
The numeric progress value, or null for indeterminate progress.

ShouldCancelAction 13.15

C#
public bool ShouldCancelAction()
Queries whether the host has requested cancellation.

Returns

Whether the action should stop.