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