LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

GamePreparedAction14.1 Beta

C#
public class Unbroken.LaunchBox.Plugins.GameLaunching.GamePreparedAction
Describes one entry plan that the host executes for a selected integration.

Remarks

The host owns execution, cancellation, process adoption, focus, pause, scripts and session accounting. This is not an action pipeline or a plugin selection mechanism.

Constructors

GamePreparedAction 14.1 Beta

C#
public GamePreparedAction(Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPlan entryPlan, Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPresentation presentation = DirectExecution, Unbroken.LaunchBox.Plugins.GameLaunching.GameActionObservation observation = EntryProcessStarted)
Initializes a prepared action.
entryPlan 14.1 Beta
The executable, URI, document or shell entry plan.
presentation 14.1 Beta
Whether execution starts directly or opens integration-owned UI.
observation 14.1 Beta
Whether the host observes game installation state after starting the action. Starting a process is not proof of installation or removal.

Properties

EntryPlan 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPlan EntryPlan { get; }
Gets the entry plan.

Observation 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.GameLaunching.GameActionObservation Observation { get; }
Gets the observation required after the action starts.

Presentation 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPresentation Presentation { get; }
Gets the presentation of the action.

UseGameLaunchSettings 14.1 Beta

C#
public bool UseGameLaunchSettings { get; init; }
Gets or initializes whether a direct storefront launch uses the saved game arguments and script.

Remarks

Use for a game executable or shortcut, not a client. The host appends saved arguments and owns script cleanup. Emulator plans already contain expanded arguments and use the emulator's script; this flag does not append them again. Ignored for UI handoffs and non-launch actions.