mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
679 lines
36 KiB
HTML
679 lines
36 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ItemPayload
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ItemPayload
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload">
|
|
|
|
|
|
<h1 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload" class="text-break">Class ItemPayload
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>An SeString Payload representing an interactable item link.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a></div>
|
|
<div class="level2"><span class="xref">ItemPayload</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_DataResolver">Payload.DataResolver</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_Dirty">Payload.Dirty</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_Decode_System_IO_BinaryReader_">Payload.Decode(BinaryReader)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_Encode_System_Boolean_">Payload.Encode(Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_START_BYTE">Payload.START_BYTE</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_END_BYTE">Payload.END_BYTE</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_GetInteger_System_IO_BinaryReader_">Payload.GetInteger(BinaryReader)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_MakeInteger_System_UInt32_">Payload.MakeInteger(UInt32)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_GetPackedIntegers_System_IO_BinaryReader_">Payload.GetPackedIntegers(BinaryReader)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_MakePackedInteger_System_UInt32_System_UInt32_">Payload.MakePackedInteger(UInt32, UInt32)</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.html">Dalamud.Game.Text.SeStringHandling.Payloads</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class ItemPayload : 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/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/#L56">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/#L37">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>
|
|
<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, 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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">isHq</span></td>
|
|
<td><p>Whether or not the link should be for 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 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>
|
|
<h3 id="properties">Properties
|
|
</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_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/#L107">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>
|
|
<div class="markdown level1 summary"><p>Gets or sets the displayed name for this item link. Note that incoming links only sometimes have names embedded,
|
|
often the name is only present in a following text payload.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string DisplayName { 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><span class="xref">System.String</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_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/#L159">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>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether or not this item link is for a high-quality version of the item.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsHQ { 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.Boolean</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_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/#L139">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>
|
|
<div class="markdown level1 summary"><p>Gets the underlying Lumina 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">public Item? Item { 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.Nullable</span><<span class="xref">Item</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Dalamud_Game_Text_SeStringHandling_Payloads_ItemPayload_Item_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>The value is evaluated lazily and cached.</p>
|
|
</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_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/#L124">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 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">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/#L165">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">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/#L130">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">public uint RawItemId { 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_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/#L101">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>
|
|
<div class="markdown level1 summary"><p>Gets the type 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">public override PayloadType Type { 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><a class="xref" href="Dalamud.Game.Text.SeStringHandling.PayloadType.html">PayloadType</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_Type">Payload.Type</a></div>
|
|
<h3 id="methods">Methods
|
|
</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_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/#L244">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>
|
|
<div class="markdown level1 summary"><p>Decodes a byte stream from the game into a payload object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override void DecodeImpl(BinaryReader reader, long endOfStream)</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.IO.BinaryReader</span></td>
|
|
<td><span class="parametername">reader</span></td>
|
|
<td><p>A BinaryReader containing at least all the data for this payload.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int64</span></td>
|
|
<td><span class="parametername">endOfStream</span></td>
|
|
<td><p>The location holding the end of the data for this payload.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_DecodeImpl_System_IO_BinaryReader_System_Int64_">Payload.DecodeImpl(BinaryReader, Int64)</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_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/#L190">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>
|
|
<div class="markdown level1 summary"><p>Encodes the internal state of this payload into a byte[] suitable for sending to in-game
|
|
handlers such as 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">protected override byte[] EncodeImpl()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.Byte</span>[]</td>
|
|
<td><p>Encoded binary payload data suitable for use with in-game handlers.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</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/#L177">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/#L184">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>
|
|
<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">public override string ToString()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.ToString()</span></div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<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/#L15" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|