IDalamudPlugin

​

Overview

​

Interface Definition

public interface IDalamudPlugin : IDisposable
{
}

​

Description

​

Key Points

• Inheritance: Extends IDisposable, requiring plugins to implement the Dispose() method
• Purpose: Serves as the marker interface for all Dalamud plugins
• Cleanup: The Dispose() method is called when the plugin is unloaded, allowing for proper resource cleanup

​

Implementation Example

using Dalamud.Plugin;

public class MyPlugin : IDalamudPlugin
{
    public MyPlugin(IDalamudPluginInterface pluginInterface)
    {
        // Initialize your plugin
    }

    public void Dispose()
    {
        // Clean up resources
        // Unsubscribe from events
        // Dispose of managed resources
    }
}

​

Best Practices

• Always implement Dispose() properly to clean up resources when the plugin is unloaded
• Unsubscribe from all events in Dispose() to prevent memory leaks
• Dispose of any managed resources that implement IDisposable
• Keep the constructor and Dispose() method as lightweight as possible

​

Related Interfaces

• IDalamudPluginInterface - Provides access to Dalamud services and functionality
• PluginLoadReason - Indicates why the plugin was loaded