IToastGui

Dalamud.Plugin.Services

public event OnNormalToastDelegate Toast;

public event OnQuestToastDelegate QuestToast;

public event OnErrorToastDelegate ErrorToast;

public void ShowNormal(string message, ToastOptions? options = null);
public void ShowNormal(SeString message, ToastOptions? options = null);

public void ShowQuest(string message, QuestToastOptions? options = null);
public void ShowQuest(SeString message, QuestToastOptions? options = null);

public void ShowError(string message);
public void ShowError(SeString message);

public class MyPlugin : IDalamudPlugin
{
    private readonly IToastGui toastGui;
    
    public MyPlugin(IToastGui toastGui)
    {
        this.toastGui = toastGui;
        
        // Subscribe to toast events
        this.toastGui.Toast += OnToast;
        this.toastGui.ErrorToast += OnErrorToast;
    }
    
    private void OnToast(
        ref SeString message,
        ref ToastOptions options,
        ref bool isHandled)
    {
        // Intercept and modify toasts
        Log.Information($"Toast: {message.TextValue}");
        
        // Optionally prevent the toast from showing
        if (message.TextValue.Contains("spam"))
        {
            isHandled = true;
        }
    }
    
    private void OnErrorToast(
        ref SeString message,
        ref bool isHandled)
    {
        Log.Warning($"Error toast: {message.TextValue}");
    }
    
    public void ShowSuccessMessage()
    {
        this.toastGui.ShowNormal("Operation completed successfully!");
    }
    
    public void ShowQuestUpdate(string questName)
    {
        var options = new QuestToastOptions
        {
            Position = QuestToastPosition.Centre,
            Speed = QuestToastSpeed.Fast
        };
        
        this.toastGui.ShowQuest($"Quest updated: {questName}", options);
    }
    
    public void ShowErrorMessage(string error)
    {
        this.toastGui.ShowError($"Error: {error}");
    }
    
    public void Dispose()
    {
        this.toastGui.Toast -= OnToast;
        this.toastGui.ErrorToast -= OnErrorToast;
    }
}

public void ShowCustomToast()
{
    var options = new ToastOptions
    {
        Speed = ToastSpeed.Slow,
        Position = ToastPosition.Bottom
    };
    
    this.toastGui.ShowNormal("This is a slow toast at the bottom", options);
}

public void ShowRichToast()
{
    var message = new SeStringBuilder()
        .AddUiForeground("Important: ", 500)
        .AddText("This is a rich text toast!")
        .Build();
    
    this.toastGui.ShowNormal(message);
}

public void ShowQuestToasts()
{
    // Center position
    this.toastGui.ShowQuest(
        "Quest objective updated",
        new QuestToastOptions { Position = QuestToastPosition.Centre });
    
    // Top position
    this.toastGui.ShowQuest(
        "Quest completed!",
        new QuestToastOptions
        {
            Position = QuestToastPosition.Top,
            Speed = QuestToastSpeed.Fast
        });
}

private readonly HashSet<string> blockedMessages = new()
{
    "You synthesize",
    "You obtain"
};

private void OnToast(
    ref SeString message,
    ref ToastOptions options,
    ref bool isHandled)
{
    var text = message.TextValue;
    
    foreach (var blocked in this.blockedMessages)
    {
        if (text.Contains(blocked, StringComparison.OrdinalIgnoreCase))
        {
            isHandled = true;
            return;
        }
    }
}