UNPKG

rot-js

Version:

A roguelike toolkit in JavaScript

ondras.github.io/rot.js

ondras/rot.js

45 lines • 45.8 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | 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="../modules/display_display.html">display/display</a></li><li><a href="display_display.default.html">default</a></li></ul><h1>Class default</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="display_display.default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_backend" class="tsd-kind-icon">_backend</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_data" class="tsd-kind-icon">_data</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_dirty" class="tsd-kind-icon">_dirty</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_options" class="tsd-kind-icon">_options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Hex" class="tsd-kind-icon">Hex</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Rect" class="tsd-kind-icon">Rect</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Term" class="tsd-kind-icon">Term</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Tile" class="tsd-kind-icon">Tile</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#TileGL" class="tsd-kind-icon">TileGL</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#DEBUG" class="tsd-kind-icon">DEBUG</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#_draw" class="tsd-kind-icon">_draw</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#_tick" class="tsd-kind-icon">_tick</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeFontSize" class="tsd-kind-icon">compute<wbr/>Font<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeSize" class="tsd-kind-icon">compute<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeTileSize" class="tsd-kind-icon">compute<wbr/>Tile<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#draw" class="tsd-kind-icon">draw</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#drawOver" class="tsd-kind-icon">draw<wbr/>Over</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#drawText" class="tsd-kind-icon">draw<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#eventToPosition" class="tsd-kind-icon">event<wbr/>To<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#getContainer" class="tsd-kind-icon">get<wbr/>Container</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#getOptions" class="tsd-kind-icon">get<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#setOptions" class="tsd-kind-icon">set<wbr/>Options</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="display_display.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L55">display/display.ts:55</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="display_display.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_backend" class="tsd-anchor"></a><h3>_backend</h3><div class="tsd-signature tsd-kind-icon">_backend<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">default</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L47">display/display.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_data" class="tsd-anchor"></a><h3>_data</h3><div class="tsd-signature tsd-kind-icon">_data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L44">display/display.ts:44</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>pos: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../modules/display_types.html#DisplayData" class="tsd-signature-type" data-tsd-kind="Type alias">DisplayData</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_dirty" class="tsd-anchor"></a><h3>_dirty</h3><div class="tsd-signature tsd-kind-icon">_dirty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L45">display/display.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_options" class="tsd-anchor"></a><h3>_options</h3><div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L46">display/display.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="Hex" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Hex</h3><div class="tsd-signature tsd-kind-icon">Hex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> = Hex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L50">display/display.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="Rect" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Rect</h3><div class="tsd-signature tsd-kind-icon">Rect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> = Rect</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L49">display/display.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="Term" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Term</h3><div class="tsd-signature tsd-kind-icon">Term<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="display_term.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = Term</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L53">display/display.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="Tile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Tile</h3><div class="tsd-signature tsd-kind-icon">Tile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> = Tile</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L51">display/display.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="TileGL" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> TileGL</h3><div class="tsd-signature tsd-kind-icon">TileGL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> = TileGL</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L52">display/display.ts:52</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="DEBUG" class="tsd-anchor"></a><h3>DEBUG</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">DEBUG<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, what<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L74">display/display.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Debug helper, ideal as a map generator callback. Always bound to this.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5></li><li><h5>y: <span class="tsd-signature-type">number</span></h5></li><li><h5>what: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_draw" class="tsd-anchor"></a><h3>_draw</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_draw<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clearBefore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L296">display/display.ts:296</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>What to draw</p> </div></div></li><li><h5>clearBefore: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Is it necessary to clean before?</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_tick" class="tsd-anchor"></a><h3>_tick</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_tick<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L277">display/display.ts:277</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Timer tick: update dirty parts</p> </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clear" class="tsd-anchor"></a><h3>clear</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L82">display/display.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Clear the whole display (cover it with background color)</p> </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="computeFontSize" class="tsd-anchor"></a><h3>compute<wbr/>Font<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">compute<wbr/>Font<wbr/>Size<span class="tsd-signature-symbol">(</span>availWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, availHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L131">display/display.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Compute the maximum font size to fit into a set of given constraints</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>availWidth: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Maximum allowed pixel width</p> </div></div></li><li><h5>availHeight: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Maximum allowed pixel height</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>fontSize</p> </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="computeSize" class="tsd-anchor"></a><h3>compute<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">compute<wbr/>Size<span class="tsd-signature-symbol">(</span>availWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, availHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L121">display/display.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Compute the maximum width/height to fit into a set of given constraints</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>availWidth: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Maximum allowed pixel width</p> </div></div></li><li><h5>availHeight: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Maximum allowed pixel height</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><div><p>cellWidth,cellHeight</p> </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="computeTileSize" class="tsd-anchor"></a><h3>compute<wbr/>Tile<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">compute<wbr/>Tile<wbr/>Size<span class="tsd-signature-symbol">(</span>availWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, availHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L135">display/display.ts:135</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>availWidth: <span class="tsd-signature-type">number</span></h5></li><li><h5>availHeight: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="draw" class="tsd-anchor"></a><h3>draw</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, fg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, bg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L166">display/display.ts:166</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5></li><li><h5>y: <span class="tsd-signature-type">number</span></h5></li><li><h5>ch: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>One or more chars (will be overlapping themselves)</p> </div></div></li><li><h5>fg: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>bg: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="drawOver" class="tsd-anchor"></a><h3>draw<wbr/>Over</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Over<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, fg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, bg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L184">display/display.ts:184</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5></li><li><h5>y: <span class="tsd-signature-type">number</span></h5></li><li><h5>ch: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>One or more chars (will be overlapping themselves)</p> </div></div></li><li><h5>fg: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>bg: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="drawText" class="tsd-anchor"></a><h3>draw<wbr/>Text</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Text<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxWidth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L210">display/display.ts:210</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Draws a text at given position. Optionally wraps at a maximum length. Currently does not work with hex layout.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5></li><li><h5>y: <span class="tsd-signature-type">number</span></h5></li><li><h5>text: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>May contain color/background format specifiers, %c{name}/%b{name}, both optional. %c{}/%b{} resets to default.</p> </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> maxWidth: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>lines drawn</p> </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="eventToPosition" class="tsd-anchor"></a><h3>event<wbr/>To<wbr/>Position</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">event<wbr/>To<wbr/>Position<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TouchEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L146">display/display.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Convert a DOM event (mouse or touch) to map coordinates. Uses first touch for multi-touch.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>e: <span class="tsd-signature-type">TouchEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>event</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><div><p>-1 for values outside of the canvas</p> </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getContainer" class="tsd-anchor"></a><h3>get<wbr/>Container</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Container<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L113">display/display.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Returns the DOM node of this display</p> </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getOptions" class="tsd-anchor"></a><h3>get<wbr/>Options</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L108">display/display.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Returns currently set options</p> </div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setOptions" class="tsd-anchor"></a><h3>set<wbr/>Options</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="display_display.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/display.ts#L90">display/display.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>see</dt><dd><p>ROT.Display</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/display_types.DisplayOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DisplayOptions</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="display_display.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></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="../modules/MinHeap.html">Min<wbr/>Heap</a></li><li class=" tsd-kind-module"><a href="../modules/color.html">color</a></li><li class=" tsd-kind-module"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-module"><a href="../modules/display_backend.html">display/backend</a></li><li class=" tsd-kind-module"><a href="../modules/display_canvas.html">display/canvas</a></li><li class="current tsd-kind-module"><a href="../modules/display_display.html">display/display</a></li><li class=" tsd-kind-module"><a href="../modules/display_hex.html">display/hex</a></li><li class=" tsd-kind-module"><a href="../modules/display_rect.html">display/rect</a></li><li class=" tsd-kind-module"><a href="../modules/display_term.html">display/term</a></li><li class=" tsd-kind-module"><a href="../modules/display_tile.html">display/tile</a></li><li class=" tsd-kind-module"><a href="../modules/display_tile_gl.html">display/tile-<wbr/>gl</a></li><li class=" tsd-kind-module"><a href="../modules/display_types.html">display/types</a></li><li class=" tsd-kind-module"><a href="../modules/engine.html">engine</a></li><li class=" tsd-kind-module"><a href="../modules/eventqueue.html">eventqueue</a></li><li class=" tsd-kind-module"><a href="../modules/fov.html">fov</a></li><li class=" tsd-kind-module"><a href="../modules/fov_discrete_shadowcasting.html">fov/discrete-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="../modules/fov_fov.html">fov/fov</a></li><li class=" tsd-kind-module"><a href="../modules/fov_precise_shadowcasting.html">fov/precise-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="../modules/fov_recursive_shadowcasting.html">fov/recursive-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/lighting.html">lighting</a></li><li class=" tsd-kind-module"><a href="../modules/map.html">map</a></li><li class=" tsd-kind-module"><a href="../modules/map_arena.html">map/arena</a></li><li class=" tsd-kind-module"><a href="../modules/map_cellular.html">map/cellular</a></li><li class=" tsd-kind-module"><a href="../modules/map_digger.html">map/digger</a></li><li class=" tsd-kind-module"><a href="../modules/map_dividedmaze.html">map/dividedmaze</a></li><li class=" tsd-kind-module"><a href="../modules/map_dungeon.html">map/dungeon</a></li><li class=" tsd-kind-module"><a href="../modules/map_ellermaze.html">map/ellermaze</a></li><li class=" tsd-kind-module"><a href="../modules/map_features.html">map/features</a></li><li class=" tsd-kind-module"><a href="../modules/map_iceymaze.html">map/iceymaze</a></li><li class=" tsd-kind-module"><a href="../modules/map_map.html">map/map</a></li><li class=" tsd-kind-module"><a href="../modules/map_rogue.html">map/rogue</a></li><li class=" tsd-kind-module"><a href="../modules/map_uniform.html">map/uniform</a></li><li class=" tsd-kind-module"><a href="../modules/noise.html">noise</a></li><li class=" tsd-kind-module"><a href="../modules/noise_noise.html">noise/noise</a></li><li class=" tsd-kind-module"><a href="../modules/noise_simplex.html">noise/simplex</a></li><li class=" tsd-kind-module"><a href="../modules/path.html">path</a></li><li class=" tsd-kind-module"><a href="../modules/path_astar.html">path/astar</a></li><li class=" tsd-kind-module"><a href="../modules/path_dijkstra.html">path/dijkstra</a></li><li class=" tsd-kind-module"><a href="../modules/path_path.html">path/path</a></li><li class=" tsd-kind-module"><a href="../modules/rng.html">rng</a></li><li class=" tsd-kind-module"><a href="../modules/scheduler.html">scheduler</a></li><li class=" tsd-kind-module"><a href="../modules/scheduler_action.html">scheduler/action</a></li><li class=" tsd-kind-module"><a href="../modules/scheduler_scheduler.html">scheduler/scheduler</a></li><li class=" tsd-kind-module"><a href="../modules/scheduler_simple.html">scheduler/simple</a></li><li class=" tsd-kind-module"><a href="../modules/scheduler_speed.html">scheduler/speed</a></li><li class=" tsd-kind-module"><a href="../modules/stringgenerator.html">stringgenerator</a></li><li class=" tsd-kind-module"><a href="../modules/text.html">text</a></li><li class=" tsd-kind-module"><a href="../modules/util.html">util</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="display_display.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="display_display.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_backend" class="tsd-kind-icon">_backend</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_data" class="tsd-kind-icon">_data</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_dirty" class="tsd-kind-icon">_dirty</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="display_display.default.html#_options" class="tsd-kind-icon">_options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Hex" class="tsd-kind-icon">Hex</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Rect" class="tsd-kind-icon">Rect</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Term" class="tsd-kind-icon">Term</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#Tile" class="tsd-kind-icon">Tile</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="display_display.default.html#TileGL" class="tsd-kind-icon">TileGL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#DEBUG" class="tsd-kind-icon">DEBUG</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#_draw" class="tsd-kind-icon">_draw</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#_tick" class="tsd-kind-icon">_tick</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeFontSize" class="tsd-kind-icon">compute<wbr/>Font<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeSize" class="tsd-kind-icon">compute<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#computeTileSize" class="tsd-kind-icon">compute<wbr/>Tile<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#draw" class="tsd-kind-icon">draw</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#drawOver" class="tsd-kind-icon">draw<wbr/>Over</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#drawText" class="tsd-kind-icon">draw<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#eventToPosition" class="tsd-kind-icon">event<wbr/>To<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#getContainer" class="tsd-kind-icon">get<wbr/>Container</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#getOptions" class="tsd-kind-icon">get<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="display_display.default.html#setOptions" class="tsd-kind-icon">set<wbr/>Options</a></li></ul></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-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><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><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-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</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>