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:
goaaats 2022-01-29 05:15:26 +01:00
parent 54f6a97c8d
commit a3686d9c93
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
992 changed files with 51626 additions and 8743 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SeString
">
<meta name="generator" content="docfx 2.58.9.0">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -334,7 +334,7 @@ with the appropriate glow and coloring.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L339">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L375">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>
@ -384,7 +384,7 @@ with the appropriate glow and coloring.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L317">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L353">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>
@ -434,7 +434,7 @@ with the appropriate glow and coloring.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L328">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L364">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>
@ -484,7 +484,7 @@ with the appropriate glow and coloring.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L193">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L229">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>
@ -537,6 +537,68 @@ with the appropriate glow and coloring.</p>
<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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_System_UInt32_Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemKind_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(System.UInt32%2CDalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemKind%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L169">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_Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemKind_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(System.UInt32,Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemKind,System.String)">CreateItemLink(UInt32, ItemPayload.ItemKind, 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, ItemPayload.ItemKind kind = ItemPayload.ItemKind.Normal, 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><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemKind.html">ItemPayload.ItemKind</a></td>
<td><span class="parametername">kind</span></td>
<td><p>The kind of item to link.</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>
@ -608,7 +670,7 @@ with the appropriate glow and coloring.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L258">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L294">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>
@ -677,7 +739,7 @@ Returns null if no corresponding PlaceName was found.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L206">View Source</a>
<a href="https://github.com/goatcorp/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_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>
@ -745,7 +807,7 @@ Returns null if no corresponding PlaceName was found.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L232">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L268">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>
@ -819,7 +881,7 @@ Returns null if no corresponding PlaceName was found.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L350">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L386">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>
@ -852,7 +914,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L286">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L322">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>
@ -1058,7 +1120,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L302">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L338">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>
@ -1090,7 +1152,7 @@ suitable for use by in-game handlers, such as the chat log.</p>
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L365">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L401">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>