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.Shuttles.UI.DockingControl.html
T
Silvertorch5 3afc617235 Deploy to GitHub Pages
2023-10-08 01:38:46 +00:00

383 lines
20 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 DockingControl
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DockingControl
">
<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.Shuttles.UI.DockingControl">
<h1 id="Content_Client_Shuttles_UI_DockingControl" data-uid="Content.Client.Shuttles.UI.DockingControl" class="text-break">Class DockingControl
</h1>
<div class="markdown level0 summary"><p>Displays the docking view from a specific docking port</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">Robust.Client.UserInterface.Control</span></div>
<div class="level2"><span class="xref">DockingControl</span></div>
</div>
<div class="inheritedMembers">
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Shuttles.UI.html">Content.Client.Shuttles.UI</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Shuttles_UI_DockingControl_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DockingControl : Control</code></pre>
</div>
<h3 id="constructors">Constructors
</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_Shuttles_UI_DockingControl__ctor.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.%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/space-wizards/space-station-14/blob/master/Content.Client/Shuttles/UI/DockingControl.cs/#L46">View Source</a>
</span>
<a id="Content_Client_Shuttles_UI_DockingControl__ctor_" data-uid="Content.Client.Shuttles.UI.DockingControl.#ctor*"></a>
<h4 id="Content_Client_Shuttles_UI_DockingControl__ctor" data-uid="Content.Client.Shuttles.UI.DockingControl.#ctor">DockingControl()</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 DockingControl()</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_Shuttles_UI_DockingControl_Angle.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.Angle%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/Shuttles/UI/DockingControl.cs/#L39">View Source</a>
</span>
<h4 id="Content_Client_Shuttles_UI_DockingControl_Angle" data-uid="Content.Client.Shuttles.UI.DockingControl.Angle">Angle</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 Angle? Angle</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">Angle</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_Shuttles_UI_DockingControl_Coordinates.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.Coordinates%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/Shuttles/UI/DockingControl.cs/#L38">View Source</a>
</span>
<h4 id="Content_Client_Shuttles_UI_DockingControl_Coordinates" data-uid="Content.Client.Shuttles.UI.DockingControl.Coordinates">Coordinates</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 EntityCoordinates? Coordinates</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">Robust.Shared.Map.EntityCoordinates</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_Shuttles_UI_DockingControl_Docks.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.Docks%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/Shuttles/UI/DockingControl.cs/#L44">View Source</a>
</span>
<h4 id="Content_Client_Shuttles_UI_DockingControl_Docks" data-uid="Content.Client.Shuttles.UI.DockingControl.Docks">Docks</h4>
<div class="markdown level1 summary"><p>Stored by GridID then by docks</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;NetEntity, List&lt;DockingInterfaceState&gt;&gt; Docks</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">Dictionary</span>&lt;<span class="xref">NetEntity</span>, <span class="xref">List</span>&lt;<a class="xref" href="../Content.Shared/Content.Shared.Shuttles.BUIStates.DockingInterfaceState.html">DockingInterfaceState</a>&gt;&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_Shuttles_UI_DockingControl_GridEntity.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.GridEntity%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/Shuttles/UI/DockingControl.cs/#L36">View Source</a>
</span>
<h4 id="Content_Client_Shuttles_UI_DockingControl_GridEntity" data-uid="Content.Client.Shuttles.UI.DockingControl.GridEntity">GridEntity</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 EntityUid? GridEntity</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">EntityUid</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_Shuttles_UI_DockingControl_ViewedDock.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.ViewedDock%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/Shuttles/UI/DockingControl.cs/#L35">View Source</a>
</span>
<h4 id="Content_Client_Shuttles_UI_DockingControl_ViewedDock" data-uid="Content.Client.Shuttles.UI.DockingControl.ViewedDock">ViewedDock</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 NetEntity? ViewedDock</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">NetEntity</span>&gt;</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_Shuttles_UI_DockingControl_Draw_Robust_Client_Graphics_DrawingHandleScreen_.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl.Draw(Robust.Client.Graphics.DrawingHandleScreen)%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/Shuttles/UI/DockingControl.cs/#L54">View Source</a>
</span>
<a id="Content_Client_Shuttles_UI_DockingControl_Draw_" data-uid="Content.Client.Shuttles.UI.DockingControl.Draw*"></a>
<h4 id="Content_Client_Shuttles_UI_DockingControl_Draw_Robust_Client_Graphics_DrawingHandleScreen_" data-uid="Content.Client.Shuttles.UI.DockingControl.Draw(Robust.Client.Graphics.DrawingHandleScreen)">Draw(DrawingHandleScreen)</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">protected override void Draw(DrawingHandleScreen handle)</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.Graphics.DrawingHandleScreen</span></td>
<td><span class="parametername">handle</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Robust.Client.UserInterface.Control.Draw(Robust.Client.Graphics.DrawingHandleScreen)</span></div>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_">ControlExtension.GetControlOfType&lt;T&gt;(Control)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetSearchableControls_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetSearchableControls(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_ChildrenContainText_Robust_Client_UserInterface_Control_System_String_">ControlExtension.ChildrenContainText(Control, String)</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/space-station-14/new/master/apiSpec/new?filename=Content_Client_Shuttles_UI_DockingControl.md&amp;value=---%0Auid%3A%20Content.Client.Shuttles.UI.DockingControl%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/Shuttles/UI/DockingControl.cs/#L15" 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