LaunchBoxContributors
On this page

GameDiscoverySourceDescriptor14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameDiscovery

C#
public sealed class GameDiscoverySourceDescriptor
Describes a logical discovery source.

Constructors

GameDiscoverySourceDescriptor

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

Properties

  • DisplayNameGets the translatable source name.
  • IconResourceIdGets or initializes an optional package image resource ID.
  • InstalledGamesRequireAccountGets or initializes whether discovering installed games requires an account connection. Defaults to false.
  • LibraryGamesRequireAccountGets or initializes whether discovering the full library requires an account connection. Defaults to false.
  • SourceIdGets the logical source ID. It does not assign ownership to discovered games.

DisplayName

C#
public PluginText DisplayName { get; }
Gets the translatable source name.

IconResourceId

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

InstalledGamesRequireAccount

C#
public bool InstalledGamesRequireAccount { get; init; }
Gets or initializes whether discovering installed games requires an account connection. Defaults to false.

Remarks

Expose the account through the shared connection capabilities. The host can defer automatic discovery and offer login during interactive import. Local installation-state checks for previously discovered games are independent of this requirement.

LibraryGamesRequireAccount

C#
public bool LibraryGamesRequireAccount { get; init; }
Gets or initializes whether discovering the full library requires an account connection. Defaults to false.

Remarks

Expose the account through the shared connection capabilities. When no account is configured, automatic import may use installed discovery if it does not require an account. This declaration does not prevent the provider from returning local games in a partial library result.

SourceId

C#
public string SourceId { get; }
Gets the logical source ID. It does not assign ownership to discovered games.