mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-14 20:54:16 +01:00
docs: regenerate
This commit is contained in:
goaaats
parent
54f6a97c8d
commit
a3686d9c93
992 changed files with 51626 additions and 8743 deletions
|
|
@ -10,7 +10,7 @@
|
|||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ItemPayload
|
||||
">
|
||||
<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">
|
||||
|
|
@ -141,12 +141,61 @@
|
|||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<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_Payloads_ItemPayload__ctor_System_UInt32_Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemKind_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.%23ctor(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/Payloads/ItemPayload.cs/#L57">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.#ctor*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload__ctor_System_UInt32_Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemKind_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.#ctor(System.UInt32,Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemKind,System.String)">ItemPayload(UInt32, ItemPayload.ItemKind, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html">ItemPayload</a> class.
|
||||
Creates a payload representing an interactable item link for the specified item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ItemPayload(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.</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>Kind of item to encode.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">displayNameOverride</span></td>
|
||||
<td><p>An optional name to include in the item link. Typically this should
|
||||
be left as null, or set to the normal item name. Actual overrides are better done with the subsequent
|
||||
TextPayload that is a part of a full item link in chat.</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_Payloads_ItemPayload__ctor_System_UInt32_System_Boolean_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.%23ctor(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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L36">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.#ctor*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload__ctor_System_UInt32_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.#ctor(System.UInt32,System.Boolean,System.String)">ItemPayload(UInt32, Boolean, String)</h4>
|
||||
|
|
@ -197,7 +246,7 @@ TextPayload that is a part of a full item link in chat.</p>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DisplayName.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DisplayName%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/Payloads/ItemPayload.cs/#L58">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L108">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DisplayName_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DisplayName*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DisplayName" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DisplayName">DisplayName</h4>
|
||||
|
|
@ -229,7 +278,7 @@ often the name is only present in a following text payload.</p>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_IsHQ.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.IsHQ%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/Payloads/ItemPayload.cs/#L90">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L160">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_IsHQ_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.IsHQ*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_IsHQ" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.IsHQ">IsHQ</h4>
|
||||
|
|
@ -261,7 +310,7 @@ public bool IsHQ { get; }</code></pre>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Item.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Item%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/Payloads/ItemPayload.cs/#L84">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L140">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Item_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Item*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Item" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Item">Item</h4>
|
||||
|
|
@ -296,17 +345,81 @@ public Item Item { get; }</code></pre>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemId.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemId%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/Payloads/ItemPayload.cs/#L75">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L125">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemId_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemId*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ItemId" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemId">ItemId</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the raw item ID of this payload.</p>
|
||||
<div class="markdown level1 summary"><p>Gets the actual item ID of this payload.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsonIgnore]
|
||||
public uint ItemId { 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.UInt32</span></td>
|
||||
<td></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_Payloads_ItemPayload_Kind.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Kind%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/Payloads/ItemPayload.cs/#L166">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Kind_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Kind*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Kind" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Kind">Kind</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the kind of item represented by this payload.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsonProperty]
|
||||
public ItemPayload.ItemKind Kind { get; set; }</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><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ItemKind.html">ItemPayload.ItemKind</a></td>
|
||||
<td></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_Payloads_ItemPayload_RawItemId.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.RawItemId%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/Payloads/ItemPayload.cs/#L131">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_RawItemId_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.RawItemId*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_RawItemId" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.RawItemId">RawItemId</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the raw, unadjusted item ID of this payload.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[JsonIgnore]
|
||||
public uint RawItemId { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue">Property Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -328,7 +441,7 @@ public uint ItemId { get; }</code></pre>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Type.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Type%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/Payloads/ItemPayload.cs/#L52">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L102">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Type_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Type*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Type" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.Type">Type</h4>
|
||||
|
|
@ -363,7 +476,7 @@ public uint ItemId { get; }</code></pre>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DecodeImpl_System_IO_BinaryReader_System_Int64_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DecodeImpl(System.IO.BinaryReader%2CSystem.Int64)%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/Payloads/ItemPayload.cs/#L155">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L245">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DecodeImpl_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DecodeImpl*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_DecodeImpl_System_IO_BinaryReader_System_Int64_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.DecodeImpl(System.IO.BinaryReader,System.Int64)">DecodeImpl(BinaryReader, Int64)</h4>
|
||||
|
|
@ -405,7 +518,7 @@ public uint ItemId { get; }</code></pre>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_EncodeImpl.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.EncodeImpl%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/Payloads/ItemPayload.cs/#L100">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L191">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_EncodeImpl_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.EncodeImpl*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_EncodeImpl" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.EncodeImpl">EncodeImpl()</h4>
|
||||
|
|
@ -435,12 +548,71 @@ handlers such as the chat log.</p>
|
|||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_EncodeImpl">Payload.EncodeImpl()</a></div>
|
||||
<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_Payloads_ItemPayload_FromRaw_System_UInt32_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.FromRaw(System.UInt32%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/Payloads/ItemPayload.cs/#L178">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_FromRaw_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.FromRaw*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_FromRaw_System_UInt32_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.FromRaw(System.UInt32,System.String)">FromRaw(UInt32, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html">ItemPayload</a> class.
|
||||
Creates a payload representing an interactable item link for the specified item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ItemPayload FromRaw(uint rawItemId, 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">rawItemId</span></td>
|
||||
<td><p>The raw, unadjusted id 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 to include in the item link. Typically this should
|
||||
be left as null, or set to the normal item name. Actual overrides are better done with the subsequent
|
||||
TextPayload that is a part of a full item link in chat.</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.Payloads.ItemPayload.html">ItemPayload</a></td>
|
||||
<td><p>The created item payload.</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_Payloads_ItemPayload_ToString.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.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/Payloads/ItemPayload.cs/#L94">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L185">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ToString_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ToString*"></a>
|
||||
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_ToString" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.ToString">ToString()</h4>
|
||||
|
|
@ -478,7 +650,7 @@ handlers such as the chat log.</p>
|
|||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload%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/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L14" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/Payloads/ItemPayload.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue