character-sheet
Version:
CharacterSheet library for assembling relationships between stats and modifiers.
363 lines (93 loc) • 4.29 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="RegisterWith"><span class="type-signature"></span>RegisterWith<span class="signature">(OperationBaseClass, OperationToRegister)</span><span class="type-signature"></span></h4>
<div class="description">
A decorator which wraps any Operation extending <a href="Operation.html">Operation</a>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>OperationBaseClass</code></td>
<td class="type">
<span class="param-type"><a href="Operation.html">Operation</a></span>
</td>
<td class="description last">The base class which provides a means to look up modules using Operation.from()</td>
</tr>
<tr>
<td class="name"><code>OperationToRegister</code></td>
<td class="type">
<span class="param-type"><a href="Operation.html">Operation</a></span>
</td>
<td class="description last">The class of any operation to register.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="operations_util_RegisterWith.js.html">operations/util/RegisterWith.js</a>, <a href="operations_util_RegisterWith.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="OperationDefinition">OperationDefinition</h4>
<div class="description">
The basic definition of any operation.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Operation.js.html">Operation.js</a>, <a href="Operation.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Add.html">Add</a></li><li><a href="Modifier.html">Modifier</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Using.html">Using</a></li></ul><h3>Global</h3><ul><li><a href="global.html#RegisterWith">RegisterWith</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 25 2018 11:17:38 GMT-0800 (Pacific Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>