rot-js
Version:
A roguelike toolkit in JavaScript
23 lines • 43.4 kB
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/map_cellular.html">map/cellular</a></li><li><a href="map_cellular.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-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param [width=ROT.DEFAULT_WIDTH]</dt><dd></dd><dt>param [height=ROT.DEFAULT_HEIGHT]</dt><dd></dd><dt>param [options]</dt><dd><p>Options</p>
</dd><dt>param [options.born]</dt><dd><p>List of neighbor counts for a new cell to be born in empty space</p>
</dd><dt>param [options.survive]</dt><dd><p>List of neighbor counts for an existing cell to survive</p>
</dd><dt>param [options.topology]</dt><dd><p>Topology 4 or 6 or 8</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="map_map.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><ul class="tsd-hierarchy"><li><span class="target">default</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_cellular.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="map_cellular.default.html#_dirs" class="tsd-kind-icon">_dirs</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="map_cellular.default.html#_height" class="tsd-kind-icon">_height</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_cellular.default.html#_map" class="tsd-kind-icon">_map</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_cellular.default.html#_options" class="tsd-kind-icon">_options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="map_cellular.default.html#_width" class="tsd-kind-icon">_width</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 tsd-is-inherited"><a href="map_cellular.default.html#_fillMap" class="tsd-kind-icon">_fill<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_findConnected" class="tsd-kind-icon">_find<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_freeSpace" class="tsd-kind-icon">_free<wbr/>Space</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getClosest" class="tsd-kind-icon">_get<wbr/>Closest</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getFromTo" class="tsd-kind-icon">_get<wbr/>From<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getNeighbors" class="tsd-kind-icon">_get<wbr/>Neighbors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_pointKey" class="tsd-kind-icon">_point<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_serviceCallback" class="tsd-kind-icon">_service<wbr/>Callback</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_tunnelToConnected" class="tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_tunnelToConnected6" class="tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected6</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_cellular.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#randomize" class="tsd-kind-icon">randomize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#set" class="tsd-kind-icon">set</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.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 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 default<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<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">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="map_cellular.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"><p>Overrides <a href="map_map.default.html">default</a>.<a href="map_map.default.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/cellular.ts#L31">map/cellular.ts:31</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>width: <span class="tsd-signature-type">number</span></h5></li><li><h5>height: <span class="tsd-signature-type">number</span></h5></li><li><h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="map_cellular.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="_dirs" class="tsd-anchor"></a><h3>_dirs</h3><div class="tsd-signature tsd-kind-icon">_dirs<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/cellular.ts#L28">map/cellular.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="_height" class="tsd-anchor"></a><h3>_height</h3><div class="tsd-signature tsd-kind-icon">_height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="map_map.default.html">default</a>.<a href="map_map.default.html#_height">_height</a></p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/map.ts#L7">map/map.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_map" class="tsd-anchor"></a><h3>_map</h3><div class="tsd-signature tsd-kind-icon">_map<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/cellular.ts#L29">map/cellular.ts:29</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> <span class="tsd-signature-type">Options</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/cellular.ts#L27">map/cellular.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="_width" class="tsd-anchor"></a><h3>_width</h3><div class="tsd-signature tsd-kind-icon">_width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="map_map.default.html">default</a>.<a href="map_map.default.html#_width">_width</a></p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/map.ts#L6">map/map.ts:6</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 tsd-is-inherited"><a id="_fillMap" class="tsd-anchor"></a><h3>_fill<wbr/>Map</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">_fill<wbr/>Map<span class="tsd-signature-symbol">(</span>value<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><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="map_map.default.html">default</a>.<a href="map_map.default.html#_fillMap">_fillMap</a></p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/map.ts#L21">map/map.ts:21</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <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><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="_findConnected" class="tsd-anchor"></a><h3>_find<wbr/>Connected</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_find<wbr/>Connected<span class="tsd-signature-symbol">(</span>connected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, notConnected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, stack<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span><span class="tsd-signature-symbol">[]</span>, keepNotConnected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, value<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/map/cellular.ts#L230">map/cellular.ts:230</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>notConnected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>stack: <span class="tsd-signature-type">Point</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>keepNotConnected: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>value: <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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_freeSpace" class="tsd-anchor"></a><h3>_free<wbr/>Space</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_free<wbr/>Space<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>, value<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">boolean</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/cellular.ts#L352">map/cellular.ts:352</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>value: <span class="tsd-signature-type">number</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"><a id="_getClosest" class="tsd-anchor"></a><h3>_get<wbr/>Closest</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_get<wbr/>Closest<span class="tsd-signature-symbol">(</span>point<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span>, space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</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/cellular.ts#L216">map/cellular.ts:216</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>point: <span class="tsd-signature-type">Point</span></h5></li><li><h5>space: <span class="tsd-signature-type">PointMap</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Point</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_getFromTo" class="tsd-anchor"></a><h3>_get<wbr/>From<wbr/>To</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_get<wbr/>From<wbr/>To<span class="tsd-signature-symbol">(</span>connected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, notConnected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</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/cellular.ts#L195">map/cellular.ts:195</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Find random points to connect. Search for the closest point in the larger space.
This is to minimize the length of the passage while maintaining good performance.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>notConnected: <span class="tsd-signature-type">PointMap</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Point</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="_getNeighbors" class="tsd-anchor"></a><h3>_get<wbr/>Neighbors</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_get<wbr/>Neighbors<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><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/cellular.ts#L112">map/cellular.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get neighbor count at [i,j] in this._map</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></ul><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="_pointKey" class="tsd-anchor"></a><h3>_point<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_point<wbr/>Key<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/cellular.ts#L356">map/cellular.ts:356</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>p: <span class="tsd-signature-type">Point</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_serviceCallback" class="tsd-anchor"></a><h3>_service<wbr/>Callback</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_service<wbr/>Callback<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a><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/map/cellular.ts#L95">map/cellular.ts:95</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a></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="_tunnelToConnected" class="tsd-anchor"></a><h3>_tunnel<wbr/>To<wbr/>Connected</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected<span class="tsd-signature-symbol">(</span>to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span>, connected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, notConnected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, connectionCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ConnectionCallback</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/map/cellular.ts#L265">map/cellular.ts:265</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>to: <span class="tsd-signature-type">Point</span></h5></li><li><h5>from: <span class="tsd-signature-type">Point</span></h5></li><li><h5>connected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>notConnected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>value: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionCallback: <span class="tsd-signature-type">ConnectionCallback</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="_tunnelToConnected6" class="tsd-anchor"></a><h3>_tunnel<wbr/>To<wbr/>Connected6</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected6<span class="tsd-signature-symbol">(</span>to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Point</span>, connected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, notConnected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PointMap</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, connectionCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ConnectionCallback</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/map/cellular.ts#L307">map/cellular.ts:307</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>to: <span class="tsd-signature-type">Point</span></h5></li><li><h5>from: <span class="tsd-signature-type">Point</span></h5></li><li><h5>connected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>notConnected: <span class="tsd-signature-type">PointMap</span></h5></li><li><h5>value: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionCallback: <span class="tsd-signature-type">ConnectionCallback</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="connect" class="tsd-anchor"></a><h3>connect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, connectionCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ConnectionCallback</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/map/cellular.ts#L132">map/cellular.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Make sure every non-wall space is accessible.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>to call to display map when do</p>
</div></div></li><li><h5>value: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>to consider empty space - defaults to 0</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionCallback: <span class="tsd-signature-type">ConnectionCallback</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 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>callback<span class="tsd-signature-symbol">?: </span><a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a><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 <a href="map_map.default.html">default</a>.<a href="map_map.default.html#create">create</a></p><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/map/cellular.ts#L65">map/cellular.ts:65</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <a href="../interfaces/map_map.CreateCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateCallback</a></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="randomize" class="tsd-anchor"></a><h3>randomize</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">randomize<span class="tsd-signature-symbol">(</span>probability<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_cellular.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/map/cellular.ts#L48">map/cellular.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fill the map with random values</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>probability: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Probability for a cell to become alive; 0 = all empty, 1 = all full</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="map_cellular.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="set" class="tsd-anchor"></a><h3>set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<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>, value<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/map/cellular.ts#L63">map/cellular.ts:63</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>value: <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></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"><</span><span class="tsd-signature-type">Options</span><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/map/cellular.ts#L61">map/cellular.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Change options.</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p>ROT.Map.Cellular</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"><</span><span class="tsd-signature-type">Options</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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="current 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="map_cellular.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="map_cellular.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_cellular.default.html#_dirs" class="tsd-kind-icon">_dirs</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="map_cellular.default.html#_height" class="tsd-kind-icon">_height</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_cellular.default.html#_map" class="tsd-kind-icon">_map</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="map_cellular.default.html#_options" class="tsd-kind-icon">_options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="map_cellular.default.html#_width" class="tsd-kind-icon">_width</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="map_cellular.default.html#_fillMap" class="tsd-kind-icon">_fill<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_findConnected" class="tsd-kind-icon">_find<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_freeSpace" class="tsd-kind-icon">_free<wbr/>Space</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getClosest" class="tsd-kind-icon">_get<wbr/>Closest</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getFromTo" class="tsd-kind-icon">_get<wbr/>From<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_getNeighbors" class="tsd-kind-icon">_get<wbr/>Neighbors</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_pointKey" class="tsd-kind-icon">_point<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_serviceCallback" class="tsd-kind-icon">_service<wbr/>Callback</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_tunnelToConnected" class="tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#_tunnelToConnected6" class="tsd-kind-icon">_tunnel<wbr/>To<wbr/>Connected6</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="map_cellular.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#randomize" class="tsd-kind-icon">randomize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.default.html#set" class="tsd-kind-icon">set</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="map_cellular.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-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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>