LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

StorefrontGamePreparedAction14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGamePreparedAction : Unbroken.LaunchBox.Plugins.GameLaunching.GamePreparedAction
Describes one process-shaped storefront action selected by the provider.

Remarks

Providers select one truthful plan before returning. Arbitrary provider-authored action-step sequences are intentionally not part of this contract.

Inheritance and interfaces

Constructors

StorefrontGamePreparedAction 14.1 Beta

C#
public StorefrontGamePreparedAction(Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPlan entryPlan, Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPresentation presentation = DirectExecution, Unbroken.LaunchBox.Plugins.GameLaunching.GameActionObservation observation = EntryProcessStarted, Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderGameData? proposedProviderData = null, Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameActionPrerequisite prerequisite = None)
entryPlan 14.1 Beta
The process-shaped entry plan.
presentation 14.1 Beta
How the host should present and execute the plan.
observation 14.1 Beta
The evidence the host should use to determine progress or completion.
proposedProviderData 14.1 Beta
Optional updated provider game data for the host to persist.
prerequisite 14.1 Beta
A host-owned client prerequisite that must be fulfilled first. A client prerequisite requires Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontClientRuntimeCapability and an installed client executable path.

Properties

Prerequisite 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameActionPrerequisite Prerequisite { get; }
Gets the host-owned client prerequisite that must be fulfilled first.

Remarks

A provider returning a client prerequisite must implement Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontClientRuntimeCapability and report an installed client with a known executable path through Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontClientStateCapability.

ProposedProviderData 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderGameData? ProposedProviderData { get; }
Gets optional updated provider game data for the host to persist.