mirror of
https://github.com/space-wizards/space-station-14.git
synced 2026-09-16 07:13:00 +02:00
325 lines
16 KiB
HTML
325 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 DoAfterSystem
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class DoAfterSystem
|
|
">
|
|
<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.DoAfter.DoAfterSystem">
|
|
|
|
|
|
<h1 id="Content_Client_DoAfter_DoAfterSystem" data-uid="Content.Client.DoAfter.DoAfterSystem" class="text-break">Class DoAfterSystem
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Handles events that need to happen after a certain amount of time where the event could be cancelled by factors
|
|
such as moving.</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="../Content.Shared/Content.Shared.DoAfter.SharedDoAfterSystem.html">SharedDoAfterSystem</a></div>
|
|
<div class="level2"><span class="xref">DoAfterSystem</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">EntitySystem</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.DoAfter.html">Content.Client.DoAfter</a></h6>
|
|
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
|
|
<h5 id="Content_Client_DoAfter_DoAfterSystem_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class DoAfterSystem : SharedDoAfterSystem, EntitySystem</code></pre>
|
|
</div>
|
|
<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_DoAfter_DoAfterSystem_Initialize.md&value=---%0Auid%3A%20Content.Client.DoAfter.DoAfterSystem.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/DoAfter/DoAfterSystem.cs/#L21">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_DoAfter_DoAfterSystem_Initialize_" data-uid="Content.Client.DoAfter.DoAfterSystem.Initialize*"></a>
|
|
<h4 id="Content_Client_DoAfter_DoAfterSystem_Initialize" data-uid="Content.Client.DoAfter.DoAfterSystem.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.DoAfter.SharedDoAfterSystem.html#Content_Shared_DoAfter_SharedDoAfterSystem_Initialize">SharedDoAfterSystem.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_DoAfter_DoAfterSystem_Shutdown.md&value=---%0Auid%3A%20Content.Client.DoAfter.DoAfterSystem.Shutdown%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/DoAfter/DoAfterSystem.cs/#L27">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_DoAfter_DoAfterSystem_Shutdown_" data-uid="Content.Client.DoAfter.DoAfterSystem.Shutdown*"></a>
|
|
<h4 id="Content_Client_DoAfter_DoAfterSystem_Shutdown" data-uid="Content.Client.DoAfter.DoAfterSystem.Shutdown">Shutdown()</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 Shutdown()</code></pre>
|
|
</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_DoAfter_DoAfterSystem_TryFindActiveDoAfter__1_EntityUid_Content_Shared_DoAfter_DoAfter____0__System_Single__.md&value=---%0Auid%3A%20Content.Client.DoAfter.DoAfterSystem.TryFindActiveDoAfter%60%601(EntityUid%2CContent.Shared.DoAfter.DoAfter%40%2C%60%600%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/DoAfter/DoAfterSystem.cs/#L65">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_DoAfter_DoAfterSystem_TryFindActiveDoAfter_" data-uid="Content.Client.DoAfter.DoAfterSystem.TryFindActiveDoAfter*"></a>
|
|
<h4 id="Content_Client_DoAfter_DoAfterSystem_TryFindActiveDoAfter__1_EntityUid_Content_Shared_DoAfter_DoAfter____0__System_Single__" data-uid="Content.Client.DoAfter.DoAfterSystem.TryFindActiveDoAfter``1(EntityUid,Content.Shared.DoAfter.DoAfter@,``0@,System.Single@)">TryFindActiveDoAfter<T>(EntityUid, out DoAfter, out T, out Single)</h4>
|
|
<div class="markdown level1 summary"><p>Try to find an active do-after being executed by the local player.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool TryFindActiveDoAfter<T>(EntityUid entity, out DoAfter doAfter, out T event, out float progress)
|
|
where T : DoAfterEvent</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">entity</span></td>
|
|
<td><p>The entity the do after must be targeting (<a class="xref" href="../Content.Shared/Content.Shared.DoAfter.DoAfterArgs.html#Content_Shared_DoAfter_DoAfterArgs_Target">Target</a>)</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="../Content.Shared/Content.Shared.DoAfter.DoAfter.html">DoAfter</a></td>
|
|
<td><span class="parametername">doAfter</span></td>
|
|
<td><p>The found do-after.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">T</span></td>
|
|
<td><span class="parametername">event</span></td>
|
|
<td><p>The event to be raised on the found do-after when it completes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">progress</span></td>
|
|
<td><p>The progress of the found do-after, from 0 to 1.</p>
|
|
</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 a do-after was found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">T</span></td>
|
|
<td><p>The type of event that must be raised by the found do-after.</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_DoAfter_DoAfterSystem_Update_System_Single_.md&value=---%0Auid%3A%20Content.Client.DoAfter.DoAfterSystem.Update(System.Single)%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/DoAfter/DoAfterSystem.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Content_Client_DoAfter_DoAfterSystem_Update_" data-uid="Content.Client.DoAfter.DoAfterSystem.Update*"></a>
|
|
<h4 id="Content_Client_DoAfter_DoAfterSystem_Update_System_Single_" data-uid="Content.Client.DoAfter.DoAfterSystem.Update(System.Single)">Update(Single)</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 Update(float frameTime)</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">System.Single</span></td>
|
|
<td><span class="parametername">frameTime</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="../Content.Shared/Content.Shared.DoAfter.SharedDoAfterSystem.html#Content_Shared_DoAfter_SharedDoAfterSystem_Update_System_Single_">SharedDoAfterSystem.Update(Single)</a></div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">EntitySystem</span>
|
|
</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_DoAfter_DoAfterSystem.md&value=---%0Auid%3A%20Content.Client.DoAfter.DoAfterSystem%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/DoAfter/DoAfterSystem.cs/#L14" 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>
|