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/_dream_daemon_api_base_8cs_source.html
T

128 lines
15 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.Api/Models/Internal/DreamDaemonApiBase.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_2ea2465064f3ff030c6dd6700a328d91.html">Tgstation.Server.Api</a></li><li class="navelem"><a class="el" href="dir_61d7974a657c30011f457b376d274ee7.html">Models</a></li><li class="navelem"><a class="el" href="dir_f2a82faa4c4beef364292694cefca86d.html">Internal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">DreamDaemonApiBase.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_dream_daemon_api_base_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;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal.html">Tgstation.Server.Api.Models.Internal</a></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>{</div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="};">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html"> 8</a></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html">DreamDaemonApiBase</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_settings.html">DreamDaemonSettings</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> [ResponseOptions]</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#ac4013f5d61031c2def57496767026e36"> 15</a></span> <span class="keyword">public</span> <span class="keywordtype">long</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#ac4013f5d61031c2def57496767026e36">SessionId</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> [ResponseOptions]</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a8f56ac5f5c532b42c18fff692927e39a"> 22</a></span> <span class="keyword">public</span> <span class="keywordtype">long</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a8f56ac5f5c532b42c18fff692927e39a">WorldIteration</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> [ResponseOptions]</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a81ed0755687d8460058bd6928599a9b4"> 28</a></span> <span class="keyword">public</span> DateTimeOffset? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a81ed0755687d8460058bd6928599a9b4">LaunchTime</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> [ResponseOptions]</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#af5b7ef136dfb6d5d3e5bfc7f2f8e94af"> 35</a></span> <span class="keyword">public</span> uint? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#af5b7ef136dfb6d5d3e5bfc7f2f8e94af">ClientCount</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> [ResponseOptions]</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0ec238fa8ff00b243392c5f1831106d2"> 42</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0ec238fa8ff00b243392c5f1831106d2">SoftRestart</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> [ResponseOptions]</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0332e2c839f5989de55d668b58cfbf04"> 48</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0332e2c839f5989de55d668b58cfbf04">SoftShutdown</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase</a></div><div class="ttdoc">Base class for DreamDaemon API models.</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00008">DreamDaemonApiBase.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_a0332e2c839f5989de55d668b58cfbf04"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0332e2c839f5989de55d668b58cfbf04">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftShutdown</a></div><div class="ttdeci">bool? SoftShutdown</div><div class="ttdoc">If the server is undergoing a soft shutdown.</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00048">DreamDaemonApiBase.cs:48</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_a0ec238fa8ff00b243392c5f1831106d2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a0ec238fa8ff00b243392c5f1831106d2">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftRestart</a></div><div class="ttdeci">bool? SoftRestart</div><div class="ttdoc">If the server is undergoing a soft reset. This may be automatically set by changes to other fields.</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00042">DreamDaemonApiBase.cs:42</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_a81ed0755687d8460058bd6928599a9b4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a81ed0755687d8460058bd6928599a9b4">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.LaunchTime</a></div><div class="ttdeci">DateTimeOffset? LaunchTime</div><div class="ttdoc">When the current server execution was started.</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00028">DreamDaemonApiBase.cs:28</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_a8f56ac5f5c532b42c18fff692927e39a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#a8f56ac5f5c532b42c18fff692927e39a">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.WorldIteration</a></div><div class="ttdeci">long? WorldIteration</div><div class="ttdoc">A incrementing ID for representing current iteration of servers world (i.e. after calling /world/proc...</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00022">DreamDaemonApiBase.cs:22</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_ac4013f5d61031c2def57496767026e36"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#ac4013f5d61031c2def57496767026e36">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SessionId</a></div><div class="ttdeci">long? SessionId</div><div class="ttdoc">An incrementing ID for representing current server execution.</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00015">DreamDaemonApiBase.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base_html_af5b7ef136dfb6d5d3e5bfc7f2f8e94af"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html#af5b7ef136dfb6d5d3e5bfc7f2f8e94af">Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.ClientCount</a></div><div class="ttdeci">uint? ClientCount</div><div class="ttdoc">The last known count of connected players. Requires DreamDaemonLaunchParameters.HealthCheckSeconds to...</div><div class="ttdef"><b>Definition</b> <a href="_dream_daemon_api_base_8cs_source.html#l00035">DreamDaemonApiBase.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_settings_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_settings.html">Tgstation.Server.Api.Models.Internal.DreamDaemonSettings</a></div><div class="ttdoc">Configurable settings for DreamDaemon.</div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_internal_2_dream_daemon_settings_8cs_source.html#l00008">DreamDaemonSettings.cs:9</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal.html">Tgstation.Server.Api.Models.Internal</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bot_api_base_8cs_source.html#l00005">ChatBotApiBase.cs:6</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