LaunchBoxContributors
On this page

ImportActionArgs13.15

Class in Unbroken.LaunchBox.Plugins

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

Constructors

ImportActionArgs

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

Properties

  • ActionGets the import action selected by the user.
  • GamesImportedGets the library games created by the import.

Action

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

GamesImported

C#
public IList<IGame> GamesImported { get; }
Gets the library games created by the import.

Methods

ReportActionProgress

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

ShouldCancelAction

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

Returns

Whether the action should stop.