rot-js

Version:

A roguelike toolkit in JavaScript

ondras.github.io/rot.js

9 lines • 39.1 kB

HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Room | 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/map_features.html">map/features</a></li><li><a href="map_features.Room.html">Room</a></li></ul><h1>Class Room</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param x1</dt><dd></dd><dt>param y1</dt><dd></dd><dt>param x2</dt><dd></dd><dt>param y2</dt><dd></dd><dt>param [doorX]</dt><dd></dd><dt>param [doorY]</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Feature</span><ul class="tsd-hierarchy"><li><span class="target">Room</span></li></ul></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 tsd-is-overwrite"><a href="map_features.Room.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="map_features.Room.html#_doors" class="tsd-kind-icon">_doors</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_x1" class="tsd-kind-icon">_x1</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_x2" class="tsd-kind-icon">_x2</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_y1" class="tsd-kind-icon">_y1</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_y2" class="tsd-kind-icon">_y2</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="map_features.Room.html#addDoor" class="tsd-kind-icon">add<wbr/>Door</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#addDoors" class="tsd-kind-icon">add<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#clearDoors" class="tsd-kind-icon">clear<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getBottom" class="tsd-kind-icon">get<wbr/>Bottom</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getCenter" class="tsd-kind-icon">get<wbr/>Center</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getDoors" class="tsd-kind-icon">get<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getLeft" class="tsd-kind-icon">get<wbr/>Left</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getRight" class="tsd-kind-icon">get<wbr/>Right</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getTop" class="tsd-kind-icon">get<wbr/>Top</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#isValid" class="tsd-kind-icon">is<wbr/>Valid</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandom" class="tsd-kind-icon">create<wbr/>Random</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandomAt" class="tsd-kind-icon">create<wbr/>Random<wbr/>At</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandomCenter" class="tsd-kind-icon">create<wbr/>Random<wbr/>Center</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Room<span class="tsd-signature-symbol">(</span>x1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, x2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, doorX<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, doorY<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><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Feature.constructor</p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L47">map/features.ts:47</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x1: <span class="tsd-signature-type">number</span></h5></li><li><h5>y1: <span class="tsd-signature-type">number</span></h5></li><li><h5>x2: <span class="tsd-signature-type">number</span></h5></li><li><h5>y2: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> doorX: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> doorY: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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="_doors" class="tsd-anchor"></a><h3>_doors</h3><div class="tsd-signature tsd-kind-icon">_doors<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/map/features.ts#L45">map/features.ts:45</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>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_x1" class="tsd-anchor"></a><h3>_x1</h3><div class="tsd-signature tsd-kind-icon">_x1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L41">map/features.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_x2" class="tsd-anchor"></a><h3>_x2</h3><div class="tsd-signature tsd-kind-icon">_x2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L43">map/features.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_y1" class="tsd-anchor"></a><h3>_y1</h3><div class="tsd-signature tsd-kind-icon">_y1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L42">map/features.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_y2" class="tsd-anchor"></a><h3>_y2</h3><div class="tsd-signature tsd-kind-icon">_y2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L44">map/features.ts:44</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="addDoor" class="tsd-anchor"></a><h3>add<wbr/>Door</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Door<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L135">map/features.ts:135</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></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addDoors" class="tsd-anchor"></a><h3>add<wbr/>Doors</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Doors<span class="tsd-signature-symbol">(</span>isWallCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TestPositionCallback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L156">map/features.ts:156</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>isWallCallback: <span class="tsd-signature-type">TestPositionCallback</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clearDoors" class="tsd-anchor"></a><h3>clear<wbr/>Doors</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<wbr/>Doors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L151">map/features.ts:151</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="create" class="tsd-anchor"></a><h3>create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>digCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DigCallback</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"><p>Overrides Feature.create</p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L200">map/features.ts:200</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>digCallback: <span class="tsd-signature-type">DigCallback</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Dig callback with a signature (x, y, value). Values: 0 = empty, 1 = wall, 2 = door. Multiple doors are allowed.</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 tsd-is-overwrite"><a id="debug" class="tsd-anchor"></a><h3>debug</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">debug<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"><p>Overrides Feature.debug</p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L174">map/features.ts:174</a></li></ul></aside><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="getBottom" class="tsd-anchor"></a><h3>get<wbr/>Bottom</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Bottom<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></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/map/features.ts#L228">map/features.ts:228</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCenter" class="tsd-anchor"></a><h3>get<wbr/>Center</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Center<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></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/map/features.ts#L221">map/features.ts:221</a></li></ul></aside><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="getDoors" class="tsd-anchor"></a><h3>get<wbr/>Doors</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Doors<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L143">map/features.ts:143</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cb: <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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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><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"><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></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLeft" class="tsd-anchor"></a><h3>get<wbr/>Left</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Left<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></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/map/features.ts#L225">map/features.ts:225</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRight" class="tsd-anchor"></a><h3>get<wbr/>Right</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Right<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></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/map/features.ts#L226">map/features.ts:226</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTop" class="tsd-anchor"></a><h3>get<wbr/>Top</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Top<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></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/map/features.ts#L227">map/features.ts:227</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="isValid" class="tsd-anchor"></a><h3>is<wbr/>Valid</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">is<wbr/>Valid<span class="tsd-signature-symbol">(</span>isWallCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TestPositionCallback</span>, canBeDugCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TestPositionCallback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Feature.isValid</p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/features.ts#L178">map/features.ts:178</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>isWallCallback: <span class="tsd-signature-type">TestPositionCallback</span></h5></li><li><h5>canBeDugCallback: <span class="tsd-signature-type">TestPositionCallback</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="createRandom" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Random</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<wbr/>Random<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>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RoomOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L115">map/features.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Room of random size within a given dimensions</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></li><li><h5>availHeight: <span class="tsd-signature-type">number</span></h5></li><li><h5>options: <span class="tsd-signature-type">RoomOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="createRandomAt" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Random<wbr/>At</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<wbr/>Random<wbr/>At<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>, dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RoomOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L60">map/features.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Room of random size, with a given doors and direction</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>dx: <span class="tsd-signature-type">number</span></h5></li><li><h5>dy: <span class="tsd-signature-type">number</span></h5></li><li><h5>options: <span class="tsd-signature-type">RoomOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="createRandomCenter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Random<wbr/>Center</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<wbr/>Random<wbr/>Center<span class="tsd-signature-symbol">(</span>cx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RoomOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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/map/features.ts#L95">map/features.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Room of random size, positioned around center coords</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cx: <span class="tsd-signature-type">number</span></h5></li><li><h5>cy: <span class="tsd-signature-type">number</span></h5></li><li><h5>options: <span class="tsd-signature-type">RoomOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_features.Room.html" class="tsd-signature-type" data-tsd-kind="Class">Room</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=" 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="current 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="map_features.Room.html" class="tsd-kind-icon">Room</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_doors" class="tsd-kind-icon">_doors</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_x1" class="tsd-kind-icon">_x1</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_x2" class="tsd-kind-icon">_x2</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_y1" class="tsd-kind-icon">_y1</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_features.Room.html#_y2" class="tsd-kind-icon">_y2</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#addDoor" class="tsd-kind-icon">add<wbr/>Door</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#addDoors" class="tsd-kind-icon">add<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#clearDoors" class="tsd-kind-icon">clear<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getBottom" class="tsd-kind-icon">get<wbr/>Bottom</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getCenter" class="tsd-kind-icon">get<wbr/>Center</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getDoors" class="tsd-kind-icon">get<wbr/>Doors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getLeft" class="tsd-kind-icon">get<wbr/>Left</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getRight" class="tsd-kind-icon">get<wbr/>Right</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_features.Room.html#getTop" class="tsd-kind-icon">get<wbr/>Top</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_features.Room.html#isValid" class="tsd-kind-icon">is<wbr/>Valid</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandom" class="tsd-kind-icon">create<wbr/>Random</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandomAt" class="tsd-kind-icon">create<wbr/>Random<wbr/>At</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="map_features.Room.html#createRandomCenter" class="tsd-kind-icon">create<wbr/>Random<wbr/>Center</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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>