space-wizards/space-station-14
1
0
Fork 0
mirror of https://github.com/space-wizards/space-station-14.git synced 2026-09-15 14:53:16 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
space-station-14/api/Content.Client/Content.Client.Paper.PaperVisualsComponent.html
T
Silvertorch5 3afc617235 Deploy to GitHub Pages
2023-10-08 01:38:46 +00:00

591 lines
29 KiB
HTML
Raw Permalink 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 PaperVisualsComponent
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PaperVisualsComponent
">
<meta name="generator" content="docfx 2.56.7.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="../../toc.html">
<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="Content.Client.Paper.PaperVisualsComponent">
<h1 id="Content_Client_Paper_PaperVisualsComponent" data-uid="Content.Client.Paper.PaperVisualsComponent" class="text-break">Class PaperVisualsComponent
</h1>
<div class="markdown level0 summary"></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">PaperVisualsComponent</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Paper.html">Content.Client.Paper</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Paper_PaperVisualsComponent_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class PaperVisualsComponent : Component</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_BackgroundImagePath.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.BackgroundImagePath%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L12">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_BackgroundImagePath" data-uid="Content.Client.Paper.PaperVisualsComponent.BackgroundImagePath">BackgroundImagePath</h4>
<div class="markdown level1 summary"><p>The path to the image which will be used as a background for the paper itself</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? BackgroundImagePath</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_BackgroundImageTile.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.BackgroundImageTile%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L32">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_BackgroundImageTile" data-uid="Content.Client.Paper.PaperVisualsComponent.BackgroundImageTile">BackgroundImageTile</h4>
<div class="markdown level1 summary"><p>Should the background image tile, or be streched? Sets <pre><code>StyleBoxTexture.StrechMode</code></pre></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool BackgroundImageTile</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_BackgroundModulate.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.BackgroundModulate%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L26">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_BackgroundModulate" data-uid="Content.Client.Paper.PaperVisualsComponent.BackgroundModulate">BackgroundModulate</h4>
<div class="markdown level1 summary"><p>Modulate the background image by this color. Can be used to add colorful
variants of images, without having to create new textures.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Color BackgroundModulate</code></pre>
</div>
<h5 class="fieldValue">Field 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">Color</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_BackgroundPatchMargin.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.BackgroundPatchMargin%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L19">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_BackgroundPatchMargin" data-uid="Content.Client.Paper.PaperVisualsComponent.BackgroundPatchMargin">BackgroundPatchMargin</h4>
<div class="markdown level1 summary"><p>An optional patch to configure tiling stretching of the background. Used to set
the PatchMargin in a <pre><code>StyleBoxTexture</code></pre></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Box2 BackgroundPatchMargin</code></pre>
</div>
<h5 class="fieldValue">Field 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">Box2</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_BackgroundScale.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.BackgroundScale%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L38">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_BackgroundScale" data-uid="Content.Client.Paper.PaperVisualsComponent.BackgroundScale">BackgroundScale</h4>
<div class="markdown level1 summary"><p>An additional scale to apply to the background image</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector2 BackgroundScale</code></pre>
</div>
<h5 class="fieldValue">Field 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">Vector2</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_ContentImageModulate.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.ContentImageModulate%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L71">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_ContentImageModulate" data-uid="Content.Client.Paper.PaperVisualsComponent.ContentImageModulate">ContentImageModulate</h4>
<div class="markdown level1 summary"><p>Modulate the content image by this color</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Color ContentImageModulate</code></pre>
</div>
<h5 class="fieldValue">Field 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">Color</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_ContentImageNumLines.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.ContentImageNumLines%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L85">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_ContentImageNumLines" data-uid="Content.Client.Paper.PaperVisualsComponent.ContentImageNumLines">ContentImageNumLines</h4>
<div class="markdown level1 summary"><p>The number of lines that the content image represents. The
content image will be vertically tiled after this many lines
of text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ContentImageNumLines</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_ContentImagePath.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.ContentImagePath%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L65">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_ContentImagePath" data-uid="Content.Client.Paper.PaperVisualsComponent.ContentImagePath">ContentImagePath</h4>
<div class="markdown level1 summary"><p>Path to an image to use as the background to the &quot;content&quot; of the paper
The header and actual written text will use this as a background. The
image will be tiled vertically with the property that the bottom of the
written text will line up with the bottom of this image.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? ContentImagePath</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_ContentMargin.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.ContentMargin%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L77">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_ContentMargin" data-uid="Content.Client.Paper.PaperVisualsComponent.ContentMargin">ContentMargin</h4>
<div class="markdown level1 summary"><p>An additional margin around the content (including header)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Box2 ContentMargin</code></pre>
</div>
<h5 class="fieldValue">Field 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">Box2</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_FontAccentColor.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.FontAccentColor%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L91">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_FontAccentColor" data-uid="Content.Client.Paper.PaperVisualsComponent.FontAccentColor">FontAccentColor</h4>
<div class="markdown level1 summary"><p>Modulate the style's font by this color</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Color FontAccentColor</code></pre>
</div>
<h5 class="fieldValue">Field 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">Color</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_HeaderImageModulate.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.HeaderImageModulate%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L50">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_HeaderImageModulate" data-uid="Content.Client.Paper.PaperVisualsComponent.HeaderImageModulate">HeaderImageModulate</h4>
<div class="markdown level1 summary"><p>Modulate the header image by this color</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Color HeaderImageModulate</code></pre>
</div>
<h5 class="fieldValue">Field 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">Color</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_HeaderImagePath.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.HeaderImagePath%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L44">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_HeaderImagePath" data-uid="Content.Client.Paper.PaperVisualsComponent.HeaderImagePath">HeaderImagePath</h4>
<div class="markdown level1 summary"><p>A path to an image which will be used as a header on the paper</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? HeaderImagePath</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_HeaderMargin.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.HeaderMargin%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L56">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_HeaderMargin" data-uid="Content.Client.Paper.PaperVisualsComponent.HeaderMargin">HeaderMargin</h4>
<div class="markdown level1 summary"><p>Any additional margin to add around the header</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Box2 HeaderMargin</code></pre>
</div>
<h5 class="fieldValue">Field 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">Box2</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent_MaxWritableArea.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent.MaxWritableArea%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L100">View Source</a>
</span>
<h4 id="Content_Client_Paper_PaperVisualsComponent_MaxWritableArea" data-uid="Content.Client.Paper.PaperVisualsComponent.MaxWritableArea">MaxWritableArea</h4>
<div class="markdown level1 summary"><p>This can enforce that your paper has a limited area to write in.
If you wish to constrain only one direction, the other direction
can be unlimited by specifying a value of zero.
This will be scaled according to UI scale.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector2? MaxWritableArea</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">Vector2</span>&gt;</td>
<td></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/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_PaperVisualsComponent.md&amp;value=---%0Auid%3A%20Content.Client.Paper.PaperVisualsComponent%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperVisualsComponent.cs/#L5" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<div class="toggle-mode">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>
<div class="pull-left">
<span>Generated by <strong>DocFX</strong></span>
</div>
<div class="toggle-mode pull-right visible-sm visible-xs">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style-m">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="../../styles/toggle-theme.js"></script>
</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 New Issue View Git Blame Copy Permalink