Class Plugin
Represents base Playnite plugin.
Namespace: Playnite.SDK.Plugins
Constructors
| Improve this Doc View SourcePlugin(IPlayniteAPI)
Creates new instance of Plugin.
Parameters
| Type | Name | Description |
|---|---|---|
| IPlayniteAPI | playniteAPI | Instance of Playnite API to be injected. |
Fields
| Improve this Doc View SourcePlayniteApi
Gets instance of runtime IPlayniteAPI.
Field Value
| Type | Description |
|---|---|
| IPlayniteAPI |
Properties
| Improve this Doc View SourceId
Property Value
| Type | Description |
|---|---|
| System.Guid |
Methods
| Improve this Doc View SourceDispose()
GetFunctions()
Returns list of plugin functions.
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ExtensionFunction> |
GetPluginConfiguration<TConfig>()
Gets plugin configuration stored in plugin.cfg file.
Returns
| Type | Description |
|---|---|
| TConfig | Plugin configuration. |
Type Parameters
| Name | Description |
|---|---|
| TConfig | Plugin configuration type. |
GetPluginUserDataPath()
Gets path dedicated for plugins to store data.
Returns
| Type | Description |
|---|---|
| System.String | Full directory path. |
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 |
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 |
LoadPluginSettings<TSettings>()
Gets plugin settings.
Returns
| Type | Description |
|---|---|
| TSettings | Plugin settings. |
Type Parameters
| Name | Description |
|---|---|
| TSettings | Plugin settings type. |
OnApplicationStarted()
Called when appliaction is started and initialized.
OnGameInstalled(Game)
Called when game has been installed.
Parameters
| Type | Name | Description |
|---|---|---|
| Game | game | Game that's been installed. |
OnGameStarted(Game)
Called when game has started.
Parameters
| Type | Name | Description |
|---|---|---|
| Game | game | Game that started. |
OnGameStarting(Game)
Called before game is started.
Parameters
| Type | Name | Description |
|---|---|---|
| Game | game | Game that will be started. |
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. |
OnGameUninstalled(Game)
Called when game has been uninstalled.
Parameters
| Type | Name | Description |
|---|---|---|
| Game | game | Game that's been uninstalled. |
SavePluginSettings<TSettings>(TSettings)
Saves plugin settings.
Parameters
| Type | Name | Description |
|---|---|---|
| TSettings | settings | Source plugin. |
Type Parameters
| Name | Description |
|---|---|
| TSettings | Plugin settings type. |