jsge
Version:
Javascript Game Engine
967 lines (230 loc) • 12.1 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: DrawTiledLayer</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: DrawTiledLayer</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>DrawTiledLayer</h2>
<div class="class-description">A render object represents a layer from tiled editor</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_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line9">line 9</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="DrawObjectFactory.html">DrawObjectFactory</a> should be created with factory method</li>
</ul>
</dd>
</dl>
</div>
<!--
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="DrawTiledLayer.html">DrawTiledLayer</a></dt>
<dd></dd>
</dl>
-->
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="drawBoundaries"><span class="type-signature"></span>drawBoundaries<span class="type-signature"> :boolean</span></h4>
<div class="description">
Should draw a boundaries helper, or not
Can be set in SystemSettings.
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line109">line 109</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasAnimations"><span class="type-signature"></span>hasAnimations<span class="type-signature"> :boolean</span></h4>
<div class="description">
Determines if image is animated or not
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<h4 class="name" id="layerKey"><span class="type-signature"></span>layerKey<span class="type-signature"> :string</span></h4>
<div class="description">
A layer name.
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setBoundaries"><span class="type-signature"></span>setBoundaries<span class="type-signature"> :boolean</span></h4>
<div class="description">
Should the layer borders used as boundaries, or not
Can be set in GameStage.addRenderLayer() method.
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line100">line 100</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sortIndex"><span class="type-signature"></span>sortIndex<span class="type-signature"> :number</span></h4>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line146">line 146</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tileMapKey"><span class="type-signature"></span>tileMapKey<span class="type-signature"> :string</span></h4>
<div class="description">
A tilemap layer key, should match key from the tilemap.
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
-->
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="removeAllAnimations"><span class="type-signature"></span>removeAllAnimations<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Removes animations
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line316">line 316</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setMask"><span class="type-signature"></span>setMask<span class="signature">(mask)</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>mask</code></td>
<td class="type">
<span class="param-type"><a href="DrawShapeObject.html">DrawShapeObject</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="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line134">line 134</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stopRepeatedAnimation"><span class="type-signature"></span>stopRepeatedAnimation<span class="signature">(eventName)</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>eventName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">animation name</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="base_2d_DrawTiledLayer.js.html">base/2d/DrawTiledLayer.js</a>, <a href="base_2d_DrawTiledLayer.js.html#line309">line 309</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>