console_commands.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. <!DOCTYPE html>
  2. <html class="writer-html4" lang="en" >
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Console commands &mdash; Crown 0.54.0 Manual 0.54.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  7. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" /><link rel="shortcut icon" href="../_static/crown-black-socket.svg"/>
  9. <!--[if lt IE 9]>
  10. <script src="../_static/js/html5shiv.min.js"></script>
  11. <![endif]-->
  12. <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  13. <script type="text/javascript" src="../_static/jquery.js"></script>
  14. <script type="text/javascript" src="../_static/underscore.js"></script>
  15. <script type="text/javascript" src="../_static/doctools.js"></script>
  16. <script type="text/javascript" src="../_static/language_data.js"></script>
  17. <script src="../_static/js/theme.js"></script>
  18. <link rel="index" title="Index" href="../genindex.html" />
  19. <link rel="search" title="Search" href="../search.html" />
  20. <link rel="copyright" title="Copyright" href="../copyright.html" />
  21. <link rel="next" title="boot.config reference" href="boot_config.html" />
  22. <link rel="prev" title="Reference" href="index.html" />
  23. </head>
  24. <body class="wy-body-for-nav">
  25. <div class="wy-grid-for-nav">
  26. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  27. <div class="wy-side-scroll">
  28. <div class="wy-side-nav-search" >
  29. <a href="../index.html"><img src="../_static/crown-black-socket.svg" class="logo" alt="Logo"/>
  30. </a>
  31. <div class="version">
  32. Crown 0.54.0 Manual
  33. </div>
  34. <div role="search">
  35. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  36. <input type="text" name="q" placeholder="Search docs" />
  37. <input type="hidden" name="check_keywords" value="yes" />
  38. <input type="hidden" name="area" value="default" />
  39. </form>
  40. </div>
  41. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  42. <ul class="current">
  43. <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
  45. <li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
  46. <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
  47. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
  48. <li class="toctree-l2 current"><a class="current reference internal" href="#">Console commands</a><ul>
  49. <li class="toctree-l3"><a class="reference internal" href="#game">game</a></li>
  50. <li class="toctree-l3"><a class="reference internal" href="#help">help</a></li>
  51. <li class="toctree-l3"><a class="reference internal" href="#unpause">unpause</a></li>
  52. <li class="toctree-l3"><a class="reference internal" href="#pause">pause</a></li>
  53. <li class="toctree-l3"><a class="reference internal" href="#graph">graph</a></li>
  54. </ul>
  55. </li>
  56. <li class="toctree-l2"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="command_line.html">Command line</a></li>
  58. </ul>
  59. </li>
  60. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  61. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
  64. </ul>
  65. </div>
  66. </div>
  67. </nav>
  68. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  69. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  70. <a href="../index.html">Crown 0.54.0 Manual</a>
  71. </nav>
  72. <div class="wy-nav-content">
  73. <div class="rst-content">
  74. <div role="navigation" aria-label="Page navigation">
  75. <ul class="wy-breadcrumbs">
  76. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  77. <li><a href="index.html">Reference</a> &raquo;</li>
  78. <li>Console commands</li>
  79. <li class="wy-breadcrumbs-aside">
  80. <a href="../_sources/reference/console_commands.rst.txt" rel="nofollow"> View page source</a>
  81. </li>
  82. </ul>
  83. <hr/>
  84. </div>
  85. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  86. <div itemprop="articleBody">
  87. <div class="section" id="console-commands">
  88. <h1>Console commands<a class="headerlink" href="#console-commands" title="Permalink to this headline">¶</a></h1>
  89. <p>The following are commands that can be typed in the Console tab. In order for a
  90. command to be interpreted as such, you must prefix it with a colon symbol when
  91. entering it in the command prompt:</p>
  92. <img alt="../_images/console_command.png" src="../_images/console_command.png" />
  93. <div class="section" id="game">
  94. <h2>game<a class="headerlink" href="#game" title="Permalink to this headline">¶</a></h2>
  95. <p>Pause/resume the game. Accepts one of the following parameters:</p>
  96. <dl class="docutils">
  97. <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt>
  98. <dd>Pause the game.</dd>
  99. <dt><code class="docutils literal notranslate"><span class="pre">resume</span></code></dt>
  100. <dd>Resume the game.</dd>
  101. </dl>
  102. </div>
  103. <div class="section" id="help">
  104. <h2>help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
  105. <p>List all commands.</p>
  106. </div>
  107. <div class="section" id="unpause">
  108. <h2>unpause<a class="headerlink" href="#unpause" title="Permalink to this headline">¶</a></h2>
  109. <p>Resume the engine. Deprecated, use <a class="reference internal" href="#game"><span class="std std-ref">game</span></a> instead.</p>
  110. </div>
  111. <div class="section" id="pause">
  112. <h2>pause<a class="headerlink" href="#pause" title="Permalink to this headline">¶</a></h2>
  113. <p>Pause the engine. Deprecated, use <a class="reference internal" href="#game"><span class="std std-ref">game</span></a> instead.</p>
  114. </div>
  115. <div class="section" id="graph">
  116. <h2>graph<a class="headerlink" href="#graph" title="Permalink to this headline">¶</a></h2>
  117. <p>Plot selected profiler data over time. The &lt;field&gt; parameter must be the name
  118. of a profiler record that the engine provides itself or one that you recorded
  119. via the <a class="reference internal" href="../lua_api.html#profiler"><span class="std std-ref">Profiler</span></a> API. The command accepts the following
  120. parameters:</p>
  121. <dl class="docutils">
  122. <dt><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">&lt;name&gt;</span></code></dt>
  123. <dd>Create a new graph.</dd>
  124. <dt><code class="docutils literal notranslate"><span class="pre">list</span></code></dt>
  125. <dd>List all the graphs.</dd>
  126. <dt><code class="docutils literal notranslate"><span class="pre">range</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">[min</span> <span class="pre">max]</span></code></dt>
  127. <dd>Set the range of a graph. If the range is omitted, it will be automatically
  128. computed.</dd>
  129. <dt><code class="docutils literal notranslate"><span class="pre">add</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">&lt;field&gt;</span></code></dt>
  130. <dd>Add a field to a graph.</dd>
  131. <dt><code class="docutils literal notranslate"><span class="pre">remove</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">&lt;field&gt;</span></code></dt>
  132. <dd>Remove a field from a graph.</dd>
  133. <dt><code class="docutils literal notranslate"><span class="pre">hide</span> <span class="pre">&lt;graph&gt;</span></code></dt>
  134. <dd>Hide a graph.</dd>
  135. <dt><code class="docutils literal notranslate"><span class="pre">show</span> <span class="pre">&lt;graph&gt;</span></code></dt>
  136. <dd>Show a graph.</dd>
  137. <dt><code class="docutils literal notranslate"><span class="pre">layout</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">&lt;type&gt;</span></code></dt>
  138. <dd>Set the layout of a graph.
  139. Type can be one of: <code class="docutils literal notranslate"><span class="pre">fill</span></code>, <code class="docutils literal notranslate"><span class="pre">left</span></code>, <code class="docutils literal notranslate"><span class="pre">right</span></code>, <code class="docutils literal notranslate"><span class="pre">bottom</span></code> or <code class="docutils literal notranslate"><span class="pre">top</span></code>.</dd>
  140. <dt><code class="docutils literal notranslate"><span class="pre">color</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">&lt;field&gt;</span> <span class="pre">&lt;color&gt;</span></code></dt>
  141. <dd>Set the color of a field in a graph. Color can be specified as a 3- or
  142. 6-digits hexadecimal RGB number or can be any of: <code class="docutils literal notranslate"><span class="pre">yellow</span></code>, <code class="docutils literal notranslate"><span class="pre">red</span></code>, <code class="docutils literal notranslate"><span class="pre">green</span></code>
  143. or <code class="docutils literal notranslate"><span class="pre">blue</span></code>.</dd>
  144. <dt><code class="docutils literal notranslate"><span class="pre">samples</span> <span class="pre">&lt;graph&gt;</span> <span class="pre">&lt;samples&gt;</span></code></dt>
  145. <dd>Set the number of samples to show in a graph.</dd>
  146. </dl>
  147. </div>
  148. </div>
  149. </div>
  150. </div>
  151. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  152. <a href="index.html" class="btn btn-neutral float-left" title="Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  153. <a href="boot_config.html" class="btn btn-neutral float-right" title="boot.config reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  154. </div>
  155. <hr/>
  156. <div role="contentinfo">
  157. <p>&#169; <a href="../copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.</p>
  158. </div>
  159. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  160. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  161. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  162. </footer>
  163. </div>
  164. </div>
  165. </section>
  166. </div>
  167. <script>
  168. jQuery(function () {
  169. SphinxRtdTheme.Navigation.enable(true);
  170. });
  171. </script>
  172. <!-- Theme Analytics -->
  173. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  174. <script>
  175. window.dataLayer = window.dataLayer || [];
  176. function gtag(){dataLayer.push(arguments);}
  177. gtag('js', new Date());
  178. gtag('config', 'G-XNVGCMNDZH', {
  179. 'anonymize_ip': true,
  180. });
  181. </script>
  182. </body>
  183. </html>