odin
Version:
Node.js Canvas/WebGL Javascript Game Framework
1,080 lines (300 loc) • 13.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Class</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">Class: Class</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Odin.html">Odin</a>.</span>
Class
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Class"><span class="type-signature"></span>new Class<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="Odin.EventEmitter.html">Odin.EventEmitter</a></li>
</ul>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="Class.create"><span class="type-signature"><static> </span>Class.create<span class="signature">(type)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
creates new Odin.Class from string type
</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>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Odin.Class
</div>
</dd>
<dt>
<h4 class="name" id="Class.extend"><span class="type-signature"><static> </span>Class.extend<span class="signature">(child, parent)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>child</code></td>
<td class="type">
<span class="param-type">constructor</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type">constructor</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
child
</div>
</dd>
<dt>
<h4 class="name" id="Class.fromJSON"><span class="type-signature"><static> </span>Class.fromJSON<span class="signature">(json)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
creates new Odin.Class from json object
</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>json</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line128">line 128</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Odin.Class
</div>
</dd>
<dt>
<h4 class="name" id="clear"><span class="type-signature"><static> </span>Class#clear<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
clears data for GC
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="clone"><span class="type-signature"><static> </span>Class#clone<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
returns new copy of this
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Class
</div>
</dd>
<dt>
<h4 class="name" id="copy"><span class="type-signature"><static> </span>Class#copy<span class="signature">(other)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
copies other of same class
</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>other</code></td>
<td class="type">
<span class="param-type"><a href="Odin.Class.html">Odin.Class</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="fromJSON"><span class="type-signature"><static> </span>Class#fromJSON<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
sets this from JSON object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="toJSON"><span class="type-signature"><static> </span>Class#toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
converts this to a JSON object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
json
</div>
</dd>
<dt>
<h4 class="name" id="toString"><span class="type-signature"><static> </span>Class#toString<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
returns class name
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="class.js.html">base/class.js</a>, <a href="class.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
string
</div>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Canvas.html">Canvas</a></li><li><a href="GUIObject.html">GUIObject</a></li><li><a href="MeshFilter.html">MeshFilter</a></li><li><a href="Odin.html">Odin</a></li><li><a href="Odin.Class.html">Class</a></li><li><a href="Odin.EventEmitter.html">EventEmitter</a></li><li><a href="Odin.GameObject.html">GameObject</a></li><li><a href="Odin.Scene.html">Scene</a></li><li><a href="P2Contact.html">P2Contact</a></li><li><a href="P2Equation.html">P2Equation</a></li><li><a href="P2Friction.html">P2Friction</a></li><li><a href="P2Solver.html">P2Solver</a></li><li><a href="ParticleSystem.html">ParticleSystem</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="SpriteAnimation.html">SpriteAnimation</a></li><li><a href="WebGLRenderer.html">WebGLRenderer</a></li><li><a href="WebGLRenderer2D.html">WebGLRenderer2D</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Feb 24 2014 16:15:46 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>