mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
464 lines
24 KiB
HTML
464 lines
24 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 IconPayload
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class IconPayload
|
|
">
|
|
<meta name="generator" content="docfx 2.56.6.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.IconPayload">
|
|
|
|
|
|
<h1 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload" class="text-break">Class IconPayload
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>SeString payload representing a bitmap icon from fontIcon</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">IconPayload</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_Dirty">Payload.Dirty</a>
|
|
</div>
|
|
<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_Encode_System_Boolean_">Payload.Encode(Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html#Dalamud_Game_Text_SeStringHandling_Payload_Decode_System_IO_BinaryReader_Dalamud_Data_DataManager_">Payload.Decode(BinaryReader, DataManager)</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.ReferenceEquals(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>
|
|
<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_IconPayload_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class IconPayload : 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_IconPayload__ctor_Dalamud_Game_Text_SeStringHandling_BitmapFontIcon_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.%23ctor(Dalamud.Game.Text.SeStringHandling.BitmapFontIcon)%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/IconPayload.cs/#L36">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.#ctor*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload__ctor_Dalamud_Game_Text_SeStringHandling_BitmapFontIcon_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.#ctor(Dalamud.Game.Text.SeStringHandling.BitmapFontIcon)">IconPayload(BitmapFontIcon)</h4>
|
|
<div class="markdown level1 summary"><p>Create a Icon payload for the specified icon.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IconPayload(BitmapFontIcon icon)</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><a class="xref" href="Dalamud.Game.Text.SeStringHandling.BitmapFontIcon.html">BitmapFontIcon</a></td>
|
|
<td><span class="parametername">icon</span></td>
|
|
<td><p>The Icon</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_IconPayload__ctor_System_UInt32_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.%23ctor(System.UInt32)%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/IconPayload.cs/#L29">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.#ctor*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload__ctor_System_UInt32_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.#ctor(System.UInt32)">IconPayload(UInt32)</h4>
|
|
<div class="markdown level1 summary"><p>Create a Icon payload for the specified icon.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("IconPayload(uint) is deprecated, please use IconPayload(BitmapFontIcon).")]
|
|
public IconPayload(uint iconIndex)</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">iconIndex</span></td>
|
|
<td><p>Index of the icon</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_IconPayload_Icon.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.Icon%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/IconPayload.cs/#L21">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_Icon_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.Icon*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_Icon" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.Icon">Icon</h4>
|
|
<div class="markdown level1 summary"><p>Icon the payload represents.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public BitmapFontIcon Icon { 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.BitmapFontIcon.html">BitmapFontIcon</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_IconPayload_IconIndex.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.IconIndex%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/IconPayload.cs/#L15">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_IconIndex_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.IconIndex*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_IconIndex" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.IconIndex">IconIndex</h4>
|
|
<div class="markdown level1 summary"><p>Index of the icon</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Obsolete("Use IconPayload.Icon")]
|
|
public uint IconIndex { 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_IconPayload_Type.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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/IconPayload.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_Type_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.Type*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_Type" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.Type">Type</h4>
|
|
<div class="markdown level1 summary"><p>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_IconPayload_DecodeImpl_System_IO_BinaryReader_System_Int64_.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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/IconPayload.cs/#L56">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_DecodeImpl_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.DecodeImpl*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_DecodeImpl_System_IO_BinaryReader_System_Int64_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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_IconPayload_EncodeImpl.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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/IconPayload.cs/#L44">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_EncodeImpl_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.EncodeImpl*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_EncodeImpl" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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_IconPayload_ToString.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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/IconPayload.cs/#L61">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_ToString_" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.ToString*"></a>
|
|
<h4 id="Dalamud_Game_Text_SeStringHandling_Payloads_IconPayload_ToString" data-uid="Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload.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_IconPayload.md&value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.Payloads.IconPayload%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/IconPayload.cs/#L10" 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>
|