IPlatform7.10
Interface in Unbroken.LaunchBox.Plugins.Data
public interface IPlatformProvides plugin access to a platform, its games, and its media settings.
Properties
BackgroundImagePathGets the selected background image path.BackImagesFolderGets or sets the configured directory for back box images.BannerImagePathGets the selected banner image path.BannerImagesFolderGets or sets the configured directory for game banner images.BigBoxTheme9.6Gets or sets the Big Box theme selected for this item.BigBoxViewGets or sets the Big Box view selected for this item.CategoryGets or sets the associated platform-category name.ClearLogoImagePathGets the selected clear-logo image path.ClearLogoImagesFolderGets or sets the configured directory for clear-logo images.CpuGets or sets the platform's processor specification.Default3DBoxImagePath9.10Gets the default three-dimensional box image path used for games without their own image.Default3DCartImagePath9.10Gets the default three-dimensional cartridge image path used for games without their own image.DefaultBoxImagePath9.10Gets the default front box image path used for games without their own image.DefaultCartImagePath9.10Gets the default cartridge image path used for games without their own image.DeveloperGets or sets the developer metadata.DeviceImagePathGets the selected device image path.DisplayGets or sets the platform's display specification.FanartImagesFolderGets or sets the configured directory for background images.FolderGets or sets the configured game directory for the platform.FrontImagesFolderGets or sets the configured directory for front box images.GraphicsGets or sets the platform's graphics specification.HideInBigBox13.1Gets whether the current Big Box visibility rules hide this item.ImageTypeGets or sets the image category selected for game display.IsEmulatedGets whether the platform is treated as emulated.LastGameIdGets or sets the identifier of the last selected game.ManualsFolderGets or sets the configured directory for game manuals.ManufacturerGets or sets the platform manufacturer.MaxControllersGets or sets the platform's maximum controller-count description.MediaGets or sets the types of game media supported by the platform.MemoryGets or sets the platform's memory specification.MusicFolderGets or sets the configured directory for game music.NameGets the display name.NestedName8.8Gets or sets the name used for this item in the platform hierarchy.NotesGets or sets the descriptive notes, which may contain formatting.PlatformCategoryClearLogoImagePathGets the clear-logo image path of the associated platform category.ReleaseDateGets or sets the release date, or null when unknown.ScrapeAsGets or sets the platform name used for metadata matching.ScreenshotImagesFolderGets or sets the configured directory for screenshot images.SortTitleGets or sets the alternate title used for sorting.SortTitleOrTitleGets the sorting title, falling back to the display title when no sorting title is set.SoundGets or sets the platform's sound specification.SteamBannerImagesFolderGets or sets the configured directory for Steam banner images.VideoPathGets or sets the configured video path.VideosFolderGets or sets the configured directory for game videos.
BackgroundImagePath
string BackgroundImagePath { get; }Gets the selected background image path.
BackImagesFolder
string BackImagesFolder { get; set; }Gets or sets the configured directory for back box images.
BannerImagePath
string BannerImagePath { get; }Gets the selected banner image path.
BannerImagesFolder
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
string BigBoxView { get; set; }Gets or sets the Big Box view selected for this item.
Category
string Category { get; set; }Gets or sets the associated platform-category name.
ClearLogoImagePath
string ClearLogoImagePath { get; }Gets the selected clear-logo image path.
ClearLogoImagesFolder
string ClearLogoImagesFolder { get; set; }Gets or sets the configured directory for clear-logo images.
Cpu
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
string Developer { get; set; }Gets or sets the developer metadata.
DeviceImagePath
string DeviceImagePath { get; }Gets the selected device image path.
Display
string Display { get; set; }Gets or sets the platform's display specification.
FanartImagesFolder
string FanartImagesFolder { get; set; }Gets or sets the configured directory for background images.
Folder
string Folder { get; set; }Gets or sets the configured game directory for the platform.
FrontImagesFolder
string FrontImagesFolder { get; set; }Gets or sets the configured directory for front box images.
Graphics
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
string ImageType { get; set; }Gets or sets the image category selected for game display.
IsEmulated
bool IsEmulated { get; }Gets whether the platform is treated as emulated.
LastGameId
string LastGameId { get; set; }Gets or sets the identifier of the last selected game.
ManualsFolder
string ManualsFolder { get; set; }Gets or sets the configured directory for game manuals.
Manufacturer
string Manufacturer { get; set; }Gets or sets the platform manufacturer.
MaxControllers
string MaxControllers { get; set; }Gets or sets the platform's maximum controller-count description.
Media
string Media { get; set; }Gets or sets the types of game media supported by the platform.
Memory
string Memory { get; set; }Gets or sets the platform's memory specification.
MusicFolder
string MusicFolder { get; set; }Gets or sets the configured directory for game music.
Name
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
string Notes { get; set; }Gets or sets the descriptive notes, which may contain formatting.
PlatformCategoryClearLogoImagePath
string PlatformCategoryClearLogoImagePath { get; }Gets the clear-logo image path of the associated platform category.
ReleaseDate
DateTime? ReleaseDate { get; set; }Gets or sets the release date, or null when unknown.
ScrapeAs
string ScrapeAs { get; set; }Gets or sets the platform name used for metadata matching.
ScreenshotImagesFolder
string ScreenshotImagesFolder { get; set; }Gets or sets the configured directory for screenshot images.
SortTitle
string SortTitle { get; set; }Gets or sets the alternate title used for sorting.
SortTitleOrTitle
string SortTitleOrTitle { get; }Gets the sorting title, falling back to the display title when no sorting title is set.
Sound
string Sound { get; set; }Gets or sets the platform's sound specification.
SteamBannerImagesFolder
string SteamBannerImagesFolder { get; set; }Gets or sets the configured directory for Steam banner images.
VideoPath
string VideoPath { get; set; }Gets or sets the configured video path.
VideosFolder
string VideosFolder { get; set; }Gets or sets the configured directory for game videos.
Methods
GetAllGames(bool, bool)Returns games that satisfy the visibility and media filters.GetAllGames(bool, bool, bool, bool, bool, bool, bool)8.2Returns games that satisfy the visibility and media filters.GetAllPlatformDocuments13.25Returns the documents assigned to the platform.GetAllPlatformFoldersReturns the media-folder configurations assigned to the platform.GetChildren8.8Returns this item's children in the platform hierarchy.GetGameCount(bool, bool)Counts games that satisfy the visibility and media filters.GetGameCount(bool, bool, bool, bool, bool, bool, bool)8.2Counts games that satisfy the visibility and media filters.GetNewPlatformLogoPathRequests a destination path for a platform logo download.GetNewPlatformVideoPathBuilds a video destination path using the item name and the source URL's extension.GetPlatformFolderByImageTypeReturns the existing platform folder associated with an image category.GetPlatformVideoPathResolves a video for the platform, category, or playlist.HasGames(bool, bool)Checks whether any games satisfy the visibility and media filters.HasGames(bool, bool, bool, bool, bool, bool, bool)8.2Checks whether any games satisfy the visibility and media filters.
GetAllGames(bool, bool)
IGame[] GetAllGames(bool includeHidden, bool includeBroken)Returns games that satisfy the visibility and media filters.
includeHidden- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
Returns
The matching library games.GetAllGames(bool, bool, bool, bool, bool, bool, bool) 8.2
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- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
excludeGamesMissingVideos- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage- Whether to exclude games without background images.
Returns
The matching library games.GetAllPlatformDocuments 13.25
IPlatformDocument[] GetAllPlatformDocuments()Returns the documents assigned to the platform.
Returns
The documents assigned to the platform.GetAllPlatformFolders
IPlatformFolder[] GetAllPlatformFolders()Returns the media-folder configurations assigned to the platform.
Returns
The media-folder configurations assigned to the platform.GetChildren 8.8
IList<IPlatform> GetChildren()Returns this item's children in the platform hierarchy.
Returns
The child platforms, categories, and playlists. Playlists return an empty list.GetGameCount(bool, bool)
int GetGameCount(bool includeHidden, bool includeBroken)Counts games that satisfy the visibility and media filters.
includeHidden- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
Returns
The number of matching games.GetGameCount(bool, bool, bool, bool, bool, bool, bool) 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- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
excludeGamesMissingVideos- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage- Whether to exclude games without background images.
Returns
The number of matching games.GetNewPlatformLogoPath
string GetNewPlatformLogoPath(string url)Requests a destination path for a platform logo download.
url- The source image URL.
Returns
The destination path, or null when this legacy operation is unsupported.GetNewPlatformVideoPath
string GetNewPlatformVideoPath(string url)Builds a video destination path using the item name and the source URL's extension.
url- The source video URL.
Returns
The destination path for the video.GetPlatformFolderByImageType
IPlatformFolder GetPlatformFolderByImageType(string imageType)Returns the existing platform folder associated with an image category.
imageType- The image category to look up.
Returns
The platform folder configuration for that category.GetPlatformVideoPath
string GetPlatformVideoPath(
bool fallBackToGameVideos = true,
bool allowThemePath = true
)Resolves a video for the platform, category, or playlist.
fallBackToGameVideos- Whether game videos may be used when no item video is found.
allowThemePath- Whether videos supplied by the current theme may be used.
Returns
The selected video path, or null when none is available.HasGames(bool, bool)
bool HasGames(bool includeHidden, bool includeBroken)Checks whether any games satisfy the visibility and media filters.
includeHidden- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
Returns
Whether at least one matching game exists.HasGames(bool, bool, bool, bool, bool, bool, bool) 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- Whether to include games marked as hidden.
includeBroken- Whether to include games marked as broken.
excludeGamesMissingVideos- Whether to exclude games without videos.
excludeGamesMissingBoxFrontImage- Whether to exclude games without front box images.
excludeGamesMissingScreenshotImage- Whether to exclude games without screenshots.
excludeGamesMissingClearLogoImage- Whether to exclude games without clear-logo images.
excludeGamesMissingBackgroundImage- Whether to exclude games without background images.