ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: regenerate

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

552
docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html
View file

@ -115,7 +115,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString__ctor.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%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/Text/SeStringHandling/SeString.cs/#L19">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L23">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor">SeString()</h4>
@ -132,7 +132,7 @@ Creates a new SeString from an ordered list of payloads.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString__ctor_Dalamud_Game_Text_SeStringHandling_Payload___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%23ctor(Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L40">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L44">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_Dalamud_Game_Text_SeStringHandling_Payload___" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor(Dalamud.Game.Text.SeStringHandling.Payload[])">SeString(Payload[])</h4>
@ -167,7 +167,7 @@ Creates a new SeString from an ordered list of payloads.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString__ctor_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%23ctor(System.Collections.Generic.List%7BDalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L29">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L33">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor(System.Collections.Generic.List{Dalamud.Game.Text.SeStringHandling.Payload})">SeString(List&lt;Payload&gt;)</h4>
@ -205,7 +205,7 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Payloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L48">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L66">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Payloads_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Payloads*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Payloads" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Payloads">Payloads</h4>
@ -231,12 +231,45 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
</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_SeString_TextArrowPayloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L54">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_TextArrowPayloads_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextArrowPayloads*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_TextArrowPayloads" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextArrowPayloads">TextArrowPayloads</h4>
<div class="markdown level1 summary"><p>Gets a list of Payloads necessary to display the arrow link marker icon in chat
with the appropriate glow and coloring.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;Payload&gt; TextArrowPayloads { 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.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><p>A list of all the payloads required to insert the link marker.</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_SeString_TextValue.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L56">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L74">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_TextValue_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextValue*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_TextValue" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextValue">TextValue</h4>
@ -270,7 +303,7 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Append_Dalamud_Game_Text_SeStringHandling_Payload_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Append(Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L132">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L323">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Append_Dalamud_Game_Text_SeStringHandling_Payload_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append(Dalamud.Game.Text.SeStringHandling.Payload)">Append(Payload)</h4>
@ -320,7 +353,7 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Append_Dalamud_Game_Text_SeStringHandling_SeString_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Append(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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L110">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L301">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Append_Dalamud_Game_Text_SeStringHandling_SeString_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append(Dalamud.Game.Text.SeStringHandling.SeString)">Append(SeString)</h4>
@ -370,7 +403,7 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Append_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Append(System.Collections.Generic.List%7BDalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L121">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L312">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Append_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Append_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Append(System.Collections.Generic.List{Dalamud.Game.Text.SeStringHandling.Payload})">Append(List&lt;Payload&gt;)</h4>
@ -417,11 +450,346 @@ public SeString(List&lt;Payload&gt; payloads)</code></pre>
</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_SeString_Encode.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.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>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_Lumina_Excel_GeneratedSheets_Item_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L177">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_Lumina_Excel_GeneratedSheets_Item_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(Lumina.Excel.GeneratedSheets.Item,System.Boolean,System.String)">CreateItemLink(Item, Boolean, String)</h4>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static 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">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Excel.GeneratedSheets.Item</span></td>
<td><span class="parametername">item</span></td>
<td><p>The Lumina Item to link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isHq</span></td>
<td><p>Whether to link the high-quality variant of the item.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">displayNameOverride</span></td>
<td><p>An optional name override to display, instead of the actual item name.</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 all the payloads necessary to display an item 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_SeString_CreateItemLink_System_UInt32_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L143">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_System_UInt32_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(System.UInt32,System.Boolean,System.String)">CreateItemLink(UInt32, Boolean, String)</h4>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static 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">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">itemId</span></td>
<td><p>The id of the item to link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isHq</span></td>
<td><p>Whether to link the high-quality variant of the item.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">displayNameOverride</span></td>
<td><p>An optional name override to display, instead of the actual item name.</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 all the payloads necessary to display an item 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_SeString_CreateMapLink_System_String_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L242">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_System_String_System_Single_System_Single_System_Single_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink(System.String,System.Single,System.Single,System.Single)">CreateMapLink(String, Single, Single, Single)</h4>
<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, matching a specified zone name.
Returns null if no corresponding PlaceName was found.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static 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">
<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">placeName</span></td>
<td><p>The name of the location for this link. This should be exactly the name as seen in a displayed map link in-game for the same zone.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">xCoord</span></td>
<td><p>The human-readable x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">yCoord</span></td>
<td><p>The human-readable y-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">fudgeFactor</span></td>
<td><p>An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.</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 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_SeString_CreateMapLink_System_UInt32_System_UInt32_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L190">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_System_UInt32_System_UInt32_System_Int32_System_Int32_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink(System.UInt32,System.UInt32,System.Int32,System.Int32)">CreateMapLink(UInt32, UInt32, Int32, Int32)</h4>
<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">
<pre><code class="lang-csharp hljs">public static 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">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">territoryId</span></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><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><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><p>The raw y-coordinate for this link..</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 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_SeString_CreateMapLink_System_UInt32_System_UInt32_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L216">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateMapLink_System_UInt32_System_UInt32_System_Single_System_Single_System_Single_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateMapLink(System.UInt32,System.UInt32,System.Single,System.Single,System.Single)">CreateMapLink(UInt32, UInt32, Single, Single, Single)</h4>
<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">
<pre><code class="lang-csharp hljs">public static 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">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">territoryId</span></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><p>The id of the Map for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">xCoord</span></td>
<td><p>The human-readable x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">yCoord</span></td>
<td><p>The human-readable y-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">fudgeFactor</span></td>
<td><p>An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.</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 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_SeString_Encode.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L334">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Encode_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Encode*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Encode" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Encode">Encode()</h4>
<div class="markdown level1 summary"><p>Encodes the Payloads in this SeString into a binary representation
@ -453,7 +821,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_FromJson_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.FromJson(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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L79">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L270">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_FromJson_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.FromJson*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_FromJson_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.FromJson(System.String)">FromJson(String)</h4>
@ -494,6 +862,162 @@ suitable for use by in-game handlers, such as the chat log.</p>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>A SeString initialized with values from the json.</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_SeString_Parse_System_Byte__System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L98">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte__System_Int32_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.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">public static 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>
</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_SeString_Parse_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.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/Text/SeStringHandling/SeString.cs/#L134">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte___" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.Byte[])">Parse(Byte[])</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">public static SeString Parse(byte[] bytes)</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">bytes</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>
</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_SeString_Parse_System_ReadOnlySpan_System_Byte__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.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/SeString.cs/#L121">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_ReadOnlySpan_System_Byte__" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.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">public static 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>
@ -503,7 +1027,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_ToJson.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.ToJson%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/SeString.cs/#L95">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L286">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_ToJson_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.ToJson*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_ToJson" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.ToJson">ToJson()</h4>
@ -535,7 +1059,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_ToString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.ToString%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/SeString.cs/#L158">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L349">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_ToString_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.ToString*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_ToString" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.ToString">ToString()</h4>
@ -571,7 +1095,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_op_Implicit_System_String__Dalamud_Game_Text_SeStringHandling_SeString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit(System.String)~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/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L72">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L90">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_op_Implicit_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_op_Implicit_System_String__Dalamud_Game_Text_SeStringHandling_SeString" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit(System.String)~Dalamud.Game.Text.SeStringHandling.SeString">Implicit(String to SeString)</h4>
@ -627,7 +1151,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString.md&amp;value=---%0Auid%3A%20Dalamud.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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L13" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L17" class="contribution-link">View Source</a>
</li>
</ul>
</div>