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
Dalamud/docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html
goat 83586fd46b
docs: regenerate
2023-01-26 23:57:38 +01:00

1327 lines
65 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class SeString
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SeString
">
<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.SeString">
<h1 id="Dalamud_Game_Text_SeStringHandling_SeString" data-uid="Dalamud.Game.Text.SeStringHandling.SeString" class="text-break">Class SeString
</h1>
<div class="markdown level0 summary"><p>This class represents a parsed SeString.</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"><span class="xref">SeString</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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.html">Dalamud.Game.Text.SeStringHandling</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_Text_SeStringHandling_SeString_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SeString</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_SeString__ctor.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L24">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor">SeString()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a> class.
Creates a new SeString from an ordered list of payloads.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString()</code></pre>
</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_SeString__ctor_Dalamud_Game_Text_SeStringHandling_Payload___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%23ctor(Dalamud.Game.Text.SeStringHandling.Payload%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L45">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_Dalamud_Game_Text_SeStringHandling_Payload___" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor(Dalamud.Game.Text.SeStringHandling.Payload[])">SeString(Payload[])</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a> class.
Creates a new SeString from an ordered list of payloads.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString(params Payload[] payloads)</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.Payload.html">Payload</a>[]</td>
<td><span class="parametername">payloads</span></td>
<td><p>The Payload objects to make up this string.</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__ctor_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.%23ctor(System.Collections.Generic.List%7BDalamud.Game.Text.SeStringHandling.Payload%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L34">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString__ctor_System_Collections_Generic_List_Dalamud_Game_Text_SeStringHandling_Payload__" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.#ctor(System.Collections.Generic.List{Dalamud.Game.Text.SeStringHandling.Payload})">SeString(List&lt;Payload&gt;)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a> class.
Creates a new SeString from an ordered list of payloads.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString(List&lt;Payload&gt; payloads)</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.Collections.Generic.List</span>&lt;<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><span class="parametername">payloads</span></td>
<td><p>The Payload objects to make up this string.</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_SeString_Empty.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Empty%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/#L67">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Empty_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Empty*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Empty" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Empty">Empty</h4>
<div class="markdown level1 summary"><p>Gets an empty SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString Empty { 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.SeString.html">SeString</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_SeString_Payloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Payloads%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L72">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Payloads_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Payloads*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Payloads" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Payloads">Payloads</h4>
<div class="markdown level1 summary"><p>Gets the ordered list of payloads included in this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;Payload&gt; Payloads { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a>&gt;</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_SeString_TextArrowPayloads.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.TextArrowPayloads%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L55">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_TextArrowPayloads_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextArrowPayloads*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_TextArrowPayloads" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextArrowPayloads">TextArrowPayloads</h4>
<div class="markdown level1 summary"><p>Gets a list of Payloads necessary to display the arrow link marker icon in chat
with the appropriate glow and coloring.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;Payload&gt; TextArrowPayloads { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><p>A list of all the payloads required to insert the link marker.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_TextValue.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.TextValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L80">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_TextValue_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextValue*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_TextValue" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.TextValue">TextValue</h4>
<div class="markdown level1 summary"><p>Gets all of the raw text from a message as a single joined string.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TextValue { 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.String</span></td>
<td><p>All the raw text from the contained payloads, joined into a single string.</p>
</td>
</tr>
</tbody>
</table>
<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_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/#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>
<div class="markdown level1 summary"><p>Appends a single payload to this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(Payload payload)</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.Payload.html">Payload</a></td>
<td><span class="parametername">payload</span></td>
<td><p>The payload to append.</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>This object.</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_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/#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>
<div class="markdown level1 summary"><p>Appends the contents of one SeString to this one.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(SeString other)</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.SeString.html">SeString</a></td>
<td><span class="parametername">other</span></td>
<td><p>The SeString to append to this one.</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>This object.</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_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/#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>
<div class="markdown level1 summary"><p>Appends a list of payloads to this SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SeString Append(List&lt;Payload&gt; payloads)</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.Collections.Generic.List</span>&lt;<a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payload.html">Payload</a>&gt;</td>
<td><span class="parametername">payloads</span></td>
<td><p>The Payloads to append.</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>This object.</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_Item_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(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/#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_Item_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(Item,System.Boolean,System.String)">CreateItemLink(Item, Boolean, String)</h4>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString CreateItemLink(Item item, bool isHq, string displayNameOverride = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Item</span></td>
<td><span class="parametername">item</span></td>
<td><p>The Lumina Item to link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isHq</span></td>
<td><p>Whether to link the high-quality variant of the item.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">displayNameOverride</span></td>
<td><p>An optional name override to display, instead of the actual item name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing all the payloads necessary to display an item link in the chat log.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/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>
</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_System_Boolean_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(System.UInt32%2CSystem.Boolean%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L159">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_CreateItemLink_System_UInt32_System_Boolean_System_String_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.CreateItemLink(System.UInt32,System.Boolean,System.String)">CreateItemLink(UInt32, Boolean, String)</h4>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString CreateItemLink(uint itemId, bool isHq, string displayNameOverride = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">itemId</span></td>
<td><p>The id of the item to link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isHq</span></td>
<td><p>Whether to link the high-quality variant of the item.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">displayNameOverride</span></td>
<td><p>An optional name override to display, instead of the actual item name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing all the payloads necessary to display an item link in the chat log.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/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/#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>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log, matching a specified zone name.
Returns null if no corresponding PlaceName was found.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString CreateMapLink(string placeName, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">placeName</span></td>
<td><p>The name of the location for this link. This should be exactly the name as seen in a displayed map link in-game for the same zone.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">xCoord</span></td>
<td><p>The human-readable x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">yCoord</span></td>
<td><p>The human-readable y-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">fudgeFactor</span></td>
<td><p>An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing all of the payloads necessary to display a map link in the chat log.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/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/#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>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString CreateMapLink(uint territoryId, uint mapId, int rawX, int rawY)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">territoryId</span></td>
<td><p>The id of the TerritoryType for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">mapId</span></td>
<td><p>The id of the Map for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rawX</span></td>
<td><p>The raw x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rawY</span></td>
<td><p>The raw y-coordinate for this link..</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing all of the payloads necessary to display a map link in the chat log.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/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/#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>
<div class="markdown level1 summary"><p>Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString CreateMapLink(uint territoryId, uint mapId, float xCoord, float yCoord, float fudgeFactor = 0.05F)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">territoryId</span></td>
<td><p>The id of the TerritoryType for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">mapId</span></td>
<td><p>The id of the Map for this map link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">xCoord</span></td>
<td><p>The human-readable x-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">yCoord</span></td>
<td><p>The human-readable y-coordinate for this link.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">fudgeFactor</span></td>
<td><p>An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing all of the payloads necessary to display a map link in the chat log.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/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/#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>
<div class="markdown level1 summary"><p>Encodes the Payloads in this SeString into a binary representation
suitable for use by 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">public byte[] Encode()</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>The binary encoded payload data.</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_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/#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>
<div class="markdown level1 summary"><p>Creates a SeString from a json. (For testing - not recommended for production use.)</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 FromJson(string json)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">json</span></td>
<td><p>A serialized SeString produced by ToJson() <a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html#Dalamud_Game_Text_SeStringHandling_SeString_ToJson">ToJson()</a>.</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>A SeString initialized with values from the json.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte__System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.Byte*%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L111">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte__System_Int32_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.Byte*,System.Int32)">Parse(Byte*, Int32)</h4>
<div class="markdown level1 summary"><p>Parse a binary game message into an SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString Parse(byte *ptr, int len)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>*</td>
<td><span class="parametername">ptr</span></td>
<td><p>Pointer to the string's data in memory.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>Length of the string's data in memory.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L150">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_Byte___" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.Byte[])">Parse(Byte[])</h4>
<div class="markdown level1 summary"><p>Parse a binary game message into an SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString Parse(byte[] bytes)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">bytes</span></td>
<td><p>Binary message payload data in SE's internal format.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_ReadOnlySpan_System_Byte__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.ReadOnlySpan%7BSystem.Byte%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L137">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_Parse_System_ReadOnlySpan_System_Byte__" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.Parse(System.ReadOnlySpan{System.Byte})">Parse(ReadOnlySpan&lt;Byte&gt;)</h4>
<div class="markdown level1 summary"><p>Parse a binary game message into an SeString.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SeString Parse(ReadOnlySpan&lt;byte&gt; data)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ReadOnlySpan</span>&lt;<span class="xref">System.Byte</span>&gt;</td>
<td><span class="parametername">data</span></td>
<td><p>Binary message payload data in SE's internal format.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.SeString.html">SeString</a></td>
<td><p>An SeString containing parsed Payload objects for each payload in the data.</p>
</td>
</tr>
</tbody>
</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_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/#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>
<div class="markdown level1 summary"><p>Serializes the SeString to json.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ToJson()</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><p>An json representation of this object.</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_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/#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>
<div class="markdown level1 summary"><p>Get the text value of this SeString.</p>
</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><p>The TextValue property.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.ToString()</span></div>
<h3 id="operators">Operators
</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_SeString_op_Explicit_Lumina_Text_SeString__Dalamud_Game_Text_SeStringHandling_SeString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.op_Explicit(Lumina.Text.SeString)~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/#L103">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_op_Explicit_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Explicit*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_op_Explicit_Lumina_Text_SeString__Dalamud_Game_Text_SeStringHandling_SeString" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Explicit(Lumina.Text.SeString)~Dalamud.Game.Text.SeStringHandling.SeString">Explicit(Lumina.Text.SeString to SeString)</h4>
<div class="markdown level1 summary"><p>Implicitly convert a string into a SeString containing a <a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html">TextPayload</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static explicit operator SeString(Lumina.Text.SeString str)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Text.SeString</span></td>
<td><span class="parametername">str</span></td>
<td><p>string to convert.</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>Equivalent SeString.</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_op_Implicit_System_String__Dalamud_Game_Text_SeStringHandling_SeString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit(System.String)~Dalamud.Game.Text.SeStringHandling.SeString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L96">View Source</a>
</span>
<a id="Dalamud_Game_Text_SeStringHandling_SeString_op_Implicit_" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit*"></a>
<h4 id="Dalamud_Game_Text_SeStringHandling_SeString_op_Implicit_System_String__Dalamud_Game_Text_SeStringHandling_SeString" data-uid="Dalamud.Game.Text.SeStringHandling.SeString.op_Implicit(System.String)~Dalamud.Game.Text.SeStringHandling.SeString">Implicit(String to SeString)</h4>
<div class="markdown level1 summary"><p>Implicitly convert a string into a SeString containing a <a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html">TextPayload</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static implicit operator SeString(string str)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">str</span></td>
<td><p>string to convert.</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>Equivalent SeString.</p>
</td>
</tr>
</tbody>
</table>
</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_SeString.md&amp;value=---%0Auid%3A%20Dalamud.Game.Text.SeStringHandling.SeString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Text/SeStringHandling/SeString.cs/#L18" 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>
Reference in a new issue View git blame Copy permalink