Show / Hide Table of Contents

    Class LibraryPlugin

    Represents base game library plugin.

    Namespace: PlayniteSDKPlugins

    Inherited members

    Searches
    PlayniteApi
    Id
    Dispose()
    GetSettings(bool)
    GetSettingsView(bool)
    OnGameStarting(OnGameStartingEventArgs)
    OnGameStarted(OnGameStartedEventArgs)
    OnGameStopped(OnGameStoppedEventArgs)
    OnGameStartupCancelled(OnGameStartupCancelledEventArgs)
    OnGameInstalled(OnGameInstalledEventArgs)
    OnGameUninstalled(OnGameUninstalledEventArgs)
    OnGameSelected(OnGameSelectedEventArgs)
    OnApplicationStarted(OnApplicationStartedEventArgs)
    OnApplicationStopped(OnApplicationStoppedEventArgs)
    OnLibraryUpdated(OnLibraryUpdatedEventArgs)
    GetGameMenuItems(GetGameMenuItemsArgs)
    GetMainMenuItems(GetMainMenuItemsArgs)
    GetPluginUserDataPath()
    GetPluginConfiguration<TConfig>()
    LoadPluginSettings<TSettings>()
    SavePluginSettings<TSettings>(TSettings)
    OpenSettingsView()
    GetPlayActions(GetPlayActionsArgs)
    GetInstallActions(GetInstallActionsArgs)
    GetUninstallActions(GetUninstallActionsArgs)
    GetGameViewControl(GetGameViewControlArgs)
    AddCustomElementSupport(AddCustomElementSupportArgs)
    AddSettingsSupport(AddSettingsSupportArgs)
    AddConvertersSupport(AddConvertersSupportArgs)
    GetSidebarItems()
    GetTopPanelItems()
    GetSearchGlobalCommands()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()

    Constructors

    | Improve this Doc View Source

    LibraryPlugin(IPlayniteAPI)

    Creates new instance of LibraryPlugin.

    Parameters
    Type Name Description
    IPlayniteAPI playniteAPI

    Properties

    | Improve this Doc View Source

    Client

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

    Property Value
    Type Description
    LibraryClient
    | Improve this Doc View Source

    LibraryBackground

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

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    LibraryIcon

    Gets library icon or null if no icon is available.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    Name

    Gets library name.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    Properties

    Gets plugin's properties.

    Property Value
    Type Description
    LibraryPluginProperties

    Methods

    | Improve this Doc View Source

    GetGames(LibraryGetGamesArgs)

    Gets library games.

    Parameters
    Type Name Description
    LibraryGetGamesArgs args
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T>GameMetadata

    List of library games.

    | Improve this Doc View Source

    GetMetadataDownloader()

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

    Returns
    Type Description
    LibraryMetadataProvider

    Metadata downloader.

    | Improve this Doc View Source

    ImportGames(LibraryImportGamesArgs)

    Initiates game import if "HasCustomizedGameImport" capability is enabled.

    Parameters
    Type Name Description
    LibraryImportGamesArgs args
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T>Game

    List of newly imported games.

    | Improve this Doc View Source

    ToString()

    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Implements

    System.IDisposable
    IIdentifiable
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX