IPlatformCategory7.10

Interface in Unbroken.LaunchBox.Plugins.Data

public interface IPlatformCategory

Provides plugin access to a category in the platform hierarchy.

Properties

BackgroundImagePathGets the selected background image path.
BannerImagePathGets the selected banner image path.
ClearLogoImagePathGets the selected clear-logo image path.
DeviceImagePathGets the selected device image path.
HideInBigBox13.1Gets whether the current Big Box visibility rules hide this item.
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.
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.
VideoPathGets or sets the configured video path.

BackgroundImagePath

string BackgroundImagePath { get; }

Gets the selected background image path.

BannerImagePath

string BannerImagePath { get; }

Gets the selected banner image path.

ClearLogoImagePath

string ClearLogoImagePath { get; }

Gets the selected clear-logo image path.

DeviceImagePath

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

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.

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.

VideoPath

string VideoPath { get; set; }

Gets or sets the configured video path.

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

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.

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.

Returns

Whether at least one matching game exists.