complex-engine
Version:
JS Component Entity Framework for Gamedevelopment
1,205 lines (267 loc) • 11.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Engine</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: Engine</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Engine<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Complex Engine. This class handles the rendering of the current scene.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Engine"><span class="type-signature"></span>new Engine<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="instance"><span class="type-signature"></span>instance<span class="type-signature"> :<a href="Engine.html">Engine</a>|null</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Engine.html">Engine</a></span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scene"><span class="type-signature"></span>scene<span class="type-signature"> :<a href="Scene.html">Scene</a>|null</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Scene.html">Scene</a></span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".getInstance"><span class="type-signature">(static) </span>getInstance<span class="signature">()</span><span class="type-signature"> → {<a href="Engine.html">Engine</a>}</span></h4>
<div class="description">
Gets current instance
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Engine.html">Engine</a></span>
</dd>
</dl>
<h4 class="name" id="getScene"><span class="type-signature"></span>getScene<span class="signature">()</span><span class="type-signature"> → {<a href="Scene.html">Scene</a>|null}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Scene.html">Scene</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="loadScene"><span class="type-signature"></span>loadScene<span class="signature">(scene)</span><span class="type-signature"> → {this}</span></h4>
<div class="description">
load a scene to be rendered
</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>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">this</span>
</dd>
</dl>
<h4 class="name" id="simpleScene"><span class="type-signature"></span>simpleScene<span class="signature">(setupFunction)</span><span class="type-signature"> → {<a href="Engine.html">Engine</a>}</span></h4>
<div class="description">
Compose a simple scene for a very quick start
</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>setupFunction</code></td>
<td class="type">
<span class="param-type">function</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="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Engine.html">Engine</a></span>
</dd>
</dl>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"> → {<a href="Engine.html">Engine</a>}</span></h4>
<div class="description">
Start the rendering loop. This updates automatically with requestAnimationFrame
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Engine.html">Engine</a></span>
</dd>
</dl>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"> → {<a href="Engine.html">Engine</a>}</span></h4>
<div class="description">
render the loaded scene
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Engine.html">Engine</a></span>
</dd>
</dl>
<h4 class="name" id="useScene"><span class="type-signature"></span>useScene<span class="signature">(scene)</span><span class="type-signature"> → {<a href="Engine.html">Engine</a>}</span></h4>
<div class="description">
Use a scene
</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>scene</code></td>
<td class="type">
</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="Engine.js.html">Engine.js</a>, <a href="Engine.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Engine.html">Engine</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Component.html">Component</a></li><li><a href="Engine.html">Engine</a></li><li><a href="Entity.html">Entity</a></li><li><a href="EntitySystem.html">EntitySystem</a></li><li><a href="GroupManager.html">GroupManager</a></li><li><a href="Manager.html">Manager</a></li><li><a href="Scene.html">Scene</a></li><li><a href="System.html">System</a></li><li><a href="VoidSystem.html">VoidSystem</a></li><li><a href="World.html">World</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Sep 08 2019 20:40:30 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>