jsge
Version:
Javascript Game Engine
1,194 lines (227 loc) • 13.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="expires" content="Wen, 05 Jun 2024 07:01:00 GMT">
<title>JSDoc: Class: ISystem</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="stage-title">Class: ISystem</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>ISystem</h2>
<div class="class-description">Public interface for a System<br>
Can be used to start/stop GameStage render, <br>
And provides access to SystemSettings, INetwork and ISystemAudio <br>
IRender, DrawObjectFactory, AssetsManager and external modules
accessible via GameStage.iSystem and System.system</div>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line21">line 21</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="System.html">System</a> a part of System class instance</li>
<li><a href="GameStage.html">GameStage</a> a part of GameStage class instance</li>
</ul>
</dd>
</dl>
</div>
<!--
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="ISystem.html">ISystem</a></dt>
<dd></dd>
</dl>
-->
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="addEventListener"><span class="type-signature"></span>addEventListener<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h4 class="name" id="audio"><span class="type-signature"></span>audio<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line127">line 127</a>
</li></ul></dd>
</dl>
<h4 class="name" id="drawObjectFactory"><span class="type-signature"></span>drawObjectFactory<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line148">line 148</a>
</li></ul></dd>
</dl>
<h4 class="name" id="emit"><span class="type-signature"></span>emit<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h4 class="name" id="iExtension"><span class="type-signature"></span>iExtension<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h4 class="name" id="iLoader"><span class="type-signature"></span>iLoader<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line134">line 134</a>
</li></ul></dd>
</dl>
<h4 class="name" id="iNetwork"><span class="type-signature"></span>iNetwork<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h4 class="name" id="iRender"><span class="type-signature"></span>iRender<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line141">line 141</a>
</li></ul></dd>
</dl>
<h4 class="name" id="installModule"><span class="type-signature"></span>installModule<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line172">line 172</a>
</li></ul></dd>
</dl>
<h4 class="name" id="modules"><span class="type-signature"></span>modules<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line161">line 161</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removeEventListener"><span class="type-signature"></span>removeEventListener<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line106">line 106</a>
</li></ul></dd>
</dl>
<h4 class="name" id="systemSettings"><span class="type-signature"></span>systemSettings<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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="startGameStage"><span class="type-signature"></span>startGameStage<span class="signature">(gameStageName, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gameStageName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">options</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line188">line 188</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stopGameStage"><span class="type-signature"></span>stopGameStage<span class="signature">(gameStageName)</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>gameStageName</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="base_ISystem.js.html">base/ISystem.js</a>, <a href="base_ISystem.js.html#line216">line 216</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<div class="switcher"><ul><li class="active"><a href="/">1.5.9</a></li></div>
<h2><a href="/">Home</a></h2><h3>Classes</h3><ul><li><a href="DrawCircleObject.html">DrawCircleObject</a></li><li><a href="DrawConusObject.html">DrawConusObject</a></li><li><a href="DrawImageObject.html">DrawImageObject</a></li><li><a href="DrawLineObject.html">DrawLineObject</a></li><li><a href="DrawObjectFactory.html">DrawObjectFactory</a></li><li><a href="DrawPolygonObject.html">DrawPolygonObject</a></li><li><a href="DrawRectObject.html">DrawRectObject</a></li><li><a href="DrawShapeObject.html">DrawShapeObject</a></li><li><a href="DrawTextObject.html">DrawTextObject</a></li><li><a href="DrawTiledLayer.html">DrawTiledLayer</a></li><li><a href="GameStage.html">GameStage</a></li><li><a href="GameStageData.html">GameStageData</a></li><li><a href="IExtension.html">IExtension</a></li><li><a href="INetwork.html">INetwork</a></li><li><a href="IRender.html">IRender</a></li><li><a href="ISystem.html">ISystem</a></li><li><a href="ISystemAudio.html">ISystemAudio</a></li><li><a href="RenderLoop.html">RenderLoop</a></li><li><a href="RenderLoopDebug.html">RenderLoopDebug</a></li><li><a href="System.html">System</a></li><li><a href="SystemSettings.html">SystemSettings</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-application_scheme.html">Application Scheme</a></li><li><a href="tutorial-assets_manager.html">Assets Manager</a></li><li><a href="tutorial-common_issues.html">Common Issues</a></li><li><a href="tutorial-how_to_add_and_use_audio.html">How to add and use audio</a></li><li><a href="tutorial-how_to_do_animations.html">How to Create Animations</a></li><li><a href="tutorial-how_to_load_and_use_tilemaps.html">How to Load and Use Tilemaps</a></li><li><a href="tutorial-quick_start.html">Quick Start</a></li><li><a href="tutorial-spine_animations.html">How to Add Spine Animations</a></li><li><a href="tutorial-stages_lifecycle.html">Stages Lifecycle</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jun 18 2025 06:53:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>