mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
518 lines
26 KiB
HTML
518 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ToastGui
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ToastGui
|
|
">
|
|
<meta name="generator" content="docfx 2.58.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Game.Gui.Toast.ToastGui">
|
|
|
|
|
|
<h1 id="Dalamud_Game_Gui_Toast_ToastGui" data-uid="Dalamud.Game.Gui.Toast.ToastGui" class="text-break">Class ToastGui
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class facilitates interacting with and creating native toast windows.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">ToastGui</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">System.IDisposable</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.Gui.Toast.html">Dalamud.Game.Gui.Toast</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Game_Gui_Toast_ToastGui_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class ToastGui : IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_Dispose.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L113">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_Dispose_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.Dispose*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_Dispose" data-uid="Dalamud.Game.Gui.Toast.ToastGui.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Disposes of managed and unmanaged resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_Enable.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.Enable%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L103">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_Enable_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.Enable*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_Enable" data-uid="Dalamud.Game.Gui.Toast.ToastGui.Enable">Enable()</h4>
|
|
<div class="markdown level1 summary"><p>Enables this module.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Enable()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowError_Dalamud_Game_Text_SeStringHandling_SeString_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowError(Dalamud.Game.Text.SeStringHandling.SeString)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L378">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowError_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowError*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowError_Dalamud_Game_Text_SeStringHandling_SeString_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowError(Dalamud.Game.Text.SeStringHandling.SeString)">ShowError(SeString)</h4>
|
|
<div class="markdown level1 summary"><p>Show an error toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowError(SeString message)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowError_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowError(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L369">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowError_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowError*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowError_System_String_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowError(System.String)">ShowError(String)</h4>
|
|
<div class="markdown level1 summary"><p>Show an error toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowError(string message)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Gui_Toast_ToastOptions_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowNormal(Dalamud.Game.Text.SeStringHandling.SeString%2CDalamud.Game.Gui.Toast.ToastOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L192">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowNormal*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Gui_Toast_ToastOptions_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowNormal(Dalamud.Game.Text.SeStringHandling.SeString,Dalamud.Game.Gui.Toast.ToastOptions)">ShowNormal(SeString, ToastOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Show a toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowNormal(SeString message, ToastOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.ToastOptions.html">ToastOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>Options for the toast.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_System_String_Dalamud_Game_Gui_Toast_ToastOptions_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowNormal(System.String%2CDalamud.Game.Gui.Toast.ToastOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L181">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowNormal*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowNormal_System_String_Dalamud_Game_Gui_Toast_ToastOptions_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowNormal(System.String,Dalamud.Game.Gui.Toast.ToastOptions)">ShowNormal(String, ToastOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Show a toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowNormal(string message, ToastOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.ToastOptions.html">ToastOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>Options for the toast.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Gui_Toast_QuestToastOptions_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowQuest(Dalamud.Game.Text.SeStringHandling.SeString%2CDalamud.Game.Gui.Toast.QuestToastOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L273">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowQuest*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_Dalamud_Game_Text_SeStringHandling_SeString_Dalamud_Game_Gui_Toast_QuestToastOptions_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowQuest(Dalamud.Game.Text.SeStringHandling.SeString,Dalamud.Game.Gui.Toast.QuestToastOptions)">ShowQuest(SeString, QuestToastOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Show a quest toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowQuest(SeString message, QuestToastOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.QuestToastOptions.html">QuestToastOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>Options for the toast.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_System_String_Dalamud_Game_Gui_Toast_QuestToastOptions_.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ShowQuest(System.String%2CDalamud.Game.Gui.Toast.QuestToastOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L262">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowQuest*"></a>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ShowQuest_System_String_Dalamud_Game_Gui_Toast_QuestToastOptions_" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ShowQuest(System.String,Dalamud.Game.Gui.Toast.QuestToastOptions)">ShowQuest(String, QuestToastOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Show a quest toast message with the given content.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ShowQuest(string message, QuestToastOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">message</span></td>
|
|
<td><p>The message to be shown.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.QuestToastOptions.html">QuestToastOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>Options for the toast.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="events">Events
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_ErrorToast.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.ErrorToast%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L96">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_ErrorToast" data-uid="Dalamud.Game.Gui.Toast.ToastGui.ErrorToast">ErrorToast</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when an error toast is sent by the game or a plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ToastGui.OnErrorToastDelegate ErrorToast</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.ToastGui.OnErrorToastDelegate.html">ToastGui.OnErrorToastDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_QuestToast.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.QuestToast%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L91">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_QuestToast" data-uid="Dalamud.Game.Gui.Toast.ToastGui.QuestToast">QuestToast</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a quest toast is sent by the game or a plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ToastGui.OnQuestToastDelegate QuestToast</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.ToastGui.OnQuestToastDelegate.html">ToastGui.OnQuestToastDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui_Toast.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui.Toast%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L86">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Gui_Toast_ToastGui_Toast" data-uid="Dalamud.Game.Gui.Toast.ToastGui.Toast">Toast</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a toast is sent by the game or a plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ToastGui.OnNormalToastDelegate Toast</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.Gui.Toast.ToastGui.OnNormalToastDelegate.html">ToastGui.OnNormalToastDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.IDisposable</span>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_Toast_ToastGui.md&value=---%0Auid%3A%20Dalamud.Game.Gui.Toast.ToastGui%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Gui/Toast/ToastGui.cs/#L363" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|