space-wizards/RobustToolbox
1
0
Fork 0
mirror of https://github.com/space-wizards/RobustToolbox.git synced 2026-02-14 19:29:36 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
b5e5a808cc98e42910d1f71836d19c73be4e8417
RobustToolbox/api/Robust.Client/Robust.Client.GameObjects.IconComponent.html
Silvertorch5 b5e5a808cc Deploy to GitHub Pages
2023-10-08 00:45:13 +00:00

210 lines
9.5 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 IconComponent
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class IconComponent
">
<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="Robust.Client.GameObjects.IconComponent">
<h1 id="Robust_Client_GameObjects_IconComponent" data-uid="Robust.Client.GameObjects.IconComponent" class="text-break">Class IconComponent
</h1>
<div class="markdown level0 summary"><p>This component can be used to give an entity a simple texture which can be used for displaying the entity in some
UI elements. The texture must be specified as an RSI state, and will correspond to the first frame of the
south-direction. To actually resolve the texture, you can use <a class="xref" href="Robust.Client.GameObjects.SpriteSystem.html#Robust_Client_GameObjects_SpriteSystem_GetIcon_Robust_Client_GameObjects_IconComponent_">GetIcon(IconComponent)</a></p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.Component.html">Component</a></div>
<div class="level2"><span class="xref">IconComponent</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IComponent.html">IComponent</a></div>
</div>
<div class="inheritedMembers">
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Robust.Client.GameObjects.html">Robust.Client.GameObjects</a></h6>
<h6><strong>Assembly</strong>: Robust.Client.dll</h6>
<h5 id="Robust_Client_GameObjects_IconComponent_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class IconComponent : Component, IComponent</code></pre>
</div>
<h5 id="Robust_Client_GameObjects_IconComponent_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>This is texture is useful displaying entities that have non-trivial sprites that require some sort of set up in
order to display. E.g., entities that randomize their colour by modulating a simple base sprite will look odd if
shown directly, and spawning a client-side entity would lead to the colour being randomized each time the UI is
updated.</p>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_IconComponent_Icon.md&amp;value=---%0Auid%3A%20Robust.Client.GameObjects.IconComponent.Icon%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/GameObjects/Components/Icon/IconComponent.cs/#L22">View Source</a>
</span>
<h4 id="Robust_Client_GameObjects_IconComponent_Icon" data-uid="Robust.Client.GameObjects.IconComponent.Icon">Icon</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SpriteSpecifier.Rsi Icon</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><a class="xref" href="../Robust.Shared/Robust.Shared.Utility.SpriteSpecifier.Rsi.html">SpriteSpecifier.Rsi</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.IComponent.html">IComponent</a>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_GameObjects_IconComponent.md&amp;value=---%0Auid%3A%20Robust.Client.GameObjects.IconComponent%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/RobustToolbox/blob/master/Robust.Client/GameObjects/Components/Icon/IconComponent.cs/#L18" 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