Interface IGameDatabase

Namespace

Playnite.SDK

Assembly

Playnite.SDK.dll

Describes game databse API.

public interface IGameDatabase

Properties

AgeRatings

Gets collection of age ratings.

IItemCollection<AgeRating> AgeRatings { get; }

Property Value

IItemCollection<AgeRating>

Categories

Gets collection of categories.

IItemCollection<Category> Categories { get; }

Property Value

IItemCollection<Category>

Companies

Gets collection of companies.

IItemCollection<Company> Companies { get; }

Property Value

IItemCollection<Company>

CompletionStatuses

Gets collection of game statuses.

IItemCollection<CompletionStatus> CompletionStatuses { get; }

Property Value

IItemCollection<CompletionStatus>

Emulators

Gets collection of emulators.

IItemCollection<Emulator> Emulators { get; }

Property Value

IItemCollection<Emulator>

Features

Gets collection of game features.

IItemCollection<GameFeature> Features { get; }

Property Value

IItemCollection<GameFeature>

FilterPresets

Gets collection of filter presets.

IItemCollection<FilterPreset> FilterPresets { get; }

Property Value

IItemCollection<FilterPreset>

GameScanners

Gets collection of game features.

IItemCollection<GameScannerConfig> GameScanners { get; }

Property Value

IItemCollection<GameScannerConfig>

Games

Gets collection of games.

IItemCollection<Game> Games { get; }

Property Value

IItemCollection<Game>

Genres

Gets collection of genres.

IItemCollection<Genre> Genres { get; }

Property Value

IItemCollection<Genre>

ImportExclusions

Gets collection of import exclusions.

IItemCollection<ImportExclusionItem> ImportExclusions { get; }

Property Value

IItemCollection<ImportExclusionItem>

IsOpen

Gets value indicating whether database is opened.

bool IsOpen { get; }

Property Value

bool

Platforms

Gets collections of platforms.

IItemCollection<Platform> Platforms { get; }

Property Value

IItemCollection<Platform>

Regions

Gets collection of regions.

IItemCollection<Region> Regions { get; }

Property Value

IItemCollection<Region>

Series

Gets collection of series.

IItemCollection<Series> Series { get; }

Property Value

IItemCollection<Series>

Sources

Gets collection of sources.

IItemCollection<GameSource> Sources { get; }

Property Value

IItemCollection<GameSource>

Tags

Gets collection of tags.

IItemCollection<Tag> Tags { get; }

Property Value

IItemCollection<Tag>

Methods

GetFilteredGames(FilterPresetSettings)

Returns enumeration of all games matching specified filter settings.

IEnumerable<Game> GetFilteredGames(FilterPresetSettings filterSettings)

Parameters

filterSettings FilterPresetSettings

Returns

IEnumerable<Game>

GetFilteredGames(FilterPresetSettings, bool)

Returns enumeration of all games matching specified filter settings.

IEnumerable<Game> GetFilteredGames(FilterPresetSettings filterSettings, bool useFuzzyNameMatch)

Parameters

filterSettings FilterPresetSettings

useFuzzyNameMatch bool

Returns

IEnumerable<Game>

GetGameMatchesFilter(Game, FilterPresetSettings)

Checks if the game matches specified filter settings.

bool GetGameMatchesFilter(Game game, FilterPresetSettings filterSettings)

Parameters

game Game

filterSettings FilterPresetSettings

Returns

bool

GetGameMatchesFilter(Game, FilterPresetSettings, bool)

Checks if the game matches specified filter settings.

bool GetGameMatchesFilter(Game game, FilterPresetSettings filterSettings, bool useFuzzyNameMatch)

Parameters

game Game

filterSettings FilterPresetSettings

useFuzzyNameMatch bool

Returns

bool

ImportGame(GameMetadata)

Import new game into database.

Game ImportGame(GameMetadata game)

Parameters

game GameMetadata

Game data to import.

Returns

Game

Imported game.

ImportGame(GameMetadata, LibraryPlugin)

Import new game into database from a library plugin.

Game ImportGame(GameMetadata game, LibraryPlugin sourcePlugin)

Parameters

game GameMetadata

Game data to import.

sourcePlugin LibraryPlugin

Source library plugin.

Returns

Game

Imported game.

Events

DatabaseOpened

Invoked when database is being opened.

event EventHandler DatabaseOpened

Event Type

EventHandler