Files
space-station-14/api/Content.Client/Content.Client.Verbs.VerbSystem.html
2023-10-08 01:38:46 +00:00

493 lines
24 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 VerbSystem
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class VerbSystem
">
<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.Verbs.VerbSystem">
<h1 id="Content_Client_Verbs_VerbSystem" data-uid="Content.Client.Verbs.VerbSystem" class="text-break">Class VerbSystem
</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"><a class="xref" href="../Content.Shared/Content.Shared.Verbs.SharedVerbSystem.html">SharedVerbSystem</a></div>
<div class="level2"><span class="xref">VerbSystem</span></div>
</div>
<div class="inheritedMembers">
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Verbs.html">Content.Client.Verbs</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Verbs_VerbSystem_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class VerbSystem : SharedVerbSystem</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_Verbs_VerbSystem_EntityMenuLookupSize.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.EntityMenuLookupSize%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/Verbs/VerbSystem.cs/#L32">View Source</a>
</span>
<h4 id="Content_Client_Verbs_VerbSystem_EntityMenuLookupSize" data-uid="Content.Client.Verbs.VerbSystem.EntityMenuLookupSize">EntityMenuLookupSize</h4>
<div class="markdown level1 summary"><p>When a user right clicks somewhere, how large is the box we use to get entities for the context menu?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const float EntityMenuLookupSize = null</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.Single</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_Verbs_VerbSystem_OnVerbsResponse.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.OnVerbsResponse%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/Verbs/VerbSystem.cs/#L41">View Source</a>
</span>
<h4 id="Content_Client_Verbs_VerbSystem_OnVerbsResponse" data-uid="Content.Client.Verbs.VerbSystem.OnVerbsResponse">OnVerbsResponse</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 Action&lt;VerbsResponseEvent&gt;? OnVerbsResponse</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">Action</span>&lt;<a class="xref" href="../Content.Shared/Content.Shared.Verbs.VerbsResponseEvent.html">VerbsResponseEvent</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_Verbs_VerbSystem_Visibility.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.Visibility%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/Verbs/VerbSystem.cs/#L39">View Source</a>
</span>
<h4 id="Content_Client_Verbs_VerbSystem_Visibility" data-uid="Content.Client.Verbs.VerbSystem.Visibility">Visibility</h4>
<div class="markdown level1 summary"><p>These flags determine what entities the user can see on the context menu.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MenuVisibility Visibility</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.Verbs.MenuVisibility.html">MenuVisibility</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_Verbs_VerbSystem_ExecuteVerb_EntityUid_Content_Shared_Verbs_Verb_.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.ExecuteVerb(EntityUid%2CContent.Shared.Verbs.Verb)%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/Verbs/VerbSystem.cs/#L201">View Source</a>
</span>
<a id="Content_Client_Verbs_VerbSystem_ExecuteVerb_" data-uid="Content.Client.Verbs.VerbSystem.ExecuteVerb*"></a>
<h4 id="Content_Client_Verbs_VerbSystem_ExecuteVerb_EntityUid_Content_Shared_Verbs_Verb_" data-uid="Content.Client.Verbs.VerbSystem.ExecuteVerb(EntityUid,Content.Shared.Verbs.Verb)">ExecuteVerb(EntityUid, Verb)</h4>
<div class="markdown level1 summary"><p>Execute actions associated with the given verb.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ExecuteVerb(EntityUid target, Verb verb)</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">EntityUid</span></td>
<td><span class="parametername">target</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="../Content.Shared/Content.Shared.Verbs.Verb.html">Verb</a></td>
<td><span class="parametername">verb</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Content_Client_Verbs_VerbSystem_ExecuteVerb_EntityUid_Content_Shared_Verbs_Verb__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Unless this is a client-exclusive verb, this will also tell the server to run the same verb.</p>
</div>
<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_Verbs_VerbSystem_GetVerbs_EntityUid_EntityUid_List_Type__System_Boolean_.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.GetVerbs(EntityUid%2CEntityUid%2CList%7BType%7D%2CSystem.Boolean)%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/Verbs/VerbSystem.cs/#L180">View Source</a>
</span>
<a id="Content_Client_Verbs_VerbSystem_GetVerbs_" data-uid="Content.Client.Verbs.VerbSystem.GetVerbs*"></a>
<h4 id="Content_Client_Verbs_VerbSystem_GetVerbs_EntityUid_EntityUid_List_Type__System_Boolean_" data-uid="Content.Client.Verbs.VerbSystem.GetVerbs(EntityUid,EntityUid,List{Type},System.Boolean)">GetVerbs(EntityUid, EntityUid, List&lt;Type&gt;, Boolean)</h4>
<div class="markdown level1 summary"><p>Ask the server to send back a list of server-side verbs, and for now return an incomplete list of verbs
(only those defined locally).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedSet&lt;Verb&gt; GetVerbs(EntityUid target, EntityUid user, List&lt;Type&gt; verbTypes, bool force = false)</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">EntityUid</span></td>
<td><span class="parametername">target</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">EntityUid</span></td>
<td><span class="parametername">user</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">List</span>&lt;<span class="xref">Type</span>&gt;</td>
<td><span class="parametername">verbTypes</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">force</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">SortedSet</span>&lt;<a class="xref" href="../Content.Shared/Content.Shared.Verbs.Verb.html">Verb</a>&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_Verbs_VerbSystem_GetVerbs_EntityUid_EntityUid_Type_System_Boolean_.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.GetVerbs(EntityUid%2CEntityUid%2CType%2CSystem.Boolean)%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/Verbs/VerbSystem.cs/#L171">View Source</a>
</span>
<a id="Content_Client_Verbs_VerbSystem_GetVerbs_" data-uid="Content.Client.Verbs.VerbSystem.GetVerbs*"></a>
<h4 id="Content_Client_Verbs_VerbSystem_GetVerbs_EntityUid_EntityUid_Type_System_Boolean_" data-uid="Content.Client.Verbs.VerbSystem.GetVerbs(EntityUid,EntityUid,Type,System.Boolean)">GetVerbs(EntityUid, EntityUid, Type, Boolean)</h4>
<div class="markdown level1 summary"><p>Asks the server to send back a list of server-side verbs, for the given verb type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedSet&lt;Verb&gt; GetVerbs(EntityUid target, EntityUid user, Type type, bool force = false)</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">EntityUid</span></td>
<td><span class="parametername">target</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">EntityUid</span></td>
<td><span class="parametername">user</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Type</span></td>
<td><span class="parametername">type</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">force</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">SortedSet</span>&lt;<a class="xref" href="../Content.Shared/Content.Shared.Verbs.Verb.html">Verb</a>&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_Verbs_VerbSystem_Initialize.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.Initialize%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/Verbs/VerbSystem.cs/#L43">View Source</a>
</span>
<a id="Content_Client_Verbs_VerbSystem_Initialize_" data-uid="Content.Client.Verbs.VerbSystem.Initialize*"></a>
<h4 id="Content_Client_Verbs_VerbSystem_Initialize" data-uid="Content.Client.Verbs.VerbSystem.Initialize">Initialize()</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 override void Initialize()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="../Content.Shared/Content.Shared.Verbs.SharedVerbSystem.html#Content_Shared_Verbs_SharedVerbSystem_Initialize">SharedVerbSystem.Initialize()</a></div>
<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_Verbs_VerbSystem_TryGetEntityMenuEntities_Robust_Shared_Map_MapCoordinates_System_Nullable_List_EntityUid____.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem.TryGetEntityMenuEntities(Robust.Shared.Map.MapCoordinates%2CSystem.Nullable%7BList%7BEntityUid%7D%7D%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/Verbs/VerbSystem.cs/#L53">View Source</a>
</span>
<a id="Content_Client_Verbs_VerbSystem_TryGetEntityMenuEntities_" data-uid="Content.Client.Verbs.VerbSystem.TryGetEntityMenuEntities*"></a>
<h4 id="Content_Client_Verbs_VerbSystem_TryGetEntityMenuEntities_Robust_Shared_Map_MapCoordinates_System_Nullable_List_EntityUid____" data-uid="Content.Client.Verbs.VerbSystem.TryGetEntityMenuEntities(Robust.Shared.Map.MapCoordinates,System.Nullable{List{EntityUid}}@)">TryGetEntityMenuEntities(MapCoordinates, out Nullable&lt;List&lt;EntityUid&gt;&gt;)</h4>
<div class="markdown level1 summary"><p>Get all of the entities in an area for displaying on the context menu.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool TryGetEntityMenuEntities(MapCoordinates targetPos, out List&lt;EntityUid&gt;? result)</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.Shared.Map.MapCoordinates</span></td>
<td><span class="parametername">targetPos</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">List</span>&lt;<span class="xref">EntityUid</span>&gt;&gt;</td>
<td><span class="parametername">result</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_Verbs_VerbSystem.md&amp;value=---%0Auid%3A%20Content.Client.Verbs.VerbSystem%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/Verbs/VerbSystem.cs/#L19" 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>