LaunchBoxContributors
On this page

GameMatchResult14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public sealed class GameMatchResult
Contains match candidates and diagnostics.

Constructors

GameMatchResult

C#
public GameMatchResult(
    IReadOnlyCollection<GameMatchCandidate> candidates,
    bool isComplete = true,
    IReadOnlyCollection<GameDataDiagnostic>? diagnostics = null
)
Creates a match result.
candidates
Candidates in preference order; empty when nothing matched.
isComplete
Whether the search itself completed; a complete empty result means no match.
diagnostics
Optional diagnostics.

Properties

  • CandidatesGets the candidates.
  • DiagnosticsGets diagnostics.
  • ExternalIdsGets or initializes identifiers discovered for the input file, such as a content fingerprint, even when no source game matched.
  • IsCompleteGets whether the search completed.

Candidates

C#
public IReadOnlyCollection<GameMatchCandidate> Candidates { get; }
Gets the candidates.

Diagnostics

C#
public IReadOnlyCollection<GameDataDiagnostic> Diagnostics { get; }
Gets diagnostics.

ExternalIds

C#
public IReadOnlyCollection<GameExternalId> ExternalIds { get; init; }
Gets or initializes identifiers discovered for the input file, such as a content fingerprint, even when no source game matched.

Remarks

These describe the input, not every candidate. Hosts decide whether to retain this evidence; an incomplete result must not clear previously saved identifiers.

IsComplete

C#
public bool IsComplete { get; }
Gets whether the search completed.