LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

GameActivitySourceDescriptor14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Activity.GameActivitySourceDescriptor
Describes a logical source independently of the package implementing it.

Constructors

GameActivitySourceDescriptor 14.1 Beta

C#
public GameActivitySourceDescriptor(string sourceId, Unbroken.LaunchBox.Plugins.PluginText displayName)
Creates a source descriptor.
sourceId 14.1 Beta
Stable lowercase ID of at most 128 ASCII letters, digits, dots, underscores or hyphens, starting with a letter or digit.
displayName 14.1 Beta
Plugin-owned translatable name.

Properties

DisplayName 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.PluginText DisplayName { get; }
Gets the translatable name.

GameIdNamespace 14.1 Beta

C#
public string? GameIdNamespace { get; init; }
Gets or initializes the external-ID namespace whose values are source-local game IDs.

Remarks

For example, storefront.steam or gamesdb. Omission requires optional GameData.IGameMatchCapability matching. Matching never assigns storefront ownership; ambiguous matches are skipped.

IconResourceId 14.1 Beta

C#
public string? IconResourceId { get; init; }
Gets or initializes an optional package image resource ID.

MaximumBatchSize 14.1 Beta

C#
public int MaximumBatchSize { get; init; }
Gets or initializes a positive batch limit; the host may request smaller batches.

SourceId 14.1 Beta

C#
public string SourceId { get; }
Gets the implementation-independent source ID.