console.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  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-15T01:23:55+00:00" /><meta property="og:title" content="Console" />
  6. <meta property="og:type" content="website" />
  7. <meta property="og:url" content="https://docs.crownengine.org/html/latest/level_editor/console.html" />
  8. <meta property="og:site_name" content="Crown 0.60.0 Manual" />
  9. <meta property="og:description" content="The Console displays information, warnings, errors, and debug output from the Level Editor, the running game, and other engine components. It also lets you interact with runtime instances by sending commands and Lua expressions. Runtime connections: Each engine runtime spawned..." />
  10. <meta property="og:image" content="https://docs.crownengine.org/html/latest/_images/console.png" />
  11. <meta property="og:image:alt" content="Crown 0.60.0 Manual" />
  12. <meta name="description" content="The Console displays information, warnings, errors, and debug output from the Level Editor, the running game, and other engine components. It also lets you interact with runtime instances by sending commands and Lua expressions. Runtime connections: Each engine runtime spawned..." />
  13. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  14. <title>Console &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/level_editor/console.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="Level Viewport" href="level_viewport.html" />
  32. <link rel="prev" title="Project Browser" href="project_browser.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 current"><a class="reference internal" href="index.html">The Level Editor</a><ul class="current">
  59. <li class="toctree-l2"><a class="reference internal" href="level_editor.html">Editor overview</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="project_browser.html">Project Browser</a></li>
  61. <li class="toctree-l2 current"><a class="current reference internal" href="#">Console</a><ul>
  62. <li class="toctree-l3"><a class="reference internal" href="#runtime-connections">Runtime connections</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="#commands">Commands</a></li>
  64. <li class="toctree-l3"><a class="reference internal" href="#lua-expressions">Lua expressions</a></li>
  65. <li class="toctree-l3"><a class="reference internal" href="#history-navigation">History navigation</a></li>
  66. <li class="toctree-l3"><a class="reference internal" href="#resource-id-lookup">Resource ID lookup</a></li>
  67. </ul>
  68. </li>
  69. <li class="toctree-l2"><a class="reference internal" href="level_viewport.html">Level Viewport</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="texture_settings.html">Texture Settings</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
  77. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  78. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Engine Hackers</a></li>
  81. </ul>
  82. </div>
  83. </div>
  84. </nav>
  85. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  86. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  87. <a href="../index.html">Crown 0.60.0 Manual</a>
  88. </nav>
  89. <div class="wy-nav-content">
  90. <div class="rst-content">
  91. <div role="navigation" aria-label="Page navigation">
  92. <ul class="wy-breadcrumbs">
  93. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  94. <li><a href="index.html">The Level Editor</a> &raquo;</li>
  95. <li>Console</li>
  96. <li class="wy-breadcrumbs-aside">
  97. <a href="../_sources/level_editor/console.rst.txt" rel="nofollow"> View page source</a>
  98. </li>
  99. </ul>
  100. <hr/>
  101. </div>
  102. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  103. <div itemprop="articleBody">
  104. <section id="console">
  105. <h1>Console<a class="headerlink" href="#console" title="Permalink to this headline">¶</a></h1>
  106. <p>The Console displays information, warnings, errors, and debug output from the
  107. Level Editor, the running game, and other engine components. It also lets you
  108. interact with runtime instances by sending commands and Lua expressions.</p>
  109. <img alt="../_images/console.png" src="../_images/console.png" />
  110. <section id="runtime-connections">
  111. <h2>Runtime connections<a class="headerlink" href="#runtime-connections" title="Permalink to this headline">¶</a></h2>
  112. <p>Each engine runtime spawned by the Level Editor is connected via TCP/IP, and
  113. the Console is the main UI for communicating with those instances. By default
  114. the Console is set to communicate with the editor runtime itself. When you
  115. start the game from the Level Editor, Crown switches the Console to
  116. communicate with the game runtime. You can also select manually which runtime
  117. the Console talks to using the runtime selector:</p>
  118. <img alt="../_images/console_runtime_selector.svg" src="../_images/console_runtime_selector.svg" /></section>
  119. <section id="commands">
  120. <h2>Commands<a class="headerlink" href="#commands" title="Permalink to this headline">¶</a></h2>
  121. <p>You can type both commands and Lua expressions in the Command Bar. Use
  122. commands for low-level testing, profiling, or engine configuration. Commands
  123. must be prefixed with a colon (<code class="docutils literal notranslate"><span class="pre">:</span></code>) so they are distinguished from Lua
  124. expressions. Type <code class="docutils literal notranslate"><span class="pre">:help</span></code> in the Command Bar to see the available commands.</p>
  125. <p>See <a class="reference internal" href="../reference/console_commands.html#console-commands"><span class="std std-ref">Console commands</span></a> for full documentation.</p>
  126. </section>
  127. <section id="lua-expressions">
  128. <h2>Lua expressions<a class="headerlink" href="#lua-expressions" title="Permalink to this headline">¶</a></h2>
  129. <p>You can send arbitrary Lua expressions to the connected runtime. Enter a Lua
  130. expression in the Command Bar and press <code class="docutils literal notranslate"><span class="pre">Enter</span></code>. The runtime evaluates the
  131. expression and prints the result back to the Console. This is useful for
  132. inspecting state, calling engine APIs, or invoking game code while the game
  133. is running.</p>
  134. <img alt="../_images/console_lua_expression.svg" src="../_images/console_lua_expression.svg" /></section>
  135. <section id="history-navigation">
  136. <h2>History navigation<a class="headerlink" href="#history-navigation" title="Permalink to this headline">¶</a></h2>
  137. <p>The Console keeps a history of executed commands and expressions. Use the <code class="docutils literal notranslate"><span class="pre">Up</span>
  138. <span class="pre">Arrow</span></code> and <code class="docutils literal notranslate"><span class="pre">Down</span> <span class="pre">Arrow</span></code> keys to navigate backward and forward through
  139. recent entries. The maximum history size is configurable from Preferences
  140. dialog.</p>
  141. </section>
  142. <section id="resource-id-lookup">
  143. <h2>Resource ID lookup<a class="headerlink" href="#resource-id-lookup" title="Permalink to this headline">¶</a></h2>
  144. <p>For efficiency, Crown runtimes in most cases use hashed numeric identifiers
  145. instead of plain-text strings. When the Console detects such numeric IDs, it
  146. attempts to resolve them back to readable names so logs are easier to
  147. understand:</p>
  148. <img alt="../_images/console_id_lookup.svg" src="../_images/console_id_lookup.svg" /></section>
  149. </section>
  150. </div>
  151. </div>
  152. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  153. <a href="project_browser.html" class="btn btn-neutral float-left" title="Project Browser" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  154. <a href="level_viewport.html" class="btn btn-neutral float-right" title="Level Viewport" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  155. </div>
  156. <hr/>
  157. <div role="contentinfo">
  158. <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.
  159. <span class="lastupdated">Last updated on Feb 15, 2026.
  160. </span></p>
  161. </div>
  162. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  163. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  164. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  165. </footer>
  166. </div>
  167. </div>
  168. </section>
  169. </div>
  170. <script>
  171. jQuery(function () {
  172. SphinxRtdTheme.Navigation.enable(true);
  173. });
  174. </script>
  175. <!-- Theme Analytics -->
  176. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  177. <script>
  178. window.dataLayer = window.dataLayer || [];
  179. function gtag(){dataLayer.push(arguments);}
  180. gtag('js', new Date());
  181. gtag('config', 'G-XNVGCMNDZH', {
  182. 'anonymize_ip': true,
  183. });
  184. </script>
  185. </body>
  186. </html>