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

Methods

| Improve this Doc View Source

Dispose()

| Improve this Doc View Source

GetFunctions()

Returns list of plugin functions.

Returns
Type Description
System.Collections.Generic.IEnumerable<ExtensionFunction>
| 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

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

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()

Called when appliaction is started and initialized.

| Improve this Doc View Source

OnApplicationStopped()

Called when appliaction is stutting down.

| Improve this Doc View Source

OnGameInstalled(Game)

Called when game has been installed.

Parameters
Type Name Description
Game game

Game that's been installed.
| Improve this Doc View Source

OnGameSelected(GameSelectionEventArgs)

Called when game selection changed.

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

OnGameStarted(Game)

Called when game has started.

Parameters
Type Name Description
Game game

Game that started.
| Improve this Doc View Source

OnGameStarting(Game)

Called before game is started.

Parameters
Type Name Description
Game game

Game that will be started.
| Improve this Doc View Source

OnGameStopped(Game, Int64)

Called when game stopped running.

Parameters
Type Name Description
Game game

Game that stopped running.
System.Int64 ellapsedSeconds

Time in seconds of how long the game was running.
| Improve this Doc View Source

OnGameUninstalled(Game)

Called when game has been uninstalled.

Parameters
Type Name Description
Game game

Game that's been uninstalled.
| Improve this Doc View Source

OnLibraryUpdated()

Called library update has been finished.

| 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