dicelang
Version:
JavaScript interpreter of the Roll20 dice language
1,285 lines • 71.8 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DiceMod | 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>
<li>
<a href="../modules/_dice_dicemod_.html">"Dice/DiceMod"</a>
</li>
<li>
<a href="_dice_dicemod_.dicemod.html">DiceMod</a>
</li>
</ul>
<h1>Class DiceMod</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">DiceMod</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#compounding" class="tsd-kind-icon">compounding</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#compoundingplaintext" class="tsd-kind-icon">compounding<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#compoundingproperties" class="tsd-kind-icon">compounding<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#exploding" class="tsd-kind-icon">exploding</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#explodingplaintext" class="tsd-kind-icon">exploding<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#explodingproperties" class="tsd-kind-icon">exploding<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#keepdrop" class="tsd-kind-icon">keep<wbr>Drop</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#keepdropplaintext" class="tsd-kind-icon">keep<wbr>Drop<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#keepdropproperties" class="tsd-kind-icon">keep<wbr>Drop<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#penetrating" class="tsd-kind-icon">penetrating</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#penetratingplaintext" class="tsd-kind-icon">penetrating<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#penetratingproperties" class="tsd-kind-icon">penetrating<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#reroll" class="tsd-kind-icon">reroll</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#rerollplaintext" class="tsd-kind-icon">reroll<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#rerollproperties" class="tsd-kind-icon">reroll<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#sort" class="tsd-kind-icon">sort</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#sortplaintext" class="tsd-kind-icon">sort<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#sortproperties" class="tsd-kind-icon">sort<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#successes" class="tsd-kind-icon">successes</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#successesplaintext" class="tsd-kind-icon">successes<wbr>Plaintext</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#successesproperties" class="tsd-kind-icon">successes<wbr>Properties</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#explodemodregexpr" class="tsd-kind-icon">explode<wbr>Mod<wbr>Reg<wbr>Expr</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#keepdropmodregexp" class="tsd-kind-icon">keep<wbr>Drop<wbr>Mod<wbr>Reg<wbr>Exp</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_dice_dicemod_.dicemod.html#maxn" class="tsd-kind-icon">maxN</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#rerollmodregexp" class="tsd-kind-icon">reroll<wbr>Mod<wbr>Reg<wbr>Exp</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#sortmodregexp" class="tsd-kind-icon">sort<wbr>Mod<wbr>Reg<wbr>Exp</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#successesmodregexpr" class="tsd-kind-icon">successes<wbr>Mod<wbr>Reg<wbr>Expr</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="_dice_dicemod_.dicemod.html#modresult" class="tsd-kind-icon">mod<wbr>Result</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#rolled" class="tsd-kind-icon">rolled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dice_dicemod_.dicemod.html#tostringplaintext" class="tsd-kind-icon">to<wbr>String<wbr>Plaintext</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_dice_dicemod_.dicemod.html#comparepoint" class="tsd-kind-icon">compare<wbr>Point</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_dice_dicemod_.dicemod.html#comparepointtostring" class="tsd-kind-icon">compare<wbr>Point<wbr>ToString</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#sortasccomparator" class="tsd-kind-icon">sort<wbr>Asc<wbr>Comparator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="_dice_dicemod_.dicemod.html#sortdescomparator" class="tsd-kind-icon">sort<wbr>Des<wbr>Comparator</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">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Dice<wbr>Mod<span class="tsd-signature-symbol">(</span>modExpr<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><a href="_dice_dicemod_.dicemod.html" class="tsd-signature-type">DiceMod</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L122">Dice/DiceMod.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>{Error} Thrown when any part of modExpr cannot be parsed.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> modExpr: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The mod expression to create the DiceMod from.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_dice_dicemod_.dicemod.html" class="tsd-signature-type">DiceMod</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="compounding" class="tsd-anchor"></a>
<h3>compounding</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> compounding<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L275">Dice/DiceMod.ts:275</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for compounding.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="compoundingplaintext" class="tsd-anchor"></a>
<h3>compounding<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> compoundingPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L282">Dice/DiceMod.ts:282</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for compounding.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="compoundingproperties" class="tsd-anchor"></a>
<h3>compounding<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> compoundingProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.ICompoundingProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L265">Dice/DiceMod.ts:265</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for compounding, or null if this modifier does not have
a compounding clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.ICompoundingProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="exploding" class="tsd-anchor"></a>
<h3>exploding</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> exploding<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L241">Dice/DiceMod.ts:241</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for exploding.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="explodingplaintext" class="tsd-anchor"></a>
<h3>exploding<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> explodingPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L248">Dice/DiceMod.ts:248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for exploding.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="explodingproperties" class="tsd-anchor"></a>
<h3>exploding<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> explodingProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.IExplodingProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L231">Dice/DiceMod.ts:231</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for exploding, or null if this modifier does not have an
exploding clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.IExplodingProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="keepdrop" class="tsd-anchor"></a>
<h3>keep<wbr>Drop</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> keepDrop<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L344">Dice/DiceMod.ts:344</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for keepDrop.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="keepdropplaintext" class="tsd-anchor"></a>
<h3>keep<wbr>Drop<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> keepDropPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L351">Dice/DiceMod.ts:351</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for keepDrop.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="keepdropproperties" class="tsd-anchor"></a>
<h3>keep<wbr>Drop<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> keepDropProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.IKeepDropProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L333">Dice/DiceMod.ts:333</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for keepDrop, or null if this modifier does not have a
keepDrop clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.IKeepDropProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="penetrating" class="tsd-anchor"></a>
<h3>penetrating</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> penetrating<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L309">Dice/DiceMod.ts:309</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for penetrating.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="penetratingplaintext" class="tsd-anchor"></a>
<h3>penetrating<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> penetratingPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L316">Dice/DiceMod.ts:316</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for penetrating.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="penetratingproperties" class="tsd-anchor"></a>
<h3>penetrating<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> penetratingProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.IPenetratingProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L299">Dice/DiceMod.ts:299</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for penetrating, or null if this modifier does not have
a penetrating clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.IPenetratingProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="reroll" class="tsd-anchor"></a>
<h3>reroll</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> reroll<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L372">Dice/DiceMod.ts:372</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for reroll.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="rerollplaintext" class="tsd-anchor"></a>
<h3>reroll<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> rerollPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L379">Dice/DiceMod.ts:379</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for reroll.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="rerollproperties" class="tsd-anchor"></a>
<h3>reroll<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> rerollProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.IRerollProps</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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L359">Dice/DiceMod.ts:359</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for reroll, or null if this modifier does not have a
reroll clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.IRerollProps</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="sort" class="tsd-anchor"></a>
<h3>sort</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sort<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L401">Dice/DiceMod.ts:401</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for sort.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="sortplaintext" class="tsd-anchor"></a>
<h3>sort<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sortPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L408">Dice/DiceMod.ts:408</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for sort.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="sortproperties" class="tsd-anchor"></a>
<h3>sort<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sortProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.ISortProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L392">Dice/DiceMod.ts:392</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties for sort, or null if this modifier does not have a sort
clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.ISortProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="successes" class="tsd-anchor"></a>
<h3>successes</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> successes<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L216">Dice/DiceMod.ts:216</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized string value for successes.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="successesplaintext" class="tsd-anchor"></a>
<h3>successes<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> successesPlaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L223">Dice/DiceMod.ts:223</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The plaintext string value for successes.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="successesproperties" class="tsd-anchor"></a>
<h3>successes<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> successesProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.ISuccessFailProps</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L202">Dice/DiceMod.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw properties of successes, or null if this modifier does not have a
successes clause.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Types.ISuccessFailProps</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="explodemodregexpr" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> explode<wbr>Mod<wbr>Reg<wbr>Expr</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> explodeModRegExpr<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L70">Dice/DiceMod.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The RegExp used for parsing exploding, compounding, and penetrating.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="keepdropmodregexp" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> keep<wbr>Drop<wbr>Mod<wbr>Reg<wbr>Exp</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> keepDropModRegExp<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L77">Dice/DiceMod.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The RegExp used for parsing keep/drop.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="maxn" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> maxN</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> maxN<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L56">Dice/DiceMod.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The maximum allowed value of n for a dice mod, which is equal to the
largest representable integer in JavaScript (9007199254740991, or
Number.MAX_SAFE_INTEGER in ES6).</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="rerollmodregexp" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> reroll<wbr>Mod<wbr>Reg<wbr>Exp</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> rerollModRegExp<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L84">Dice/DiceMod.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The RegExp used for parsing rerolls.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="sortmodregexp" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> sort<wbr>Mod<wbr>Reg<wbr>Exp</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sortModRegExp<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L91">Dice/DiceMod.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The RegExp used for parsing sorting.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="successesmodregexpr" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> successes<wbr>Mod<wbr>Reg<wbr>Expr</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> successesModRegExpr<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L63">Dice/DiceMod.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The RegExp used for parsing successes and failures.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
</li>
</ul>
</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 name="modresult" class="tsd-anchor"></a>
<h3>mod<wbr>Result</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">mod<wbr>Result<span class="tsd-signature-symbol">(</span>result<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-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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L194">Dice/DiceMod.ts:194</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A dice has been rolled and there are no more rolls to make. Modify the
final result in place if necessary, and return the combined result of the
rolls.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>result: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The result array to modify.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The combined total of the roll.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rolled" class="tsd-anchor"></a>
<h3>rolled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">rolled<span class="tsd-signature-symbol">(</span>roll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, dice<span class="tsd-signature-symbol">: </span><a href="_dice_dice_.dice.html" class="tsd-signature-type">Dice</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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L182">Dice/DiceMod.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Apply modifiers to a dice that was just rolled and add it to the result in
place if necessary.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>roll: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The value that was just rolled.</p>
</div>
</li>
<li>
<h5>result: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The result object.</p>
</div>
</li>
<li>
<h5>dice: <a href="_dice_dice_.dice.html" class="tsd-signature-type">Dice</a></h5>
<div class="tsd-comment tsd-typography">
<p>The dice that was used to roll the value.</p>
</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">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L416">Dice/DiceMod.ts:416</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The combined value of the modifier as a string.</p>
</div>
</div>
<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 name="tostringplaintext" class="tsd-anchor"></a>
<h3>to<wbr>String<wbr>Plaintext</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<wbr>Plaintext<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L424">Dice/DiceMod.ts:424</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The combined plaintext value of the modifier.</p>
</div>
</div>
<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 tsd-is-static">
<a name="comparepoint" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> compare<wbr>Point</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">compare<wbr>Point<span class="tsd-signature-symbol">(</span>cp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.ComparePoint</span>, n<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L38">Dice/DiceMod.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>{Error} Thrown if cp is not a compare point.</p>
</dd>
<dt>example</dt>
<dd><p> DiceMod.comparePoint('>', 3, 4); // => true</p>
</dd>
<dt>example</dt>
<dd><p> DiceMod.comparePoint('>', 3, 3); // => true</p>
</dd>
<dt>example</dt>
<dd><p> DiceMod.comparePoint('>', 3, 2); // => false</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cp: <span class="tsd-signature-type">Types.ComparePoint</span></h5>
<div class="tsd-comment tsd-typography">
<p>The compare point to use.</p>
</div>
</li>
<li>
<h5>n: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The numeric value of the compare point.</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The number to compare against the compare point.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if value "matches" the compare point.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="comparepointtostring" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> compare<wbr>Point<wbr>ToString</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">compare<wbr>Point<wbr>ToString<span class="tsd-signature-symbol">(</span>cp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Types.ComparePoint</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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L12">Dice/DiceMod.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>{Error} If the cp param is not a compare point.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cp: <span class="tsd-signature-type">Types.ComparePoint</span></h5>
<div class="tsd-comment tsd-typography">
<p>The compare point to translate.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The english plaintext representation of the compare point.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a name="sortasccomparator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> sort<wbr>Asc<wbr>Comparator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon">sort<wbr>Asc<wbr>Comparator<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L98">Dice/DiceMod.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compare function used to sort numbers ascending.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>b: <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 tsd-is-protected tsd-is-static">
<a name="sortdescomparator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> sort<wbr>Des<wbr>Comparator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static">
<li class="tsd-signature tsd-kind-icon">sort<wbr>Des<wbr>Comparator<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<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/IrisAmp/dicelang/blob/48a3edf/src/Dice/DiceMod.ts#L105">Dice/DiceMod.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compare function used to sort numbers descending.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>b: <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>
</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="current 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>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_dice_dicemod_.dicemod.html" class="tsd-kind-icon">Dice<wbr>Mod</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#compounding" class="tsd-kind-icon">compounding</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#compoundingplaintext" class="tsd-kind-icon">compounding<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#compoundingproperties" class="tsd-kind-icon">compounding<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#exploding" class="tsd-kind-icon">exploding</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#explodingplaintext" class="tsd-kind-icon">exploding<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#explodingproperties" class="tsd-kind-icon">exploding<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#keepdrop" class="tsd-kind-icon">keep<wbr>Drop</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#keepdropplaintext" class="tsd-kind-icon">keep<wbr>Drop<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#keepdropproperties" class="tsd-kind-icon">keep<wbr>Drop<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#penetrating" class="tsd-kind-icon">penetrating</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#penetratingplaintext" class="tsd-kind-icon">penetrating<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#penetratingproperties" class="tsd-kind-icon">penetrating<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#reroll" class="tsd-kind-icon">reroll</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#rerollplaintext" class="tsd-kind-icon">reroll<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#rerollproperties" class="tsd-kind-icon">reroll<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#sort" class="tsd-kind-icon">sort</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#sortplaintext" class="tsd-kind-icon">sort<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#sortproperties" class="tsd-kind-icon">sort<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#successes" class="tsd-kind-icon">successes</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#successesplaintext" class="tsd-kind-icon">successes<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#successesproperties" class="tsd-kind-icon">successes<wbr>Properties</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#explodemodregexpr" class="tsd-kind-icon">explode<wbr>Mod<wbr>Reg<wbr>Expr</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#keepdropmodregexp" class="tsd-kind-icon">keep<wbr>Drop<wbr>Mod<wbr>Reg<wbr>Exp</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#maxn" class="tsd-kind-icon">maxN</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#rerollmodregexp" class="tsd-kind-icon">reroll<wbr>Mod<wbr>Reg<wbr>Exp</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#sortmodregexp" class="tsd-kind-icon">sort<wbr>Mod<wbr>Reg<wbr>Exp</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#successesmodregexpr" class="tsd-kind-icon">successes<wbr>Mod<wbr>Reg<wbr>Expr</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#modresult" class="tsd-kind-icon">mod<wbr>Result</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#rolled" class="tsd-kind-icon">rolled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_dice_dicemod_.dicemod.html#tostringplaintext" class="tsd-kind-icon">to<wbr>String<wbr>Plaintext</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#comparepoint" class="tsd-kind-icon">compare<wbr>Point</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#comparepointtostring" class="tsd-kind-icon">compare<wbr>Point<wbr>ToString</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#sortasccomparator" class="tsd-kind-icon">sort<wbr>Asc<wbr>Comparator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static">
<a href="_dice_dicemod_.dicemod.html#sortdescomparator" class="tsd-kind-icon">sort<wbr>Des<wbr>Comparator</a>
</li>
</ul>
</li>
</ul>
<ul class="after-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>