Class DalamudPluginInterface

This class acts as an interface to various objects needed to interact with Dalamud and the game.

Inheritance
System.Object
DalamudPluginInterface
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Dalamud.Plugin
Assembly: Dalamud.dll
Syntax
public sealed class DalamudPluginInterface : IDisposable

Properties

| Improve this Doc View Source

ConfigDirectory

Gets the directory your plugin configurations are stored in.

Declaration
public DirectoryInfo ConfigDirectory { get; }
Property Value
Type Description
System.IO.DirectoryInfo
| Improve this Doc View Source

ConfigFile

Gets the config file of your plugin.

Declaration
public FileInfo ConfigFile { get; }
Property Value
Type Description
System.IO.FileInfo
| Improve this Doc View Source

DalamudAssetDirectory

Gets the directory Dalamud assets are stored in.

Declaration
public DirectoryInfo DalamudAssetDirectory { get; }
Property Value
Type Description
System.IO.DirectoryInfo
| Improve this Doc View Source

GeneralChatType

Gets the chat type used by default for plugin messages.

Declaration
public XivChatType GeneralChatType { get; }
Property Value
Type Description
XivChatType
| Improve this Doc View Source

IsDebugging

Gets a value indicating whether Dalamud is running in Debug mode or the /xldev menu is open. This can occur on release builds.

Declaration
public bool IsDebugging { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PluginInternalNames

Gets a list of installed plugin internal names.

Declaration
public List<string> PluginInternalNames { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

PluginNames

Gets a list of installed plugin names.

Declaration
public List<string> PluginNames { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Reason

Gets the reason this plugin was loaded.

Declaration
public PluginLoadReason Reason { get; }
Property Value
Type Description
PluginLoadReason
| Improve this Doc View Source

Sanitizer

Gets serializer class with functions to remove special characters from strings.

Declaration
public ISanitizer Sanitizer { get; }
Property Value
Type Description
ISanitizer
| Improve this Doc View Source

UiBuilder

Gets the UiBuilder instance which allows you to draw UI into the game via ImGui draw calls.

Declaration
public UiBuilder UiBuilder { get; }
Property Value
Type Description
UiBuilder
| Improve this Doc View Source

UiLanguage

Gets the current UI language in two-letter iso format.

Declaration
public string UiLanguage { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

AddChatLinkHandler(UInt32, Action<UInt32, SeString>)

Register a chat link handler.

Declaration
public DalamudLinkPayload AddChatLinkHandler(uint commandId, Action<uint, SeString> commandAction)
Parameters
Type Name Description
System.UInt32 commandId

The ID of the command.
System.Action<System.UInt32, SeString> commandAction

The action to be executed.
Returns
Type Description
DalamudLinkPayload

Returns an SeString payload for the link.
| Improve this Doc View Source

Dispose()

Unregister your plugin and dispose all references. You have to call this when your IDalamudPlugin is disposed.

Declaration
public void Dispose()
| Improve this Doc View Source

GetPluginConfig()

Get a previously saved plugin configuration or null if none was saved before.

Declaration
public IPluginConfiguration GetPluginConfig()
Returns
Type Description
IPluginConfiguration

A previously saved config or null if none was saved before.
| Improve this Doc View Source

GetPluginConfigDirectory()

Get the config directory.

Declaration
public string GetPluginConfigDirectory()
Returns
Type Description
System.String

directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName.
| Improve this Doc View Source

GetPluginLocDirectory()

Get the loc directory.

Declaration
public string GetPluginLocDirectory()
Returns
Type Description
System.String

directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName/loc.
| Improve this Doc View Source

RemoveChatLinkHandler()

Removes all chat link handlers registered by the plugin.

Declaration
public void RemoveChatLinkHandler()
| Improve this Doc View Source

RemoveChatLinkHandler(UInt32)

Remove a chat link handler.

Declaration
public void RemoveChatLinkHandler(uint commandId)
Parameters
Type Name Description
System.UInt32 commandId

The ID of the command.
| Improve this Doc View Source

SavePluginConfig(IPluginConfiguration)

Save a plugin configuration(inheriting IPluginConfiguration).

Declaration
public void SavePluginConfig(IPluginConfiguration currentConfig)
Parameters
Type Name Description
IPluginConfiguration currentConfig

The current configuration.

Events

| Improve this Doc View Source

LanguageChanged

Event that gets fired when loc is changed

Declaration
public event DalamudPluginInterface.LanguageChangedDelegate LanguageChanged
Event Type
Type Description
DalamudPluginInterface.LanguageChangedDelegate

Implements

System.IDisposable