LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IPlaylistGame7.10

C#
public interface Unbroken.LaunchBox.Plugins.Data.IPlaylistGame
Describes a playlist entry and the information used to resolve its library game.

Properties

GameFileName 7.10

C#
string GameFileName { get; set; }
Gets or sets the stored game filename used when resolving the playlist entry.

GameId 7.10

C#
string GameId { get; set; }
Gets or sets the identifier of the linked library game.

GamePlatform 7.10

C#
string GamePlatform { get; set; }
Gets or sets the stored platform name used when resolving the playlist entry.

GameTitle 7.10

C#
string GameTitle { get; set; }
Gets or sets the stored game title used when resolving the playlist entry.

LaunchBoxDbId 7.10

C#
int? LaunchBoxDbId { get; set; }
Gets or sets the LaunchBox Games Database identifier, or null when not linked.

ManualOrder 7.10

C#
int ManualOrder { get; set; }
Gets or sets the entry's position in the playlist's manual ordering.

PlaylistId 7.10

C#
string PlaylistId { get; }
Gets the playlist identifier.

Methods

GetActualGame 7.10

C#
Unbroken.LaunchBox.Plugins.Data.IGame GetActualGame()
Resolves this playlist entry to a library game using its stored identifiers and matching metadata.

Returns

The matching game, or null when no game can be resolved.