14.1 Beta 1 SDK

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

IPlatform7.10

public interface Unbroken.LaunchBox.Plugins.Data.IPlatform

Provides plugin access to a platform, its games, and its media settings.

Properties

string BackgroundImagePath { get; }
string BackImagesFolder { get; set; }
string BannerImagePath { get; }
string BannerImagesFolder { get; set; }
string BigBoxTheme { get; set; }
string BigBoxView { get; set; }
string Category { get; set; }
string ClearLogoImagePath { get; }
string ClearLogoImagesFolder { get; set; }
string Cpu { get; set; }
string Default3DBoxImagePath { get; }
string Default3DCartImagePath { get; }
string DefaultBoxImagePath { get; }
string DefaultCartImagePath { get; }
string Developer { get; set; }
string DeviceImagePath { get; }
string Display { get; set; }
string FanartImagesFolder { get; set; }
string Folder { get; set; }
string FrontImagesFolder { get; set; }
string Graphics { get; set; }
bool HideInBigBox { get; }
string ImageType { get; set; }
bool IsEmulated { get; }
string LastGameId { get; set; }
string ManualsFolder { get; set; }
string Manufacturer { get; set; }
string MaxControllers { get; set; }
string Media { get; set; }
string Memory { get; set; }
string MusicFolder { get; set; }
string Name { get; }
string NestedName { get; set; }
string Notes { get; set; }
string PlatformCategoryClearLogoImagePath { get; }
System.DateTime? ReleaseDate { get; set; }
string ScrapeAs { get; set; }
string ScreenshotImagesFolder { get; set; }
string SortTitle { get; set; }
string SortTitleOrTitle { get; }
string Sound { get; set; }
string SteamBannerImagesFolder { get; set; }
string VideoPath { get; set; }
string VideosFolder { get; set; }

BackgroundImagePath 7.10

string BackgroundImagePath { get; }

Gets the selected background image path.

BackImagesFolder 7.10

string BackImagesFolder { get; set; }

Gets or sets the configured directory for back box images.

BannerImagePath 7.10

string BannerImagePath { get; }

Gets the selected banner image path.

BannerImagesFolder 7.10

string BannerImagesFolder { get; set; }

Gets or sets the configured directory for game banner images.

BigBoxTheme 9.6

string BigBoxTheme { get; set; }

Gets or sets the Big Box theme selected for this item.

BigBoxView 7.10

string BigBoxView { get; set; }

Gets or sets the Big Box view selected for this item.

Category 7.10

string Category { get; set; }

Gets or sets the associated platform-category name.

ClearLogoImagePath 7.10

string ClearLogoImagePath { get; }

Gets the selected clear-logo image path.

ClearLogoImagesFolder 7.10

string ClearLogoImagesFolder { get; set; }

Gets or sets the configured directory for clear-logo images.

Cpu 7.10

string Cpu { get; set; }

Gets or sets the platform's processor specification.

Default3DBoxImagePath 9.10

string Default3DBoxImagePath { get; }

Gets the default three-dimensional box image path used for games without their own image.

Default3DCartImagePath 9.10

string Default3DCartImagePath { get; }

Gets the default three-dimensional cartridge image path used for games without their own image.

DefaultBoxImagePath 9.10

string DefaultBoxImagePath { get; }

Gets the default front box image path used for games without their own image.

DefaultCartImagePath 9.10

string DefaultCartImagePath { get; }

Gets the default cartridge image path used for games without their own image.

Developer 7.10

string Developer { get; set; }

Gets or sets the developer metadata.

DeviceImagePath 7.10

string DeviceImagePath { get; }

Gets the selected device image path.

Display 7.10

string Display { get; set; }

Gets or sets the platform's display specification.

FanartImagesFolder 7.10

string FanartImagesFolder { get; set; }

Gets or sets the configured directory for background images.

Folder 7.10

string Folder { get; set; }

Gets or sets the configured game directory for the platform.

FrontImagesFolder 7.10

string FrontImagesFolder { get; set; }

Gets or sets the configured directory for front box images.

Graphics 7.10

string Graphics { get; set; }

Gets or sets the platform's graphics specification.

HideInBigBox 13.1

bool HideInBigBox { get; }

Gets whether the current Big Box visibility rules hide this item.

ImageType 7.10

string ImageType { get; set; }

Gets or sets the image category selected for game display.

IsEmulated 7.10

bool IsEmulated { get; }

Gets whether the platform is treated as emulated.

LastGameId 7.10

string LastGameId { get; set; }

Gets or sets the identifier of the last selected game.

ManualsFolder 7.10

string ManualsFolder { get; set; }

Gets or sets the configured directory for game manuals.

Manufacturer 7.10

string Manufacturer { get; set; }

Gets or sets the platform manufacturer.

MaxControllers 7.10

string MaxControllers { get; set; }

Gets or sets the platform's maximum controller-count description.

Media 7.10

string Media { get; set; }

Gets or sets the types of game media supported by the platform.

Memory 7.10

string Memory { get; set; }

Gets or sets the platform's memory specification.

MusicFolder 7.10

string MusicFolder { get; set; }

Gets or sets the configured directory for game music.

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.

PlatformCategoryClearLogoImagePath 7.10

string PlatformCategoryClearLogoImagePath { get; }

Gets the clear-logo image path of the associated platform category.

ReleaseDate 7.10

System.DateTime? ReleaseDate { get; set; }

Gets or sets the release date, or null when unknown.

ScrapeAs 7.10

string ScrapeAs { get; set; }

Gets or sets the platform name used for metadata matching.

ScreenshotImagesFolder 7.10

string ScreenshotImagesFolder { get; set; }

Gets or sets the configured directory for screenshot images.

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.

Sound 7.10

string Sound { get; set; }

Gets or sets the platform's sound specification.

SteamBannerImagesFolder 7.10

string SteamBannerImagesFolder { get; set; }

Gets or sets the configured directory for Steam banner images.

VideoPath 7.10

string VideoPath { get; set; }

Gets or sets the configured video path.

VideosFolder 7.10

string VideosFolder { get; set; }

Gets or sets the configured directory for game videos.

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)
Unbroken.LaunchBox.Plugins.Data.IPlatformDocument[] GetAllPlatformDocuments()
Unbroken.LaunchBox.Plugins.Data.IPlatformFolder[] GetAllPlatformFolders()
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)
Unbroken.LaunchBox.Plugins.Data.IPlatformFolder GetPlatformFolderByImageType(string imageType)
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)

Returns games that satisfy the visibility and media filters.

includeHidden 7.10: Whether to include games marked as hidden.

includeBroken 7.10: Whether to include games marked as broken.

Returns

The matching library games.

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.

includeHidden 8.2: Whether to include games marked as hidden.

includeBroken 8.2: Whether to include games marked as broken.

excludeGamesMissingVideos 8.2: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage 8.2: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage 8.2: Whether to exclude games without screenshots.

excludeGamesMissingClearLogoImage 8.2: Whether to exclude games without clear-logo images.

excludeGamesMissingBackgroundImage 8.2: Whether to exclude games without background images.

Returns

The matching library games.

GetAllPlatformDocuments 13.25

Unbroken.LaunchBox.Plugins.Data.IPlatformDocument[] GetAllPlatformDocuments()

Returns the documents assigned to the platform.

Returns

The documents assigned to the platform.

GetAllPlatformFolders 7.10

Unbroken.LaunchBox.Plugins.Data.IPlatformFolder[] GetAllPlatformFolders()

Returns the media-folder configurations assigned to the platform.

Returns

The media-folder configurations assigned to the platform.

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)

Counts games that satisfy the visibility and media filters.

includeHidden 7.10: Whether to include games marked as hidden.

includeBroken 7.10: Whether to include games marked as broken.

Returns

The number of matching games.

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.

includeHidden 8.2: Whether to include games marked as hidden.

includeBroken 8.2: Whether to include games marked as broken.

excludeGamesMissingVideos 8.2: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage 8.2: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage 8.2: Whether to exclude games without screenshots.

excludeGamesMissingClearLogoImage 8.2: Whether to exclude games without clear-logo images.

excludeGamesMissingBackgroundImage 8.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.

url 7.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.

url 7.10: The source video URL.

Returns

The destination path for the video.

GetPlatformFolderByImageType 7.10

Unbroken.LaunchBox.Plugins.Data.IPlatformFolder GetPlatformFolderByImageType(string imageType)

Returns the existing platform folder associated with an image category.

imageType 7.10: The image category to look up.

Returns

The platform folder configuration for that category.

GetPlatformVideoPath 7.10

string GetPlatformVideoPath(bool fallBackToGameVideos = true, bool allowThemePath = true)

Resolves a video for the platform, category, or playlist.

fallBackToGameVideos 7.10: Whether game videos may be used when no item video is found.

allowThemePath 7.10: Whether videos supplied by the current theme may be used.

Returns

The selected video path, or null when none is available.

HasGames 7.10

bool HasGames(bool includeHidden, bool includeBroken)

Checks whether any games satisfy the visibility and media filters.

includeHidden 7.10: Whether to include games marked as hidden.

includeBroken 7.10: Whether to include games marked as broken.

Returns

Whether at least one matching game exists.

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.

includeHidden 8.2: Whether to include games marked as hidden.

includeBroken 8.2: Whether to include games marked as broken.

excludeGamesMissingVideos 8.2: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage 8.2: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage 8.2: Whether to exclude games without screenshots.

excludeGamesMissingClearLogoImage 8.2: Whether to exclude games without clear-logo images.

excludeGamesMissingBackgroundImage 8.2: Whether to exclude games without background images.

Returns

Whether at least one matching game exists.