Interface IToastGui
This class facilitates interacting with and creating native toast windows.
Assembly: Dalamud.dll
Declaration
public interface IToastGui : IDalamudService
Methods
ShowNormal(ReadOnlySeString, ToastOptions?)
Show a toast message with the given content.
Declaration
void ShowNormal(ReadOnlySeString message, ToastOptions? options = null)
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | message | The message to be shown. |
| Dalamud.Game.Gui.Toast.ToastOptions | options | Options for the toast. |
ShowQuest(ReadOnlySeString, QuestToastOptions?)
Show a quest toast message with the given content.
Declaration
void ShowQuest(ReadOnlySeString message, QuestToastOptions? options = null)
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | message | The message to be shown. |
| Dalamud.Game.Gui.Toast.QuestToastOptions | options | Options for the toast. |
ShowError(ReadOnlySeString)
Show an error toast message with the given content.
Declaration
void ShowError(ReadOnlySeString message)
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | message | The message to be shown. |
Events
Toast
Event that will be fired when a toast is sent by the game or a plugin.
Declaration
event IToastGui.NormalToastDelegate Toast
Event Type
Dalamud.Plugin.Services.IToastGui.NormalToastDelegate
QuestToast
Event that will be fired when a quest toast is sent by the game or a plugin.
Declaration
event IToastGui.QuestToastDelegate QuestToast
Event Type
Dalamud.Plugin.Services.IToastGui.QuestToastDelegate
ErrorToast
Event that will be fired when an error toast is sent by the game or a plugin.
Declaration
event IToastGui.ErrorToastDelegate ErrorToast