LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IStorefrontClientRuntimeCapability14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontClientRuntimeCapability : Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontClientStateCapability
Reports storefront client readiness and prepares a declarative client-start plan.

Remarks

The host owns process creation, exact-path restart, timeouts, and readiness polling. Providers should not kill or wait for client processes inside these methods. The inherited client-state capability supplies the installed client executable path that the host needs to start or restart it.

Inheritance and interfaces

Methods

GetClientRuntimeStateAsync 14.1 Beta

C#
System.Threading.Tasks.Task<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontClientRuntimeState> GetClientRuntimeStateAsync(System.Threading.CancellationToken cancellationToken)
Gets whether the installed storefront client is ready for game actions.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

The current client runtime state.

PrepareClientStartAsync 14.1 Beta

C#
System.Threading.Tasks.Task<Unbroken.LaunchBox.Plugins.GameLaunching.GameActionPlan?> PrepareClientStartAsync(System.Threading.CancellationToken cancellationToken)
Prepares the process-shaped plan used to start the storefront client.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

A client-start plan, or null when the client cannot be started.