jsge
Version:
Javascript Game Engine
72 lines (58 loc) • 4.8 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: Tutorial: Stages Lifecycle</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">Tutorial: Stages Lifecycle</h1>
<section>
<header>
<h2>Stages Lifecycle</h2>
</header>
<article>
<p>The <code>GameStage</code> has a lifecycle methods:</p>
<ol>
<li>
<p><strong>GameStage.constructor()</strong> - This is the default class method, called once right after the stage has been registered in the app with <a href="System.html#registerStage">System.registerStage()</a>. <br>
Nothing special happens here.</p>
</li>
<li>
<p><strong>GameStage.register()</strong> - In this method, <a href="ISystem.html">ISystem</a>, which includes <a href="SystemSettings.html">SystemSettings</a> (systemSettings), <a href="ISystemAudio.html">ISystemAudio</a>(audio), and <a href="INetwork.html">INetwork</a>(network), are attached to the <a href="GameStage.html">GameStage</a>. This is the place where assets should be added (see <a href="tutorial-assets_manager.html">Assets Manager</a> and <a href="tutorial-how_to_add_and_use_audio.html">How to add and use audio</a>).</p>
</li>
<li>
<p><strong>GameStage.init()</strong> - This method is called after <a href="ISystem.html#startGameStage">ISystem.startGameStage()</a> is invoked. It is called only once per game. Assets that were added in the register() stage will already be loaded and ready to be used here.</p>
</li>
<li>
<p><strong>GameStage.start()</strong> - This method is called right after GameStage.init(). If the stage is stopped with ISystem.stopGameStage() and then restarted, it will be called again without invoking GameStage.init() on the second start.</p>
</li>
<li>
<p><strong>GameStage.stop()</strong> - This method is called after <a href="ISystem.html#stopGameStage">ISystem.stopGameStage()</a> is invoked. It can be used to shut down the stage, remove listeners, etc.</p>
</li>
</ol>
<p>All methods above can be overwritten.</p>
<img src="lifecycle.png">
</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>