Interface IExposedPlugin

Interface representing an installed plugin, to be exposed to other plugins.

Assembly: Dalamud.dll

Declaration

public interface IExposedPlugin

Properties

Name

Gets the name of the plugin.

Declaration

string Name { get; }

InternalName

Gets the internal name of the plugin.

Declaration

string InternalName { get; }

IsLoaded

Gets a value indicating whether the plugin is loaded.

Declaration

bool IsLoaded { get; }

IsOutdated

Gets a value indicating whether this plugin's API level is out of date.

Declaration

bool IsOutdated { get; }

IsTesting

Gets a value indicating whether the plugin is for testing use only.

Declaration

bool IsTesting { get; }

IsOrphaned

Gets a value indicating whether this plugin is orphaned(belongs to a repo) or not.

Declaration

bool IsOrphaned { get; }

IsDecommissioned

Gets a value indicating whether this plugin is serviced(repo still exists, but plugin no longer does).

Declaration

bool IsDecommissioned { get; }

IsBanned

Gets a value indicating whether this plugin has been banned.

Declaration

bool IsBanned { get; }

IsDev

Gets a value indicating whether this plugin is dev plugin.

Declaration

bool IsDev { get; }

IsThirdParty

Gets a value indicating whether this manifest is associated with a plugin that was installed from a third party repo.

Declaration

bool IsThirdParty { get; }

Manifest

Gets the plugin manifest.

Declaration

ILocalPluginManifest Manifest { get; }

Version

Gets the version of the plugin.

Declaration

Version Version { get; }

HasMainUi

Gets a value indicating whether the plugin has a main UI.

Declaration

bool HasMainUi { get; }

HasConfigUi

Gets a value indicating whether the plugin has a config UI.

Declaration

bool HasConfigUi { get; }

Methods

OpenMainUi()

Opens the main UI of the plugin. Throws System.InvalidOperationException if Dalamud.Plugin.IExposedPlugin.HasMainUi is false.

Declaration

void OpenMainUi()

OpenConfigUi()

Opens the config UI of the plugin. Throws System.InvalidOperationException if Dalamud.Plugin.IExposedPlugin.HasConfigUi is false.

Declaration

void OpenConfigUi()