jsge
Version:
Javascript Game Engine
1,732 lines (349 loc) • 18.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: Class: GameStageData</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: GameStageData</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>GameStageData</h2>
<div class="class-description">A storage for stage data, such as gameObjects,
boundaries, worldDimensions and offset</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_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line18">line 18</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="GameStage.html">GameStage</a> a part of GameStage</li>
</ul>
</dd>
</dl>
</div>
<!--
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="GameStageData.html">GameStageData</a></dt>
<dd></dd>
</dl>
-->
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="boundariesLen"><span class="type-signature"></span>boundariesLen<span class="type-signature"></span></h4>
<div class="description">
Tiled polygon and Tiled layer boundaries length
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line513">line 513</a>
</li></ul></dd>
</dl>
<h4 class="name" id="canvasDimensions"><span class="type-signature"></span>canvasDimensions<span class="type-signature"></span></h4>
<div class="description">
Current canvas dimensions
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line474">line 474</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ellipseBLen"><span class="type-signature"></span>ellipseBLen<span class="type-signature"></span></h4>
<div class="description">
Tiled ellipse boundaries length
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line521">line 521</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isWorldBoundariesEnabled"><span class="type-signature"></span>isWorldBoundariesEnabled<span class="type-signature"></span></h4>
<!---->
<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="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line467">line 467</a>
</li></ul></dd>
</dl>
<h4 class="name" id="mapCenter"><span class="type-signature"></span>mapCenter<span class="type-signature"></span></h4>
<div class="description">
Current focus point
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line498">line 498</a>
</li></ul></dd>
</dl>
<h4 class="name" id="mapRotate"><span class="type-signature"></span>mapRotate<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_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line505">line 505</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pointBLen"><span class="type-signature"></span>pointBLen<span class="type-signature"></span></h4>
<div class="description">
Tiled point length
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line529">line 529</a>
</li></ul></dd>
</dl>
<h4 class="name" id="renderObjects"><span class="type-signature"></span>renderObjects<span class="type-signature"></span></h4>
<div class="description">
a getter to retrieve all attached renderObjects
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line614">line 614</a>
</li></ul></dd>
</dl>
<h4 class="name" id="worldDimensions"><span class="type-signature"></span>worldDimensions<span class="type-signature"></span></h4>
<div class="description">
Current game world dimensions
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line482">line 482</a>
</li></ul></dd>
</dl>
<h4 class="name" id="worldOffset"><span class="type-signature"></span>worldOffset<span class="type-signature"></span></h4>
<div class="description">
Current word x/y offset
</div>
<!---->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line490">line 490</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="centerCameraPosition"><span class="type-signature"></span>centerCameraPosition<span class="signature">(x, y)</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</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_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line538">line 538</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cleanUp"><span class="type-signature"></span>cleanUp<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Used to remove all render objects,
Designed for restart the stage
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line631">line 631</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getBoundaries"><span class="type-signature"></span>getBoundaries<span class="signature">()</span><span class="type-signature"> → {Array.<Array.<number>>}</span></h4>
<div class="description">
current screen boundaries,
this method is for backward capability with jsge@1.4.4
recommended to use getRawBoundaries()
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line408">line 408</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array.<number>></span>
</dd>
</dl>
<h4 class="name" id="getEllipseBoundaries"><span class="type-signature"></span>getEllipseBoundaries<span class="signature">()</span><span class="type-signature"> → {Float32Array}</span></h4>
<div class="description">
ellipse boundaries from Tiled,
stored as floatArray,
each 4 cells, represent am ellipse with cords centerX, centerY, radiusX, radiusY
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line442">line 442</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Float32Array</span>
</dd>
</dl>
<h4 class="name" id="getObjectsByInstance"><span class="type-signature"></span>getObjectsByInstance<span class="signature">(instance)</span><span class="type-signature"> → {Array.<Object>}</span></h4>
<div class="description">
Retrieve specific objects instances
</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>instance</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">drawObjectInstance to retrieve</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line623">line 623</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Object></span>
</dd>
</dl>
<h4 class="name" id="getPointBoundaries"><span class="type-signature"></span>getPointBoundaries<span class="signature">()</span><span class="type-signature"> → {Float32Array}</span></h4>
<div class="description">
point boundaries from Tiled,
stored as floatArray,
each 2 cells, represent a point with coords x1,y1
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line452">line 452</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Float32Array</span>
</dd>
</dl>
<h4 class="name" id="getRawBoundaries"><span class="type-signature"></span>getRawBoundaries<span class="signature">()</span><span class="type-signature"> → {Float32Array}</span></h4>
<div class="description">
current screen boundaries
polygon boundaries from Tiled and Tiled boundaries layers are merged here
each 4 cells, represent a line with coords x1,y1,x2,y2
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line432">line 432</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Float32Array</span>
</dd>
</dl>
<h4 class="name" id="isOffsetTurnedOff"><span class="type-signature"></span>isOffsetTurnedOff<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_GameStageData.js.html">base/GameStageData.js</a>, <a href="base_GameStageData.js.html#line144">line 144</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</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>