Skip to main content
Version: 14.x (API 14) [Legacy]

Interface IAsyncDalamudPlugin

This interface represents a basic Dalamud plugin that loads and unloads asynchronously. All plugins have to implement either Dalamud.Plugin.IDalamudPlugin or Dalamud.Plugin.IAsyncDalamudPlugin.

Assembly: Dalamud.dll​
Declaration
public interface IAsyncDalamudPlugin : IAsyncDisposable

Methods​

LoadAsync(CancellationToken)​

Performs plugin-defined tasks associated with loading the plugin asynchronously. The plugin will not be considered loaded until this method completes, and will not be unloaded until System.IAsyncDisposable.DisposeAsync completes.

Declaration
ValueTask LoadAsync(CancellationToken cancellationToken)
Returns​

System.Threading.Tasks.ValueTask: A task that represents the asynchronous load operation.

Parameters​
TypeNameDescription
System.Threading.CancellationTokencancellationTokenA token that can be used to cancel the load operation. If cancellation is requested,
the plugin should throw System.OperationCanceledException to signal that it
did not fully load. Dalamud will not consider the plugin loaded in this case.
System.IAsyncDisposable.DisposeAsync will still be called.