14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
IPlatformCategory7.10
public interface Unbroken.LaunchBox.Plugins.Data.IPlatformCategoryProvides plugin access to a category in the platform hierarchy.
Properties
string BackgroundImagePath { get; }string BannerImagePath { get; }string ClearLogoImagePath { get; }string DeviceImagePath { get; }bool HideInBigBox { get; }string Name { get; }string NestedName { get; set; }string Notes { get; set; }string SortTitle { get; set; }string SortTitleOrTitle { get; }string VideoPath { get; set; }
BackgroundImagePath 7.10
string BackgroundImagePath { get; }Gets the selected background image path.
BannerImagePath 7.10
string BannerImagePath { get; }Gets the selected banner image path.
ClearLogoImagePath 7.10
string ClearLogoImagePath { get; }Gets the selected clear-logo image path.
DeviceImagePath 7.10
string DeviceImagePath { get; }Gets the selected device image path.
HideInBigBox 13.1
bool HideInBigBox { get; }Gets whether the current Big Box visibility rules hide this item.
Name 7.10
string Name { get; }Gets the display name.
NestedName 8.8
string NestedName { get; set; }Gets or sets the name used for this item in the platform hierarchy.
Notes 7.10
string Notes { get; set; }Gets or sets the descriptive notes, which may contain formatting.
SortTitle 7.10
string SortTitle { get; set; }Gets or sets the alternate title used for sorting.
SortTitleOrTitle 7.10
string SortTitleOrTitle { get; }Gets the sorting title, falling back to the display title when no sorting title is set.
VideoPath 7.10
string VideoPath { get; set; }Gets or sets the configured video path.
Methods
Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool includeHidden, bool includeBroken)Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IPlatform> GetChildren()int GetGameCount(bool includeHidden, bool includeBroken)int GetGameCount(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)string GetNewPlatformLogoPath(string url)string GetNewPlatformVideoPath(string url)string GetPlatformVideoPath(bool fallBackToGameVideos = true, bool allowThemePath = true)bool HasGames(bool includeHidden, bool includeBroken)bool HasGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)
GetAllGames 7.10
Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool includeHidden, bool includeBroken)GetAllGames 8.2
Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)Returns games that satisfy the visibility and media filters.
includeHidden8.2- Whether to include games marked as hidden.
includeBroken8.2- Whether to include games marked as broken.
excludeGamesMissingVideos8.2- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage8.2- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage8.2- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage8.2- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage8.2- Whether to exclude games without background images.
Returns
The matching library games.GetChildren 8.8
System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IPlatform> GetChildren()Returns this item's children in the platform hierarchy.
Returns
The child platforms, categories, and playlists. Playlists return an empty list.GetGameCount 7.10
int GetGameCount(bool includeHidden, bool includeBroken)GetGameCount 8.2
int GetGameCount(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)Counts games that satisfy the visibility and media filters.
includeHidden8.2- Whether to include games marked as hidden.
includeBroken8.2- Whether to include games marked as broken.
excludeGamesMissingVideos8.2- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage8.2- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage8.2- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage8.2- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage8.2- Whether to exclude games without background images.
Returns
The number of matching games.GetNewPlatformLogoPath 7.10
string GetNewPlatformLogoPath(string url)Requests a destination path for a platform logo download.
url7.10- The source image URL.
Returns
The destination path, or null when this legacy operation is unsupported.GetNewPlatformVideoPath 7.10
string GetNewPlatformVideoPath(string url)Builds a video destination path using the item name and the source URL's extension.
url7.10- The source video URL.
Returns
The destination path for the video.GetPlatformVideoPath 7.10
string GetPlatformVideoPath(bool fallBackToGameVideos = true, bool allowThemePath = true)HasGames 7.10
bool HasGames(bool includeHidden, bool includeBroken)HasGames 8.2
bool HasGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)Checks whether any games satisfy the visibility and media filters.
includeHidden8.2- Whether to include games marked as hidden.
includeBroken8.2- Whether to include games marked as broken.
excludeGamesMissingVideos8.2- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage8.2- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage8.2- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage8.2- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage8.2- Whether to exclude games without background images.