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

Namespace: Dalamud.Plugin

Assembly: Dalamud.dll

Syntax

public class DalamudPluginInterface : IDisposable

Constructors

DalamudPluginInterface(Dalamud, String, PluginConfigurations)

Set up the interface and populate all fields needed.

Declaration

public DalamudPluginInterface(Dalamud dalamud, string pluginName, PluginConfigurations configs)

Parameters

Type	Name	Description
Dalamud.Dalamud	dalamud
System.String	pluginName
PluginConfigurations	configs

Fields

ClientState

The ClientState object that allows you to access current client memory information like actors, territories, etc.

Declaration

public readonly ClientState ClientState

Field Value

Type	Description
ClientState

CommandManager

The CommandManager object that allows you to add and remove custom chat commands.

Declaration

public readonly CommandManager CommandManager

Field Value

Type	Description
CommandManager

Data

A DataManager instance which allows you to access game data needed by the main dalamud features.

Declaration

public readonly DataManager Data

Field Value

Type	Description
DataManager

Framework

The Framework object that allows you to interact with the client.

Declaration

public readonly Framework Framework

Field Value

Type	Description
Framework

TargetModuleScanner

A SigScanner instance targeting the main module of the FFXIV process.

Declaration

public readonly SigScanner TargetModuleScanner

Field Value

Type	Description
SigScanner

UiBuilder

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

Declaration

public readonly UiBuilder UiBuilder

Field Value

Type	Description
UiBuilder

Methods

Dispose()

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

Declaration

public void Dispose()

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.

Log(String, Object[])

Log a templated message to the in-game debug log.

Declaration

public void Log(string messageTemplate, params object[] values)

Parameters

Type	Name	Description
System.String	messageTemplate	The message template.
System.Object[]	values	Values to log.

LogError(Exception, String, Object[])

Log a templated error message to the in-game debug log.

Declaration

public void LogError(Exception exception, string messageTemplate, params object[] values)

Parameters

Type	Name	Description
System.Exception	exception	The exception that caused the error.
System.String	messageTemplate	The message template.
System.Object[]	values	Values to log.

LogError(String, Object[])

Log a templated error message to the in-game debug log.

Declaration

public void LogError(string messageTemplate, params object[] values)

Parameters

Type	Name	Description
System.String	messageTemplate	The message template.
System.Object[]	values	Values to log.

SavePluginConfig(IPluginConfiguration)

Save a plugin configuration(inheriting IPluginConfiguration).

Declaration

public void SavePluginConfig(IPluginConfiguration currentConfig)

Parameters

Type	Name	Description
IPluginConfiguration	currentConfig	The current configuration.

Implements

System.IDisposable