UNPKG

168 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Class: CB_GraphicSpritesScene</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<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;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <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>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <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>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <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>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Class: CB_GraphicSpritesScene</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_GraphicSpritesScene
91 </h2>
92
93 <div class="class-description"><p>Class to manage different groups of graphic sprites (2D or 3D). Internally, it manages <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></div>
94
95
96</header>
97
98
99<article>
100 <div class="container-overview">
101
102
103<hr>
104<dt>
105 <h4 class="name" id="CB_GraphicSpritesScene"><span class="type-signature"></span>new CB_GraphicSpritesScene<span class="signature">( [spritesGroups] [, byReference])</span><span class="type-signature"> &rarr; {<a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a>}</span></h4>
106
107
108</dt>
109<dd>
110
111
112 <div class="description">
113 <p>Class to manage different groups of graphic sprites (2D or 3D). Internally, it manages <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p>
114 </div>
115
116
117
118
119
120
121
122
123 <h5>Parameters:</h5>
124
125
126<table class="params table table-striped">
127 <thead>
128 <tr>
129
130 <th style="width:12%; min-width:110px;">Name</th>
131
132
133 <th style="width:12%; min-width:110px;">Type</th>
134
135
136 <th style="width:12%; min-width:110px;">Argument</th>
137
138
139
140 <th style="width:12%; min-width:110px;">Default</th>
141
142
143 <th class="last" style="min-width:310px;">Description</th>
144 </tr>
145 </thead>
146
147 <tbody>
148
149
150 <tr>
151
152 <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>spritesGroups</code></td>
153
154
155 <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;">
156
157
158<span class="param-type"><a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a></span>
159
160
161
162
163 </td>
164
165
166 <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;">
167
168 &lt;optional><br>
169
170
171
172
173
174 </td>
175
176
177
178 <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;">
179
180 </td>
181
182
183 <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 groups of sprites. The information will be used for the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> property. Used as the &quot;spritesGroups&quot; parameter when calling the <a href="CB_GraphicSpritesScene.html#insertSpritesGroups"><code>CB_GraphicSpritesScene#insertSpritesGroups</code></a> method internally.</p></td>
184 </tr>
185
186
187
188 <tr>
189
190 <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>
191
192
193 <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;">
194
195
196<span class="param-type">boolean</span>
197
198
199
200
201 </td>
202
203
204 <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;">
205
206 &lt;optional><br>
207
208
209
210
211
212 </td>
213
214
215
216 <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;">
217
218 false
219
220 </td>
221
222
223 <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 &quot;byReference&quot; parameter of the constructor when creating the new internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects. If a boolean value is not provided, it will use the value of the <code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT.byReference_DEFAULT</code> property of the given <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object (parsed to boolean).</p></td>
224 </tr>
225
226
227 </tbody>
228</table>
229
230
231
232
233<dl class="details">
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
264 <dd class="tag-source">
265 <ul class="dummy">
266 <li>
267 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
268 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-127">line 127</a>
269 </li>
270 </ul>
271 </dd>
272
273
274
275
276
277
278
279 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
280 <dd class="tag-todo">
281 <ul>
282 <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>
283
284 <li>Think about a method to remove a sprite group object when the same sprite group is received by parameter. The same to remove a <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object, receiving a <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object by parameter. The same to remove the sprites groups object, receiving a sprites groups object by parameter. Only remove them if they match exactly.</li>
285
286 <li>Think about a method to insert <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object directly. The same with a method that inserts many <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects (receiving an array with them).</li>
287 </ul>
288 </dd>
289
290</dl>
291
292
293
294
295
296
297
298
299
300
301
302
303
304 <h5>Returns:</h5>
305
306
307<div class="param-desc">
308 <p>Returns a new <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object.</p>
309</div>
310
311
312
313<dl>
314 <dt>
315 Type
316 </dt>
317 <dd>
318
319<span class="param-type"><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></span>
320
321
322
323 </dd>
324</dl>
325
326
327
328
329
330</dd>
331
332
333 </div>
334
335
336
337
338
339
340
341
342
343
344
345
346 <h3 class="subsection-title">Members</h3>
347
348 <dl>
349
350<hr>
351<dt class="name" id="id">
352 <h4 id="id"><span class="type-signature">&lt;readonly> </span>id<span class="type-signature"> :string|*</span></h4>
353
354
355</dt>
356<dd>
357
358 <div class="description">
359 <p>Identifier of the sprites groups object (the &quot;id&quot; property of the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> stored in the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> property) and the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</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>
360 </div>
361
362
363
364 <h5>Type:</h5>
365 <ul>
366 <li>
367
368<span class="param-type">string</span>
369|
370
371<span class="param-type">*</span>
372
373
374
375 </li>
376 </ul>
377
378
379
380<dl class="details">
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
407 <dd class="tag-default">
408 <ul class="dummy">
409 <li>'CB_GraphicSpritesScene_' + CB_GraphicSpritesScene._idUnique++</li>
410 </ul>
411 </dd>
412
413
414
415
416
417 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
418 <dd class="tag-source">
419 <ul class="dummy">
420 <li>
421 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
422 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-140">line 140</a>
423 </li>
424 </ul>
425 </dd>
426
427
428
429
430
431
432
433</dl>
434
435
436
437</dd>
438
439
440
441<hr>
442<dt class="name" id="isSpritesScene">
443 <h4 id="isSpritesScene"><span class="type-signature">&lt;constant> </span>isSpritesScene<span class="type-signature"> :boolean</span></h4>
444
445
446</dt>
447<dd>
448
449 <div class="description">
450 <p>Property which is always set to true to help identify this type of object.</p>
451 </div>
452
453
454
455 <h5>Type:</h5>
456 <ul>
457 <li>
458
459<span class="param-type">boolean</span>
460
461
462
463 </li>
464 </ul>
465
466
467
468<dl class="details">
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
495 <dd class="tag-default">
496 <ul class="dummy">
497 <li>true</li>
498 </ul>
499 </dd>
500
501
502
503
504
505 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
506 <dd class="tag-source">
507 <ul class="dummy">
508 <li>
509 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
510 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-173">line 173</a>
511 </li>
512 </ul>
513 </dd>
514
515
516
517
518
519
520
521</dl>
522
523
524
525</dd>
526
527
528
529<hr>
530<dt class="name" id="parent">
531 <h4 id="parent"><span class="type-signature">&lt;readonly> </span>parent<span class="type-signature"> :*</span></h4>
532
533
534</dt>
535<dd>
536
537 <div class="description">
538 <p>Property pointing to or containing its parent. It is the same as the &quot;parent&quot; property of the <code>CB_GraphicSprites.SPRITES_GROUPS_OBJECT</code> stored in the <code>CB_GraphicSprites#spritesGroups</code> property.</p>
539 </div>
540
541
542
543 <h5>Type:</h5>
544 <ul>
545 <li>
546
547<span class="param-type">*</span>
548
549
550
551 </li>
552 </ul>
553
554
555
556<dl class="details">
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
587 <dd class="tag-source">
588 <ul class="dummy">
589 <li>
590 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
591 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-149">line 149</a>
592 </li>
593 </ul>
594 </dd>
595
596
597
598
599
600
601
602</dl>
603
604
605
606</dd>
607
608
609
610<hr>
611<dt class="name" id="spritesGroups">
612 <h4 id="spritesGroups"><span class="type-signature">&lt;readonly> </span>spritesGroups<span class="type-signature"> :SPRITES_GROUPS_OBJECT</span></h4>
613
614
615</dt>
616<dd>
617
618 <div class="description">
619 <p>Object containing all the internally-created <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects and their information.</p>
620 </div>
621
622
623
624 <h5>Type:</h5>
625 <ul>
626 <li>
627
628<span class="param-type">SPRITES_GROUPS_OBJECT</span>
629
630
631
632 </li>
633 </ul>
634
635
636
637<dl class="details">
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
664 <dd class="tag-default">
665 <ul class="dummy">
666 <li>{}</li>
667 </ul>
668 </dd>
669
670
671
672
673
674 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
675 <dd class="tag-source">
676 <ul class="dummy">
677 <li>
678 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
679 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-159">line 159</a>
680 </li>
681 </ul>
682 </dd>
683
684
685
686
687
688
689
690</dl>
691
692
693
694</dd>
695
696
697
698<hr>
699<dt class="name" id="type">
700 <h4 id="type"><span class="type-signature">&lt;constant> </span>type<span class="type-signature"> :string</span></h4>
701
702
703</dt>
704<dd>
705
706 <div class="description">
707 <p>Indicates the type of object (always &quot;spritesScene&quot;).</p>
708 </div>
709
710
711
712 <h5>Type:</h5>
713 <ul>
714 <li>
715
716<span class="param-type">string</span>
717
718
719
720 </li>
721 </ul>
722
723
724
725<dl class="details">
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
752 <dd class="tag-default">
753 <ul class="dummy">
754 <li>spritesScene</li>
755 </ul>
756 </dd>
757
758
759
760
761
762 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
763 <dd class="tag-source">
764 <ul class="dummy">
765 <li>
766 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
767 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-182">line 182</a>
768 </li>
769 </ul>
770 </dd>
771
772
773
774
775
776
777
778</dl>
779
780
781
782</dd>
783
784 </dl>
785
786
787
788 <h3 class="subsection-title">Methods</h3>
789
790 <dl>
791
792<hr>
793<dt>
794 <h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">()</span><span class="type-signature"></span></h4>
795
796
797</dt>
798<dd>
799
800
801 <div class="description">
802 <p>Destroys the graphic sprites scene object (removing all the sprites groups and the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects, etc.) and frees memory.</p>
803 </div>
804
805
806
807
808
809
810
811
812
813
814<dl class="details">
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
845 <dd class="tag-source">
846 <ul class="dummy">
847 <li>
848 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
849 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-201">line 201</a>
850 </li>
851 </ul>
852 </dd>
853
854
855
856
857
858
859
860</dl>
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876</dd>
877
878
879
880<hr>
881<dt>
882 <h4 class="name" id="executeAll"><span class="type-signature"></span>executeAll<span class="signature">()</span><span class="type-signature"></span></h4>
883
884
885</dt>
886<dd>
887
888
889 <div class="description">
890 <p>Alias for <a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a>.</p>
891 </div>
892
893
894
895
896
897
898
899
900
901
902<dl class="details">
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
933 <dd class="tag-source">
934 <ul class="dummy">
935 <li>
936 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
937 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-600">line 600</a>
938 </li>
939 </ul>
940 </dd>
941
942
943
944
945
946 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
947 <dd class="tag-see">
948 <ul>
949 <li><a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a></li>
950 </ul>
951 </dd>
952
953
954
955</dl>
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971</dd>
972
973
974
975<hr>
976<dt>
977 <h4 class="name" id="executeFunctionAll"><span class="type-signature"></span>executeFunctionAll<span class="signature">(functionEach [, orderedByZIndex] [, delayBetweenEach] [, graphicSpritesObjects] [, returnSetTimeoutsArray] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> &rarr; {integer|array}</span></h4>
978
979
980</dt>
981<dd>
982
983
984 <div class="description">
985 <p>Performs a desired action, using the provided function, on all the existing <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</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>
986 </div>
987
988
989
990
991
992
993
994
995 <h5>Parameters:</h5>
996
997
998<table class="params table table-striped">
999 <thead>
1000 <tr>
1001
1002 <th style="width:12%; min-width:110px;">Name</th>
1003
1004
1005 <th style="width:12%; min-width:110px;">Type</th>
1006
1007
1008 <th style="width:12%; min-width:110px;">Argument</th>
1009
1010
1011
1012 <th style="width:12%; min-width:110px;">Default</th>
1013
1014
1015 <th class="last" style="min-width:310px;">Description</th>
1016 </tr>
1017 </thead>
1018
1019 <tbody>
1020
1021
1022 <tr>
1023
1024 <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>
1025
1026
1027 <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;">
1028
1029
1030<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
1031
1032
1033
1034
1035 </td>
1036
1037
1038 <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;">
1039
1040
1041
1042
1043
1044 </td>
1045
1046
1047
1048 <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;">
1049
1050 </td>
1051
1052
1053 <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>Function that will be called for each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object. As the first parameter it receives the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object of the &quot;graphicSpritesObjects&quot; being looped, as the second parameter the position of this <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object in the &quot;graphicSpritesObjects&quot; array provided (or, if not provided, in the array returned by the <a href="CB_GraphicSpritesScene.html#getGraphicSpritesAll"><code>CB_GraphicSpritesScene#getGraphicSpritesAll</code></a> method), the third parameter is the array being looped and the fourth parameter will be the &quot;delayBetweenEach&quot; being used, being &quot;this&quot; the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself.</p></td>
1054 </tr>
1055
1056
1057
1058 <tr>
1059
1060 <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>orderedByZIndex</code></td>
1061
1062
1063 <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;">
1064
1065
1066<span class="param-type">boolean</span>
1067
1068
1069
1070
1071 </td>
1072
1073
1074 <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;">
1075
1076 &lt;optional><br>
1077
1078
1079
1080
1081
1082 </td>
1083
1084
1085
1086 <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;">
1087
1088 false
1089
1090 </td>
1091
1092
1093 <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>If set to true, it will loop the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> sorted by their z-index (ascending order).</p></td>
1094 </tr>
1095
1096
1097
1098 <tr>
1099
1100 <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>delayBetweenEach</code></td>
1101
1102
1103 <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;">
1104
1105
1106<span class="param-type">number</span>
1107|
1108
1109<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
1110
1111
1112
1113
1114 </td>
1115
1116
1117 <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;">
1118
1119 &lt;optional><br>
1120
1121
1122
1123
1124
1125 </td>
1126
1127
1128
1129 <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;">
1130
1131 0
1132
1133 </td>
1134
1135
1136 <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>If a value greater than zero is used, it will be used as the delay desired between each call to the &quot;functionEach&quot; function (calling them using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function internally). If not provided or the value is 0 (zero) or lower, each call to the &quot;functionEach&quot; function will be performed immediately one after the other. If a function is provided, it will be called with the same parameters as the &quot;functionEach&quot; function and its returning value will be used as the delay (executed every loop for each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object).</p></td>
1137 </tr>
1138
1139
1140
1141 <tr>
1142
1143 <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>graphicSpritesObjects</code></td>
1144
1145
1146 <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;">
1147
1148
1149<span class="param-type">array</span>
1150
1151
1152
1153
1154 </td>
1155
1156
1157 <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;">
1158
1159 &lt;optional><br>
1160
1161
1162
1163
1164
1165 </td>
1166
1167
1168
1169 <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;">
1170
1171 <a href="CB_GraphicSpritesScene.html#getGraphicSpritesAll"><code>CB_GraphicSpritesScene#getGraphicSpritesAll</code></a>()
1172
1173 </td>
1174
1175
1176 <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>A numeric array containing the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects that we want to loop. It should contain only <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects which are already in the current <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object. If not provided, it will use all the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects contained in the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object.</p></td>
1177 </tr>
1178
1179
1180
1181 <tr>
1182
1183 <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>returnSetTimeoutsArray</code></td>
1184
1185
1186 <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;">
1187
1188
1189<span class="param-type">boolean</span>
1190
1191
1192
1193
1194 </td>
1195
1196
1197 <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;">
1198
1199 &lt;optional><br>
1200
1201
1202
1203
1204
1205 </td>
1206
1207
1208
1209 <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;">
1210
1211 false
1212
1213 </td>
1214
1215
1216 <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>Defines whether we want the method to return an integer or a numeric array with information of each <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> call. Returning an array with information of each <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> call is only useful when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function is called internally, which happens when the &quot;delayBetweenEach&quot; parameter is greater than 0 (zero).</p></td>
1217 </tr>
1218
1219
1220
1221 <tr>
1222
1223 <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>delayBetweenEachAffectsFirst</code></td>
1224
1225
1226 <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;">
1227
1228
1229<span class="param-type">boolean</span>
1230
1231
1232
1233
1234 </td>
1235
1236
1237 <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;">
1238
1239 &lt;optional><br>
1240
1241
1242
1243
1244
1245 </td>
1246
1247
1248
1249 <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;">
1250
1251 false
1252
1253 </td>
1254
1255
1256 <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>If set to true, the desired delay (if any) will also affect the first call to the &quot;functionEach&quot; function.</p></td>
1257 </tr>
1258
1259
1260
1261 <tr>
1262
1263 <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>functionFinish</code></td>
1264
1265
1266 <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;">
1267
1268
1269<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_FINISH_CALLBACK">CB_Arrays.executeFunctionAll_ON_FINISH_CALLBACK</a></span>
1270
1271
1272
1273
1274 </td>
1275
1276
1277 <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;">
1278
1279 &lt;optional><br>
1280
1281
1282
1283
1284
1285 </td>
1286
1287
1288
1289 <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;">
1290
1291 </td>
1292
1293
1294 <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>Function that will be called for when it has finished looping all the items. The first parameter will be the array which was looped, the second parameter will be the number of times that the &quot;functionEach&quot; callback was called (the most likely, matches the number of elements unless they are undefined or null), and the third parameter will be the maximum &quot;delay&quot; used, being &quot;this&quot; the array itself.</p></td>
1295 </tr>
1296
1297
1298 </tbody>
1299</table>
1300
1301
1302
1303
1304<dl class="details">
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1335 <dd class="tag-source">
1336 <ul class="dummy">
1337 <li>
1338 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
1339 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-628">line 628</a>
1340 </li>
1341 </ul>
1342 </dd>
1343
1344
1345
1346
1347
1348
1349
1350 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1351 <dd class="tag-todo">
1352 <ul>
1353 <li>Think about only allowing <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects (in the "graphicSpritesObjects" parameter) which are already in the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> (identify them by their ID), to avoid problems.</li>
1354 </ul>
1355 </dd>
1356
1357</dl>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371 <h5>Returns:</h5>
1372
1373
1374<div class="param-desc">
1375 <p>If the &quot;returnSetTimeoutsArray&quot; parameter is set to false, it will return the number of calls to the &quot;functionEach&quot; function that were performed (which should be the same number as the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects given in the &quot;graphicSpritesObjects&quot; parameter). Otherwise, if the &quot;returnSetTimeoutsArray&quot; is set to true, it will return a numeric array with a <a href="CB_Arrays.html#.executeFunctionAll_OBJECT"><code>CB_Arrays.executeFunctionAll_OBJECT</code></a> object for each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> given. The length of this array will also be the number of calls to the &quot;functionEach&quot; function that were performed. Note that if a value greater than 0 (zero) for the &quot;delayBetweenEach&quot; parameter has been provided, perhaps not all calls of the &quot;functionEach&quot; function will have been performed yet when exiting this method because of the asynchronous nature of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function.</p>
1376</div>
1377
1378
1379
1380<dl>
1381 <dt>
1382 Type
1383 </dt>
1384 <dd>
1385
1386<span class="param-type">integer</span>
1387|
1388
1389<span class="param-type">array</span>
1390
1391
1392
1393 </dd>
1394</dl>
1395
1396
1397
1398
1399
1400</dd>
1401
1402
1403
1404<hr>
1405<dt>
1406 <h4 class="name" id="forEach"><span class="type-signature"></span>forEach<span class="signature">()</span><span class="type-signature"></span></h4>
1407
1408
1409</dt>
1410<dd>
1411
1412
1413 <div class="description">
1414 <p>Alias for <a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a>.</p>
1415 </div>
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426<dl class="details">
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1457 <dd class="tag-source">
1458 <ul class="dummy">
1459 <li>
1460 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
1461 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-605">line 605</a>
1462 </li>
1463 </ul>
1464 </dd>
1465
1466
1467
1468
1469
1470 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1471 <dd class="tag-see">
1472 <ul>
1473 <li><a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a></li>
1474 </ul>
1475 </dd>
1476
1477
1478
1479</dl>
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495</dd>
1496
1497
1498
1499<hr>
1500<dt>
1501 <h4 class="name" id="forEachGraphicSprites"><span class="type-signature"></span>forEachGraphicSprites<span class="signature">()</span><span class="type-signature"></span></h4>
1502
1503
1504</dt>
1505<dd>
1506
1507
1508 <div class="description">
1509 <p>Alias for <a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a>.</p>
1510 </div>
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521<dl class="details">
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1552 <dd class="tag-source">
1553 <ul class="dummy">
1554 <li>
1555 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
1556 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-610">line 610</a>
1557 </li>
1558 </ul>
1559 </dd>
1560
1561
1562
1563
1564
1565 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1566 <dd class="tag-see">
1567 <ul>
1568 <li><a href="CB_GraphicSpritesScene.html#executeFunctionAll"><code>CB_GraphicSpritesScene#executeFunctionAll</code></a></li>
1569 </ul>
1570 </dd>
1571
1572
1573
1574</dl>
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590</dd>
1591
1592
1593
1594<hr>
1595<dt>
1596 <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">()</span><span class="type-signature"></span></h4>
1597
1598
1599</dt>
1600<dd>
1601
1602
1603 <div class="description">
1604 <p>Alias for <a href="CB_GraphicSpritesScene.html#getGraphicSprites"><code>CB_GraphicSpritesScene#getGraphicSprites</code></a>.</p>
1605 </div>
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616<dl class="details">
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1647 <dd class="tag-source">
1648 <ul class="dummy">
1649 <li>
1650 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
1651 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-534">line 534</a>
1652 </li>
1653 </ul>
1654 </dd>
1655
1656
1657
1658
1659
1660 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1661 <dd class="tag-see">
1662 <ul>
1663 <li><a href="CB_GraphicSpritesScene.html#getGraphicSprites"><code>CB_GraphicSpritesScene#getGraphicSprites</code></a></li>
1664 </ul>
1665 </dd>
1666
1667
1668
1669</dl>
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685</dd>
1686
1687
1688
1689<hr>
1690<dt>
1691 <h4 class="name" id="getAll"><span class="type-signature"></span>getAll<span class="signature">()</span><span class="type-signature"></span></h4>
1692
1693
1694</dt>
1695<dd>
1696
1697
1698 <div class="description">
1699 <p>Alias for <a href="CB_GraphicSpritesScene.html#getGraphicSpritesAll"><code>CB_GraphicSpritesScene#getGraphicSpritesAll</code></a>.</p>
1700 </div>
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711<dl class="details">
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1742 <dd class="tag-source">
1743 <ul class="dummy">
1744 <li>
1745 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
1746 <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-505">line 505</a>
1747 </li>
1748 </ul>
1749 </dd>
1750
1751
1752
1753
1754
1755 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
1756 <dd class="tag-see">
1757 <ul>
1758 <li><a href="CB_GraphicSpritesScene.html#getGraphicSpritesAll"><code>CB_GraphicSpritesScene#getGraphicSpritesAll</code></a></li>
1759 </ul>
1760 </dd>
1761
1762
1763
1764</dl>
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780</dd>
1781
1782
1783
1784<hr>
1785<dt>
1786 <h4 class="name" id="getById"><span class="type-signature"></span>getById<span class="signature">()</span><span class="type-signature"></span></h4>
1787
1788
1789</dt>
1790<dd>
1791
1792
1793 <div class="description">
1794 <p>Alias for <a href="CB_GraphicSpritesScene.html#getGraphicSpritesById"><code>CB_GraphicSpritesScene#getGraphicSpritesById</code></a>.</p>
1795 </div>
1796
1797
1798
1799
1800
1801