rot-js
Version:
A roguelike toolkit in JavaScript
1 lines • 22.8 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DisplayOptions | 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_types.html">display/types</a></li><li><a href="display_types.DisplayOptions.html">DisplayOptions</a></li></ul><h1>Interface DisplayOptions</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">DisplayOptions</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#bg" class="tsd-kind-icon">bg</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fg" class="tsd-kind-icon">fg</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontFamily" class="tsd-kind-icon">font<wbr/>Family</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontSize" class="tsd-kind-icon">font<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontStyle" class="tsd-kind-icon">font<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#forceSquareRatio" class="tsd-kind-icon">force<wbr/>Square<wbr/>Ratio</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#layout" class="tsd-kind-icon">layout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileColorize" class="tsd-kind-icon">tile<wbr/>Colorize</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileHeight" class="tsd-kind-icon">tile<wbr/>Height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileMap" class="tsd-kind-icon">tile<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileSet" class="tsd-kind-icon">tile<wbr/>Set</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileWidth" class="tsd-kind-icon">tile<wbr/>Width</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#transpose" class="tsd-kind-icon">transpose</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#width" class="tsd-kind-icon">width</a></li></ul></section></div></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-interface"><a id="bg" class="tsd-anchor"></a><h3>bg</h3><div class="tsd-signature tsd-kind-icon">bg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L15">display/types.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="border" class="tsd-anchor"></a><h3>border</h3><div class="tsd-signature tsd-kind-icon">border<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/display/types.ts#L10">display/types.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fg" class="tsd-anchor"></a><h3>fg</h3><div class="tsd-signature tsd-kind-icon">fg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L14">display/types.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fontFamily" class="tsd-anchor"></a><h3>font<wbr/>Family</h3><div class="tsd-signature tsd-kind-icon">font<wbr/>Family<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L12">display/types.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fontSize" class="tsd-anchor"></a><h3>font<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">font<wbr/>Size<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/display/types.ts#L8">display/types.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fontStyle" class="tsd-anchor"></a><h3>font<wbr/>Style</h3><div class="tsd-signature tsd-kind-icon">font<wbr/>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L13">display/types.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="forceSquareRatio" class="tsd-anchor"></a><h3>force<wbr/>Square<wbr/>Ratio</h3><div class="tsd-signature tsd-kind-icon">force<wbr/>Square<wbr/>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L11">display/types.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L5">display/types.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="layout" class="tsd-anchor"></a><h3>layout</h3><div class="tsd-signature tsd-kind-icon">layout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LayoutType</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L7">display/types.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="spacing" class="tsd-anchor"></a><h3>spacing</h3><div class="tsd-signature tsd-kind-icon">spacing<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/display/types.ts#L9">display/types.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tileColorize" class="tsd-anchor"></a><h3>tile<wbr/>Colorize</h3><div class="tsd-signature tsd-kind-icon">tile<wbr/>Colorize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L20">display/types.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tileHeight" class="tsd-anchor"></a><h3>tile<wbr/>Height</h3><div class="tsd-signature tsd-kind-icon">tile<wbr/>Height<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/display/types.ts#L17">display/types.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tileMap" class="tsd-anchor"></a><h3>tile<wbr/>Map</h3><div class="tsd-signature tsd-kind-icon">tile<wbr/>Map<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/types.ts#L18">display/types.ts:18</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-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></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tileSet" class="tsd-anchor"></a><h3>tile<wbr/>Set</h3><div class="tsd-signature tsd-kind-icon">tile<wbr/>Set<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ImageBitmap</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L19">display/types.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tileWidth" class="tsd-anchor"></a><h3>tile<wbr/>Width</h3><div class="tsd-signature tsd-kind-icon">tile<wbr/>Width<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/display/types.ts#L16">display/types.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transpose" class="tsd-anchor"></a><h3>transpose</h3><div class="tsd-signature tsd-kind-icon">transpose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L6">display/types.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/ondras/rot.js/blob/394b3e4/src/display/types.ts#L4">display/types.ts:4</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="../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="current 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-interface tsd-parent-kind-module"><a href="display_types.DisplayOptions.html" class="tsd-kind-icon">Display<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#bg" class="tsd-kind-icon">bg</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fg" class="tsd-kind-icon">fg</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontFamily" class="tsd-kind-icon">font<wbr/>Family</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontSize" class="tsd-kind-icon">font<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#fontStyle" class="tsd-kind-icon">font<wbr/>Style</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#forceSquareRatio" class="tsd-kind-icon">force<wbr/>Square<wbr/>Ratio</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#layout" class="tsd-kind-icon">layout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileColorize" class="tsd-kind-icon">tile<wbr/>Colorize</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileHeight" class="tsd-kind-icon">tile<wbr/>Height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileMap" class="tsd-kind-icon">tile<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileSet" class="tsd-kind-icon">tile<wbr/>Set</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#tileWidth" class="tsd-kind-icon">tile<wbr/>Width</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#transpose" class="tsd-kind-icon">transpose</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="display_types.DisplayOptions.html#width" class="tsd-kind-icon">width</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-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><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>