complex-engine
Version:
JS Component Entity Framework for Gamedevelopment
745 lines (158 loc) • 7.81 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: System</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: System</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>System<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Abstract System. A System is responsible that your game works. It holds all the business logic and processes the
entities based on the data in the components</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="System"><span class="type-signature"></span>new System<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="System.js.html">System.js</a>, <a href="System.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="World.html">World</a>|null</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="World.html">World</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="System.js.html">System.js</a>, <a href="System.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="added"><span class="type-signature">(abstract) </span>added<span class="signature">(entity)</span><span class="type-signature"></span></h4>
<div class="description">
get notified when entity is added to world
</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>entity</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</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="System.js.html">System.js</a>, <a href="System.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addedToWorld"><span class="type-signature">(abstract) </span>addedToWorld<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
get notified when System is added to world
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="System.js.html">System.js</a>, <a href="System.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removed"><span class="type-signature">(abstract) </span>removed<span class="signature">(entity)</span><span class="type-signature"></span></h4>
<div class="description">
get notified when entity is removed from world
</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>entity</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</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="System.js.html">System.js</a>, <a href="System.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setWorld"><span class="type-signature"></span>setWorld<span class="signature">(world)</span><span class="type-signature"></span></h4>
<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>world</code></td>
<td class="type">
<span class="param-type"><a href="World.html">World</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="System.js.html">System.js</a>, <a href="System.js.html#line38">line 38</a>
</li></ul></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>