Class Plugin

Represents base Playnite plugin.

Namespace: Playnite.SDK.Plugins

Inherited members

System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

Constructors

| Improve this Doc View Source

Plugin(IPlayniteAPI)

Creates new instance of Plugin.

Parameters
Type Name Description
IPlayniteAPI playniteAPI

Instance of Playnite API to be injected.

Fields

| Improve this Doc View Source

PlayniteApi

Gets instance of runtime IPlayniteAPI.

Field Value
Type Description
IPlayniteAPI

Properties

| Improve this Doc View Source

Id

Property Value
Type Description
System.Guid
| Improve this Doc View Source

Searches

Gets or sets list of global searches.

Property Value
Type Description
System.Collections.Generic.List<SearchSupport>

Methods

| Improve this Doc View Source

AddConvertersSupport(AddConvertersSupportArgs)

Parameters
Type Name Description
AddConvertersSupportArgs args
| Improve this Doc View Source

AddCustomElementSupport(AddCustomElementSupportArgs)

Parameters
Type Name Description
AddCustomElementSupportArgs args
| Improve this Doc View Source

AddSettingsSupport(AddSettingsSupportArgs)

Parameters
Type Name Description
AddSettingsSupportArgs args
| Improve this Doc View Source

Dispose()

| Improve this Doc View Source

GetGameMenuItems(GetGameMenuItemsArgs)

Gets list of items to be displayed in game's context menu.

Parameters
Type Name Description
GetGameMenuItemsArgs args

Contextual arguments.
Returns
Type Description
System.Collections.Generic.IEnumerable<GameMenuItem>

List of menu items to be displayed in game menu.
| Improve this Doc View Source

GetGameViewControl(GetGameViewControlArgs)

Parameters
Type Name Description
GetGameViewControlArgs args
Returns
Type Description
System.Windows.Controls.Control
| Improve this Doc View Source

GetInstallActions(GetInstallActionsArgs)

Parameters
Type Name Description
GetInstallActionsArgs args
Returns
Type Description
System.Collections.Generic.IEnumerable<InstallController>
| Improve this Doc View Source

GetMainMenuItems(GetMainMenuItemsArgs)

Gets list of items to be displayed in Playnite's main menu.

Parameters
Type Name Description
GetMainMenuItemsArgs args

Contextual arguments.
Returns
Type Description
System.Collections.Generic.IEnumerable<MainMenuItem>

List of menu items to be displayed in Playnite's main menu.
| Improve this Doc View Source

GetPlayActions(GetPlayActionsArgs)

Parameters
Type Name Description
GetPlayActionsArgs args
Returns
Type Description
System.Collections.Generic.IEnumerable<PlayController>
| Improve this Doc View Source

GetPluginConfiguration<TConfig>()

Gets plugin configuration stored in plugin.cfg file.

Returns
Type Description
TConfig

Plugin configuration.
Type Parameters
Name Description
TConfig

Plugin configuration type.
| Improve this Doc View Source

GetPluginUserDataPath()

Gets path dedicated for plugins to store data.

Returns
Type Description
System.String

Full directory path.
| Improve this Doc View Source

GetSearchGlobalCommands()

Gets items to be included in default global search.

Returns
Type Description
System.Collections.Generic.IEnumerable<SearchItem>
| Improve this Doc View Source

GetSettings(Boolean)

Gets plugin settings or null if plugin doesn't provide any settings.

Parameters
Type Name Description
System.Boolean firstRunSettings
Returns
Type Description
ISettings
| Improve this Doc View Source

GetSettingsView(Boolean)

Gets plugin settings view or null if plugin doesn't provide settings view.

Parameters
Type Name Description
System.Boolean firstRunView
Returns
Type Description
System.Windows.Controls.UserControl
| Improve this Doc View Source

GetSidebarItems()

Gets sidebar items provided by this plugin.

Returns
Type Description
System.Collections.Generic.IEnumerable<SidebarItem>
| Improve this Doc View Source

GetTopPanelItems()

Gets top panel items provided by this plugin.

Returns
Type Description
System.Collections.Generic.IEnumerable<TopPanelItem>
| Improve this Doc View Source

GetUninstallActions(GetUninstallActionsArgs)

Parameters
Type Name Description
GetUninstallActionsArgs args
Returns
Type Description
System.Collections.Generic.IEnumerable<UninstallController>
| Improve this Doc View Source

LoadPluginSettings<TSettings>()

Gets plugin settings.

Returns
Type Description
TSettings

Plugin settings.
Type Parameters
Name Description
TSettings

Plugin settings type.
| Improve this Doc View Source

OnApplicationStarted(OnApplicationStartedEventArgs)

Called when appliaction is started and initialized.

Parameters
Type Name Description
OnApplicationStartedEventArgs args
| Improve this Doc View Source

OnApplicationStopped(OnApplicationStoppedEventArgs)

Called when appliaction is shutting down.

Parameters
Type Name Description
OnApplicationStoppedEventArgs args
| Improve this Doc View Source

OnGameInstalled(OnGameInstalledEventArgs)

Called when game has been installed.

Parameters
Type Name Description
OnGameInstalledEventArgs args
| Improve this Doc View Source

OnGameSelected(OnGameSelectedEventArgs)

Called when game selection changed.

Parameters
Type Name Description
OnGameSelectedEventArgs args
| Improve this Doc View Source

OnGameStarted(OnGameStartedEventArgs)

Called when game has started.

Parameters
Type Name Description
OnGameStartedEventArgs args
| Improve this Doc View Source

OnGameStarting(OnGameStartingEventArgs)

Called before game is started.

Parameters
Type Name Description
OnGameStartingEventArgs args
| Improve this Doc View Source

OnGameStopped(OnGameStoppedEventArgs)

Called when game stopped running.

Parameters
Type Name Description
OnGameStoppedEventArgs args
| Improve this Doc View Source

OnGameUninstalled(OnGameUninstalledEventArgs)

Called when game has been uninstalled.

Parameters
Type Name Description
OnGameUninstalledEventArgs args
| Improve this Doc View Source

OnLibraryUpdated(OnLibraryUpdatedEventArgs)

Called when library update has been finished.

Parameters
Type Name Description
OnLibraryUpdatedEventArgs args
| Improve this Doc View Source

OpenSettingsView()

Opens plugin's settings view. Only works in Desktop application mode!

Returns
Type Description
System.Boolean

True if user saved any changes, False if dialog was canceled.
| Improve this Doc View Source

SavePluginSettings<TSettings>(TSettings)

Saves plugin settings.

Parameters
Type Name Description
TSettings settings

Source plugin.
Type Parameters
Name Description
TSettings

Plugin settings type.

Implements

System.IDisposable