crossbrowdy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>CrossBrowdy API documentation [printable] Class: CB_GraphicSprites</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.yeti.css"> </head> <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">CrossBrowdy API documentation [printable]</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content" style="width:100%;"> <div class="row" style="width:100%;"> <div class="col-md-8" style="width:85%;"> <div id="main"> <h1 class="page-title">Class: CB_GraphicSprites</h1> <section> <header> <h2> CB_GraphicSprites </h2> <div class="class-description"><p>Class to manage a group of graphic sprites (2D or 3D).</p></div> </header> <article> <div class="container-overview"> <hr> <dt> <h4 class="name" id="CB_GraphicSprites"><span class="type-signature"></span>new CB_GraphicSprites<span class="signature">( [spritesGroup] [, byReference])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html">CB_GraphicSprites</a>}</span></h4> </dt> <dd> <div class="description"> <p>Class to manage a group of graphic sprites (2D or 3D).</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>spritesGroup</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object with the desired sprites. The information will be used for the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property. Used as the "spritesGroup" parameter when calling the <a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>byReference</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> !!<code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>This value will be used as the default value when the "byReference" property is not given in the sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects). The value will be stored in the <a href="CB_GraphicSprites.html#byReference_DEFAULT"><code>CB_GraphicSprites#byReference_DEFAULT</code></a> property. If a boolean value is not provided, it will use the value of the <code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code> property of the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object (parsed to boolean).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-233">line 233</a> </li> </ul> </dd> <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt> <dd class="tag-todo"> <ul> <li>Think about a "createCopy" parameter on different the insert methods (to insert sprites groups/graphic sprites objects, etc.) so it will make a copy of the object to avoid using/modifying the original one. If the "createCopy" is set to false, it should always use the object as reference (using/modifying it).</li> <li>Think about a method to remove a sprite when the same sprite is received by parameter. The same with sub-sprites, receiving the sub-sprite by parameter. The same to remove the sprites group object, receiving a sprites group object by parameter. Only remove them if they match exactly.</li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns a new <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span> </dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <hr> <dt class="name" id="byReference_DEFAULT"> <h4 id="byReference_DEFAULT"><span class="type-signature"></span>byReference_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>This value will be used as the default value when the "byReference" property is not given in the sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-311">line 311</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="id"> <h4 id="id"><span class="type-signature"><readonly> </span>id<span class="type-signature"> :string|*</span></h4> </dt> <dd> <div class="description"> <p>Identifier of the sprites group object (the "id" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property) and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself (same one). It should be unique. It must be a value which evaluates to true. By default, it is generated automatically (with an internal counter).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> | <span class="param-type">*</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>'CB_GraphicSprites_' + CB_GraphicSprites._idUnique++</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-246">line 246</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="isSprites"> <h4 id="isSprites"><span class="type-signature"><constant> </span>isSprites<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Property which is always set to true to help identify this type of object.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>true</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-326">line 326</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="parent"> <h4 id="parent"><span class="type-signature"><readonly> </span>parent<span class="type-signature"> :*</span></h4> </dt> <dd> <div class="description"> <p>Property pointing to or containing its parent. It could be a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object. It is the same as the "parent" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">*</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-255">line 255</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="pointer"> <h4 id="pointer"><span class="type-signature"><readonly> </span>pointer<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Pointer with the position of the current sprite (belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">integer</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-282">line 282</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="pointerPrevious"> <h4 id="pointerPrevious"><span class="type-signature"><readonly> </span>pointerPrevious<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Keeps the previous value of the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if any).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">integer</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-292">line 292</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="spritesGroup"> <h4 id="spritesGroup"><span class="type-signature"><readonly> </span>spritesGroup<span class="type-signature"> :<a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span></h4> </dt> <dd> <div class="description"> <p>Object with information about the sprites.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{}</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-273">line 273</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="time"> <h4 id="time"><span class="type-signature"><readonly> </span>time<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Stores the time in milliseconds when the current sprite was started being pointed (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which will be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">integer</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-302">line 302</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="type"> <h4 id="type"><span class="type-signature"><constant> </span>type<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Indicates the type of object (always "sprites").</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>sprites</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-335">line 335</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="zIndex"> <h4 id="zIndex"><span class="type-signature"><readonly> </span>zIndex<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Z-index of the sprites group object (the "zIndex" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property) and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself (same one). To change the value of this property, use the <a href="CB_GraphicSprites.html#setZIndex"><code>CB_GraphicSprites#setZIndex</code></a> method (which will call the <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally if there is a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> parent object). Only numeric values which are not zero (0) are allowed.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>CB_GraphicSprites.ZINDEX_DEFAULT</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-264">line 264</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".HEIGHT_DEFAULT"> <h4 id=".HEIGHT_DEFAULT"><span class="type-signature"><static, constant> </span>HEIGHT_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default "height" of the destiny. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-417">line 417</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".HEIGHT_SOURCE_DEFAULT"> <h4 id=".HEIGHT_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>HEIGHT_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default height ("srcHeight") of the original source. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>32</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-387">line 387</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".LEFT_DEFAULT"> <h4 id=".LEFT_DEFAULT"><span class="type-signature"><static, constant> </span>LEFT_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default "left" (horizontal position) in the destiny. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-425">line 425</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".LEFT_SOURCE_DEFAULT"> <h4 id=".LEFT_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>LEFT_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default left ("srcLeft", horizontal position) in the original source. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-395">line 395</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".SRC_TYPES"> <h4 id=".SRC_TYPES"><span class="type-signature"><static, constant> </span>SRC_TYPES<span class="type-signature"> :object</span></h4> </dt> <dd> <div class="description"> <p>Object with some "srcType". Each property of this object belong to one source type, having an integer as value which represents it. You can define more source types here.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{"DEFAULT":0,"IMAGE":0,"TEXT":1,"SEGMENT":2,"PIXEL":3,"RECTANGLE":4,"CIRCLE":5,"ARC":6,"ELLIPSE":7,"TRIANGLE":8,"BEZIER_CURVE":9,"QUADRATIC_BEZIER_CURVE":10,"BITMAP":11,"MAP":12}</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-344">line 344</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".SRC_TYPES_DEFAULT"> <h4 id=".SRC_TYPES_DEFAULT"><span class="type-signature"><static, constant> </span>SRC_TYPES_DEFAULT<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Default "srcType", the type of the original source.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">integer</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li><code>CB_GraphicSprites.SRC_TYPES.IMAGE</code></li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-372">line 372</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".TOP_DEFAULT"> <h4 id=".TOP_DEFAULT"><span class="type-signature"><static, constant> </span>TOP_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default "top" (vertical position) in the destiny. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-432">line 432</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".TOP_SOURCE_DEFAULT"> <h4 id=".TOP_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>TOP_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default top ("srcTop", vertical position) in the original source. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-402">line 402</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".WIDTH_DEFAULT"> <h4 id=".WIDTH_DEFAULT"><span class="type-signature"><static, constant> </span>WIDTH_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default "width" of the destiny. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-410">line 410</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".WIDTH_SOURCE_DEFAULT"> <h4 id=".WIDTH_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>WIDTH_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default width ("srcWidth") of the original source. Unit agnostic.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>32</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-380">line 380</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".ZINDEX_DEFAULT"> <h4 id=".ZINDEX_DEFAULT"><span class="type-signature"><static, constant> </span>ZINDEX_DEFAULT<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Default "zIndex" in the destiny.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>1</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-440">line 440</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".filterProperties_DEFAULT_PROPERTIES"> <h4 id=".filterProperties_DEFAULT_PROPERTIES"><span class="type-signature"><static, constant> </span>filterProperties_DEFAULT_PROPERTIES<span class="type-signature"> :<a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span></h4> </dt> <dd> <div class="description"> <p>Object used as the default value for the "propertiesToKeepObject" parameter if not provided when calling the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{"spritesScene":"","spritesGroups":"","sprites":"","spritesGroup":"","sprite":"","subSprite":""}</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1887">line 1887</a> </li> </ul> </dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <hr> <dt> <h4 class="name" id="current"><span class="type-signature"></span>current<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Alias for <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a>.</p> </div> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1361">line 1361</a> </li> </ul> </dd> <dt class="tag-see method-doc-label method-doc-details-label">See:</dt> <dd class="tag-see"> <ul> <li><a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a></li> </ul> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Destroys the graphic sprites object (removing all the sprites and their sub-sprites, etc.) and frees memory.</p> </div> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-462">line 462</a> </li> </ul> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="executeAll"><span class="type-signature"></span>executeAll<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Alias for <a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a>.</p> </div> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>, <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1219">line 1219</a> </li> </ul> </dd> <dt class="tag-see method-doc-label method-doc-details-label">See:</dt> <dd class="tag-see"> <ul> <li><a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a></li> </ul> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="executeFunctionAll"><span class="type-signature"></span>executeFunctionAll<span class="signature">(functionEach [, orderedByZIndex] [, delayBetweenEach] [, sprites] [, returnSetTimeoutsArray] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> → {integer|array}</span></h4> </dt> <dd> <div class="description"> <p>Performs a desired action, using the provided function, on all the existing sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or on the desired ones (if provided). Calls the <a href="CB_Arrays.html#.executeFunctionAll"><code>CB_Arrays.executeFunctionAll</code></a> function internally and returns its returning value.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>functionEach</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz