docs: regenerate

This commit is contained in:
goat 2020-05-12 20:44:53 +02:00
parent 5a80342243
commit 054315dfc0
85 changed files with 24425 additions and 2247 deletions

View file

@ -113,16 +113,51 @@
</div>
<h3 id="constructors">Constructors
</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_Chat_SeStringHandling_SeString__ctor_Dalamud_Game_Chat_SeStringHandling_Payload___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.%23ctor(Dalamud.Game.Chat.SeStringHandling.Payload%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/Chat/SeStringHandling/SeString.cs/#L75">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString__ctor_Dalamud_Game_Chat_SeStringHandling_Payload___" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.#ctor(Dalamud.Game.Chat.SeStringHandling.Payload[])">SeString(Payload[])</h4>
<div class="markdown level1 summary"><p>Creates a new SeString from an ordered list of payloads.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString(Payload[] payloads)</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.Chat.SeStringHandling.Payload.html">Payload</a>[]</td>
<td><span class="parametername">payloads</span></td>
<td><p>The Payload objects to make up this string.</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_Chat_SeStringHandling_SeString__ctor_System_Collections_Generic_List_Dalamud_Game_Chat_SeStringHandling_Payload__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.%23ctor(System.Collections.Generic.List%7BDalamud.Game.Chat.SeStringHandling.Payload%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/Chat/SeStringHandling/SeString.cs/#L19">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L66">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString__ctor_System_Collections_Generic_List_Dalamud_Game_Chat_SeStringHandling_Payload__" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.#ctor(System.Collections.Generic.List{Dalamud.Game.Chat.SeStringHandling.Payload})">SeString(List&lt;Payload&gt;)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Creates a new SeString from an ordered list of payloads.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -141,7 +176,8 @@
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Dalamud.Game.Chat.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><span class="parametername">payloads</span></td>
<td></td>
<td><p>The Payload objects to make up this string.</p>
</td>
</tr>
</tbody>
</table>
@ -152,11 +188,12 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_SeString_Payloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.Payloads%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/Chat/SeStringHandling/SeString.cs/#L17">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L20">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Payloads_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Payloads*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Payloads" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Payloads">Payloads</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The ordered list of payloads included in this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -182,7 +219,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_SeString_TextValue.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.TextValue%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/Chat/SeStringHandling/SeString.cs/#L30">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L28">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_TextValue_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.TextValue*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_TextValue" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.TextValue">TextValue</h4>
@ -211,16 +248,167 @@
</table>
<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_Chat_SeStringHandling_SeString_Append_Dalamud_Game_Chat_SeStringHandling_Payload_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.Append(Dalamud.Game.Chat.SeStringHandling.Payload)%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/Chat/SeStringHandling/SeString.cs/#L107">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_Dalamud_Game_Chat_SeStringHandling_Payload_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append(Dalamud.Game.Chat.SeStringHandling.Payload)">Append(Payload)</h4>
<div class="markdown level1 summary"><p>Appends a single payload to this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(Payload payload)</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.Chat.SeStringHandling.Payload.html">Payload</a></td>
<td><span class="parametername">payload</span></td>
<td><p>The payload to append.</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.Chat.SeStringHandling.SeString.html">SeString</a></td>
<td><p>This object.</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_Chat_SeStringHandling_SeString_Append_Dalamud_Game_Chat_SeStringHandling_SeString_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.Append(Dalamud.Game.Chat.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/Chat/SeStringHandling/SeString.cs/#L85">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_Dalamud_Game_Chat_SeStringHandling_SeString_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append(Dalamud.Game.Chat.SeStringHandling.SeString)">Append(SeString)</h4>
<div class="markdown level1 summary"><p>Appends the contents of one SeString to this one.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(SeString other)</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.Chat.SeStringHandling.SeString.html">SeString</a></td>
<td><span class="parametername">other</span></td>
<td><p>The SeString to append to this one.</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.Chat.SeStringHandling.SeString.html">SeString</a></td>
<td><p>This object.</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_Chat_SeStringHandling_SeString_Append_System_Collections_Generic_List_Dalamud_Game_Chat_SeStringHandling_Payload__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.Append(System.Collections.Generic.List%7BDalamud.Game.Chat.SeStringHandling.Payload%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/Chat/SeStringHandling/SeString.cs/#L96">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Append_System_Collections_Generic_List_Dalamud_Game_Chat_SeStringHandling_Payload__" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Append(System.Collections.Generic.List{Dalamud.Game.Chat.SeStringHandling.Payload})">Append(List&lt;Payload&gt;)</h4>
<div class="markdown level1 summary"><p>Appends a list of payloads to this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(List&lt;Payload&gt; payloads)</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.Collections.Generic.List</span>&lt;<a class="xref" href="Dalamud.Game.Chat.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><span class="parametername">payloads</span></td>
<td><p>The Payloads to append.</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.Chat.SeStringHandling.SeString.html">SeString</a></td>
<td><p>This object.</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_Chat_SeStringHandling_SeString_Encode.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.Encode%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/Chat/SeStringHandling/SeString.cs/#L74">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L118">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Encode_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Encode*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Encode" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Encode">Encode()</h4>
<div class="markdown level1 summary"><p>Encode a parsed/created SeString to an array of bytes, to be used for injection.</p>
<div class="markdown level1 summary"><p>Encodes the Payloads in this SeString into a binary representation
suitable for use by in-game handlers, such as the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -238,7 +426,7 @@
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><p>The bytes of the message.</p>
<td><p>The binary encoded payload data.</p>
</td>
</tr>
</tbody>
@ -248,11 +436,11 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_SeString_Parse_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.SeString.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/Chat/SeStringHandling/SeString.cs/#L51">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L44">View Source</a>
</span>
<a id="Dalamud_Game_Chat_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Chat_SeStringHandling_SeString_Parse_System_Byte___" data-uid="Dalamud.Game.Chat.SeStringHandling.SeString.Parse(System.Byte[])">Parse(Byte[])</h4>
<div class="markdown level1 summary"><p>Parse an array of bytes to a SeString.</p>
<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>
@ -272,7 +460,8 @@
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">bytes</span></td>
<td></td>
<td><p>Binary message payload data in SE's internal format.</p>
</td>
</tr>
</tbody>
</table>
@ -287,7 +476,8 @@
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Chat.SeStringHandling.SeString.html">SeString</a></td>
<td></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
</table>
@ -302,7 +492,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_SeString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Chat.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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L15" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/SeString.cs/#L12" class="contribution-link">View Source</a>
</li>
</ul>
</div>