mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
650 lines
33 KiB
HTML
650 lines
33 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 ChatGui
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ChatGui
|
|
">
|
|
<meta name="generator" content="docfx 2.56.6.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.Internal.Gui.ChatGui">
|
|
|
|
|
|
<h1 id="Dalamud_Game_Internal_Gui_ChatGui" data-uid="Dalamud.Game.Internal.Gui.ChatGui" class="text-break">Class ChatGui
|
|
</h1>
|
|
<div class="markdown level0 summary"></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">ChatGui</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.ToString()</span>
|
|
</div>
|
|
<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.ReferenceEquals(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>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.Internal.Gui.html">Dalamud.Game.Internal.Gui</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Game_Internal_Gui_ChatGui_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class ChatGui : IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui__ctor_System_IntPtr_Dalamud_Game_SigScanner_Dalamud_Dalamud_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.%23ctor(System.IntPtr%2CDalamud.Game.SigScanner%2CDalamud.Dalamud)%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L89">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui__ctor_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.#ctor*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui__ctor_System_IntPtr_Dalamud_Game_SigScanner_Dalamud_Dalamud_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.#ctor(System.IntPtr,Dalamud.Game.SigScanner,Dalamud.Dalamud)">ChatGui(IntPtr, SigScanner, Dalamud)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ChatGui(IntPtr baseAddress, SigScanner scanner, Dalamud dalamud)</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.IntPtr</span></td>
|
|
<td><span class="parametername">baseAddress</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.SigScanner.html">SigScanner</a></td>
|
|
<td><span class="parametername">scanner</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Dalamud.html">Dalamud</a></td>
|
|
<td><span class="parametername">dalamud</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemFlags.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemFlags%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L81">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemFlags_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemFlags*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemFlags" data-uid="Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemFlags">LastLinkedItemFlags</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte LastLinkedItemFlags { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Byte</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemId.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemId%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L80">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemId_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemId*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_LastLinkedItemId" data-uid="Dalamud.Game.Internal.Gui.ChatGui.LastLinkedItemId">LastLinkedItemId</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int LastLinkedItemId { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_Dispose.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L116">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_Dispose_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Dispose*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_Dispose" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"></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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_Enable.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L110">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_Enable_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Enable*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_Enable" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Enable">Enable()</h4>
|
|
<div class="markdown level1 summary"></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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_Print_Dalamud_Game_Text_SeStringHandling_SeString_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.Print(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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L313">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_Print_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Print*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_Print_Dalamud_Game_Text_SeStringHandling_SeString_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Print(Dalamud.Game.Text.SeStringHandling.SeString)">Print(SeString)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Print(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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_Print_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.Print(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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L305">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_Print_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Print*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_Print_System_String_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.Print(System.String)">Print(String)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Print(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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_PrintChat_Dalamud_Game_Text_XivChatEntry_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.PrintChat(Dalamud.Game.Text.XivChatEntry)%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L301">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_PrintChat_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintChat*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_PrintChat_Dalamud_Game_Text_XivChatEntry_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintChat(Dalamud.Game.Text.XivChatEntry)">PrintChat(XivChatEntry)</h4>
|
|
<div class="markdown level1 summary"><p>Queue a chat message. While method is named as PrintChat, it only add a entry to the queue,
|
|
later to be processed when UpdateQueue() is called.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PrintChat(XivChatEntry chat)</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.XivChatEntry.html">XivChatEntry</a></td>
|
|
<td><span class="parametername">chat</span></td>
|
|
<td><p>A message to send.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_PrintError_Dalamud_Game_Text_SeStringHandling_SeString_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.PrintError(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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L329">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_Dalamud_Game_Text_SeStringHandling_SeString_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError(Dalamud.Game.Text.SeStringHandling.SeString)">PrintError(SeString)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PrintError(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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_PrintError_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.PrintError(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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L321">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_System_String_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError(System.String)">PrintError(String)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void PrintError(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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_Dalamud_Game_Internal_Framework_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue(Dalamud.Game.Internal.Framework)%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L340">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue*"></a>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_Dalamud_Game_Internal_Framework_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue(Dalamud.Game.Internal.Framework)">UpdateQueue(Framework)</h4>
|
|
<div class="markdown level1 summary"><p>Process a chat queue.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void UpdateQueue(Framework framework)</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.Internal.Framework.html">Framework</a></td>
|
|
<td><span class="parametername">framework</span></td>
|
|
<td></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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_OnChatMessage.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.OnChatMessage%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L33">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_OnChatMessage" data-uid="Dalamud.Game.Internal.Gui.ChatGui.OnChatMessage">OnChatMessage</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a chat message is sent to chat by the game.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ChatGui.OnMessageDelegate OnChatMessage</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.Internal.Gui.ChatGui.OnMessageDelegate.html">ChatGui.OnMessageDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageHandled.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageHandled%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L38">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageHandled" data-uid="Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageHandled">OnChatMessageHandled</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a chat message is handled by Dalamud 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 ChatGui.OnMessageHandledDelegate OnChatMessageHandled</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.Internal.Gui.ChatGui.OnMessageHandledDelegate.html">ChatGui.OnMessageHandledDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageRaw.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageRaw%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L49">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageRaw" data-uid="Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageRaw">OnChatMessageRaw</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a chat message is sent by the game, containing raw, unparsed data.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("Please use OnChatMessage instead. For modifications, it will take precedence.")]
|
|
public event ChatGui.OnMessageRawDelegate OnChatMessageRaw</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.Internal.Gui.ChatGui.OnMessageRawDelegate.html">ChatGui.OnMessageRawDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageUnhandled.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageUnhandled%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L43">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_OnChatMessageUnhandled" data-uid="Dalamud.Game.Internal.Gui.ChatGui.OnChatMessageUnhandled">OnChatMessageUnhandled</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be fired when a chat message is not handled by Dalamud 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 ChatGui.OnMessageUnhandledDelegate OnChatMessageUnhandled</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.Internal.Gui.ChatGui.OnMessageUnhandledDelegate.html">ChatGui.OnMessageUnhandledDelegate</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_OnCheckMessageHandled.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.OnCheckMessageHandled%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L28">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_OnCheckMessageHandled" data-uid="Dalamud.Game.Internal.Gui.ChatGui.OnCheckMessageHandled">OnCheckMessageHandled</h4>
|
|
<div class="markdown level1 summary"><p>Event that allows you to stop messages from appearing in chat by setting the isHandled parameter to true.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ChatGui.OnCheckMessageHandledDelegate OnCheckMessageHandled</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.Internal.Gui.ChatGui.OnCheckMessageHandledDelegate.html">ChatGui.OnCheckMessageHandledDelegate</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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L14" 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>
|