docs: regenerate

This commit is contained in:
goat 2021-08-28 19:41:14 +02:00
parent 5efe65a655
commit 92d646f538
No known key found for this signature in database
GPG key ID: F18F057873895461
324 changed files with 13728 additions and 6843 deletions

View file

@ -109,7 +109,8 @@
<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 sealed class SeStringManager</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This class is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public sealed class SeStringManager</code></pre>
</div>
<h3 id="methods">Methods
</h3>
@ -118,7 +119,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L91">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L71">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>
@ -127,7 +128,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString CreateItemLink(Item item, bool isHQ, string displayNameOverride = null)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString CreateItemLink(Item item, bool isHQ, string displayNameOverride = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -180,7 +182,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L57">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L61">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>
@ -189,7 +191,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString CreateItemLink(uint itemId, bool isHQ, string displayNameOverride = null)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString CreateItemLink(uint itemId, bool isHQ, string displayNameOverride = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -242,7 +245,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L155">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L106">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>
@ -251,7 +254,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString CreateMapLink(string placeName, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString CreateMapLink(string placeName, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -310,7 +314,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L104">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L82">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>
@ -319,7 +323,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString CreateMapLink(uint territoryId, uint mapId, int rawX, int rawY)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString CreateMapLink(uint territoryId, uint mapId, int rawX, int rawY)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -378,7 +383,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L130">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L95">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>
@ -387,7 +392,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString CreateMapLink(uint territoryId, uint mapId, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString CreateMapLink(uint territoryId, uint mapId, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -443,6 +449,63 @@
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeStringManager_Parse_System_Byte__System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.Byte*%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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L35">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__System_Int32_" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.Byte*,System.Int32)">Parse(Byte*, Int32)</h4>
<div class="markdown level1 summary"><p>Parse a binary game message into an SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString Parse(byte *ptr, int len)</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.Byte</span>*</td>
<td><span class="parametername">ptr</span></td>
<td><p>Pointer to the string's data in memory.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>Length of the string's data in memory.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
@ -452,7 +515,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L32">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L51">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>
@ -461,7 +524,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Parse(byte[] bytes)</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString Parse(byte[] bytes)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -493,6 +557,57 @@
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</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_Text_SeStringHandling_SeStringManager_Parse_System_ReadOnlySpan_System_Byte__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.ReadOnlySpan%7BSystem.Byte%7D)%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/Text/SeStringHandling/SeStringManager.cs/#L43">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_ReadOnlySpan_System_Byte__" data-uid="Dalamud.Game.Text.SeStringHandling.SeStringManager.Parse(System.ReadOnlySpan{System.Byte})">Parse(ReadOnlySpan&lt;Byte&gt;)</h4>
<div class="markdown level1 summary"><p>Parse a binary game message into an SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is obsolete. Please use the static methods on SeString instead.&quot;, true)]
public SeString Parse(ReadOnlySpan&lt;byte&gt; 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><span class="xref">System.ReadOnlySpan</span>&lt;<span class="xref">System.Byte</span>&gt;</td>
<td><span class="parametername">data</span></td>
<td><p>Binary message payload data in SE's internal format.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
@ -502,7 +617,7 @@
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L183">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L114">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>
@ -512,7 +627,8 @@ with the appropriate glow and coloring.</p>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;Payload&gt; TextArrowPayloads()</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This data is obsolete. Please use the static version on SeString instead.&quot;, true)]
public List&lt;Payload&gt; TextArrowPayloads()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
@ -541,7 +657,7 @@ with the appropriate glow and coloring.</p>
<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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L16" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeStringManager.cs/#L17" class="contribution-link">View Source</a>
</li>
</ul>
</div>