mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
388 lines
18 KiB
HTML
388 lines
18 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 GameFontLayoutPlan.Builder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GameFontLayoutPlan.Builder
|
|
">
|
|
<meta name="generator" content="docfx 2.59.1.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.Interface.GameFonts.GameFontLayoutPlan.Builder">
|
|
|
|
|
|
<h1 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder" class="text-break">Class GameFontLayoutPlan.Builder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Build a GameFontLayoutPlan.</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">GameFontLayoutPlan.Builder</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>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Interface.GameFonts.html">Dalamud.Interface.GameFonts</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class Builder</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_Interface_GameFonts_GameFontLayoutPlan_Builder__ctor_ImGuiNET_ImFontPtr_Dalamud_Interface_GameFonts_FdtReader_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.%23ctor(ImGuiNET.ImFontPtr%2CDalamud.Interface.GameFonts.FdtReader%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/Interface/GameFonts/GameFontLayoutPlan.cs/#L253">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder__ctor_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.#ctor*"></a>
|
|
<h4 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder__ctor_ImGuiNET_ImFontPtr_Dalamud_Interface_GameFonts_FdtReader_System_String_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.#ctor(ImGuiNET.ImFontPtr,Dalamud.Interface.GameFonts.FdtReader,System.String)">Builder(ImFontPtr, FdtReader, String)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.html">GameFontLayoutPlan.Builder</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Builder(ImFontPtr fontPtr, FdtReader fdt, string text)</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="ImGuiNET.ImFontPtr.html">ImFontPtr</a></td>
|
|
<td><span class="parametername">fontPtr</span></td>
|
|
<td><p>Corresponding ImFontPtr.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Interface.GameFonts.FdtReader.html">FdtReader</a></td>
|
|
<td><span class="parametername">fdt</span></td>
|
|
<td><p>FDT file to base on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">text</span></td>
|
|
<td><p>Text.</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_Interface_GameFonts_GameFontLayoutPlan_Builder_Build.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.Build%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/Interface/GameFonts/GameFontLayoutPlan.cs/#L298">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_Build_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.Build*"></a>
|
|
<h4 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_Build" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.Build">Build()</h4>
|
|
<div class="markdown level1 summary"><p>Builds the layout plan.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GameFontLayoutPlan Build()</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><a class="xref" href="Dalamud.Interface.GameFonts.GameFontLayoutPlan.html">GameFontLayoutPlan</a></td>
|
|
<td><p>Newly created layout plan.</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_Interface_GameFonts_GameFontLayoutPlan_Builder_WithHorizontalAlignment_Dalamud_Interface_GameFonts_GameFontLayoutPlan_HorizontalAlignment_.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithHorizontalAlignment(Dalamud.Interface.GameFonts.GameFontLayoutPlan.HorizontalAlignment)%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/Interface/GameFonts/GameFontLayoutPlan.cs/#L288">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithHorizontalAlignment_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithHorizontalAlignment*"></a>
|
|
<h4 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithHorizontalAlignment_Dalamud_Interface_GameFonts_GameFontLayoutPlan_HorizontalAlignment_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithHorizontalAlignment(Dalamud.Interface.GameFonts.GameFontLayoutPlan.HorizontalAlignment)">WithHorizontalAlignment(GameFontLayoutPlan.HorizontalAlignment)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the horizontal alignment of the text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GameFontLayoutPlan.Builder WithHorizontalAlignment(GameFontLayoutPlan.HorizontalAlignment horizontalAlignment)</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.Interface.GameFonts.GameFontLayoutPlan.HorizontalAlignment.html">GameFontLayoutPlan.HorizontalAlignment</a></td>
|
|
<td><span class="parametername">horizontalAlignment</span></td>
|
|
<td><p>Horizontal alignment.</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.Interface.GameFonts.GameFontLayoutPlan.Builder.html">GameFontLayoutPlan.Builder</a></td>
|
|
<td><p>This.</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_Interface_GameFonts_GameFontLayoutPlan_Builder_WithMaxWidth_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithMaxWidth(System.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/Interface/GameFonts/GameFontLayoutPlan.cs/#L277">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithMaxWidth_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithMaxWidth*"></a>
|
|
<h4 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithMaxWidth_System_Int32_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithMaxWidth(System.Int32)">WithMaxWidth(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the maximum width of the text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GameFontLayoutPlan.Builder WithMaxWidth(int maxWidth)</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.Int32</span></td>
|
|
<td><span class="parametername">maxWidth</span></td>
|
|
<td><p>Maximum width in pixels.</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.Interface.GameFonts.GameFontLayoutPlan.Builder.html">GameFontLayoutPlan.Builder</a></td>
|
|
<td><p>This.</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_Interface_GameFonts_GameFontLayoutPlan_Builder_WithSize_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithSize(System.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/Interface/GameFonts/GameFontLayoutPlan.cs/#L266">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithSize_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithSize*"></a>
|
|
<h4 id="Dalamud_Interface_GameFonts_GameFontLayoutPlan_Builder_WithSize_System_Single_" data-uid="Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder.WithSize(System.Single)">WithSize(Single)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the size of resulting text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GameFontLayoutPlan.Builder WithSize(float size)</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.Single</span></td>
|
|
<td><span class="parametername">size</span></td>
|
|
<td><p>Size in pixels.</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.Interface.GameFonts.GameFontLayoutPlan.Builder.html">GameFontLayoutPlan.Builder</a></td>
|
|
<td><p>This.</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_Interface_GameFonts_GameFontLayoutPlan_Builder.md&value=---%0Auid%3A%20Dalamud.Interface.GameFonts.GameFontLayoutPlan.Builder%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/Interface/GameFonts/GameFontLayoutPlan.cs/#L238" 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>
|