mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-02-04 23:14:35 +01:00
docs: regenerate
This commit is contained in:
goat
parent
1a6971d3f3
commit
1b2bdb74bb
30 changed files with 352 additions and 1987 deletions
|
|
@ -121,39 +121,22 @@
|
|||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public abstract class Payload</code></pre>
|
||||
</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_Payload__ctor.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.%23ctor%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/Payload.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload__ctor_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.#ctor*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload__ctor" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.#ctor">Payload()</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">protected Payload()</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</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_Payload_dataResolver.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.dataResolver%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_Chat_SeStringHandling_Payload_DataResolver.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.DataResolver%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/Payload.cs/#L54">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_dataResolver" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.dataResolver">dataResolver</h4>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_DataResolver" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.DataResolver">DataResolver</h4>
|
||||
<div class="markdown level1 summary"><p>The Lumina instance to use for any necessary data lookups.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected DataManager dataResolver</code></pre>
|
||||
<pre><code class="lang-csharp hljs">protected DataManager DataResolver</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -175,7 +158,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_END_BYTE.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.END_BYTE%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/Payload.cs/#L215">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L207">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_END_BYTE" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.END_BYTE">END_BYTE</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -204,7 +187,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_START_BYTE.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.START_BYTE%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/Payload.cs/#L214">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L206">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_START_BYTE" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.START_BYTE">START_BYTE</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -296,19 +279,19 @@
|
|||
</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_Payload_Decode_System_IO_BinaryReader_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.Decode(System.IO.BinaryReader)%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_Chat_SeStringHandling_Payload_Decode_System_IO_BinaryReader_Dalamud_Data_DataManager_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.Decode(System.IO.BinaryReader%2CDalamud.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/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L91">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L81">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_Decode_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.Decode*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_Decode_System_IO_BinaryReader_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.Decode(System.IO.BinaryReader)">Decode(BinaryReader)</h4>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_Decode_System_IO_BinaryReader_Dalamud_Data_DataManager_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.Decode(System.IO.BinaryReader,Dalamud.Data.DataManager)">Decode(BinaryReader, DataManager)</h4>
|
||||
<div class="markdown level1 summary"><p>Decodes a binary representation of a payload into its corresponding nice object payload.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Payload Decode(BinaryReader reader)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static Payload Decode(BinaryReader reader, DataManager data)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -326,6 +309,11 @@
|
|||
<td><p>A reader positioned at the start of the payload, and containing at least one entire payload.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<h5 class="returns">Returns</h5>
|
||||
|
|
@ -389,7 +377,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_Encode_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.Encode(System.Boolean)%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/Payload.cs/#L75">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L65">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_Encode_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.Encode*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_Encode_System_Boolean_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.Encode(System.Boolean)">Encode(Boolean)</h4>
|
||||
|
|
@ -472,7 +460,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_GetInteger_System_IO_BinaryReader_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.GetInteger(System.IO.BinaryReader)%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/Payload.cs/#L257">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L256">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_GetInteger_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetInteger*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_GetInteger_System_IO_BinaryReader_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetInteger(System.IO.BinaryReader)">GetInteger(BinaryReader)</h4>
|
||||
|
|
@ -519,7 +507,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForIntegerBytes_System_Byte___.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForIntegerBytes(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/Payload.cs/#L350">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L389">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForIntegerBytes_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForIntegerBytes*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForIntegerBytes_System_Byte___" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForIntegerBytes(System.Byte[])">GetMarkerForIntegerBytes(Byte[])</h4>
|
||||
|
|
@ -566,7 +554,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForPackedIntegerBytes_System_Byte___.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForPackedIntegerBytes(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/Payload.cs/#L366">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L405">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForPackedIntegerBytes_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForPackedIntegerBytes*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_GetMarkerForPackedIntegerBytes_System_Byte___" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetMarkerForPackedIntegerBytes(System.Byte[])">GetMarkerForPackedIntegerBytes(Byte[])</h4>
|
||||
|
|
@ -613,7 +601,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_GetPackedIntegers_System_IO_BinaryReader_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.GetPackedIntegers(System.IO.BinaryReader)%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/Payload.cs/#L380">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L419">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_GetPackedIntegers_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetPackedIntegers*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_GetPackedIntegers_System_IO_BinaryReader_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.GetPackedIntegers(System.IO.BinaryReader)">GetPackedIntegers(BinaryReader)</h4>
|
||||
|
|
@ -660,7 +648,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_MakeInteger_System_UInt32_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.MakeInteger(System.UInt32%2CSystem.Boolean%2CSystem.Boolean)%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/Payload.cs/#L318">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L357">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_MakeInteger_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.MakeInteger*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_MakeInteger_System_UInt32_System_Boolean_System_Boolean_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.MakeInteger(System.UInt32,System.Boolean,System.Boolean)">MakeInteger(UInt32, Boolean, Boolean)</h4>
|
||||
|
|
@ -717,7 +705,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Chat_SeStringHandling_Payload_MakePackedInteger_System_UInt32_System_UInt32_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Game.Chat.SeStringHandling.Payload.MakePackedInteger(System.UInt32%2CSystem.UInt32%2CSystem.Boolean)%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/Payload.cs/#L411">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Chat/SeStringHandling/Payload.cs/#L450">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Chat_SeStringHandling_Payload_MakePackedInteger_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.MakePackedInteger*"></a>
|
||||
<h4 id="Dalamud_Game_Chat_SeStringHandling_Payload_MakePackedInteger_System_UInt32_System_UInt32_System_Boolean_" data-uid="Dalamud.Game.Chat.SeStringHandling.Payload.MakePackedInteger(System.UInt32,System.UInt32,System.Boolean)">MakePackedInteger(UInt32, UInt32, Boolean)</h4>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue