LaunchBoxContributors
On this page

IStorefrontClientRuntimeCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Components.Storefronts

C#
public interface IStorefrontClientRuntimeCapability
    : 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

C#
Task<StorefrontClientRuntimeState> GetClientRuntimeStateAsync(
    CancellationToken cancellationToken
)
Gets whether the installed storefront client is ready for game actions.
cancellationToken
A token used to cancel the operation.

Returns

The current client runtime state.

PrepareClientStartAsync

C#
Task<ActionPlan?> PrepareClientStartAsync(CancellationToken cancellationToken)
Prepares the process-shaped plan used to start the storefront client.
cancellationToken
A token used to cancel the operation.

Returns

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