mirror of
https://github.com/space-wizards/space-station-14.git
synced 2026-09-15 14:53:16 +02:00
336 lines
16 KiB
HTML
336 lines
16 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 ClickableComponent
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ClickableComponent
|
|
">
|
|
<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.Clickable.ClickableComponent">
|
|
|
|
|
|
<h1 id="Content_Client_Clickable_ClickableComponent" data-uid="Content.Client.Clickable.ClickableComponent" class="text-break">Class ClickableComponent
|
|
</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">ClickableComponent</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Clickable.html">Content.Client.Clickable</a></h6>
|
|
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
|
|
<h5 id="Content_Client_Clickable_ClickableComponent_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class ClickableComponent : 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_Clickable_ClickableComponent_Bounds.md&value=---%0Auid%3A%20Content.Client.Clickable.ClickableComponent.Bounds%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/Clickable/ClickableComponent.cs/#L16">View Source</a>
|
|
</span>
|
|
<h4 id="Content_Client_Clickable_ClickableComponent_Bounds" data-uid="Content.Client.Clickable.ClickableComponent.Bounds">Bounds</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 ClickableComponent.DirBoundData Bounds</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="Content.Client.Clickable.ClickableComponent.DirBoundData.html">ClickableComponent.DirBoundData</a></td>
|
|
<td></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/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Clickable_ClickableComponent_CheckClick_Robust_Client_GameObjects_SpriteComponent_TransformComponent_EntityQuery_TransformComponent__Vector2_Robust_Shared_Graphics_IEye_System_Int32__System_UInt32__System_Single__.md&value=---%0Auid%3A%20Content.Client.Clickable.ClickableComponent.CheckClick(Robust.Client.GameObjects.SpriteComponent%2CTransformComponent%2CEntityQuery%7BTransformComponent%7D%2CVector2%2CRobust.Shared.Graphics.IEye%2CSystem.Int32%40%2CSystem.UInt32%40%2CSystem.Single%40)%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/Clickable/ClickableComponent.cs/#L27">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Clickable_ClickableComponent_CheckClick_" data-uid="Content.Client.Clickable.ClickableComponent.CheckClick*"></a>
|
|
<h4 id="Content_Client_Clickable_ClickableComponent_CheckClick_Robust_Client_GameObjects_SpriteComponent_TransformComponent_EntityQuery_TransformComponent__Vector2_Robust_Shared_Graphics_IEye_System_Int32__System_UInt32__System_Single__" data-uid="Content.Client.Clickable.ClickableComponent.CheckClick(Robust.Client.GameObjects.SpriteComponent,TransformComponent,EntityQuery{TransformComponent},Vector2,Robust.Shared.Graphics.IEye,System.Int32@,System.UInt32@,System.Single@)">CheckClick(SpriteComponent, TransformComponent, EntityQuery<TransformComponent>, Vector2, IEye, out Int32, out UInt32, out Single)</h4>
|
|
<div class="markdown level1 summary"><p>Used to check whether a click worked. Will first check if the click falls inside of some explicit bounding
|
|
boxes (see <a class="xref" href="Content.Client.Clickable.ClickableComponent.html#Content_Client_Clickable_ClickableComponent_Bounds">Bounds</a>). If that fails, attempts to use automatically generated click maps.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool CheckClick(SpriteComponent sprite, TransformComponent transform, EntityQuery<TransformComponent> xformQuery, Vector2 worldPos, IEye eye, out int drawDepth, out uint renderOrder, out float bottom)</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">Robust.Client.GameObjects.SpriteComponent</span></td>
|
|
<td><span class="parametername">sprite</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TransformComponent</span></td>
|
|
<td><span class="parametername">transform</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">EntityQuery</span><<span class="xref">TransformComponent</span>></td>
|
|
<td><span class="parametername">xformQuery</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Vector2</span></td>
|
|
<td><span class="parametername">worldPos</span></td>
|
|
<td><p>The world position that was clicked.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Robust.Shared.Graphics.IEye</span></td>
|
|
<td><span class="parametername">eye</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">drawDepth</span></td>
|
|
<td><p>The draw depth for the sprite that captured the click.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">renderOrder</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">bottom</span></td>
|
|
<td></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><span class="xref">System.Boolean</span></td>
|
|
<td><p>True if the click worked, false otherwise.</p>
|
|
</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_Clickable_ClickableComponent_CheckDirBound_Robust_Client_GameObjects_SpriteComponent_Angle_Vector2_.md&value=---%0Auid%3A%20Content.Client.Clickable.ClickableComponent.CheckDirBound(Robust.Client.GameObjects.SpriteComponent%2CAngle%2CVector2)%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/Clickable/ClickableComponent.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_Clickable_ClickableComponent_CheckDirBound_" data-uid="Content.Client.Clickable.ClickableComponent.CheckDirBound*"></a>
|
|
<h4 id="Content_Client_Clickable_ClickableComponent_CheckDirBound_Robust_Client_GameObjects_SpriteComponent_Angle_Vector2_" data-uid="Content.Client.Clickable.ClickableComponent.CheckDirBound(Robust.Client.GameObjects.SpriteComponent,Angle,Vector2)">CheckDirBound(SpriteComponent, Angle, Vector2)</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 bool CheckDirBound(SpriteComponent sprite, Angle relativeRotation, Vector2 localPos)</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">Robust.Client.GameObjects.SpriteComponent</span></td>
|
|
<td><span class="parametername">sprite</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Angle</span></td>
|
|
<td><span class="parametername">relativeRotation</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Vector2</span></td>
|
|
<td><span class="parametername">localPos</span></td>
|
|
<td></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><span class="xref">System.Boolean</span></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_Clickable_ClickableComponent.md&value=---%0Auid%3A%20Content.Client.Clickable.ClickableComponent%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/Clickable/ClickableComponent.cs/#L11" 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>
|