rot-js
Version:
A roguelike toolkit in JavaScript
1 lines • 17.5 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>index | rot.js</title><meta name="description" content="Documentation for rot.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">rot.js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">rot.js</a></li><li><a href="index.html">index</a></li></ul><h1>Module index</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DEFAULT_HEIGHT" class="tsd-kind-icon">DEFAULT_<wbr/>HEIGHT</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DEFAULT_WIDTH" class="tsd-kind-icon">DEFAULT_<wbr/>WIDTH</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DIRS" class="tsd-kind-icon">DIRS</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Engine" class="tsd-kind-icon">Engine</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#EventQueue" class="tsd-kind-icon">Event<wbr/>Queue</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#FOV" class="tsd-kind-icon">FOV</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#KEYS" class="tsd-kind-icon">KEYS</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Lighting" class="tsd-kind-icon">Lighting</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Map" class="tsd-kind-icon">Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Noise" class="tsd-kind-icon">Noise</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Path" class="tsd-kind-icon">Path</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#RNG" class="tsd-kind-icon">RNG</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Scheduler" class="tsd-kind-icon">Scheduler</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#SpeedActor" class="tsd-kind-icon">Speed<wbr/>Actor</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#StringGenerator" class="tsd-kind-icon">String<wbr/>Generator</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Color" class="tsd-kind-icon">Color</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Text" class="tsd-kind-icon">Text</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Util" class="tsd-kind-icon">Util</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="DEFAULT_HEIGHT" class="tsd-anchor"></a><h3>DEFAULT_<wbr/>HEIGHT</h3>Re-exports <a href="constants.html#DEFAULT_HEIGHT">DEFAULT_HEIGHT</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="DEFAULT_WIDTH" class="tsd-anchor"></a><h3>DEFAULT_<wbr/>WIDTH</h3>Re-exports <a href="constants.html#DEFAULT_WIDTH">DEFAULT_WIDTH</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="DIRS" class="tsd-anchor"></a><h3>DIRS</h3>Re-exports <a href="constants.html#DIRS">DIRS</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Display" class="tsd-anchor"></a><h3>Display</h3>Renames and re-exports <a href="../classes/display_display.default.html">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Engine" class="tsd-anchor"></a><h3>Engine</h3>Renames and re-exports <a href="../classes/engine.default.html">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventQueue" class="tsd-anchor"></a><h3>Event<wbr/>Queue</h3>Renames and re-exports <a href="../classes/eventqueue.default.html">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="FOV" class="tsd-anchor"></a><h3>FOV</h3>Renames and re-exports <a href="fov.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="KEYS" class="tsd-anchor"></a><h3>KEYS</h3>Re-exports <a href="constants.html#KEYS">KEYS</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Lighting" class="tsd-anchor"></a><h3>Lighting</h3>Renames and re-exports <a href="../classes/lighting.default.html">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Map" class="tsd-anchor"></a><h3>Map</h3>Renames and re-exports <a href="map.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Noise" class="tsd-anchor"></a><h3>Noise</h3>Renames and re-exports <a href="noise.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Path" class="tsd-anchor"></a><h3>Path</h3>Renames and re-exports <a href="path.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="RNG" class="tsd-anchor"></a><h3>RNG</h3>Renames and re-exports <a href="rng.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Scheduler" class="tsd-anchor"></a><h3>Scheduler</h3>Renames and re-exports <a href="scheduler.html#default">default</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SpeedActor" class="tsd-anchor"></a><h3>Speed<wbr/>Actor</h3>Re-exports <a href="../interfaces/scheduler_speed.SpeedActor.html">SpeedActor</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="StringGenerator" class="tsd-anchor"></a><h3>String<wbr/>Generator</h3>Renames and re-exports <a href="../classes/stringgenerator.default.html">default</a></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="Color" class="tsd-anchor"></a><h3>Color</h3><div class="tsd-signature tsd-kind-icon">Color<span class="tsd-signature-symbol">:</span> <a href="color.html" class="tsd-signature-type" data-tsd-kind="Module">color</a><span class="tsd-signature-symbol"> = color</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/index.ts#L19">index.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="Text" class="tsd-anchor"></a><h3>Text</h3><div class="tsd-signature tsd-kind-icon">Text<span class="tsd-signature-symbol">:</span> <a href="text.html" class="tsd-signature-type" data-tsd-kind="Module">text</a><span class="tsd-signature-symbol"> = text</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/index.ts#L22">index.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="Util" class="tsd-anchor"></a><h3>Util</h3><div class="tsd-signature tsd-kind-icon">Util<span class="tsd-signature-symbol">:</span> <a href="util.html" class="tsd-signature-type" data-tsd-kind="Module">util</a><span class="tsd-signature-symbol"> = util</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/index.ts#L16">index.ts:16</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="MinHeap.html">Min<wbr/>Heap</a></li><li class=" tsd-kind-module"><a href="color.html">color</a></li><li class=" tsd-kind-module"><a href="constants.html">constants</a></li><li class=" tsd-kind-module"><a href="display_backend.html">display/backend</a></li><li class=" tsd-kind-module"><a href="display_canvas.html">display/canvas</a></li><li class=" tsd-kind-module"><a href="display_display.html">display/display</a></li><li class=" tsd-kind-module"><a href="display_hex.html">display/hex</a></li><li class=" tsd-kind-module"><a href="display_rect.html">display/rect</a></li><li class=" tsd-kind-module"><a href="display_term.html">display/term</a></li><li class=" tsd-kind-module"><a href="display_tile.html">display/tile</a></li><li class=" tsd-kind-module"><a href="display_tile_gl.html">display/tile-<wbr/>gl</a></li><li class=" tsd-kind-module"><a href="display_types.html">display/types</a></li><li class=" tsd-kind-module"><a href="engine.html">engine</a></li><li class=" tsd-kind-module"><a href="eventqueue.html">eventqueue</a></li><li class=" tsd-kind-module"><a href="fov.html">fov</a></li><li class=" tsd-kind-module"><a href="fov_discrete_shadowcasting.html">fov/discrete-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="fov_fov.html">fov/fov</a></li><li class=" tsd-kind-module"><a href="fov_precise_shadowcasting.html">fov/precise-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="fov_recursive_shadowcasting.html">fov/recursive-<wbr/>shadowcasting</a></li><li class="current tsd-kind-module"><a href="index.html">index</a></li><li class=" tsd-kind-module"><a href="lighting.html">lighting</a></li><li class=" tsd-kind-module"><a href="map.html">map</a></li><li class=" tsd-kind-module"><a href="map_arena.html">map/arena</a></li><li class=" tsd-kind-module"><a href="map_cellular.html">map/cellular</a></li><li class=" tsd-kind-module"><a href="map_digger.html">map/digger</a></li><li class=" tsd-kind-module"><a href="map_dividedmaze.html">map/dividedmaze</a></li><li class=" tsd-kind-module"><a href="map_dungeon.html">map/dungeon</a></li><li class=" tsd-kind-module"><a href="map_ellermaze.html">map/ellermaze</a></li><li class=" tsd-kind-module"><a href="map_features.html">map/features</a></li><li class=" tsd-kind-module"><a href="map_iceymaze.html">map/iceymaze</a></li><li class=" tsd-kind-module"><a href="map_map.html">map/map</a></li><li class=" tsd-kind-module"><a href="map_rogue.html">map/rogue</a></li><li class=" tsd-kind-module"><a href="map_uniform.html">map/uniform</a></li><li class=" tsd-kind-module"><a href="noise.html">noise</a></li><li class=" tsd-kind-module"><a href="noise_noise.html">noise/noise</a></li><li class=" tsd-kind-module"><a href="noise_simplex.html">noise/simplex</a></li><li class=" tsd-kind-module"><a href="path.html">path</a></li><li class=" tsd-kind-module"><a href="path_astar.html">path/astar</a></li><li class=" tsd-kind-module"><a href="path_dijkstra.html">path/dijkstra</a></li><li class=" tsd-kind-module"><a href="path_path.html">path/path</a></li><li class=" tsd-kind-module"><a href="rng.html">rng</a></li><li class=" tsd-kind-module"><a href="scheduler.html">scheduler</a></li><li class=" tsd-kind-module"><a href="scheduler_action.html">scheduler/action</a></li><li class=" tsd-kind-module"><a href="scheduler_scheduler.html">scheduler/scheduler</a></li><li class=" tsd-kind-module"><a href="scheduler_simple.html">scheduler/simple</a></li><li class=" tsd-kind-module"><a href="scheduler_speed.html">scheduler/speed</a></li><li class=" tsd-kind-module"><a href="stringgenerator.html">stringgenerator</a></li><li class=" tsd-kind-module"><a href="text.html">text</a></li><li class=" tsd-kind-module"><a href="util.html">util</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DEFAULT_HEIGHT" class="tsd-kind-icon">DEFAULT_<wbr/>HEIGHT</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DEFAULT_WIDTH" class="tsd-kind-icon">DEFAULT_<wbr/>WIDTH</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#DIRS" class="tsd-kind-icon">DIRS</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Engine" class="tsd-kind-icon">Engine</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#EventQueue" class="tsd-kind-icon">Event<wbr/>Queue</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#FOV" class="tsd-kind-icon">FOV</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#KEYS" class="tsd-kind-icon">KEYS</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Lighting" class="tsd-kind-icon">Lighting</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Map" class="tsd-kind-icon">Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Noise" class="tsd-kind-icon">Noise</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Path" class="tsd-kind-icon">Path</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#RNG" class="tsd-kind-icon">RNG</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#Scheduler" class="tsd-kind-icon">Scheduler</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#SpeedActor" class="tsd-kind-icon">Speed<wbr/>Actor</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="index.html#StringGenerator" class="tsd-kind-icon">String<wbr/>Generator</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Color" class="tsd-kind-icon">Color</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Text" class="tsd-kind-icon">Text</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#Util" class="tsd-kind-icon">Util</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>