rot-js
Version:
A roguelike toolkit in JavaScript
10 lines • 14.1 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>util | 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="util.html">util</a></li></ul><h1>Module util</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#capitalize" class="tsd-kind-icon">capitalize</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#clamp" class="tsd-kind-icon">clamp</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#format" class="tsd-kind-icon">format</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#mod" class="tsd-kind-icon">mod</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="capitalize" class="tsd-anchor"></a><h3>capitalize</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">capitalize<span class="tsd-signature-symbol">(</span>string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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/util.ts#L17">util.ts:17</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>string: <span class="tsd-signature-type">string</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-function tsd-parent-kind-module"><a id="clamp" class="tsd-anchor"></a><h3>clamp</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">clamp<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, min<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, max<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/util.ts#L11">util.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>val: <span class="tsd-signature-type">number</span></h5></li><li><h5>min: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5></li><li><h5>max: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</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-function tsd-parent-kind-module"><a id="format" class="tsd-anchor"></a><h3>format</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">(</span>template<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</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/util.ts#L31">util.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Format a string in a flexible way. Scans for %s strings and replaces them with arguments. List of patterns is modifiable via String.format.map.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>template: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</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-function tsd-parent-kind-module"><a id="mod" class="tsd-anchor"></a><h3>mod</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">mod<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, n<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/util.ts#L7">util.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Always positive modulus</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><div class="tsd-comment tsd-typography"><div class="lead">
<p>Operand</p>
</div></div></li><li><h5>n: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Modulus</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>x modulo n</p>
</div></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="MinHeap.html">Min<wbr/>Heap</a></li><li class=" tsd-kind-module"><a href="color.html">color</a></li><li class=" tsd-kind-module"><a href="constants.html">constants</a></li><li class=" tsd-kind-module"><a href="display_backend.html">display/backend</a></li><li class=" tsd-kind-module"><a href="display_canvas.html">display/canvas</a></li><li class=" tsd-kind-module"><a href="display_display.html">display/display</a></li><li class=" tsd-kind-module"><a href="display_hex.html">display/hex</a></li><li class=" tsd-kind-module"><a href="display_rect.html">display/rect</a></li><li class=" tsd-kind-module"><a href="display_term.html">display/term</a></li><li class=" tsd-kind-module"><a href="display_tile.html">display/tile</a></li><li class=" tsd-kind-module"><a href="display_tile_gl.html">display/tile-<wbr/>gl</a></li><li class=" tsd-kind-module"><a href="display_types.html">display/types</a></li><li class=" tsd-kind-module"><a href="engine.html">engine</a></li><li class=" tsd-kind-module"><a href="eventqueue.html">eventqueue</a></li><li class=" tsd-kind-module"><a href="fov.html">fov</a></li><li class=" tsd-kind-module"><a href="fov_discrete_shadowcasting.html">fov/discrete-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="fov_fov.html">fov/fov</a></li><li class=" tsd-kind-module"><a href="fov_precise_shadowcasting.html">fov/precise-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="fov_recursive_shadowcasting.html">fov/recursive-<wbr/>shadowcasting</a></li><li class=" tsd-kind-module"><a href="index.html">index</a></li><li class=" tsd-kind-module"><a href="lighting.html">lighting</a></li><li class=" tsd-kind-module"><a href="map.html">map</a></li><li class=" tsd-kind-module"><a href="map_arena.html">map/arena</a></li><li class=" tsd-kind-module"><a href="map_cellular.html">map/cellular</a></li><li class=" tsd-kind-module"><a href="map_digger.html">map/digger</a></li><li class=" tsd-kind-module"><a href="map_dividedmaze.html">map/dividedmaze</a></li><li class=" tsd-kind-module"><a href="map_dungeon.html">map/dungeon</a></li><li class=" tsd-kind-module"><a href="map_ellermaze.html">map/ellermaze</a></li><li class=" tsd-kind-module"><a href="map_features.html">map/features</a></li><li class=" tsd-kind-module"><a href="map_iceymaze.html">map/iceymaze</a></li><li class=" tsd-kind-module"><a href="map_map.html">map/map</a></li><li class=" tsd-kind-module"><a href="map_rogue.html">map/rogue</a></li><li class=" tsd-kind-module"><a href="map_uniform.html">map/uniform</a></li><li class=" tsd-kind-module"><a href="noise.html">noise</a></li><li class=" tsd-kind-module"><a href="noise_noise.html">noise/noise</a></li><li class=" tsd-kind-module"><a href="noise_simplex.html">noise/simplex</a></li><li class=" tsd-kind-module"><a href="path.html">path</a></li><li class=" tsd-kind-module"><a href="path_astar.html">path/astar</a></li><li class=" tsd-kind-module"><a href="path_dijkstra.html">path/dijkstra</a></li><li class=" tsd-kind-module"><a href="path_path.html">path/path</a></li><li class=" tsd-kind-module"><a href="rng.html">rng</a></li><li class=" tsd-kind-module"><a href="scheduler.html">scheduler</a></li><li class=" tsd-kind-module"><a href="scheduler_action.html">scheduler/action</a></li><li class=" tsd-kind-module"><a href="scheduler_scheduler.html">scheduler/scheduler</a></li><li class=" tsd-kind-module"><a href="scheduler_simple.html">scheduler/simple</a></li><li class=" tsd-kind-module"><a href="scheduler_speed.html">scheduler/speed</a></li><li class=" tsd-kind-module"><a href="stringgenerator.html">stringgenerator</a></li><li class=" tsd-kind-module"><a href="text.html">text</a></li><li class="current tsd-kind-module"><a href="util.html">util</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#capitalize" class="tsd-kind-icon">capitalize</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#clamp" class="tsd-kind-icon">clamp</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#format" class="tsd-kind-icon">format</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="util.html#mod" class="tsd-kind-icon">mod</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>