dicelang
Version:
JavaScript interpreter of the Roll20 dice language
204 lines (202 loc) • 10.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>dicelang</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">dicelang</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="globals.html">Globals</a>
</li>
</ul>
<h1> dicelang</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="dicelang">dicelang</h1>
<p>A JavaScript interpreter for Roll20's <a href="https://wiki.roll20.net/Dice_Reference">Dice Specification</a>.</p>
<h2 id="installing">Installing</h2>
<p><code>npm i --save dicelang</code></p>
<h2 id="usage">Usage</h2>
<p>See the <code>doc</code> directory for full documentation.</p>
<h3 id="typescript">TypeScript</h3>
<pre><code class="lang-ts"><span class="hljs-keyword">import</span> { Dice } <span class="hljs-keyword">from</span> <span class="hljs-string">'dicelang'</span>;
<span class="hljs-keyword">let</span> d: Dice = <span class="hljs-keyword">new</span> Dice(<span class="hljs-string">'d20'</span>);
alert(d.roll()); <span class="hljs-comment">// 20</span>
alert(d.roll()); <span class="hljs-comment">// 1</span>
alert(d.roll()); <span class="hljs-comment">// 12</span>
</code></pre>
<h3 id="es6">ES6</h3>
<pre><code class="lang-js"><span class="hljs-keyword">import</span> { Dice } <span class="hljs-keyword">from</span> <span class="hljs-string">'dicelang'</span>;
<span class="hljs-keyword">let</span> d = <span class="hljs-keyword">new</span> Dice(<span class="hljs-string">'d20'</span>);
alert(d.roll()); <span class="hljs-comment">// 11</span>
alert(d.roll()); <span class="hljs-comment">// 5</span>
alert(d.roll()); <span class="hljs-comment">// 17</span>
</code></pre>
<h2 id="license">License</h2>
<p>This software is licensed under the terms of the <em>MIT license</em>. See the <code>LICENSE</code> file.</p>
<p>The Roll20 Dice Specification is provided under the <em>Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license</em> (CC BY-NC-SA 3.0) by The Orr Group, LLC.
See the <code>CC-BY-NC-SA-3.txt</code> file or the <a href="https://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons website</a>.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_common_constants_.html">"<wbr>Common/<wbr>Constants"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_common_iexpression_.html">"<wbr>Common/IExpression"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_common_random_.html">"<wbr>Common/<wbr>Random"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_common_util_.html">"<wbr>Common/<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_dice_dice_.html">"<wbr>Dice/<wbr>Dice"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_dice_dicemod_.html">"<wbr>Dice/<wbr>Dice<wbr>Mod"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_dice_dicemod_types_.html">"<wbr>Dice/<wbr>Dice<wbr>Mod.<wbr>Types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_dice_testhelpers_.html">"<wbr>Dice/<wbr>Test<wbr>Helpers"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_parser_parser_.html">"<wbr>Parser/<wbr>Parser"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</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-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</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>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>