jsge

<!DOCTYPE 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: DrawObjectFactory</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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: DrawObjectFactory</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>DrawObjectFactory</h2> <div class="class-description">Creates drawObjects instances.<br> accessible via GameStage.draw <br> Attach images for image objects and tilemaps <br> Adds drawObjects to current GameStage.stageData</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_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line22">line 22</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">Methods</h3> <h4 class="name" id="circle"><span class="type-signature"></span>circle<span class="signature">(radius, bgColor)</span><span class="type-signature"> → {<a href="DrawCircleObject.html">DrawCircleObject</a>}</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>radius</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>bgColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line98">line 98</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawCircleObject.html">DrawCircleObject</a></span> </dd> </dl> <h4 class="name" id="conus"><span class="type-signature"></span>conus<span class="signature">(radius, bgColor, angle<span class="signature-attributes">opt</span>, fade<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="DrawConusObject.html">DrawConusObject</a>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>radius</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>bgColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> <tr> <td class="name"><code>angle</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>fade</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">(0 - 1)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line86">line 86</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawConusObject.html">DrawConusObject</a></span> </dd> </dl> <h4 class="name" id="image"><span class="type-signature"></span>image<span class="signature">(x, y, width, height, key, imageIndex<span class="signature-attributes">opt</span>, boundaries, spacing<span class="signature-attributes">opt</span>, margin<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="DrawImageObject.html">DrawImageObject</a>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</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="attributes"> </td> <td class="default"> </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="attributes"> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>imageIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>boundaries</code></td> <td class="type"> <span class="param-type">Array.<{x:Number, y:Number}></span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">boundaries as polygon, or circle</td> </tr> <tr> <td class="name"><code>spacing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">for tilesets.spacing > 0</td> </tr> <tr> <td class="name"><code>margin</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">for tilesets.margin > 0</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line116">line 116</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawImageObject.html">DrawImageObject</a></span> </dd> </dl> <h4 class="name" id="line"><span class="type-signature"></span>line<span class="signature">(vertices, color)</span><span class="type-signature"> → {<a href="DrawLineObject.html">DrawLineObject</a>}</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>vertices</code></td> <td class="type"> <span class="param-type">Array.<number></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line134">line 134</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawLineObject.html">DrawLineObject</a></span> </dd> </dl> <h4 class="name" id="polygon"><span class="type-signature"></span>polygon<span class="signature">(vertices, bgColor)</span><span class="type-signature"> → {<a href="DrawPolygonObject.html">DrawPolygonObject</a>}</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>vertices</code></td> <td class="type"> <span class="param-type">Array.<{x:number, y:number}></span> </td> <td class="description last">should go in anticlockwise order</td> </tr> <tr> <td class="name"><code>bgColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line145">line 145</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawPolygonObject.html">DrawPolygonObject</a></span> </dd> </dl> <h4 class="name" id="rect"><span class="type-signature"></span>rect<span class="signature">(x, y, width, height, backgroundColor)</span><span class="type-signature"> → {<a href="DrawRectObject.html">DrawRectObject</a>}</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> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>backgroundColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line58">line 58</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawRectObject.html">DrawRectObject</a></span> </dd> </dl> <h4 class="name" id="text"><span class="type-signature"></span>text<span class="signature">(x, y, text, font, color)</span><span class="type-signature"> → {<a href="DrawTextObject.html">DrawTextObject</a>}</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> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>font</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">size fontFamily</td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">rgba(r,g,b,a)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line72">line 72</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawTextObject.html">DrawTextObject</a></span> </dd> </dl> <h4 class="name" id="tiledLayer"><span class="type-signature"></span>tiledLayer<span class="signature">(layerKey, tileMapKey, setBoundaries<span class="signature-attributes">opt</span>, shapeMask<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="DrawTiledLayer.html">DrawTiledLayer</a>}</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>layerKey</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>tileMapKey</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>setBoundaries</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>shapeMask</code></td> <td class="type"> <span class="param-type"><a href="DrawShapeObject.html">DrawShapeObject</a></span> </td> <td class="attributes"> <optional><br> </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_DrawObjectFactory.js.html">base/DrawObjectFactory.js</a>, <a href="base_DrawObjectFactory.js.html#line159">line 159</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="DrawTiledLayer.html">DrawTiledLayer</a></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>