cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_i_console_8cs_source.html
T

125 lines
13 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/IO/IConsole.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_a536e49cdf631f66733cf2c9791144ce.html">IO</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IConsole.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_console_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_i_o.html">Tgstation.Server.Host.IO</a></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span>{</div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html"> 9</a></span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html">IConsole</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a555a7fe50697f3b18c5d9081f5f58f4b"> 14</a></span> <span class="keywordtype">string</span>? <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a555a7fe50697f3b18c5d9081f5f58f4b">Title</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ab35fa75560527910780645de7dc54ca8"> 19</a></span> <span class="keywordtype">bool</span> <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ab35fa75560527910780645de7dc54ca8">Available</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a850a82073bea75fd1c0011f92aa91191"> 24</a></span> CancellationToken <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a850a82073bea75fd1c0011f92aa91191">CancelKeyPress</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a1ea8d75d4508cc393e3445db997479f0"> 33</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a1ea8d75d4508cc393e3445db997479f0">WriteAsync</a>(<span class="keywordtype">string</span>? text, <span class="keywordtype">bool</span> newLine, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ad674c458bbe343698fb0da3494bf3e37"> 40</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ad674c458bbe343698fb0da3494bf3e37">PressAnyKeyAsync</a>(CancellationToken cancellationToken);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#acae9e2a36d9f2907a69390221443db34"> 48</a></span> Task&lt;string&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#acae9e2a36d9f2907a69390221443db34">ReadLineAsync</a>(<span class="keywordtype">bool</span> usePasswordChar, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#abcec01af471cee5fce210b9fbcb2fa74"> 54</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#abcec01af471cee5fce210b9fbcb2fa74">SetTitle</a>(<span class="keywordtype">string</span> newTitle);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>}</div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html">Tgstation.Server.Host.IO.IConsole</a></div><div class="ttdoc">Abstraction for global::System.Console.</div><div class="ttdef"><b>Definition</b> <a href="_i_console_8cs_source.html#l00009">IConsole.cs:10</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_a1ea8d75d4508cc393e3445db997479f0"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a1ea8d75d4508cc393e3445db997479f0">Tgstation.Server.Host.IO.IConsole.WriteAsync</a></div><div class="ttdeci">Task WriteAsync(string? text, bool newLine, CancellationToken cancellationToken)</div><div class="ttdoc">Write some text to the IConsole.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_a555a7fe50697f3b18c5d9081f5f58f4b"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a555a7fe50697f3b18c5d9081f5f58f4b">Tgstation.Server.Host.IO.IConsole.Title</a></div><div class="ttdeci">string? Title</div><div class="ttdoc">Gets or sets the IConsole window's title. Can return null if getting the console title is not support...</div><div class="ttdef"><b>Definition</b> <a href="_i_console_8cs_source.html#l00014">IConsole.cs:14</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_a850a82073bea75fd1c0011f92aa91191"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#a850a82073bea75fd1c0011f92aa91191">Tgstation.Server.Host.IO.IConsole.CancelKeyPress</a></div><div class="ttdeci">CancellationToken CancelKeyPress</div><div class="ttdoc">Gets a CancellationToken that triggers if Crtl+C or an equivalent is pressed.</div><div class="ttdef"><b>Definition</b> <a href="_i_console_8cs_source.html#l00024">IConsole.cs:24</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_ab35fa75560527910780645de7dc54ca8"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ab35fa75560527910780645de7dc54ca8">Tgstation.Server.Host.IO.IConsole.Available</a></div><div class="ttdeci">bool Available</div><div class="ttdoc">If the IConsole is visible to the user.</div><div class="ttdef"><b>Definition</b> <a href="_i_console_8cs_source.html#l00019">IConsole.cs:19</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_abcec01af471cee5fce210b9fbcb2fa74"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#abcec01af471cee5fce210b9fbcb2fa74">Tgstation.Server.Host.IO.IConsole.SetTitle</a></div><div class="ttdeci">void SetTitle(string newTitle)</div><div class="ttdoc">Sets a newTitle console window.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_acae9e2a36d9f2907a69390221443db34"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#acae9e2a36d9f2907a69390221443db34">Tgstation.Server.Host.IO.IConsole.ReadLineAsync</a></div><div class="ttdeci">Task&lt; string &gt; ReadLineAsync(bool usePasswordChar, CancellationToken cancellationToken)</div><div class="ttdoc">Read a line from the IConsole.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console_html_ad674c458bbe343698fb0da3494bf3e37"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html#ad674c458bbe343698fb0da3494bf3e37">Tgstation.Server.Host.IO.IConsole.PressAnyKeyAsync</a></div><div class="ttdeci">Task PressAnyKeyAsync(CancellationToken cancellationToken)</div><div class="ttdoc">Wait for a key press on the IConsole.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_i_o_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_i_o.html">Tgstation.Server.Host.IO</a></div><div class="ttdef"><b>Definition</b> <a href="_buffered_file_stream_provider_8cs_source.html#l00008">BufferedFileStreamProvider.cs:9</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink