docs: regenerate

This commit is contained in:
goat 2021-08-21 22:57:51 +02:00
parent c864cae087
commit 1eb35f29eb
No known key found for this signature in database
GPG key ID: F18F057873895461
935 changed files with 148201 additions and 35402 deletions

View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SeStringManager
">
<meta name="generator" content="docfx 2.56.6.0">
<meta name="generator" content="docfx 2.58.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -73,7 +73,8 @@
<h1 id="Dalamud_Game_Text_SeStringHandling_SeStringManager" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager" class="text-break">Class SeStringManager
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 summary"><p>This class facilitates creating new SeStrings and breaking down existing ones into their individual payload components.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
@ -82,18 +83,12 @@
</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>
@ -103,55 +98,27 @@
<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.Text.SeStringHandling.html">Dalamud.Game.Text.SeStringHandling</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SeStringManager</code></pre>
<pre><code class="lang-csharp hljs">public sealed class SeStringManager</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_Text_SeStringHandling_SeStringManager__ctor_Dalamud_Data_DataManager_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.%23ctor(Dalamud.Data.DataManager)%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/Text/SeStringHandling/SeStringManager.cs/#L18">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager__ctor_Dalamud_Data_DataManager_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.#ctor(Dalamud.Data.DataManager)">SeStringManager(DataManager)</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 SeStringManager(DataManager Data)</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.Data.DataManager.html">DataManager</a></td>
<td><span class="parametername">Data</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_Text_SeStringHandling_SeStringManager_CreateItemLink_Lumina_Excel_GeneratedSheets_Item_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(Lumina.Excel.GeneratedSheets.Item%2CSystem.Boolean%2CSystem.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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_Lumina_Excel_GeneratedSheets_Item_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(Lumina.Excel.GeneratedSheets.Item%2CSystem.Boolean%2CSystem.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/Text/SeStringHandling/SeStringManager.cs/#L84">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L91">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_Lumina_Excel_GeneratedSheets_Item_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(Lumina.Excel.GeneratedSheets.Item,System.Boolean,System.String)">CreateItemLink(Item, Boolean, String)</h4>
@ -210,10 +177,10 @@
</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_Text_SeStringHandling_SeStringManager_CreateItemLink_System_UInt32_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(System.UInt32%2CSystem.Boolean%2CSystem.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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_System_UInt32_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(System.UInt32%2CSystem.Boolean%2CSystem.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/Text/SeStringHandling/SeStringManager.cs/#L52">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L57">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateItemLink_System_UInt32_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateItemLink(System.UInt32,System.Boolean,System.String)">CreateItemLink(UInt32, Boolean, String)</h4>
@ -272,10 +239,10 @@
</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_Text_SeStringHandling_SeStringManager_CreateMapLink_System_String_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.String%2CSystem.Single%2CSystem.Single%2CSystem.Single)%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_String_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.String%2CSystem.Single%2CSystem.Single%2CSystem.Single)%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/Text/SeStringHandling/SeStringManager.cs/#L140">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L155">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_String_System_Single_System_Single_System_Single_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.String,System.Single,System.Single,System.Single)">CreateMapLink(String, Single, Single, Single)</h4>
@ -340,14 +307,15 @@
</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_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32%2CSystem.UInt32%2CSystem.Int32%2CSystem.Int32)%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32%2CSystem.UInt32%2CSystem.Int32%2CSystem.Int32)%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/Text/SeStringHandling/SeStringManager.cs/#L89">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L104">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Int32_System_Int32_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32,System.UInt32,System.Int32,System.Int32)">CreateMapLink(UInt32, UInt32, Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -366,22 +334,26 @@
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">territoryId</span></td>
<td></td>
<td><p>The id of the TerritoryType for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">mapId</span></td>
<td></td>
<td><p>The id of the Map for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rawX</span></td>
<td></td>
<td><p>The raw x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rawY</span></td>
<td></td>
<td><p>The raw y-coordinate for this link..</p>
</td>
</tr>
</tbody>
</table>
@ -396,16 +368,17 @@
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td></td>
<td><p>An SeString containing all of the payloads necessary to display a map link in the chat log.</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_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32%2CSystem.UInt32%2CSystem.Single%2CSystem.Single%2CSystem.Single)%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32%2CSystem.UInt32%2CSystem.Single%2CSystem.Single%2CSystem.Single)%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/Text/SeStringHandling/SeStringManager.cs/#L115">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L130">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_CreateMapLink_System_UInt32_System_UInt32_System_Single_System_Single_System_Single_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.CreateMapLink(System.UInt32,System.UInt32,System.Single,System.Single,System.Single)">CreateMapLink(UInt32, UInt32, Single, Single, Single)</h4>
@ -476,10 +449,10 @@
</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_Text_SeStringHandling_SeStringManager_Parse_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.Byte%5B%5D)%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_Parse_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.Byte%5B%5D)%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/Text/SeStringHandling/SeStringManager.cs/#L27">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L32">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_Parse_System_Byte___" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.Byte[])">Parse(Byte[])</h4>
@ -526,10 +499,10 @@
</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_Text_SeStringHandling_SeStringManager_TextArrowPayloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.TextArrowPayloads%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_TextArrowPayloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.TextArrowPayloads%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/Text/SeStringHandling/SeStringManager.cs/#L166">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L183">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeStringManager_TextArrowPayloads_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.TextArrowPayloads*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeStringManager_TextArrowPayloads" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.TextArrowPayloads">TextArrowPayloads()</h4>
@ -565,10 +538,10 @@ with the appropriate glow and coloring.</p>
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager%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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager%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/Text/SeStringHandling/SeStringManager.cs/#L14" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L16" class="contribution-link">View Source</a>
</li>
</ul>
</div>