console_commands.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  5. <meta property="article:modified_time" content="2026-02-16T16:34:21+00:00" /><meta property="og:title" content="Console commands" />
  6. <meta property="og:type" content="website" />
  7. <meta property="og:url" content="https://docs.crownengine.org/html/latest/reference/console_commands.html" />
  8. <meta property="og:site_name" content="Crown 0.60.0 Manual" />
  9. <meta property="og:description" content="The following are commands that can be typed in the Console tab. In order for a command to be interpreted as such, you must prefix it with a colon symbol when entering it in the command prompt: Typing a console command with the: prefix., crash: Crash the engine for testing pur..." />
  10. <meta property="og:image" content="https://docs.crownengine.org/html/latest/_images/console_command.png" />
  11. <meta property="og:image:alt" content="Crown 0.60.0 Manual" />
  12. <meta name="description" content="The following are commands that can be typed in the Console tab. In order for a command to be interpreted as such, you must prefix it with a colon symbol when entering it in the command prompt: Typing a console command with the: prefix., crash: Crash the engine for testing pur..." />
  13. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  14. <title>Console commands &mdash; Crown 0.60.0 Manual 0.61.0 documentation</title>
  15. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  17. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  18. <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
  19. <link rel="canonical" href="https://docs.crownengine.org/html/latest/reference/console_commands.html" />
  20. <!--[if lt IE 9]>
  21. <script src="../_static/js/html5shiv.min.js"></script>
  22. <![endif]-->
  23. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  24. <script src="../_static/jquery.js"></script>
  25. <script src="../_static/underscore.js"></script>
  26. <script src="../_static/doctools.js"></script>
  27. <script src="../_static/js/theme.js"></script>
  28. <link rel="index" title="Index" href="../genindex.html" />
  29. <link rel="search" title="Search" href="../search.html" />
  30. <link rel="copyright" title="Copyright" href="../copyright.html" />
  31. <link rel="next" title="boot.config reference" href="boot_config.html" />
  32. <link rel="prev" title="Reference" href="index.html" />
  33. </head>
  34. <body class="wy-body-for-nav">
  35. <div class="wy-grid-for-nav">
  36. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  37. <div class="wy-side-scroll">
  38. <div class="wy-side-nav-search" >
  39. <a href="../index.html">
  40. <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
  41. </a>
  42. <div class="version">
  43. Crown 0.60.0 Manual
  44. </div>
  45. <div role="search">
  46. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  47. <input type="text" name="q" placeholder="Search docs" />
  48. <input type="hidden" name="check_keywords" value="yes" />
  49. <input type="hidden" name="area" value="default" />
  50. </form>
  51. </div>
  52. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  53. <ul class="current">
  54. <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="../level_editor/index.html">Level Editor</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
  60. <li class="toctree-l1"><a class="reference internal" href="../units/index.html">Units</a></li>
  61. <li class="toctree-l1"><a class="reference internal" href="../rendering/index.html">Rendering</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
  64. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
  65. <li class="toctree-l2 current"><a class="current reference internal" href="#">Console commands</a><ul>
  66. <li class="toctree-l3"><a class="reference internal" href="#crash">crash</a></li>
  67. <li class="toctree-l3"><a class="reference internal" href="#game">game</a></li>
  68. <li class="toctree-l3"><a class="reference internal" href="#help">help</a></li>
  69. <li class="toctree-l3"><a class="reference internal" href="#unpause">unpause</a></li>
  70. <li class="toctree-l3"><a class="reference internal" href="#pause">pause</a></li>
  71. <li class="toctree-l3"><a class="reference internal" href="#graph">graph</a></li>
  72. </ul>
  73. </li>
  74. <li class="toctree-l2"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
  75. <li class="toctree-l2"><a class="reference internal" href="command_line.html">Command line</a></li>
  76. </ul>
  77. </li>
  78. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Engine Hackers</a></li>
  82. </ul>
  83. </div>
  84. </div>
  85. </nav>
  86. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  87. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  88. <a href="../index.html">Crown 0.60.0 Manual</a>
  89. </nav>
  90. <div class="wy-nav-content">
  91. <div class="rst-content">
  92. <div role="navigation" aria-label="Page navigation">
  93. <ul class="wy-breadcrumbs">
  94. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  95. <li><a href="index.html">Reference</a> &raquo;</li>
  96. <li>Console commands</li>
  97. <li class="wy-breadcrumbs-aside">
  98. <a href="../_sources/reference/console_commands.rst.txt" rel="nofollow"> View page source</a>
  99. </li>
  100. </ul>
  101. <hr/>
  102. </div>
  103. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  104. <div itemprop="articleBody">
  105. <section id="console-commands">
  106. <span id="id1"></span><h1>Console commands<a class="headerlink" href="#console-commands" title="Permalink to this headline">¶</a></h1>
  107. <p>The following are commands that can be typed in the Console tab. In order for a
  108. command to be interpreted as such, you must prefix it with a colon symbol when
  109. entering it in the command prompt:</p>
  110. <figure class="align-center" id="id2">
  111. <img alt="../_images/console_command.png" src="../_images/console_command.png" />
  112. <figcaption>
  113. <p><span class="caption-text">Typing a console command with the <code class="docutils literal notranslate"><span class="pre">:</span></code> prefix.</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
  114. </figcaption>
  115. </figure>
  116. <section id="crash">
  117. <h2>crash<a class="headerlink" href="#crash" title="Permalink to this headline">¶</a></h2>
  118. <p>Crash the engine for testing purposes. Accepts the following parameters:</p>
  119. <dl class="simple">
  120. <dt><code class="docutils literal notranslate"><span class="pre">div_by_zero</span></code></dt><dd><p>Divide a number by zero.</p>
  121. </dd>
  122. <dt><code class="docutils literal notranslate"><span class="pre">unaligned</span></code></dt><dd><p>Do an unaligned memory access.</p>
  123. </dd>
  124. <dt><code class="docutils literal notranslate"><span class="pre">segfault</span></code></dt><dd><p>Trigger a segmentation fault.</p>
  125. </dd>
  126. <dt><code class="docutils literal notranslate"><span class="pre">oom</span></code></dt><dd><p>Allocate too much memory.</p>
  127. </dd>
  128. <dt><code class="docutils literal notranslate"><span class="pre">assert</span></code></dt><dd><p>Call CE_ASSERT(false).</p>
  129. </dd>
  130. </dl>
  131. </section>
  132. <section id="game">
  133. <h2>game<a class="headerlink" href="#game" title="Permalink to this headline">¶</a></h2>
  134. <p>Pause/resume the game. Accepts one of the following parameters:</p>
  135. <dl class="simple">
  136. <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt><dd><p>Pause the game.</p>
  137. </dd>
  138. <dt><code class="docutils literal notranslate"><span class="pre">resume</span></code></dt><dd><p>Resume the game.</p>
  139. </dd>
  140. </dl>
  141. </section>
  142. <section id="help">
  143. <h2>help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
  144. <p>List all commands.</p>
  145. </section>
  146. <section id="unpause">
  147. <h2>unpause<a class="headerlink" href="#unpause" title="Permalink to this headline">¶</a></h2>
  148. <p>Resume the engine. Deprecated, use <a class="reference internal" href="#game"><span class="std std-ref">game</span></a> instead.</p>
  149. </section>
  150. <section id="pause">
  151. <h2>pause<a class="headerlink" href="#pause" title="Permalink to this headline">¶</a></h2>
  152. <p>Pause the engine. Deprecated, use <a class="reference internal" href="#game"><span class="std std-ref">game</span></a> instead.</p>
  153. </section>
  154. <section id="graph">
  155. <h2>graph<a class="headerlink" href="#graph" title="Permalink to this headline">¶</a></h2>
  156. <p>Plot selected profiler data over time. The &lt;field&gt; parameter must be the name
  157. of a profiler record that the engine provides itself or one that you recorded
  158. 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
  159. parameters:</p>
  160. <dl class="simple">
  161. <dt><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">&lt;name&gt;</span></code></dt><dd><p>Create a new graph.</p>
  162. </dd>
  163. <dt><code class="docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>List all the graphs.</p>
  164. </dd>
  165. <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><dd><p>Set the range of a graph. If the range is omitted, it will be automatically
  166. computed.</p>
  167. </dd>
  168. <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><dd><p>Add a field to a graph.</p>
  169. </dd>
  170. <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><dd><p>Remove a field from a graph.</p>
  171. </dd>
  172. <dt><code class="docutils literal notranslate"><span class="pre">hide</span> <span class="pre">&lt;graph&gt;</span></code></dt><dd><p>Hide a graph.</p>
  173. </dd>
  174. <dt><code class="docutils literal notranslate"><span class="pre">show</span> <span class="pre">&lt;graph&gt;</span></code></dt><dd><p>Show a graph.</p>
  175. </dd>
  176. <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><dd><p>Set the layout of a graph.
  177. 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>.</p>
  178. </dd>
  179. <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><dd><p>Set the color of a field in a graph. Color can be specified as a 3- or
  180. 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>
  181. or <code class="docutils literal notranslate"><span class="pre">blue</span></code>.</p>
  182. </dd>
  183. <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><dd><p>Set the number of samples to show in a graph.</p>
  184. </dd>
  185. </dl>
  186. </section>
  187. </section>
  188. </div>
  189. </div>
  190. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  191. <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>
  192. <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>
  193. </div>
  194. <hr/>
  195. <div role="contentinfo">
  196. <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.
  197. <span class="lastupdated">Last updated on Feb 16, 2026.
  198. </span></p>
  199. </div>
  200. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  201. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  202. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  203. </footer>
  204. </div>
  205. </div>
  206. </section>
  207. </div>
  208. <script>
  209. jQuery(function () {
  210. SphinxRtdTheme.Navigation.enable(true);
  211. });
  212. </script>
  213. <!-- Theme Analytics -->
  214. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  215. <script>
  216. window.dataLayer = window.dataLayer || [];
  217. function gtag(){dataLayer.push(arguments);}
  218. gtag('js', new Date());
  219. gtag('config', 'G-XNVGCMNDZH', {
  220. 'anonymize_ip': true,
  221. });
  222. </script>
  223. </body>
  224. </html>