Class LibraryPlugin

Namespace

Playnite.SDK.Plugins

Assembly

Playnite.SDK.dll

Represents base game library plugin.

public abstract class LibraryPlugin : Plugin, IDisposable, IIdentifiable

Inheritance

object

Plugin

LibraryPlugin

Implements

IDisposable

IIdentifiable

Inherited Members

Plugin.Searches

Plugin.PlayniteApi

Plugin.Id

Plugin.Dispose()

Plugin.GetSettings(bool)

Plugin.GetSettingsView(bool)

Plugin.OnGameStarting(OnGameStartingEventArgs)

Plugin.OnGameStarted(OnGameStartedEventArgs)

Plugin.OnGameStopped(OnGameStoppedEventArgs)

Plugin.OnGameStartupCancelled(OnGameStartupCancelledEventArgs)

Plugin.OnGameInstalled(OnGameInstalledEventArgs)

Plugin.OnGameUninstalled(OnGameUninstalledEventArgs)

Plugin.OnGameSelected(OnGameSelectedEventArgs)

Plugin.OnApplicationStarted(OnApplicationStartedEventArgs)

Plugin.OnApplicationStopped(OnApplicationStoppedEventArgs)

Plugin.OnLibraryUpdated(OnLibraryUpdatedEventArgs)

Plugin.GetGameMenuItems(GetGameMenuItemsArgs)

Plugin.GetMainMenuItems(GetMainMenuItemsArgs)

Plugin.GetPluginUserDataPath()

Plugin.GetPluginConfiguration<TConfig>()

Plugin.LoadPluginSettings<TSettings>()

Plugin.SavePluginSettings<TSettings>(TSettings)

Plugin.OpenSettingsView()

Plugin.GetPlayActions(GetPlayActionsArgs)

Plugin.GetInstallActions(GetInstallActionsArgs)

Plugin.GetUninstallActions(GetUninstallActionsArgs)

Plugin.GetGameViewControl(GetGameViewControlArgs)

Plugin.AddCustomElementSupport(AddCustomElementSupportArgs)

Plugin.AddSettingsSupport(AddSettingsSupportArgs)

Plugin.AddConvertersSupport(AddConvertersSupportArgs)

Plugin.GetSidebarItems()

Plugin.GetTopPanelItems()

Plugin.GetSearchGlobalCommands()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

LibraryPlugin(IPlayniteAPI)

Creates new instance of LibraryPlugin.

public LibraryPlugin(IPlayniteAPI playniteAPI)

Parameters

playniteAPI IPlayniteAPI

Properties

Client

Gets library client application or null if no client is associated with this library.

public virtual LibraryClient Client { get; }

Property Value

LibraryClient

LibraryBackground

Gets library background image or null if no background is available.

public virtual string LibraryBackground { get; }

Property Value

string

LibraryIcon

Gets library icon or null if no icon is available.

public virtual string LibraryIcon { get; }

Property Value

string

Name

Gets library name.

public abstract string Name { get; }

Property Value

string

Properties

Gets plugin's properties.

public LibraryPluginProperties Properties { get; protected set; }

Property Value

LibraryPluginProperties

Methods

GetGames(LibraryGetGamesArgs)

Gets library games.

public virtual IEnumerable<GameMetadata> GetGames(LibraryGetGamesArgs args)

Parameters

args LibraryGetGamesArgs

Returns

IEnumerable<GameMetadata>

List of library games.

GetMetadataDownloader()

Gets library metadata downloader or null if no metadata provider is available.

public virtual LibraryMetadataProvider GetMetadataDownloader()

Returns

LibraryMetadataProvider

Metadata downloader.

ImportGames(LibraryImportGamesArgs)

Initiates game import if "HasCustomizedGameImport" capability is enabled.

public virtual IEnumerable<Game> ImportGames(LibraryImportGamesArgs args)

Parameters

args LibraryImportGamesArgs

Returns

IEnumerable<Game>

List of newly imported games.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.