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 | |
10 |
|
11 |
|
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_baseSymbols.html">CB_baseSymbols</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>
|
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_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_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_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_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</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_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</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_NAME">CB_NAME</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_OPTIONS">CB_OPTIONS</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><li><a href="global.html#CB_VERSION">CB_VERSION</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"> → {<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 | <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 "spritesGroups" 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 | <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 "byReference" 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"><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 "id" 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"><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"><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 "parent" 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"><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"><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 "spritesScene").</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"> → {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 "graphicSpritesObjects" being looped, as the second parameter the position of this <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object in the "graphicSpritesObjects" 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 "delayBetweenEach" being used, being "this" 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 | <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 | <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 "functionEach" 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 "functionEach" function will be performed immediately one after the other. If a function is provided, it will be called with the same parameters as the "functionEach" 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 | <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 | <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 "delayBetweenEach" 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 | <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 "functionEach" 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 | <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 "functionEach" 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 "delay" used, being "this" 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 "returnSetTimeoutsArray" parameter is set to false, it will return the number of calls to the "functionEach" 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 "graphicSpritesObjects" parameter). Otherwise, if the "returnSetTimeoutsArray" 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 "functionEach" function that were performed. Note that if a value greater than 0 (zero) for the "delayBetweenEach" parameter has been provided, perhaps not all calls of the "functionEach" 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 |
|
1802 |
|
1803 |
|
1804 |
|
1805 |
|
1806 | <dl class="details">
|
1807 |
|
1808 |
|
1809 |
|
1810 |
|
1811 |
|
1812 |
|
1813 |
|
1814 |
|
1815 |
|
1816 |
|
1817 |
|
1818 |
|
1819 |
|
1820 |
|
1821 |
|
1822 |
|
1823 |
|
1824 |
|
1825 |
|
1826 |
|
1827 |
|
1828 |
|
1829 |
|
1830 |
|
1831 |
|
1832 |
|
1833 |
|
1834 |
|
1835 |
|
1836 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1837 | <dd class="tag-source">
|
1838 | <ul class="dummy">
|
1839 | <li>
|
1840 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
1841 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-555">line 555</a>
|
1842 | </li>
|
1843 | </ul>
|
1844 | </dd>
|
1845 |
|
1846 |
|
1847 |
|
1848 |
|
1849 |
|
1850 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
1851 | <dd class="tag-see">
|
1852 | <ul>
|
1853 | <li><a href="CB_GraphicSpritesScene.html#getGraphicSpritesById"><code>CB_GraphicSpritesScene#getGraphicSpritesById</code></a></li>
|
1854 | </ul>
|
1855 | </dd>
|
1856 |
|
1857 |
|
1858 |
|
1859 | </dl>
|
1860 |
|
1861 |
|
1862 |
|
1863 |
|
1864 |
|
1865 |
|
1866 |
|
1867 |
|
1868 |
|
1869 |
|
1870 |
|
1871 |
|
1872 |
|
1873 |
|
1874 |
|
1875 | </dd>
|
1876 |
|
1877 |
|
1878 |
|
1879 | <hr>
|
1880 | <dt>
|
1881 | <h4 class="name" id="getCopy"><span class="type-signature"></span>getCopy<span class="signature">( [avoidCopyingPointers] [, avoidCopyingTimes] [, clearReferences] [, filterProperties] [, propertiesToKeepObject])</span><span class="type-signature"> → {<a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a>}</span></h4>
|
1882 |
|
1883 |
|
1884 | </dt>
|
1885 | <dd>
|
1886 |
|
1887 |
|
1888 | <div class="description">
|
1889 | <p>Gets a new copy of this object with the same attributes (all sub-objects will be a copy, they will not the same reference).</p>
|
1890 | </div>
|
1891 |
|
1892 |
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 |
|
1899 | <h5>Parameters:</h5>
|
1900 |
|
1901 |
|
1902 | <table class="params table table-striped">
|
1903 | <thead>
|
1904 | <tr>
|
1905 |
|
1906 | <th style="width:12%; min-width:110px;">Name</th>
|
1907 |
|
1908 |
|
1909 | <th style="width:12%; min-width:110px;">Type</th>
|
1910 |
|
1911 |
|
1912 | <th style="width:12%; min-width:110px;">Argument</th>
|
1913 |
|
1914 |
|
1915 |
|
1916 | <th style="width:12%; min-width:110px;">Default</th>
|
1917 |
|
1918 |
|
1919 | <th class="last" style="min-width:310px;">Description</th>
|
1920 | </tr>
|
1921 | </thead>
|
1922 |
|
1923 | <tbody>
|
1924 |
|
1925 |
|
1926 | <tr>
|
1927 |
|
1928 | <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>avoidCopyingPointers</code></td>
|
1929 |
|
1930 |
|
1931 | <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;">
|
1932 |
|
1933 |
|
1934 | <span class="param-type">boolean</span>
|
1935 |
|
1936 |
|
1937 |
|
1938 |
|
1939 | </td>
|
1940 |
|
1941 |
|
1942 | <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;">
|
1943 |
|
1944 | <optional><br>
|
1945 |
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 | </td>
|
1951 |
|
1952 |
|
1953 |
|
1954 | <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;">
|
1955 |
|
1956 | false
|
1957 |
|
1958 | </td>
|
1959 |
|
1960 |
|
1961 | <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 not copy the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property of each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object.</p></td>
|
1962 | </tr>
|
1963 |
|
1964 |
|
1965 |
|
1966 | <tr>
|
1967 |
|
1968 | <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>avoidCopyingTimes</code></td>
|
1969 |
|
1970 |
|
1971 | <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;">
|
1972 |
|
1973 |
|
1974 | <span class="param-type">boolean</span>
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 | </td>
|
1980 |
|
1981 |
|
1982 | <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;">
|
1983 |
|
1984 | <optional><br>
|
1985 |
|
1986 |
|
1987 |
|
1988 |
|
1989 |
|
1990 | </td>
|
1991 |
|
1992 |
|
1993 |
|
1994 | <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;">
|
1995 |
|
1996 | false
|
1997 |
|
1998 | </td>
|
1999 |
|
2000 |
|
2001 | <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 not copy neither the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property of each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object nor the "time" property of each of their sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects).</p></td>
|
2002 | </tr>
|
2003 |
|
2004 |
|
2005 |
|
2006 | <tr>
|
2007 |
|
2008 | <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>clearReferences</code></td>
|
2009 |
|
2010 |
|
2011 | <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;">
|
2012 |
|
2013 |
|
2014 | <span class="param-type">boolean</span>
|
2015 |
|
2016 |
|
2017 |
|
2018 |
|
2019 | </td>
|
2020 |
|
2021 |
|
2022 | <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;">
|
2023 |
|
2024 | <optional><br>
|
2025 |
|
2026 |
|
2027 |
|
2028 |
|
2029 |
|
2030 | </td>
|
2031 |
|
2032 |
|
2033 |
|
2034 | <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;">
|
2035 |
|
2036 | false
|
2037 |
|
2038 | </td>
|
2039 |
|
2040 |
|
2041 | <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 not copy neither the "container" nor the "parent" nor the "data.that" nor the "data.getThis" properties of any element. Useful to be able to stringify the object preventing the "TypeError: cyclic object value" error. When set to true, calls the <a href="CB_GraphicSprites.html#.clearReferences"><code>CB_GraphicSprites.clearReferences</code></a> function internally. If set to true and the "filterProperties" parameter is also set to true, the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> will always be called before calling the <a href="CB_GraphicSprites.html#.clearReferences"><code>CB_GraphicSprites.clearReferences</code></a> function.</p></td>
|
2042 | </tr>
|
2043 |
|
2044 |
|
2045 |
|
2046 | <tr>
|
2047 |
|
2048 | <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>filterProperties</code></td>
|
2049 |
|
2050 |
|
2051 | <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;">
|
2052 |
|
2053 |
|
2054 | <span class="param-type">boolean</span>
|
2055 |
|
2056 |
|
2057 |
|
2058 |
|
2059 | </td>
|
2060 |
|
2061 |
|
2062 | <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;">
|
2063 |
|
2064 | <optional><br>
|
2065 |
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 | </td>
|
2071 |
|
2072 |
|
2073 |
|
2074 | <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;">
|
2075 |
|
2076 | false
|
2077 |
|
2078 | </td>
|
2079 |
|
2080 |
|
2081 | <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 call the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function internally to filter the properties that we do not want to keep (using the given "propertiesToKeepObject" as the parameter to call it). When set to true, calls the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function internally. If set to true and the "clearReferences" parameter is also set to true, the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> will always be called before calling the <a href="CB_GraphicSprites.html#.clearReferences"><code>CB_GraphicSprites.clearReferences</code></a> function.</p></td>
|
2082 | </tr>
|
2083 |
|
2084 |
|
2085 |
|
2086 | <tr>
|
2087 |
|
2088 | <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>propertiesToKeepObject</code></td>
|
2089 |
|
2090 |
|
2091 | <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;">
|
2092 |
|
2093 |
|
2094 | <span class="param-type"><a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span>
|
2095 |
|
2096 |
|
2097 |
|
2098 |
|
2099 | </td>
|
2100 |
|
2101 |
|
2102 | <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;">
|
2103 |
|
2104 | <optional><br>
|
2105 |
|
2106 |
|
2107 |
|
2108 |
|
2109 |
|
2110 | </td>
|
2111 |
|
2112 |
|
2113 |
|
2114 | <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;">
|
2115 |
|
2116 | CB_GraphicSprites.filterProperties_DEFAULT_PROPERTIES
|
2117 |
|
2118 | </td>
|
2119 |
|
2120 |
|
2121 | <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>The object with the properties that we want to keep. Only used when the "filterProperties" parameter is set to true, as the "propertiesToKeepObject" when calling the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function internally.</p></td>
|
2122 | </tr>
|
2123 |
|
2124 |
|
2125 | </tbody>
|
2126 | </table>
|
2127 |
|
2128 |
|
2129 |
|
2130 |
|
2131 | <dl class="details">
|
2132 |
|
2133 |
|
2134 |
|
2135 |
|
2136 |
|
2137 |
|
2138 |
|
2139 |
|
2140 |
|
2141 |
|
2142 |
|
2143 |
|
2144 |
|
2145 |
|
2146 |
|
2147 |
|
2148 |
|
2149 |
|
2150 |
|
2151 |
|
2152 |
|
2153 |
|
2154 |
|
2155 |
|
2156 |
|
2157 |
|
2158 |
|
2159 |
|
2160 |
|
2161 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2162 | <dd class="tag-source">
|
2163 | <ul class="dummy">
|
2164 | <li>
|
2165 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
2166 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-665">line 665</a>
|
2167 | </li>
|
2168 | </ul>
|
2169 | </dd>
|
2170 |
|
2171 |
|
2172 |
|
2173 |
|
2174 |
|
2175 |
|
2176 |
|
2177 | </dl>
|
2178 |
|
2179 |
|
2180 |
|
2181 |
|
2182 |
|
2183 |
|
2184 |
|
2185 |
|
2186 |
|
2187 |
|
2188 |
|
2189 |
|
2190 |
|
2191 | <h5>Returns:</h5>
|
2192 |
|
2193 |
|
2194 | <div class="param-desc">
|
2195 | <p>Returns a copy of this object with the same attributes (all sub-objects will be a copy, not the same reference).</p>
|
2196 | </div>
|
2197 |
|
2198 |
|
2199 |
|
2200 | <dl>
|
2201 | <dt>
|
2202 | Type
|
2203 | </dt>
|
2204 | <dd>
|
2205 |
|
2206 | <span class="param-type"><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></span>
|
2207 |
|
2208 |
|
2209 |
|
2210 | </dd>
|
2211 | </dl>
|
2212 |
|
2213 |
|
2214 |
|
2215 |
|
2216 |
|
2217 | </dd>
|
2218 |
|
2219 |
|
2220 |
|
2221 | <hr>
|
2222 | <dt>
|
2223 | <h4 class="name" id="getGraphicSprites"><span class="type-signature"></span>getGraphicSprites<span class="signature">( [index] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html">CB_GraphicSprites</a>|*}</span></h4>
|
2224 |
|
2225 |
|
2226 | </dt>
|
2227 | <dd>
|
2228 |
|
2229 |
|
2230 | <div class="description">
|
2231 | <p>Gets a desired <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object through its index (its position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array). Faster than getting it through its identifier with the <a href="CB_GraphicSpritesScene.html#getGraphicSpritesById"><code>CB_GraphicSpritesScene#getGraphicSpritesById</code></a> method.</p>
|
2232 | </div>
|
2233 |
|
2234 |
|
2235 |
|
2236 |
|
2237 |
|
2238 |
|
2239 |
|
2240 |
|
2241 | <h5>Parameters:</h5>
|
2242 |
|
2243 |
|
2244 | <table class="params table table-striped">
|
2245 | <thead>
|
2246 | <tr>
|
2247 |
|
2248 | <th style="width:12%; min-width:110px;">Name</th>
|
2249 |
|
2250 |
|
2251 | <th style="width:12%; min-width:110px;">Type</th>
|
2252 |
|
2253 |
|
2254 | <th style="width:12%; min-width:110px;">Argument</th>
|
2255 |
|
2256 |
|
2257 |
|
2258 | <th style="width:12%; min-width:110px;">Default</th>
|
2259 |
|
2260 |
|
2261 | <th class="last" style="min-width:310px;">Description</th>
|
2262 | </tr>
|
2263 | </thead>
|
2264 |
|
2265 | <tbody>
|
2266 |
|
2267 |
|
2268 | <tr>
|
2269 |
|
2270 | <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>index</code></td>
|
2271 |
|
2272 |
|
2273 | <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;">
|
2274 |
|
2275 |
|
2276 | <span class="param-type">integer</span>
|
2277 |
|
2278 |
|
2279 |
|
2280 |
|
2281 | </td>
|
2282 |
|
2283 |
|
2284 | <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;">
|
2285 |
|
2286 | <optional><br>
|
2287 |
|
2288 |
|
2289 |
|
2290 |
|
2291 |
|
2292 | </td>
|
2293 |
|
2294 |
|
2295 |
|
2296 | <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;">
|
2297 |
|
2298 | 0
|
2299 |
|
2300 | </td>
|
2301 |
|
2302 |
|
2303 | <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>The index where the desired <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object must be located (its position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array).</p></td>
|
2304 | </tr>
|
2305 |
|
2306 |
|
2307 |
|
2308 | <tr>
|
2309 |
|
2310 | <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>returnValueOnFail</code></td>
|
2311 |
|
2312 |
|
2313 | <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;">
|
2314 |
|
2315 |
|
2316 | <span class="param-type">*</span>
|
2317 |
|
2318 |
|
2319 |
|
2320 |
|
2321 | </td>
|
2322 |
|
2323 |
|
2324 | <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;">
|
2325 |
|
2326 | <optional><br>
|
2327 |
|
2328 |
|
2329 |
|
2330 |
|
2331 |
|
2332 | </td>
|
2333 |
|
2334 |
|
2335 |
|
2336 | <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;">
|
2337 |
|
2338 | </td>
|
2339 |
|
2340 |
|
2341 | <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>The value we want it to return in the case that no value is found. If not provided, undefined will be returned.</p></td>
|
2342 | </tr>
|
2343 |
|
2344 |
|
2345 | </tbody>
|
2346 | </table>
|
2347 |
|
2348 |
|
2349 |
|
2350 |
|
2351 | <dl class="details">
|
2352 |
|
2353 |
|
2354 |
|
2355 |
|
2356 |
|
2357 |
|
2358 |
|
2359 |
|
2360 |
|
2361 |
|
2362 |
|
2363 |
|
2364 |
|
2365 |
|
2366 |
|
2367 |
|
2368 |
|
2369 |
|
2370 |
|
2371 |
|
2372 |
|
2373 |
|
2374 |
|
2375 |
|
2376 |
|
2377 |
|
2378 |
|
2379 |
|
2380 |
|
2381 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2382 | <dd class="tag-source">
|
2383 | <ul class="dummy">
|
2384 | <li>
|
2385 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
2386 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-546">line 546</a>
|
2387 | </li>
|
2388 | </ul>
|
2389 | </dd>
|
2390 |
|
2391 |
|
2392 |
|
2393 |
|
2394 |
|
2395 |
|
2396 |
|
2397 | </dl>
|
2398 |
|
2399 |
|
2400 |
|
2401 |
|
2402 |
|
2403 |
|
2404 |
|
2405 |
|
2406 |
|
2407 |
|
2408 |
|
2409 |
|
2410 |
|
2411 | <h5>Returns:</h5>
|
2412 |
|
2413 |
|
2414 | <div class="param-desc">
|
2415 | <p>Returns a <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
2416 | </div>
|
2417 |
|
2418 |
|
2419 |
|
2420 | <dl>
|
2421 | <dt>
|
2422 | Type
|
2423 | </dt>
|
2424 | <dd>
|
2425 |
|
2426 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
2427 | |
|
2428 |
|
2429 | <span class="param-type">*</span>
|
2430 |
|
2431 |
|
2432 |
|
2433 | </dd>
|
2434 | </dl>
|
2435 |
|
2436 |
|
2437 |
|
2438 |
|
2439 |
|
2440 | </dd>
|
2441 |
|
2442 |
|
2443 |
|
2444 | <hr>
|
2445 | <dt>
|
2446 | <h4 class="name" id="getGraphicSpritesAll"><span class="type-signature"></span>getGraphicSpritesAll<span class="signature">( [orderedByZIndex] [, returnValueOnFail])</span><span class="type-signature"> → {array|*}</span></h4>
|
2447 |
|
2448 |
|
2449 | </dt>
|
2450 | <dd>
|
2451 |
|
2452 |
|
2453 | <div class="description">
|
2454 | <p>Gets all the sprites graphic objects (the "items" property of the internal <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object, if any).</p>
|
2455 | </div>
|
2456 |
|
2457 |
|
2458 |
|
2459 |
|
2460 |
|
2461 |
|
2462 |
|
2463 |
|
2464 | <h5>Parameters:</h5>
|
2465 |
|
2466 |
|
2467 | <table class="params table table-striped">
|
2468 | <thead>
|
2469 | <tr>
|
2470 |
|
2471 | <th style="width:12%; min-width:110px;">Name</th>
|
2472 |
|
2473 |
|
2474 | <th style="width:12%; min-width:110px;">Type</th>
|
2475 |
|
2476 |
|
2477 | <th style="width:12%; min-width:110px;">Argument</th>
|
2478 |
|
2479 |
|
2480 |
|
2481 | <th style="width:12%; min-width:110px;">Default</th>
|
2482 |
|
2483 |
|
2484 | <th class="last" style="min-width:310px;">Description</th>
|
2485 | </tr>
|
2486 | </thead>
|
2487 |
|
2488 | <tbody>
|
2489 |
|
2490 |
|
2491 | <tr>
|
2492 |
|
2493 | <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>
|
2494 |
|
2495 |
|
2496 | <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;">
|
2497 |
|
2498 |
|
2499 | <span class="param-type">boolean</span>
|
2500 |
|
2501 |
|
2502 |
|
2503 |
|
2504 | </td>
|
2505 |
|
2506 |
|
2507 | <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;">
|
2508 |
|
2509 | <optional><br>
|
2510 |
|
2511 |
|
2512 |
|
2513 |
|
2514 |
|
2515 | </td>
|
2516 |
|
2517 |
|
2518 |
|
2519 | <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;">
|
2520 |
|
2521 | false
|
2522 |
|
2523 | </td>
|
2524 |
|
2525 |
|
2526 | <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 return the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects sorted by their z-index (ascending order).</p></td>
|
2527 | </tr>
|
2528 |
|
2529 |
|
2530 |
|
2531 | <tr>
|
2532 |
|
2533 | <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>returnValueOnFail</code></td>
|
2534 |
|
2535 |
|
2536 | <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;">
|
2537 |
|
2538 |
|
2539 | <span class="param-type">*</span>
|
2540 |
|
2541 |
|
2542 |
|
2543 |
|
2544 | </td>
|
2545 |
|
2546 |
|
2547 | <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;">
|
2548 |
|
2549 | <optional><br>
|
2550 |
|
2551 |
|
2552 |
|
2553 |
|
2554 |
|
2555 | </td>
|
2556 |
|
2557 |
|
2558 |
|
2559 | <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;">
|
2560 |
|
2561 | </td>
|
2562 |
|
2563 |
|
2564 | <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>The value we want it to return in the case that no value is found. If not provided, undefined will be returned.</p></td>
|
2565 | </tr>
|
2566 |
|
2567 |
|
2568 | </tbody>
|
2569 | </table>
|
2570 |
|
2571 |
|
2572 |
|
2573 |
|
2574 | <dl class="details">
|
2575 |
|
2576 |
|
2577 |
|
2578 |
|
2579 |
|
2580 |
|
2581 |
|
2582 |
|
2583 |
|
2584 |
|
2585 |
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 |
|
2592 |
|
2593 |
|
2594 |
|
2595 |
|
2596 |
|
2597 |
|
2598 |
|
2599 |
|
2600 |
|
2601 |
|
2602 |
|
2603 |
|
2604 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2605 | <dd class="tag-source">
|
2606 | <ul class="dummy">
|
2607 | <li>
|
2608 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
2609 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-517">line 517</a>
|
2610 | </li>
|
2611 | </ul>
|
2612 | </dd>
|
2613 |
|
2614 |
|
2615 |
|
2616 |
|
2617 |
|
2618 |
|
2619 |
|
2620 | </dl>
|
2621 |
|
2622 |
|
2623 |
|
2624 |
|
2625 |
|
2626 |
|
2627 |
|
2628 |
|
2629 |
|
2630 |
|
2631 |
|
2632 |
|
2633 |
|
2634 | <h5>Returns:</h5>
|
2635 |
|
2636 |
|
2637 | <div class="param-desc">
|
2638 | <p>Returns an array with all the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects or the value of "returnValueOnFail" otherwise.</p>
|
2639 | </div>
|
2640 |
|
2641 |
|
2642 |
|
2643 | <dl>
|
2644 | <dt>
|
2645 | Type
|
2646 | </dt>
|
2647 | <dd>
|
2648 |
|
2649 | <span class="param-type">array</span>
|
2650 | |
|
2651 |
|
2652 | <span class="param-type">*</span>
|
2653 |
|
2654 |
|
2655 |
|
2656 | </dd>
|
2657 | </dl>
|
2658 |
|
2659 |
|
2660 |
|
2661 |
|
2662 |
|
2663 | </dd>
|
2664 |
|
2665 |
|
2666 |
|
2667 | <hr>
|
2668 | <dt>
|
2669 | <h4 class="name" id="getGraphicSpritesById"><span class="type-signature"></span>getGraphicSpritesById<span class="signature">( [id] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html">CB_GraphicSprites</a>|*}</span></h4>
|
2670 |
|
2671 |
|
2672 | </dt>
|
2673 | <dd>
|
2674 |
|
2675 |
|
2676 | <div class="description">
|
2677 | <p>Gets a desired <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object through its identifier. Slower than getting it through its index with the <a href="CB_GraphicSpritesScene.html#getGraphicSprites"><code>CB_GraphicSpritesScene#getGraphicSprites</code></a> method.</p>
|
2678 | </div>
|
2679 |
|
2680 |
|
2681 |
|
2682 |
|
2683 |
|
2684 |
|
2685 |
|
2686 |
|
2687 | <h5>Parameters:</h5>
|
2688 |
|
2689 |
|
2690 | <table class="params table table-striped">
|
2691 | <thead>
|
2692 | <tr>
|
2693 |
|
2694 | <th style="width:12%; min-width:110px;">Name</th>
|
2695 |
|
2696 |
|
2697 | <th style="width:12%; min-width:110px;">Type</th>
|
2698 |
|
2699 |
|
2700 | <th style="width:12%; min-width:110px;">Argument</th>
|
2701 |
|
2702 |
|
2703 |
|
2704 |
|
2705 | <th class="last" style="min-width:310px;">Description</th>
|
2706 | </tr>
|
2707 | </thead>
|
2708 |
|
2709 | <tbody>
|
2710 |
|
2711 |
|
2712 | <tr>
|
2713 |
|
2714 | <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>id</code></td>
|
2715 |
|
2716 |
|
2717 | <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;">
|
2718 |
|
2719 |
|
2720 | <span class="param-type">string</span>
|
2721 | |
|
2722 |
|
2723 | <span class="param-type">*</span>
|
2724 |
|
2725 |
|
2726 |
|
2727 |
|
2728 | </td>
|
2729 |
|
2730 |
|
2731 | <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;">
|
2732 |
|
2733 | <optional><br>
|
2734 |
|
2735 |
|
2736 |
|
2737 |
|
2738 |
|
2739 | </td>
|
2740 |
|
2741 |
|
2742 |
|
2743 |
|
2744 | <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>The identifier of the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object that we want to get.</p></td>
|
2745 | </tr>
|
2746 |
|
2747 |
|
2748 |
|
2749 | <tr>
|
2750 |
|
2751 | <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>returnValueOnFail</code></td>
|
2752 |
|
2753 |
|
2754 | <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;">
|
2755 |
|
2756 |
|
2757 | <span class="param-type">*</span>
|
2758 |
|
2759 |
|
2760 |
|
2761 |
|
2762 | </td>
|
2763 |
|
2764 |
|
2765 | <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;">
|
2766 |
|
2767 | <optional><br>
|
2768 |
|
2769 |
|
2770 |
|
2771 |
|
2772 |
|
2773 | </td>
|
2774 |
|
2775 |
|
2776 |
|
2777 |
|
2778 | <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>The value we want it to return in the case that no value is found. If not provided, undefined will be returned.</p></td>
|
2779 | </tr>
|
2780 |
|
2781 |
|
2782 | </tbody>
|
2783 | </table>
|
2784 |
|
2785 |
|
2786 |
|
2787 |
|
2788 | <dl class="details">
|
2789 |
|
2790 |
|
2791 |
|
2792 |
|
2793 |
|
2794 |
|
2795 |
|
2796 |
|
2797 |
|
2798 |
|
2799 |
|
2800 |
|
2801 |
|
2802 |
|
2803 |
|
2804 |
|
2805 |
|
2806 |
|
2807 |
|
2808 |
|
2809 |
|
2810 |
|
2811 |
|
2812 |
|
2813 |
|
2814 |
|
2815 |
|
2816 |
|
2817 |
|
2818 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2819 | <dd class="tag-source">
|
2820 | <ul class="dummy">
|
2821 | <li>
|
2822 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
2823 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-567">line 567</a>
|
2824 | </li>
|
2825 | </ul>
|
2826 | </dd>
|
2827 |
|
2828 |
|
2829 |
|
2830 |
|
2831 |
|
2832 |
|
2833 |
|
2834 | </dl>
|
2835 |
|
2836 |
|
2837 |
|
2838 |
|
2839 |
|
2840 |
|
2841 |
|
2842 |
|
2843 |
|
2844 |
|
2845 |
|
2846 |
|
2847 |
|
2848 | <h5>Returns:</h5>
|
2849 |
|
2850 |
|
2851 | <div class="param-desc">
|
2852 | <p>Returns a <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
2853 | </div>
|
2854 |
|
2855 |
|
2856 |
|
2857 | <dl>
|
2858 | <dt>
|
2859 | Type
|
2860 | </dt>
|
2861 | <dd>
|
2862 |
|
2863 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
2864 | |
|
2865 |
|
2866 | <span class="param-type">*</span>
|
2867 |
|
2868 |
|
2869 |
|
2870 | </dd>
|
2871 | </dl>
|
2872 |
|
2873 |
|
2874 |
|
2875 |
|
2876 |
|
2877 | </dd>
|
2878 |
|
2879 |
|
2880 |
|
2881 | <hr>
|
2882 | <dt>
|
2883 | <h4 class="name" id="getGraphicSpritesIndexById"><span class="type-signature"></span>getGraphicSpritesIndexById<span class="signature">( [id])</span><span class="type-signature"> → {integer}</span></h4>
|
2884 |
|
2885 |
|
2886 | </dt>
|
2887 | <dd>
|
2888 |
|
2889 |
|
2890 | <div class="description">
|
2891 | <p>Gets the index (the position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array) of a desired <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object by its identifier.</p>
|
2892 | </div>
|
2893 |
|
2894 |
|
2895 |
|
2896 |
|
2897 |
|
2898 |
|
2899 |
|
2900 |
|
2901 | <h5>Parameters:</h5>
|
2902 |
|
2903 |
|
2904 | <table class="params table table-striped">
|
2905 | <thead>
|
2906 | <tr>
|
2907 |
|
2908 | <th style="width:12%; min-width:110px;">Name</th>
|
2909 |
|
2910 |
|
2911 | <th style="width:12%; min-width:110px;">Type</th>
|
2912 |
|
2913 |
|
2914 | <th style="width:12%; min-width:110px;">Argument</th>
|
2915 |
|
2916 |
|
2917 |
|
2918 |
|
2919 | <th class="last" style="min-width:310px;">Description</th>
|
2920 | </tr>
|
2921 | </thead>
|
2922 |
|
2923 | <tbody>
|
2924 |
|
2925 |
|
2926 | <tr>
|
2927 |
|
2928 | <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>id</code></td>
|
2929 |
|
2930 |
|
2931 | <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;">
|
2932 |
|
2933 |
|
2934 | <span class="param-type">string</span>
|
2935 | |
|
2936 |
|
2937 | <span class="param-type">*</span>
|
2938 |
|
2939 |
|
2940 |
|
2941 |
|
2942 | </td>
|
2943 |
|
2944 |
|
2945 | <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;">
|
2946 |
|
2947 | <optional><br>
|
2948 |
|
2949 |
|
2950 |
|
2951 |
|
2952 |
|
2953 | </td>
|
2954 |
|
2955 |
|
2956 |
|
2957 |
|
2958 | <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>The identifier of the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object whose index we want to get.</p></td>
|
2959 | </tr>
|
2960 |
|
2961 |
|
2962 | </tbody>
|
2963 | </table>
|
2964 |
|
2965 |
|
2966 |
|
2967 |
|
2968 | <dl class="details">
|
2969 |
|
2970 |
|
2971 |
|
2972 |
|
2973 |
|
2974 |
|
2975 |
|
2976 |
|
2977 |
|
2978 |
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 |
|
2984 |
|
2985 |
|
2986 |
|
2987 |
|
2988 |
|
2989 |
|
2990 |
|
2991 |
|
2992 |
|
2993 |
|
2994 |
|
2995 |
|
2996 |
|
2997 |
|
2998 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2999 | <dd class="tag-source">
|
3000 | <ul class="dummy">
|
3001 | <li>
|
3002 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3003 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-586">line 586</a>
|
3004 | </li>
|
3005 | </ul>
|
3006 | </dd>
|
3007 |
|
3008 |
|
3009 |
|
3010 |
|
3011 |
|
3012 |
|
3013 |
|
3014 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
3015 | <dd class="tag-todo">
|
3016 | <ul>
|
3017 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
3018 | </ul>
|
3019 | </dd>
|
3020 |
|
3021 | </dl>
|
3022 |
|
3023 |
|
3024 |
|
3025 |
|
3026 |
|
3027 |
|
3028 |
|
3029 |
|
3030 |
|
3031 |
|
3032 |
|
3033 |
|
3034 |
|
3035 | <h5>Returns:</h5>
|
3036 |
|
3037 |
|
3038 | <div class="param-desc">
|
3039 | <p>Returns the index (the position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array) of the desired <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object or -1 if not found.</p>
|
3040 | </div>
|
3041 |
|
3042 |
|
3043 |
|
3044 | <dl>
|
3045 | <dt>
|
3046 | Type
|
3047 | </dt>
|
3048 | <dd>
|
3049 |
|
3050 | <span class="param-type">integer</span>
|
3051 |
|
3052 |
|
3053 |
|
3054 | </dd>
|
3055 | </dl>
|
3056 |
|
3057 |
|
3058 |
|
3059 |
|
3060 |
|
3061 | </dd>
|
3062 |
|
3063 |
|
3064 |
|
3065 | <hr>
|
3066 | <dt>
|
3067 | <h4 class="name" id="getIndexById"><span class="type-signature"></span>getIndexById<span class="signature">()</span><span class="type-signature"></span></h4>
|
3068 |
|
3069 |
|
3070 | </dt>
|
3071 | <dd>
|
3072 |
|
3073 |
|
3074 | <div class="description">
|
3075 | <p>Alias for <a href="CB_GraphicSpritesScene.html#getGraphicSpritesIndexById"><code>CB_GraphicSpritesScene#getGraphicSpritesIndexById</code></a>.</p>
|
3076 | </div>
|
3077 |
|
3078 |
|
3079 |
|
3080 |
|
3081 |
|
3082 |
|
3083 |
|
3084 |
|
3085 |
|
3086 |
|
3087 | <dl class="details">
|
3088 |
|
3089 |
|
3090 |
|
3091 |
|
3092 |
|
3093 |
|
3094 |
|
3095 |
|
3096 |
|
3097 |
|
3098 |
|
3099 |
|
3100 |
|
3101 |
|
3102 |
|
3103 |
|
3104 |
|
3105 |
|
3106 |
|
3107 |
|
3108 |
|
3109 |
|
3110 |
|
3111 |
|
3112 |
|
3113 |
|
3114 |
|
3115 |
|
3116 |
|
3117 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3118 | <dd class="tag-source">
|
3119 | <ul class="dummy">
|
3120 | <li>
|
3121 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3122 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-574">line 574</a>
|
3123 | </li>
|
3124 | </ul>
|
3125 | </dd>
|
3126 |
|
3127 |
|
3128 |
|
3129 |
|
3130 |
|
3131 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3132 | <dd class="tag-see">
|
3133 | <ul>
|
3134 | <li><a href="CB_GraphicSpritesScene.html#getGraphicSpritesIndexById"><code>CB_GraphicSpritesScene#getGraphicSpritesIndexById</code></a></li>
|
3135 | </ul>
|
3136 | </dd>
|
3137 |
|
3138 |
|
3139 |
|
3140 | </dl>
|
3141 |
|
3142 |
|
3143 |
|
3144 |
|
3145 |
|
3146 |
|
3147 |
|
3148 |
|
3149 |
|
3150 |
|
3151 |
|
3152 |
|
3153 |
|
3154 |
|
3155 |
|
3156 | </dd>
|
3157 |
|
3158 |
|
3159 |
|
3160 | <hr>
|
3161 | <dt>
|
3162 | <h4 class="name" id="getSpritesGroups"><span class="type-signature"></span>getSpritesGroups<span class="signature">( [returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a>|*}</span></h4>
|
3163 |
|
3164 |
|
3165 | </dt>
|
3166 | <dd>
|
3167 |
|
3168 |
|
3169 | <div class="description">
|
3170 | <p>Gets the sprites groups object (the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object which is in the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> property), if any.</p>
|
3171 | </div>
|
3172 |
|
3173 |
|
3174 |
|
3175 |
|
3176 |
|
3177 |
|
3178 |
|
3179 |
|
3180 | <h5>Parameters:</h5>
|
3181 |
|
3182 |
|
3183 | <table class="params table table-striped">
|
3184 | <thead>
|
3185 | <tr>
|
3186 |
|
3187 | <th style="width:12%; min-width:110px;">Name</th>
|
3188 |
|
3189 |
|
3190 | <th style="width:12%; min-width:110px;">Type</th>
|
3191 |
|
3192 |
|
3193 | <th style="width:12%; min-width:110px;">Argument</th>
|
3194 |
|
3195 |
|
3196 |
|
3197 |
|
3198 | <th class="last" style="min-width:310px;">Description</th>
|
3199 | </tr>
|
3200 | </thead>
|
3201 |
|
3202 | <tbody>
|
3203 |
|
3204 |
|
3205 | <tr>
|
3206 |
|
3207 | <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>returnValueOnFail</code></td>
|
3208 |
|
3209 |
|
3210 | <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;">
|
3211 |
|
3212 |
|
3213 | <span class="param-type">*</span>
|
3214 |
|
3215 |
|
3216 |
|
3217 |
|
3218 | </td>
|
3219 |
|
3220 |
|
3221 | <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;">
|
3222 |
|
3223 | <optional><br>
|
3224 |
|
3225 |
|
3226 |
|
3227 |
|
3228 |
|
3229 | </td>
|
3230 |
|
3231 |
|
3232 |
|
3233 |
|
3234 | <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>The value we want it to return in the case that no value is found. If not provided, undefined will be returned.</p></td>
|
3235 | </tr>
|
3236 |
|
3237 |
|
3238 | </tbody>
|
3239 | </table>
|
3240 |
|
3241 |
|
3242 |
|
3243 |
|
3244 | <dl class="details">
|
3245 |
|
3246 |
|
3247 |
|
3248 |
|
3249 |
|
3250 |
|
3251 |
|
3252 |
|
3253 |
|
3254 |
|
3255 |
|
3256 |
|
3257 |
|
3258 |
|
3259 |
|
3260 |
|
3261 |
|
3262 |
|
3263 |
|
3264 |
|
3265 |
|
3266 |
|
3267 |
|
3268 |
|
3269 |
|
3270 |
|
3271 |
|
3272 |
|
3273 |
|
3274 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3275 | <dd class="tag-source">
|
3276 | <ul class="dummy">
|
3277 | <li>
|
3278 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3279 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-499">line 499</a>
|
3280 | </li>
|
3281 | </ul>
|
3282 | </dd>
|
3283 |
|
3284 |
|
3285 |
|
3286 |
|
3287 |
|
3288 |
|
3289 |
|
3290 | </dl>
|
3291 |
|
3292 |
|
3293 |
|
3294 |
|
3295 |
|
3296 |
|
3297 |
|
3298 |
|
3299 |
|
3300 |
|
3301 |
|
3302 |
|
3303 |
|
3304 | <h5>Returns:</h5>
|
3305 |
|
3306 |
|
3307 | <div class="param-desc">
|
3308 | <p>Returns the sprites groups object (the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object which is in the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> property), if any, or the value of "returnValueOnFail" otherwise.</p>
|
3309 | </div>
|
3310 |
|
3311 |
|
3312 |
|
3313 | <dl>
|
3314 | <dt>
|
3315 | Type
|
3316 | </dt>
|
3317 | <dd>
|
3318 |
|
3319 | <span class="param-type"><a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a></span>
|
3320 | |
|
3321 |
|
3322 | <span class="param-type">*</span>
|
3323 |
|
3324 |
|
3325 |
|
3326 | </dd>
|
3327 | </dl>
|
3328 |
|
3329 |
|
3330 |
|
3331 |
|
3332 |
|
3333 | </dd>
|
3334 |
|
3335 |
|
3336 |
|
3337 | <hr>
|
3338 | <dt>
|
3339 | <h4 class="name" id="getSpritesGroupsAll"><span class="type-signature"></span>getSpritesGroupsAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
3340 |
|
3341 |
|
3342 | </dt>
|
3343 | <dd>
|
3344 |
|
3345 |
|
3346 | <div class="description">
|
3347 | <p>Alias for <a href="CB_GraphicSpritesScene.html#getSpritesGroups"><code>CB_GraphicSpritesScene#getSpritesGroups</code></a>.</p>
|
3348 | </div>
|
3349 |
|
3350 |
|
3351 |
|
3352 |
|
3353 |
|
3354 |
|
3355 |
|
3356 |
|
3357 |
|
3358 |
|
3359 | <dl class="details">
|
3360 |
|
3361 |
|
3362 |
|
3363 |
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 |
|
3375 |
|
3376 |
|
3377 |
|
3378 |
|
3379 |
|
3380 |
|
3381 |
|
3382 |
|
3383 |
|
3384 |
|
3385 |
|
3386 |
|
3387 |
|
3388 |
|
3389 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3390 | <dd class="tag-source">
|
3391 | <ul class="dummy">
|
3392 | <li>
|
3393 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3394 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-488">line 488</a>
|
3395 | </li>
|
3396 | </ul>
|
3397 | </dd>
|
3398 |
|
3399 |
|
3400 |
|
3401 |
|
3402 |
|
3403 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3404 | <dd class="tag-see">
|
3405 | <ul>
|
3406 | <li><a href="CB_GraphicSpritesScene.html#getSpritesGroups"><code>CB_GraphicSpritesScene#getSpritesGroups</code></a></li>
|
3407 | </ul>
|
3408 | </dd>
|
3409 |
|
3410 |
|
3411 |
|
3412 | </dl>
|
3413 |
|
3414 |
|
3415 |
|
3416 |
|
3417 |
|
3418 |
|
3419 |
|
3420 |
|
3421 |
|
3422 |
|
3423 |
|
3424 |
|
3425 |
|
3426 |
|
3427 |
|
3428 | </dd>
|
3429 |
|
3430 |
|
3431 |
|
3432 | <hr>
|
3433 | <dt>
|
3434 | <h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">()</span><span class="type-signature"></span></h4>
|
3435 |
|
3436 |
|
3437 | </dt>
|
3438 | <dd>
|
3439 |
|
3440 |
|
3441 | <div class="description">
|
3442 | <p>Alias for <a href="CB_GraphicSpritesScene.html#insertSpritesGroup"><code>CB_GraphicSpritesScene#insertSpritesGroup</code></a>.</p>
|
3443 | </div>
|
3444 |
|
3445 |
|
3446 |
|
3447 |
|
3448 |
|
3449 |
|
3450 |
|
3451 |
|
3452 |
|
3453 |
|
3454 | <dl class="details">
|
3455 |
|
3456 |
|
3457 |
|
3458 |
|
3459 |
|
3460 |
|
3461 |
|
3462 |
|
3463 |
|
3464 |
|
3465 |
|
3466 |
|
3467 |
|
3468 |
|
3469 |
|
3470 |
|
3471 |
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 |
|
3479 |
|
3480 |
|
3481 |
|
3482 |
|
3483 |
|
3484 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3485 | <dd class="tag-source">
|
3486 | <ul class="dummy">
|
3487 | <li>
|
3488 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3489 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-397">line 397</a>
|
3490 | </li>
|
3491 | </ul>
|
3492 | </dd>
|
3493 |
|
3494 |
|
3495 |
|
3496 |
|
3497 |
|
3498 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3499 | <dd class="tag-see">
|
3500 | <ul>
|
3501 | <li><a href="CB_GraphicSpritesScene.html#insertSpritesGroup"><code>CB_GraphicSpritesScene#insertSpritesGroup</code></a></li>
|
3502 | </ul>
|
3503 | </dd>
|
3504 |
|
3505 |
|
3506 |
|
3507 | </dl>
|
3508 |
|
3509 |
|
3510 |
|
3511 |
|
3512 |
|
3513 |
|
3514 |
|
3515 |
|
3516 |
|
3517 |
|
3518 |
|
3519 |
|
3520 |
|
3521 |
|
3522 |
|
3523 | </dd>
|
3524 |
|
3525 |
|
3526 |
|
3527 | <hr>
|
3528 | <dt>
|
3529 | <h4 class="name" id="insertSpritesGroup"><span class="type-signature"></span>insertSpritesGroup<span class="signature">( [spritesGroup] [, avoidUpdatingGraphicSpritesByZIndex] [, byReference])</span><span class="type-signature"> → {<a href="CB_GraphicSpritesScene.html#.insertSpritesGroup_OBJECT">CB_GraphicSpritesScene.insertSpritesGroup_OBJECT</a>}</span></h4>
|
3530 |
|
3531 |
|
3532 | </dt>
|
3533 | <dd>
|
3534 |
|
3535 |
|
3536 | <div class="description">
|
3537 | <p>Adds the desired group of graphic sprites. Creates internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p>
|
3538 | </div>
|
3539 |
|
3540 |
|
3541 |
|
3542 |
|
3543 |
|
3544 |
|
3545 |
|
3546 |
|
3547 | <h5>Parameters:</h5>
|
3548 |
|
3549 |
|
3550 | <table class="params table table-striped">
|
3551 | <thead>
|
3552 | <tr>
|
3553 |
|
3554 | <th style="width:12%; min-width:110px;">Name</th>
|
3555 |
|
3556 |
|
3557 | <th style="width:12%; min-width:110px;">Type</th>
|
3558 |
|
3559 |
|
3560 | <th style="width:12%; min-width:110px;">Argument</th>
|
3561 |
|
3562 |
|
3563 |
|
3564 | <th style="width:12%; min-width:110px;">Default</th>
|
3565 |
|
3566 |
|
3567 | <th class="last" style="min-width:310px;">Description</th>
|
3568 | </tr>
|
3569 | </thead>
|
3570 |
|
3571 | <tbody>
|
3572 |
|
3573 |
|
3574 | <tr>
|
3575 |
|
3576 | <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>
|
3577 |
|
3578 |
|
3579 | <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;">
|
3580 |
|
3581 |
|
3582 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
3583 |
|
3584 |
|
3585 |
|
3586 |
|
3587 | </td>
|
3588 |
|
3589 |
|
3590 | <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;">
|
3591 |
|
3592 | <optional><br>
|
3593 |
|
3594 |
|
3595 |
|
3596 |
|
3597 |
|
3598 | </td>
|
3599 |
|
3600 |
|
3601 |
|
3602 | <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;">
|
3603 |
|
3604 | </td>
|
3605 |
|
3606 |
|
3607 | <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 group. It will be stored in the "<a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a>.spritesGroups" property and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object created internally will be stored in the "<a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a>.items" property.</p></td>
|
3608 | </tr>
|
3609 |
|
3610 |
|
3611 |
|
3612 | <tr>
|
3613 |
|
3614 | <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>avoidUpdatingGraphicSpritesByZIndex</code></td>
|
3615 |
|
3616 |
|
3617 | <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;">
|
3618 |
|
3619 |
|
3620 | <span class="param-type">boolean</span>
|
3621 |
|
3622 |
|
3623 |
|
3624 |
|
3625 | </td>
|
3626 |
|
3627 |
|
3628 | <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;">
|
3629 |
|
3630 | <optional><br>
|
3631 |
|
3632 |
|
3633 |
|
3634 |
|
3635 |
|
3636 | </td>
|
3637 |
|
3638 |
|
3639 |
|
3640 | <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;">
|
3641 |
|
3642 | false
|
3643 |
|
3644 | </td>
|
3645 |
|
3646 |
|
3647 | <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 not call the {CB_GraphicSpritesScene#updateGraphicSpritesByZIndex} method internally. Internal usage recommended only.</p></td>
|
3648 | </tr>
|
3649 |
|
3650 |
|
3651 |
|
3652 | <tr>
|
3653 |
|
3654 | <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>
|
3655 |
|
3656 |
|
3657 | <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;">
|
3658 |
|
3659 |
|
3660 | <span class="param-type">boolean</span>
|
3661 |
|
3662 |
|
3663 |
|
3664 |
|
3665 | </td>
|
3666 |
|
3667 |
|
3668 | <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;">
|
3669 |
|
3670 | <optional><br>
|
3671 |
|
3672 |
|
3673 |
|
3674 |
|
3675 |
|
3676 | </td>
|
3677 |
|
3678 |
|
3679 |
|
3680 | <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;">
|
3681 |
|
3682 | false
|
3683 |
|
3684 | </td>
|
3685 |
|
3686 |
|
3687 | <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 "byReference" parameter of the constructor when creating the new internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
3688 | </tr>
|
3689 |
|
3690 |
|
3691 | </tbody>
|
3692 | </table>
|
3693 |
|
3694 |
|
3695 |
|
3696 |
|
3697 | <dl class="details">
|
3698 |
|
3699 |
|
3700 |
|
3701 |
|
3702 |
|
3703 |
|
3704 |
|
3705 |
|
3706 |
|
3707 |
|
3708 |
|
3709 |
|
3710 |
|
3711 |
|
3712 |
|
3713 |
|
3714 |
|
3715 |
|
3716 |
|
3717 |
|
3718 |
|
3719 |
|
3720 |
|
3721 |
|
3722 |
|
3723 |
|
3724 |
|
3725 |
|
3726 |
|
3727 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3728 | <dd class="tag-source">
|
3729 | <ul class="dummy">
|
3730 | <li>
|
3731 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3732 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-410">line 410</a>
|
3733 | </li>
|
3734 | </ul>
|
3735 | </dd>
|
3736 |
|
3737 |
|
3738 |
|
3739 |
|
3740 |
|
3741 |
|
3742 |
|
3743 | </dl>
|
3744 |
|
3745 |
|
3746 |
|
3747 |
|
3748 |
|
3749 |
|
3750 |
|
3751 |
|
3752 |
|
3753 |
|
3754 |
|
3755 |
|
3756 |
|
3757 | <h5>Returns:</h5>
|
3758 |
|
3759 |
|
3760 | <div class="param-desc">
|
3761 | <p>Returns an object whose "spritesGroup" property contains the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> which has been inserted (it could have been modified/sanitized from the given one and some missing properties or those which were wrong could have been inherited) and was used to create the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object when calling its constructor and the "item" property contains the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object created and inserted.</p>
|
3762 | </div>
|
3763 |
|
3764 |
|
3765 |
|
3766 | <dl>
|
3767 | <dt>
|
3768 | Type
|
3769 | </dt>
|
3770 | <dd>
|
3771 |
|
3772 | <span class="param-type"><a href="CB_GraphicSpritesScene.html#.insertSpritesGroup_OBJECT">CB_GraphicSpritesScene.insertSpritesGroup_OBJECT</a></span>
|
3773 |
|
3774 |
|
3775 |
|
3776 | </dd>
|
3777 | </dl>
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 | </dd>
|
3784 |
|
3785 |
|
3786 |
|
3787 | <hr>
|
3788 | <dt>
|
3789 | <h4 class="name" id="insertSpritesGroups"><span class="type-signature"></span>insertSpritesGroups<span class="signature">( [spritesGroups] [, byReference])</span><span class="type-signature"> → {<a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a>}</span></h4>
|
3790 |
|
3791 |
|
3792 | </dt>
|
3793 | <dd>
|
3794 |
|
3795 |
|
3796 | <div class="description">
|
3797 | <p>Adds the desired groups of graphic sprites. Calls the <a href="CB_GraphicSpritesScene.html#insertSpritesGroup"><code>CB_GraphicSpritesScene#insertSpritesGroup</code></a> and <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> methods internally.</p>
|
3798 | </div>
|
3799 |
|
3800 |
|
3801 |
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 |
|
3807 | <h5>Parameters:</h5>
|
3808 |
|
3809 |
|
3810 | <table class="params table table-striped">
|
3811 | <thead>
|
3812 | <tr>
|
3813 |
|
3814 | <th style="width:12%; min-width:110px;">Name</th>
|
3815 |
|
3816 |
|
3817 | <th style="width:12%; min-width:110px;">Type</th>
|
3818 |
|
3819 |
|
3820 | <th style="width:12%; min-width:110px;">Argument</th>
|
3821 |
|
3822 |
|
3823 |
|
3824 | <th style="width:12%; min-width:110px;">Default</th>
|
3825 |
|
3826 |
|
3827 | <th class="last" style="min-width:310px;">Description</th>
|
3828 | </tr>
|
3829 | </thead>
|
3830 |
|
3831 | <tbody>
|
3832 |
|
3833 |
|
3834 | <tr>
|
3835 |
|
3836 | <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>
|
3837 |
|
3838 |
|
3839 | <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;">
|
3840 |
|
3841 |
|
3842 | <span class="param-type"><a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a></span>
|
3843 |
|
3844 |
|
3845 |
|
3846 |
|
3847 | </td>
|
3848 |
|
3849 |
|
3850 | <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;">
|
3851 |
|
3852 | <optional><br>
|
3853 |
|
3854 |
|
3855 |
|
3856 |
|
3857 |
|
3858 | </td>
|
3859 |
|
3860 |
|
3861 |
|
3862 | <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;">
|
3863 |
|
3864 | </td>
|
3865 |
|
3866 |
|
3867 | <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 groups. They will be stored in the "<a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a>.spritesGroups" property and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects created internally will be stored in the "<a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a>.items" property.</p></td>
|
3868 | </tr>
|
3869 |
|
3870 |
|
3871 |
|
3872 | <tr>
|
3873 |
|
3874 | <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>
|
3875 |
|
3876 |
|
3877 | <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;">
|
3878 |
|
3879 |
|
3880 | <span class="param-type">boolean</span>
|
3881 |
|
3882 |
|
3883 |
|
3884 |
|
3885 | </td>
|
3886 |
|
3887 |
|
3888 | <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;">
|
3889 |
|
3890 | <optional><br>
|
3891 |
|
3892 |
|
3893 |
|
3894 |
|
3895 |
|
3896 | </td>
|
3897 |
|
3898 |
|
3899 |
|
3900 | <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;">
|
3901 |
|
3902 | !!<code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT.byReference_DEFAULT</code>
|
3903 |
|
3904 | </td>
|
3905 |
|
3906 |
|
3907 | <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 "byReference" 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>
|
3908 | </tr>
|
3909 |
|
3910 |
|
3911 | </tbody>
|
3912 | </table>
|
3913 |
|
3914 |
|
3915 |
|
3916 |
|
3917 | <dl class="details">
|
3918 |
|
3919 |
|
3920 |
|
3921 |
|
3922 |
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 |
|
3928 |
|
3929 |
|
3930 |
|
3931 |
|
3932 |
|
3933 |
|
3934 |
|
3935 |
|
3936 |
|
3937 |
|
3938 |
|
3939 |
|
3940 |
|
3941 |
|
3942 |
|
3943 |
|
3944 |
|
3945 |
|
3946 |
|
3947 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3948 | <dd class="tag-source">
|
3949 | <ul class="dummy">
|
3950 | <li>
|
3951 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
3952 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-238">line 238</a>
|
3953 | </li>
|
3954 | </ul>
|
3955 | </dd>
|
3956 |
|
3957 |
|
3958 |
|
3959 |
|
3960 |
|
3961 |
|
3962 |
|
3963 | </dl>
|
3964 |
|
3965 |
|
3966 |
|
3967 |
|
3968 |
|
3969 |
|
3970 |
|
3971 |
|
3972 |
|
3973 |
|
3974 |
|
3975 |
|
3976 |
|
3977 | <h5>Returns:</h5>
|
3978 |
|
3979 |
|
3980 | <div class="param-desc">
|
3981 | <p>Returns the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> property after updating it.</p>
|
3982 | </div>
|
3983 |
|
3984 |
|
3985 |
|
3986 | <dl>
|
3987 | <dt>
|
3988 | Type
|
3989 | </dt>
|
3990 | <dd>
|
3991 |
|
3992 | <span class="param-type"><a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT">CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</a></span>
|
3993 |
|
3994 |
|
3995 |
|
3996 | </dd>
|
3997 | </dl>
|
3998 |
|
3999 |
|
4000 |
|
4001 |
|
4002 |
|
4003 | </dd>
|
4004 |
|
4005 |
|
4006 |
|
4007 | <hr>
|
4008 | <dt>
|
4009 | <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">()</span><span class="type-signature"></span></h4>
|
4010 |
|
4011 |
|
4012 | </dt>
|
4013 | <dd>
|
4014 |
|
4015 |
|
4016 | <div class="description">
|
4017 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroup"><code>CB_GraphicSpritesScene#removeSpritesGroup</code></a>.</p>
|
4018 | </div>
|
4019 |
|
4020 |
|
4021 |
|
4022 |
|
4023 |
|
4024 |
|
4025 |
|
4026 |
|
4027 |
|
4028 |
|
4029 | <dl class="details">
|
4030 |
|
4031 |
|
4032 |
|
4033 |
|
4034 |
|
4035 |
|
4036 |
|
4037 |
|
4038 |
|
4039 |
|
4040 |
|
4041 |
|
4042 |
|
4043 |
|
4044 |
|
4045 |
|
4046 |
|
4047 |
|
4048 |
|
4049 |
|
4050 |
|
4051 |
|
4052 |
|
4053 |
|
4054 |
|
4055 |
|
4056 |
|
4057 |
|
4058 |
|
4059 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4060 | <dd class="tag-source">
|
4061 | <ul class="dummy">
|
4062 | <li>
|
4063 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4064 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-323">line 323</a>
|
4065 | </li>
|
4066 | </ul>
|
4067 | </dd>
|
4068 |
|
4069 |
|
4070 |
|
4071 |
|
4072 |
|
4073 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4074 | <dd class="tag-see">
|
4075 | <ul>
|
4076 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroup"><code>CB_GraphicSpritesScene#removeSpritesGroup</code></a></li>
|
4077 | </ul>
|
4078 | </dd>
|
4079 |
|
4080 |
|
4081 |
|
4082 | </dl>
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 |
|
4088 |
|
4089 |
|
4090 |
|
4091 |
|
4092 |
|
4093 |
|
4094 |
|
4095 |
|
4096 |
|
4097 |
|
4098 | </dd>
|
4099 |
|
4100 |
|
4101 |
|
4102 | <hr>
|
4103 | <dt>
|
4104 | <h4 class="name" id="removeAll"><span class="type-signature"></span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
4105 |
|
4106 |
|
4107 | </dt>
|
4108 | <dd>
|
4109 |
|
4110 |
|
4111 | <div class="description">
|
4112 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroups"><code>CB_GraphicSpritesScene#removeSpritesGroups</code></a>.</p>
|
4113 | </div>
|
4114 |
|
4115 |
|
4116 |
|
4117 |
|
4118 |
|
4119 |
|
4120 |
|
4121 |
|
4122 |
|
4123 |
|
4124 | <dl class="details">
|
4125 |
|
4126 |
|
4127 |
|
4128 |
|
4129 |
|
4130 |
|
4131 |
|
4132 |
|
4133 |
|
4134 |
|
4135 |
|
4136 |
|
4137 |
|
4138 |
|
4139 |
|
4140 |
|
4141 |
|
4142 |
|
4143 |
|
4144 |
|
4145 |
|
4146 |
|
4147 |
|
4148 |
|
4149 |
|
4150 |
|
4151 |
|
4152 |
|
4153 |
|
4154 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4155 | <dd class="tag-source">
|
4156 | <ul class="dummy">
|
4157 | <li>
|
4158 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4159 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-211">line 211</a>
|
4160 | </li>
|
4161 | </ul>
|
4162 | </dd>
|
4163 |
|
4164 |
|
4165 |
|
4166 |
|
4167 |
|
4168 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4169 | <dd class="tag-see">
|
4170 | <ul>
|
4171 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroups"><code>CB_GraphicSpritesScene#removeSpritesGroups</code></a></li>
|
4172 | </ul>
|
4173 | </dd>
|
4174 |
|
4175 |
|
4176 |
|
4177 | </dl>
|
4178 |
|
4179 |
|
4180 |
|
4181 |
|
4182 |
|
4183 |
|
4184 |
|
4185 |
|
4186 |
|
4187 |
|
4188 |
|
4189 |
|
4190 |
|
4191 |
|
4192 |
|
4193 | </dd>
|
4194 |
|
4195 |
|
4196 |
|
4197 | <hr>
|
4198 | <dt>
|
4199 | <h4 class="name" id="removeById"><span class="type-signature"></span>removeById<span class="signature">()</span><span class="type-signature"></span></h4>
|
4200 |
|
4201 |
|
4202 | </dt>
|
4203 | <dd>
|
4204 |
|
4205 |
|
4206 | <div class="description">
|
4207 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroupById"><code>CB_GraphicSpritesScene#removeSpritesGroupById</code></a>.</p>
|
4208 | </div>
|
4209 |
|
4210 |
|
4211 |
|
4212 |
|
4213 |
|
4214 |
|
4215 |
|
4216 |
|
4217 |
|
4218 |
|
4219 | <dl class="details">
|
4220 |
|
4221 |
|
4222 |
|
4223 |
|
4224 |
|
4225 |
|
4226 |
|
4227 |
|
4228 |
|
4229 |
|
4230 |
|
4231 |
|
4232 |
|
4233 |
|
4234 |
|
4235 |
|
4236 |
|
4237 |
|
4238 |
|
4239 |
|
4240 |
|
4241 |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4250 | <dd class="tag-source">
|
4251 | <ul class="dummy">
|
4252 | <li>
|
4253 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4254 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-355">line 355</a>
|
4255 | </li>
|
4256 | </ul>
|
4257 | </dd>
|
4258 |
|
4259 |
|
4260 |
|
4261 |
|
4262 |
|
4263 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4264 | <dd class="tag-see">
|
4265 | <ul>
|
4266 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroupById"><code>CB_GraphicSpritesScene#removeSpritesGroupById</code></a></li>
|
4267 | </ul>
|
4268 | </dd>
|
4269 |
|
4270 |
|
4271 |
|
4272 | </dl>
|
4273 |
|
4274 |
|
4275 |
|
4276 |
|
4277 |
|
4278 |
|
4279 |
|
4280 |
|
4281 |
|
4282 |
|
4283 |
|
4284 |
|
4285 |
|
4286 |
|
4287 |
|
4288 | </dd>
|
4289 |
|
4290 |
|
4291 |
|
4292 | <hr>
|
4293 | <dt>
|
4294 | <h4 class="name" id="removeGraphicSprites"><span class="type-signature"></span>removeGraphicSprites<span class="signature">()</span><span class="type-signature"></span></h4>
|
4295 |
|
4296 |
|
4297 | </dt>
|
4298 | <dd>
|
4299 |
|
4300 |
|
4301 | <div class="description">
|
4302 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroup"><code>CB_GraphicSpritesScene#removeSpritesGroup</code></a>.</p>
|
4303 | </div>
|
4304 |
|
4305 |
|
4306 |
|
4307 |
|
4308 |
|
4309 |
|
4310 |
|
4311 |
|
4312 |
|
4313 |
|
4314 | <dl class="details">
|
4315 |
|
4316 |
|
4317 |
|
4318 |
|
4319 |
|
4320 |
|
4321 |
|
4322 |
|
4323 |
|
4324 |
|
4325 |
|
4326 |
|
4327 |
|
4328 |
|
4329 |
|
4330 |
|
4331 |
|
4332 |
|
4333 |
|
4334 |
|
4335 |
|
4336 |
|
4337 |
|
4338 |
|
4339 |
|
4340 |
|
4341 |
|
4342 |
|
4343 |
|
4344 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4345 | <dd class="tag-source">
|
4346 | <ul class="dummy">
|
4347 | <li>
|
4348 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4349 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-328">line 328</a>
|
4350 | </li>
|
4351 | </ul>
|
4352 | </dd>
|
4353 |
|
4354 |
|
4355 |
|
4356 |
|
4357 |
|
4358 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4359 | <dd class="tag-see">
|
4360 | <ul>
|
4361 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroup"><code>CB_GraphicSpritesScene#removeSpritesGroup</code></a></li>
|
4362 | </ul>
|
4363 | </dd>
|
4364 |
|
4365 |
|
4366 |
|
4367 | </dl>
|
4368 |
|
4369 |
|
4370 |
|
4371 |
|
4372 |
|
4373 |
|
4374 |
|
4375 |
|
4376 |
|
4377 |
|
4378 |
|
4379 |
|
4380 |
|
4381 |
|
4382 |
|
4383 | </dd>
|
4384 |
|
4385 |
|
4386 |
|
4387 | <hr>
|
4388 | <dt>
|
4389 | <h4 class="name" id="removeGraphicSpritesById"><span class="type-signature"></span>removeGraphicSpritesById<span class="signature">()</span><span class="type-signature"></span></h4>
|
4390 |
|
4391 |
|
4392 | </dt>
|
4393 | <dd>
|
4394 |
|
4395 |
|
4396 | <div class="description">
|
4397 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroupById"><code>CB_GraphicSpritesScene#removeSpritesGroupById</code></a>.</p>
|
4398 | </div>
|
4399 |
|
4400 |
|
4401 |
|
4402 |
|
4403 |
|
4404 |
|
4405 |
|
4406 |
|
4407 |
|
4408 |
|
4409 | <dl class="details">
|
4410 |
|
4411 |
|
4412 |
|
4413 |
|
4414 |
|
4415 |
|
4416 |
|
4417 |
|
4418 |
|
4419 |
|
4420 |
|
4421 |
|
4422 |
|
4423 |
|
4424 |
|
4425 |
|
4426 |
|
4427 |
|
4428 |
|
4429 |
|
4430 |
|
4431 |
|
4432 |
|
4433 |
|
4434 |
|
4435 |
|
4436 |
|
4437 |
|
4438 |
|
4439 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4440 | <dd class="tag-source">
|
4441 | <ul class="dummy">
|
4442 | <li>
|
4443 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4444 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-360">line 360</a>
|
4445 | </li>
|
4446 | </ul>
|
4447 | </dd>
|
4448 |
|
4449 |
|
4450 |
|
4451 |
|
4452 |
|
4453 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4454 | <dd class="tag-see">
|
4455 | <ul>
|
4456 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroupById"><code>CB_GraphicSpritesScene#removeSpritesGroupById</code></a></li>
|
4457 | </ul>
|
4458 | </dd>
|
4459 |
|
4460 |
|
4461 |
|
4462 | </dl>
|
4463 |
|
4464 |
|
4465 |
|
4466 |
|
4467 |
|
4468 |
|
4469 |
|
4470 |
|
4471 |
|
4472 |
|
4473 |
|
4474 |
|
4475 |
|
4476 |
|
4477 |
|
4478 | </dd>
|
4479 |
|
4480 |
|
4481 |
|
4482 | <hr>
|
4483 | <dt>
|
4484 | <h4 class="name" id="removeSpritesGroup"><span class="type-signature"></span>removeSpritesGroup<span class="signature">( [index])</span><span class="type-signature"> → {boolean}</span></h4>
|
4485 |
|
4486 |
|
4487 | </dt>
|
4488 | <dd>
|
4489 |
|
4490 |
|
4491 | <div class="description">
|
4492 | <p>Removes a sprites group and its <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object by its index (its position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array). Calls the <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally.</p>
|
4493 | </div>
|
4494 |
|
4495 |
|
4496 |
|
4497 |
|
4498 |
|
4499 |
|
4500 |
|
4501 |
|
4502 | <h5>Parameters:</h5>
|
4503 |
|
4504 |
|
4505 | <table class="params table table-striped">
|
4506 | <thead>
|
4507 | <tr>
|
4508 |
|
4509 | <th style="width:12%; min-width:110px;">Name</th>
|
4510 |
|
4511 |
|
4512 | <th style="width:12%; min-width:110px;">Type</th>
|
4513 |
|
4514 |
|
4515 | <th style="width:12%; min-width:110px;">Argument</th>
|
4516 |
|
4517 |
|
4518 |
|
4519 | <th style="width:12%; min-width:110px;">Default</th>
|
4520 |
|
4521 |
|
4522 | <th class="last" style="min-width:310px;">Description</th>
|
4523 | </tr>
|
4524 | </thead>
|
4525 |
|
4526 | <tbody>
|
4527 |
|
4528 |
|
4529 | <tr>
|
4530 |
|
4531 | <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>index</code></td>
|
4532 |
|
4533 |
|
4534 | <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;">
|
4535 |
|
4536 |
|
4537 | <span class="param-type">integer</span>
|
4538 |
|
4539 |
|
4540 |
|
4541 |
|
4542 | </td>
|
4543 |
|
4544 |
|
4545 | <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;">
|
4546 |
|
4547 | <optional><br>
|
4548 |
|
4549 |
|
4550 |
|
4551 |
|
4552 |
|
4553 | </td>
|
4554 |
|
4555 |
|
4556 |
|
4557 | <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;">
|
4558 |
|
4559 | 0
|
4560 |
|
4561 | </td>
|
4562 |
|
4563 |
|
4564 | <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>The index where the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object is located (its position in the <code>CB_GraphicSpritesScene#spritesGroups.items</code> array).</p></td>
|
4565 | </tr>
|
4566 |
|
4567 |
|
4568 | </tbody>
|
4569 | </table>
|
4570 |
|
4571 |
|
4572 |
|
4573 |
|
4574 | <dl class="details">
|
4575 |
|
4576 |
|
4577 |
|
4578 |
|
4579 |
|
4580 |
|
4581 |
|
4582 |
|
4583 |
|
4584 |
|
4585 |
|
4586 |
|
4587 |
|
4588 |
|
4589 |
|
4590 |
|
4591 |
|
4592 |
|
4593 |
|
4594 |
|
4595 |
|
4596 |
|
4597 |
|
4598 |
|
4599 |
|
4600 |
|
4601 |
|
4602 |
|
4603 |
|
4604 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4605 | <dd class="tag-source">
|
4606 | <ul class="dummy">
|
4607 | <li>
|
4608 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4609 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-339">line 339</a>
|
4610 | </li>
|
4611 | </ul>
|
4612 | </dd>
|
4613 |
|
4614 |
|
4615 |
|
4616 |
|
4617 |
|
4618 |
|
4619 |
|
4620 | </dl>
|
4621 |
|
4622 |
|
4623 |
|
4624 |
|
4625 |
|
4626 |
|
4627 |
|
4628 |
|
4629 |
|
4630 |
|
4631 |
|
4632 |
|
4633 |
|
4634 | <h5>Returns:</h5>
|
4635 |
|
4636 |
|
4637 | <div class="param-desc">
|
4638 | <p>Returns true if the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object has been deleted from the graphic sprites scene object or false otherwise.</p>
|
4639 | </div>
|
4640 |
|
4641 |
|
4642 |
|
4643 | <dl>
|
4644 | <dt>
|
4645 | Type
|
4646 | </dt>
|
4647 | <dd>
|
4648 |
|
4649 | <span class="param-type">boolean</span>
|
4650 |
|
4651 |
|
4652 |
|
4653 | </dd>
|
4654 | </dl>
|
4655 |
|
4656 |
|
4657 |
|
4658 |
|
4659 |
|
4660 | </dd>
|
4661 |
|
4662 |
|
4663 |
|
4664 | <hr>
|
4665 | <dt>
|
4666 | <h4 class="name" id="removeSpritesGroupById"><span class="type-signature"></span>removeSpritesGroupById<span class="signature">( [id])</span><span class="type-signature"> → {boolean}</span></h4>
|
4667 |
|
4668 |
|
4669 | </dt>
|
4670 | <dd>
|
4671 |
|
4672 |
|
4673 | <div class="description">
|
4674 | <p>Removes a sprites group and its <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object by its identifier. Calls the <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally.</p>
|
4675 | </div>
|
4676 |
|
4677 |
|
4678 |
|
4679 |
|
4680 |
|
4681 |
|
4682 |
|
4683 |
|
4684 | <h5>Parameters:</h5>
|
4685 |
|
4686 |
|
4687 | <table class="params table table-striped">
|
4688 | <thead>
|
4689 | <tr>
|
4690 |
|
4691 | <th style="width:12%; min-width:110px;">Name</th>
|
4692 |
|
4693 |
|
4694 | <th style="width:12%; min-width:110px;">Type</th>
|
4695 |
|
4696 |
|
4697 | <th style="width:12%; min-width:110px;">Argument</th>
|
4698 |
|
4699 |
|
4700 |
|
4701 |
|
4702 | <th class="last" style="min-width:310px;">Description</th>
|
4703 | </tr>
|
4704 | </thead>
|
4705 |
|
4706 | <tbody>
|
4707 |
|
4708 |
|
4709 | <tr>
|
4710 |
|
4711 | <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>id</code></td>
|
4712 |
|
4713 |
|
4714 | <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;">
|
4715 |
|
4716 |
|
4717 | <span class="param-type">string</span>
|
4718 | |
|
4719 |
|
4720 | <span class="param-type">*</span>
|
4721 |
|
4722 |
|
4723 |
|
4724 |
|
4725 | </td>
|
4726 |
|
4727 |
|
4728 | <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;">
|
4729 |
|
4730 | <optional><br>
|
4731 |
|
4732 |
|
4733 |
|
4734 |
|
4735 |
|
4736 | </td>
|
4737 |
|
4738 |
|
4739 |
|
4740 |
|
4741 | <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>The identifier of the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object.</p></td>
|
4742 | </tr>
|
4743 |
|
4744 |
|
4745 | </tbody>
|
4746 | </table>
|
4747 |
|
4748 |
|
4749 |
|
4750 |
|
4751 | <dl class="details">
|
4752 |
|
4753 |
|
4754 |
|
4755 |
|
4756 |
|
4757 |
|
4758 |
|
4759 |
|
4760 |
|
4761 |
|
4762 |
|
4763 |
|
4764 |
|
4765 |
|
4766 |
|
4767 |
|
4768 |
|
4769 |
|
4770 |
|
4771 |
|
4772 |
|
4773 |
|
4774 |
|
4775 |
|
4776 |
|
4777 |
|
4778 |
|
4779 |
|
4780 |
|
4781 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4782 | <dd class="tag-source">
|
4783 | <ul class="dummy">
|
4784 | <li>
|
4785 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4786 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-372">line 372</a>
|
4787 | </li>
|
4788 | </ul>
|
4789 | </dd>
|
4790 |
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 |
|
4797 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
4798 | <dd class="tag-todo">
|
4799 | <ul>
|
4800 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
4801 | </ul>
|
4802 | </dd>
|
4803 |
|
4804 | </dl>
|
4805 |
|
4806 |
|
4807 |
|
4808 |
|
4809 |
|
4810 |
|
4811 |
|
4812 |
|
4813 |
|
4814 |
|
4815 |
|
4816 |
|
4817 |
|
4818 | <h5>Returns:</h5>
|
4819 |
|
4820 |
|
4821 | <div class="param-desc">
|
4822 | <p>Returns true if the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object has been deleted from the graphic sprites scene object or false otherwise.</p>
|
4823 | </div>
|
4824 |
|
4825 |
|
4826 |
|
4827 | <dl>
|
4828 | <dt>
|
4829 | Type
|
4830 | </dt>
|
4831 | <dd>
|
4832 |
|
4833 | <span class="param-type">boolean</span>
|
4834 |
|
4835 |
|
4836 |
|
4837 | </dd>
|
4838 | </dl>
|
4839 |
|
4840 |
|
4841 |
|
4842 |
|
4843 |
|
4844 | </dd>
|
4845 |
|
4846 |
|
4847 |
|
4848 | <hr>
|
4849 | <dt>
|
4850 | <h4 class="name" id="removeSpritesGroups"><span class="type-signature"></span>removeSpritesGroups<span class="signature">()</span><span class="type-signature"></span></h4>
|
4851 |
|
4852 |
|
4853 | </dt>
|
4854 | <dd>
|
4855 |
|
4856 |
|
4857 | <div class="description">
|
4858 | <p>Removes all the sprites groups (and all the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects) by clearing the <code>CB_GraphicSprites#spritesGroups</code> property.</p>
|
4859 | </div>
|
4860 |
|
4861 |
|
4862 |
|
4863 |
|
4864 |
|
4865 |
|
4866 |
|
4867 |
|
4868 |
|
4869 |
|
4870 | <dl class="details">
|
4871 |
|
4872 |
|
4873 |
|
4874 |
|
4875 |
|
4876 |
|
4877 |
|
4878 |
|
4879 |
|
4880 |
|
4881 |
|
4882 |
|
4883 |
|
4884 |
|
4885 |
|
4886 |
|
4887 |
|
4888 |
|
4889 |
|
4890 |
|
4891 |
|
4892 |
|
4893 |
|
4894 |
|
4895 |
|
4896 |
|
4897 |
|
4898 |
|
4899 |
|
4900 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4901 | <dd class="tag-source">
|
4902 | <ul class="dummy">
|
4903 | <li>
|
4904 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4905 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-225">line 225</a>
|
4906 | </li>
|
4907 | </ul>
|
4908 | </dd>
|
4909 |
|
4910 |
|
4911 |
|
4912 |
|
4913 |
|
4914 |
|
4915 |
|
4916 | </dl>
|
4917 |
|
4918 |
|
4919 |
|
4920 |
|
4921 |
|
4922 |
|
4923 |
|
4924 |
|
4925 |
|
4926 |
|
4927 |
|
4928 |
|
4929 |
|
4930 |
|
4931 |
|
4932 | </dd>
|
4933 |
|
4934 |
|
4935 |
|
4936 | <hr>
|
4937 | <dt>
|
4938 | <h4 class="name" id="removeSpritesGroupsAll"><span class="type-signature"></span>removeSpritesGroupsAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
4939 |
|
4940 |
|
4941 | </dt>
|
4942 | <dd>
|
4943 |
|
4944 |
|
4945 | <div class="description">
|
4946 | <p>Alias for <a href="CB_GraphicSpritesScene.html#removeSpritesGroups"><code>CB_GraphicSpritesScene#removeSpritesGroups</code></a>.</p>
|
4947 | </div>
|
4948 |
|
4949 |
|
4950 |
|
4951 |
|
4952 |
|
4953 |
|
4954 |
|
4955 |
|
4956 |
|
4957 |
|
4958 | <dl class="details">
|
4959 |
|
4960 |
|
4961 |
|
4962 |
|
4963 |
|
4964 |
|
4965 |
|
4966 |
|
4967 |
|
4968 |
|
4969 |
|
4970 |
|
4971 |
|
4972 |
|
4973 |
|
4974 |
|
4975 |
|
4976 |
|
4977 |
|
4978 |
|
4979 |
|
4980 |
|
4981 |
|
4982 |
|
4983 |
|
4984 |
|
4985 |
|
4986 |
|
4987 |
|
4988 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4989 | <dd class="tag-source">
|
4990 | <ul class="dummy">
|
4991 | <li>
|
4992 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
4993 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-216">line 216</a>
|
4994 | </li>
|
4995 | </ul>
|
4996 | </dd>
|
4997 |
|
4998 |
|
4999 |
|
5000 |
|
5001 |
|
5002 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
5003 | <dd class="tag-see">
|
5004 | <ul>
|
5005 | <li><a href="CB_GraphicSpritesScene.html#removeSpritesGroups"><code>CB_GraphicSpritesScene#removeSpritesGroups</code></a></li>
|
5006 | </ul>
|
5007 | </dd>
|
5008 |
|
5009 |
|
5010 |
|
5011 | </dl>
|
5012 |
|
5013 |
|
5014 |
|
5015 |
|
5016 |
|
5017 |
|
5018 |
|
5019 |
|
5020 |
|
5021 |
|
5022 |
|
5023 |
|
5024 |
|
5025 |
|
5026 |
|
5027 | </dd>
|
5028 |
|
5029 |
|
5030 |
|
5031 | <hr>
|
5032 | <dt>
|
5033 | <h4 class="name" id="setPropertyCascade"><span class="type-signature"></span>setPropertyCascade<span class="signature">(propertyName [, value] [, onlyCurrent])</span><span class="type-signature"> → {integer}</span></h4>
|
5034 |
|
5035 |
|
5036 | </dt>
|
5037 | <dd>
|
5038 |
|
5039 |
|
5040 | <div class="description">
|
5041 | <p>Sets the desired value of a given property name to the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object as well to its <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects and their children (their <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object, including their <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> and their <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects). Calls the <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> method internally.</p>
|
5042 | </div>
|
5043 |
|
5044 |
|
5045 |
|
5046 |
|
5047 |
|
5048 |
|
5049 |
|
5050 |
|
5051 | <h5>Parameters:</h5>
|
5052 |
|
5053 |
|
5054 | <table class="params table table-striped">
|
5055 | <thead>
|
5056 | <tr>
|
5057 |
|
5058 | <th style="width:12%; min-width:110px;">Name</th>
|
5059 |
|
5060 |
|
5061 | <th style="width:12%; min-width:110px;">Type</th>
|
5062 |
|
5063 |
|
5064 | <th style="width:12%; min-width:110px;">Argument</th>
|
5065 |
|
5066 |
|
5067 |
|
5068 | <th style="width:12%; min-width:110px;">Default</th>
|
5069 |
|
5070 |
|
5071 | <th class="last" style="min-width:310px;">Description</th>
|
5072 | </tr>
|
5073 | </thead>
|
5074 |
|
5075 | <tbody>
|
5076 |
|
5077 |
|
5078 | <tr>
|
5079 |
|
5080 | <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>propertyName</code></td>
|
5081 |
|
5082 |
|
5083 | <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;">
|
5084 |
|
5085 |
|
5086 | <span class="param-type">number</span>
|
5087 |
|
5088 |
|
5089 |
|
5090 |
|
5091 | </td>
|
5092 |
|
5093 |
|
5094 | <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;">
|
5095 |
|
5096 |
|
5097 |
|
5098 |
|
5099 |
|
5100 | </td>
|
5101 |
|
5102 |
|
5103 |
|
5104 | <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;">
|
5105 |
|
5106 | </td>
|
5107 |
|
5108 |
|
5109 | <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>The name of the property we want to affect. Also used as the "propertyName" parameter when calling the <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> method internally.</p></td>
|
5110 | </tr>
|
5111 |
|
5112 |
|
5113 |
|
5114 | <tr>
|
5115 |
|
5116 | <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>value</code></td>
|
5117 |
|
5118 |
|
5119 | <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;">
|
5120 |
|
5121 |
|
5122 | <span class="param-type">*</span>
|
5123 |
|
5124 |
|
5125 |
|
5126 |
|
5127 | </td>
|
5128 |
|
5129 |
|
5130 | <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;">
|
5131 |
|
5132 | <optional><br>
|
5133 |
|
5134 |
|
5135 |
|
5136 |
|
5137 |
|
5138 | </td>
|
5139 |
|
5140 |
|
5141 |
|
5142 | <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;">
|
5143 |
|
5144 | </td>
|
5145 |
|
5146 |
|
5147 | <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>The value desired for the given property. Also used as the "value" parameter when calling the <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> method internally.</p></td>
|
5148 | </tr>
|
5149 |
|
5150 |
|
5151 |
|
5152 | <tr>
|
5153 |
|
5154 | <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>onlyCurrent</code></td>
|
5155 |
|
5156 |
|
5157 | <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;">
|
5158 |
|
5159 |
|
5160 | <span class="param-type">boolean</span>
|
5161 |
|
5162 |
|
5163 |
|
5164 |
|
5165 | </td>
|
5166 |
|
5167 |
|
5168 | <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;">
|
5169 |
|
5170 | <optional><br>
|
5171 |
|
5172 |
|
5173 |
|
5174 |
|
5175 |
|
5176 | </td>
|
5177 |
|
5178 |
|
5179 |
|
5180 | <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;">
|
5181 |
|
5182 | false
|
5183 |
|
5184 | </td>
|
5185 |
|
5186 |
|
5187 | <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 only affect the current sprite and its sub-sprites of each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object (and also the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object and the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object of each <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object). Used as the "propertyName" parameter when calling the <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> method internally.</p></td>
|
5188 | </tr>
|
5189 |
|
5190 |
|
5191 | </tbody>
|
5192 | </table>
|
5193 |
|
5194 |
|
5195 |
|
5196 |
|
5197 | <dl class="details">
|
5198 |
|
5199 |
|
5200 |
|
5201 |
|
5202 |
|
5203 |
|
5204 |
|
5205 |
|
5206 |
|
5207 |
|
5208 |
|
5209 |
|
5210 |
|
5211 |
|
5212 |
|
5213 |
|
5214 |
|
5215 |
|
5216 |
|
5217 |
|
5218 |
|
5219 |
|
5220 |
|
5221 |
|
5222 |
|
5223 |
|
5224 |
|
5225 |
|
5226 |
|
5227 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5228 | <dd class="tag-source">
|
5229 | <ul class="dummy">
|
5230 | <li>
|
5231 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
5232 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-642">line 642</a>
|
5233 | </li>
|
5234 | </ul>
|
5235 | </dd>
|
5236 |
|
5237 |
|
5238 |
|
5239 |
|
5240 |
|
5241 |
|
5242 |
|
5243 | </dl>
|
5244 |
|
5245 |
|
5246 |
|
5247 |
|
5248 |
|
5249 |
|
5250 |
|
5251 |
|
5252 |
|
5253 |
|
5254 |
|
5255 |
|
5256 |
|
5257 | <h5>Returns:</h5>
|
5258 |
|
5259 |
|
5260 | <div class="param-desc">
|
5261 | <p>Returns the number of elements affected (counting the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> object and the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects).</p>
|
5262 | </div>
|
5263 |
|
5264 |
|
5265 |
|
5266 | <dl>
|
5267 | <dt>
|
5268 | Type
|
5269 | </dt>
|
5270 | <dd>
|
5271 |
|
5272 | <span class="param-type">integer</span>
|
5273 |
|
5274 |
|
5275 |
|
5276 | </dd>
|
5277 | </dl>
|
5278 |
|
5279 |
|
5280 |
|
5281 |
|
5282 |
|
5283 | </dd>
|
5284 |
|
5285 |
|
5286 |
|
5287 | <hr>
|
5288 | <dt>
|
5289 | <h4 class="name" id="updateGraphicSpritesByZIndex"><span class="type-signature"></span>updateGraphicSpritesByZIndex<span class="signature">()</span><span class="type-signature"> → {array}</span></h4>
|
5290 |
|
5291 |
|
5292 | </dt>
|
5293 | <dd>
|
5294 |
|
5295 |
|
5296 | <div class="description">
|
5297 | <p>Updates (sorts again) the "itemsByZIndex" property (which is an array with the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects ordered by z-index, whose data comes from the array in the "items" property of the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> object) of the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> object.</p>
|
5298 | </div>
|
5299 |
|
5300 |
|
5301 |
|
5302 |
|
5303 |
|
5304 |
|
5305 |
|
5306 |
|
5307 |
|
5308 |
|
5309 | <dl class="details">
|
5310 |
|
5311 |
|
5312 |
|
5313 |
|
5314 |
|
5315 |
|
5316 |
|
5317 |
|
5318 |
|
5319 |
|
5320 |
|
5321 |
|
5322 |
|
5323 |
|
5324 |
|
5325 |
|
5326 |
|
5327 |
|
5328 |
|
5329 |
|
5330 |
|
5331 |
|
5332 |
|
5333 |
|
5334 |
|
5335 |
|
5336 |
|
5337 |
|
5338 |
|
5339 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5340 | <dd class="tag-source">
|
5341 | <ul class="dummy">
|
5342 | <li>
|
5343 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
5344 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-300">line 300</a>
|
5345 | </li>
|
5346 | </ul>
|
5347 | </dd>
|
5348 |
|
5349 |
|
5350 |
|
5351 |
|
5352 |
|
5353 |
|
5354 |
|
5355 | </dl>
|
5356 |
|
5357 |
|
5358 |
|
5359 |
|
5360 |
|
5361 |
|
5362 |
|
5363 |
|
5364 |
|
5365 |
|
5366 |
|
5367 |
|
5368 |
|
5369 | <h5>Returns:</h5>
|
5370 |
|
5371 |
|
5372 | <div class="param-desc">
|
5373 | <p>Returns the "itemsByZIndex" array of the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> object after updating it. Returns null if the property could not be obtained or updated.</p>
|
5374 | </div>
|
5375 |
|
5376 |
|
5377 |
|
5378 | <dl>
|
5379 | <dt>
|
5380 | Type
|
5381 | </dt>
|
5382 | <dd>
|
5383 |
|
5384 | <span class="param-type">array</span>
|
5385 |
|
5386 |
|
5387 |
|
5388 | </dd>
|
5389 | </dl>
|
5390 |
|
5391 |
|
5392 |
|
5393 |
|
5394 |
|
5395 | </dd>
|
5396 |
|
5397 |
|
5398 |
|
5399 | <hr>
|
5400 | <dt>
|
5401 | <h4 class="name" id="updateItemsByZIndex"><span class="type-signature"></span>updateItemsByZIndex<span class="signature">()</span><span class="type-signature"></span></h4>
|
5402 |
|
5403 |
|
5404 | </dt>
|
5405 | <dd>
|
5406 |
|
5407 |
|
5408 | <div class="description">
|
5409 | <p>Alias for <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a>.</p>
|
5410 | </div>
|
5411 |
|
5412 |
|
5413 |
|
5414 |
|
5415 |
|
5416 |
|
5417 |
|
5418 |
|
5419 |
|
5420 |
|
5421 | <dl class="details">
|
5422 |
|
5423 |
|
5424 |
|
5425 |
|
5426 |
|
5427 |
|
5428 |
|
5429 |
|
5430 |
|
5431 |
|
5432 |
|
5433 |
|
5434 |
|
5435 |
|
5436 |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 |
|
5442 |
|
5443 |
|
5444 |
|
5445 |
|
5446 |
|
5447 |
|
5448 |
|
5449 |
|
5450 |
|
5451 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5452 | <dd class="tag-source">
|
5453 | <ul class="dummy">
|
5454 | <li>
|
5455 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
5456 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-290">line 290</a>
|
5457 | </li>
|
5458 | </ul>
|
5459 | </dd>
|
5460 |
|
5461 |
|
5462 |
|
5463 |
|
5464 |
|
5465 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
5466 | <dd class="tag-see">
|
5467 | <ul>
|
5468 | <li><a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a></li>
|
5469 | </ul>
|
5470 | </dd>
|
5471 |
|
5472 |
|
5473 |
|
5474 | </dl>
|
5475 |
|
5476 |
|
5477 |
|
5478 |
|
5479 |
|
5480 |
|
5481 |
|
5482 |
|
5483 |
|
5484 |
|
5485 |
|
5486 |
|
5487 |
|
5488 |
|
5489 |
|
5490 | </dd>
|
5491 |
|
5492 | </dl>
|
5493 |
|
5494 |
|
5495 |
|
5496 | <h3 class="subsection-title">Type Definitions</h3>
|
5497 |
|
5498 | <dl>
|
5499 |
|
5500 | <hr>
|
5501 | <dt class="name" id=".insertSpritesGroup_OBJECT">
|
5502 | <h4 id=".insertSpritesGroup_OBJECT">insertSpritesGroup_OBJECT</h4>
|
5503 |
|
5504 |
|
5505 | </dt>
|
5506 | <dd>
|
5507 |
|
5508 | <div class="description">
|
5509 | <p>Object used as the returning value of the <a href="CB_GraphicSpritesScene.html#insertSpritesGroup"><code>CB_GraphicSpritesScene#insertSpritesGroup</code></a> method.</p>
|
5510 | </div>
|
5511 |
|
5512 |
|
5513 |
|
5514 | <h5>Type:</h5>
|
5515 | <ul>
|
5516 | <li>
|
5517 |
|
5518 | <span class="param-type">Object</span>
|
5519 |
|
5520 |
|
5521 |
|
5522 | </li>
|
5523 | </ul>
|
5524 |
|
5525 |
|
5526 |
|
5527 | <dl class="details">
|
5528 |
|
5529 |
|
5530 | <h5 class="subsection-title">Properties:</h5>
|
5531 |
|
5532 | <dl>
|
5533 |
|
5534 | <table class="props table table-striped">
|
5535 | <thead>
|
5536 | <tr>
|
5537 |
|
5538 | <th>Name</th>
|
5539 |
|
5540 |
|
5541 | <th>Type</th>
|
5542 |
|
5543 |
|
5544 |
|
5545 |
|
5546 |
|
5547 | <th class="last">Description</th>
|
5548 | </tr>
|
5549 | </thead>
|
5550 |
|
5551 | <tbody>
|
5552 |
|
5553 |
|
5554 | <tr>
|
5555 |
|
5556 | <td class="name"><code>spritesGroup</code></td>
|
5557 |
|
5558 |
|
5559 | <td class="type">
|
5560 |
|
5561 |
|
5562 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
5563 |
|
5564 |
|
5565 |
|
5566 |
|
5567 | </td>
|
5568 |
|
5569 |
|
5570 |
|
5571 |
|
5572 |
|
5573 | <td class="description last"><p>The <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> which has been inserted (it could have been modified/sanitized from the given one and some missing properties or those which were wrong could have been inherited) and was used to create the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object when calling its constructor.</p></td>
|
5574 | </tr>
|
5575 |
|
5576 |
|
5577 |
|
5578 | <tr>
|
5579 |
|
5580 | <td class="name"><code>item</code></td>
|
5581 |
|
5582 |
|
5583 | <td class="type">
|
5584 |
|
5585 |
|
5586 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
5587 |
|
5588 |
|
5589 |
|
5590 |
|
5591 | </td>
|
5592 |
|
5593 |
|
5594 |
|
5595 |
|
5596 |
|
5597 | <td class="description last"><p>The <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object created and inserted from the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a>.</p></td>
|
5598 | </tr>
|
5599 |
|
5600 |
|
5601 | </tbody>
|
5602 | </table>
|
5603 | </dl>
|
5604 |
|
5605 |
|
5606 |
|
5607 |
|
5608 |
|
5609 |
|
5610 |
|
5611 |
|
5612 |
|
5613 |
|
5614 |
|
5615 |
|
5616 |
|
5617 |
|
5618 |
|
5619 |
|
5620 |
|
5621 |
|
5622 |
|
5623 |
|
5624 |
|
5625 |
|
5626 |
|
5627 |
|
5628 |
|
5629 |
|
5630 |
|
5631 |
|
5632 |
|
5633 |
|
5634 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5635 | <dd class="tag-source">
|
5636 | <ul class="dummy">
|
5637 | <li>
|
5638 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
5639 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-389">line 389</a>
|
5640 | </li>
|
5641 | </ul>
|
5642 | </dd>
|
5643 |
|
5644 |
|
5645 |
|
5646 |
|
5647 |
|
5648 |
|
5649 |
|
5650 | </dl>
|
5651 |
|
5652 |
|
5653 |
|
5654 | </dd>
|
5655 |
|
5656 |
|
5657 |
|
5658 | <hr>
|
5659 | <dt class="name" id=".SPRITES_GROUPS_OBJECT">
|
5660 | <h4 id=".SPRITES_GROUPS_OBJECT">SPRITES_GROUPS_OBJECT</h4>
|
5661 |
|
5662 |
|
5663 | </dt>
|
5664 | <dd>
|
5665 |
|
5666 | <div class="description">
|
5667 | <p>An object with the information that belongs to a group of graphic sprites.</p>
|
5668 | </div>
|
5669 |
|
5670 |
|
5671 |
|
5672 | <h5>Type:</h5>
|
5673 | <ul>
|
5674 | <li>
|
5675 |
|
5676 | <span class="param-type">Object</span>
|
5677 |
|
5678 |
|
5679 |
|
5680 | </li>
|
5681 | </ul>
|
5682 |
|
5683 |
|
5684 |
|
5685 | <dl class="details">
|
5686 |
|
5687 |
|
5688 | <h5 class="subsection-title">Properties:</h5>
|
5689 |
|
5690 | <dl>
|
5691 |
|
5692 | <table class="props table table-striped">
|
5693 | <thead>
|
5694 | <tr>
|
5695 |
|
5696 | <th>Name</th>
|
5697 |
|
5698 |
|
5699 | <th>Type</th>
|
5700 |
|
5701 |
|
5702 | <th>Argument</th>
|
5703 |
|
5704 |
|
5705 |
|
5706 | <th>Default</th>
|
5707 |
|
5708 |
|
5709 | <th class="last">Description</th>
|
5710 | </tr>
|
5711 | </thead>
|
5712 |
|
5713 | <tbody>
|
5714 |
|
5715 |
|
5716 | <tr>
|
5717 |
|
5718 | <td class="name"><code>id</code></td>
|
5719 |
|
5720 |
|
5721 | <td class="type">
|
5722 |
|
5723 |
|
5724 | <span class="param-type">string</span>
|
5725 | |
|
5726 |
|
5727 | <span class="param-type">*</span>
|
5728 |
|
5729 |
|
5730 |
|
5731 |
|
5732 | </td>
|
5733 |
|
5734 |
|
5735 | <td class="attributes">
|
5736 |
|
5737 | <optional><br>
|
5738 |
|
5739 |
|
5740 |
|
5741 | </td>
|
5742 |
|
5743 |
|
5744 |
|
5745 | <td class="default">
|
5746 |
|
5747 | 'CB_GraphicSpritesScene_' + CB_GraphicSpritesScene._idUnique++
|
5748 |
|
5749 | </td>
|
5750 |
|
5751 |
|
5752 | <td class="description last"><p>Identifier of the sprites groups object and also for the graphic sprites scene (also used as the <code>CB_GraphicSprites.id</code> property for the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object). It should be unique. Recommended. It must be a value which evaluates to true. By default, it is generated automatically (with an internal counter).</p></td>
|
5753 | </tr>
|
5754 |
|
5755 |
|
5756 |
|
5757 | <tr>
|
5758 |
|
5759 | <td class="name"><code>src</code></td>
|
5760 |
|
5761 |
|
5762 | <td class="type">
|
5763 |
|
5764 |
|
5765 | <span class="param-type">*</span>
|
5766 |
|
5767 |
|
5768 |
|
5769 |
|
5770 | </td>
|
5771 |
|
5772 |
|
5773 | <td class="attributes">
|
5774 |
|
5775 | <optional><br>
|
5776 |
|
5777 |
|
5778 |
|
5779 | </td>
|
5780 |
|
5781 |
|
5782 |
|
5783 | <td class="default">
|
5784 |
|
5785 | ""
|
5786 |
|
5787 | </td>
|
5788 |
|
5789 |
|
5790 | <td class="description last"><p>The value for the "src" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
5791 | </tr>
|
5792 |
|
5793 |
|
5794 |
|
5795 | <tr>
|
5796 |
|
5797 | <td class="name"><code>srcType</code></td>
|
5798 |
|
5799 |
|
5800 | <td class="type">
|
5801 |
|
5802 |
|
5803 | <span class="param-type">string</span>
|
5804 |
|
5805 |
|
5806 |
|
5807 |
|
5808 | </td>
|
5809 |
|
5810 |
|
5811 | <td class="attributes">
|
5812 |
|
5813 | <optional><br>
|
5814 |
|
5815 |
|
5816 |
|
5817 | </td>
|
5818 |
|
5819 |
|
5820 |
|
5821 | <td class="default">
|
5822 |
|
5823 | <a href="CB_GraphicSprites.html#.SRC_TYPES_DEFAULT"><code>CB_GraphicSprites.SRC_TYPES_DEFAULT</code></a>
|
5824 |
|
5825 | </td>
|
5826 |
|
5827 |
|
5828 | <td class="description last"><p>The value for the "srcType" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects. It should point to a property of the <a href="CB_GraphicSprites.html#.SRC_TYPES"><code>CB_GraphicSprites.SRC_TYPES</code></a> object. You can use other values of the <a href="CB_GraphicSprites.html#.SRC_TYPES"><code>CB_GraphicSprites.SRC_TYPES</code></a> object or create new ones.</p></td>
|
5829 | </tr>
|
5830 |
|
5831 |
|
5832 |
|
5833 | <tr>
|
5834 |
|
5835 | <td class="name"><code>srcLeft</code></td>
|
5836 |
|
5837 |
|
5838 | <td class="type">
|
5839 |
|
5840 |
|
5841 | <span class="param-type">number</span>
|
5842 |
|
5843 |
|
5844 |
|
5845 |
|
5846 | </td>
|
5847 |
|
5848 |
|
5849 | <td class="attributes">
|
5850 |
|
5851 | <optional><br>
|
5852 |
|
5853 |
|
5854 |
|
5855 | </td>
|
5856 |
|
5857 |
|
5858 |
|
5859 | <td class="default">
|
5860 |
|
5861 | <a href="CB_GraphicSprites.html#.LEFT_SOURCE_DEFAULT"><code>CB_GraphicSprites.LEFT_SOURCE_DEFAULT</code></a>
|
5862 |
|
5863 | </td>
|
5864 |
|
5865 |
|
5866 | <td class="description last"><p>The value for the "srcLeft" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
5867 | </tr>
|
5868 |
|
5869 |
|
5870 |
|
5871 | <tr>
|
5872 |
|
5873 | <td class="name"><code>srcTop</code></td>
|
5874 |
|
5875 |
|
5876 | <td class="type">
|
5877 |
|
5878 |
|
5879 | <span class="param-type">number</span>
|
5880 |
|
5881 |
|
5882 |
|
5883 |
|
5884 | </td>
|
5885 |
|
5886 |
|
5887 | <td class="attributes">
|
5888 |
|
5889 | <optional><br>
|
5890 |
|
5891 |
|
5892 |
|
5893 | </td>
|
5894 |
|
5895 |
|
5896 |
|
5897 | <td class="default">
|
5898 |
|
5899 | <a href="CB_GraphicSprites.html#.TOP_SOURCE_DEFAULT"><code>CB_GraphicSprites.TOP_SOURCE_DEFAULT</code></a>
|
5900 |
|
5901 | </td>
|
5902 |
|
5903 |
|
5904 | <td class="description last"><p>The value for the "srcTop" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
5905 | </tr>
|
5906 |
|
5907 |
|
5908 |
|
5909 | <tr>
|
5910 |
|
5911 | <td class="name"><code>srcWidth</code></td>
|
5912 |
|
5913 |
|
5914 | <td class="type">
|
5915 |
|
5916 |
|
5917 | <span class="param-type">number</span>
|
5918 |
|
5919 |
|
5920 |
|
5921 |
|
5922 | </td>
|
5923 |
|
5924 |
|
5925 | <td class="attributes">
|
5926 |
|
5927 | <optional><br>
|
5928 |
|
5929 |
|
5930 |
|
5931 | </td>
|
5932 |
|
5933 |
|
5934 |
|
5935 | <td class="default">
|
5936 |
|
5937 | <a href="CB_GraphicSprites.html#.WIDTH_SOURCE_DEFAULT"><code>CB_GraphicSprites.WIDTH_SOURCE_DEFAULT</code></a>
|
5938 |
|
5939 | </td>
|
5940 |
|
5941 |
|
5942 | <td class="description last"><p>The value for the "srcWidth" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
5943 | </tr>
|
5944 |
|
5945 |
|
5946 |
|
5947 | <tr>
|
5948 |
|
5949 | <td class="name"><code>srcHeight</code></td>
|
5950 |
|
5951 |
|
5952 | <td class="type">
|
5953 |
|
5954 |
|
5955 | <span class="param-type">number</span>
|
5956 |
|
5957 |
|
5958 |
|
5959 |
|
5960 | </td>
|
5961 |
|
5962 |
|
5963 | <td class="attributes">
|
5964 |
|
5965 | <optional><br>
|
5966 |
|
5967 |
|
5968 |
|
5969 | </td>
|
5970 |
|
5971 |
|
5972 |
|
5973 | <td class="default">
|
5974 |
|
5975 | <a href="CB_GraphicSprites.html#.HEIGHT_SOURCE_DEFAULT"><code>CB_GraphicSprites.HEIGHT_SOURCE_DEFAULT</code></a>
|
5976 |
|
5977 | </td>
|
5978 |
|
5979 |
|
5980 | <td class="description last"><p>The value for the "srcHeight" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
5981 | </tr>
|
5982 |
|
5983 |
|
5984 |
|
5985 | <tr>
|
5986 |
|
5987 | <td class="name"><code>left</code></td>
|
5988 |
|
5989 |
|
5990 | <td class="type">
|
5991 |
|
5992 |
|
5993 | <span class="param-type">number</span>
|
5994 |
|
5995 |
|
5996 |
|
5997 |
|
5998 | </td>
|
5999 |
|
6000 |
|
6001 | <td class="attributes">
|
6002 |
|
6003 | <optional><br>
|
6004 |
|
6005 |
|
6006 |
|
6007 | </td>
|
6008 |
|
6009 |
|
6010 |
|
6011 | <td class="default">
|
6012 |
|
6013 | <a href="CB_GraphicSprites.html#.LEFT_DEFAULT"><code>CB_GraphicSprites.LEFT_DEFAULT</code></a>
|
6014 |
|
6015 | </td>
|
6016 |
|
6017 |
|
6018 | <td class="description last"><p>The value for the "left" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6019 | </tr>
|
6020 |
|
6021 |
|
6022 |
|
6023 | <tr>
|
6024 |
|
6025 | <td class="name"><code>top</code></td>
|
6026 |
|
6027 |
|
6028 | <td class="type">
|
6029 |
|
6030 |
|
6031 | <span class="param-type">number</span>
|
6032 |
|
6033 |
|
6034 |
|
6035 |
|
6036 | </td>
|
6037 |
|
6038 |
|
6039 | <td class="attributes">
|
6040 |
|
6041 | <optional><br>
|
6042 |
|
6043 |
|
6044 |
|
6045 | </td>
|
6046 |
|
6047 |
|
6048 |
|
6049 | <td class="default">
|
6050 |
|
6051 | <a href="CB_GraphicSprites.html#.TOP_DEFAULT"><code>CB_GraphicSprites.TOP_DEFAULT</code></a>
|
6052 |
|
6053 | </td>
|
6054 |
|
6055 |
|
6056 | <td class="description last"><p>The value for the "top" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6057 | </tr>
|
6058 |
|
6059 |
|
6060 |
|
6061 | <tr>
|
6062 |
|
6063 | <td class="name"><code>width</code></td>
|
6064 |
|
6065 |
|
6066 | <td class="type">
|
6067 |
|
6068 |
|
6069 | <span class="param-type">number</span>
|
6070 |
|
6071 |
|
6072 |
|
6073 |
|
6074 | </td>
|
6075 |
|
6076 |
|
6077 | <td class="attributes">
|
6078 |
|
6079 | <optional><br>
|
6080 |
|
6081 |
|
6082 |
|
6083 | </td>
|
6084 |
|
6085 |
|
6086 |
|
6087 | <td class="default">
|
6088 |
|
6089 | <a href="CB_GraphicSprites.html#.WIDTH_DEFAULT"><code>CB_GraphicSprites.WIDTH_DEFAULT</code></a>
|
6090 |
|
6091 | </td>
|
6092 |
|
6093 |
|
6094 | <td class="description last"><p>The value for the "width" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6095 | </tr>
|
6096 |
|
6097 |
|
6098 |
|
6099 | <tr>
|
6100 |
|
6101 | <td class="name"><code>height</code></td>
|
6102 |
|
6103 |
|
6104 | <td class="type">
|
6105 |
|
6106 |
|
6107 | <span class="param-type">number</span>
|
6108 |
|
6109 |
|
6110 |
|
6111 |
|
6112 | </td>
|
6113 |
|
6114 |
|
6115 | <td class="attributes">
|
6116 |
|
6117 | <optional><br>
|
6118 |
|
6119 |
|
6120 |
|
6121 | </td>
|
6122 |
|
6123 |
|
6124 |
|
6125 | <td class="default">
|
6126 |
|
6127 | <a href="CB_GraphicSprites.html#.HEIGHT_DEFAULT"><code>CB_GraphicSprites.HEIGHT_DEFAULT</code></a>
|
6128 |
|
6129 | </td>
|
6130 |
|
6131 |
|
6132 | <td class="description last"><p>The value for the "height" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6133 | </tr>
|
6134 |
|
6135 |
|
6136 |
|
6137 | <tr>
|
6138 |
|
6139 | <td class="name"><code>zIndex</code></td>
|
6140 |
|
6141 |
|
6142 | <td class="type">
|
6143 |
|
6144 |
|
6145 | <span class="param-type">number</span>
|
6146 |
|
6147 |
|
6148 |
|
6149 |
|
6150 | </td>
|
6151 |
|
6152 |
|
6153 | <td class="attributes">
|
6154 |
|
6155 | <optional><br>
|
6156 |
|
6157 |
|
6158 |
|
6159 | </td>
|
6160 |
|
6161 |
|
6162 |
|
6163 | <td class="default">
|
6164 |
|
6165 | <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a>
|
6166 |
|
6167 | </td>
|
6168 |
|
6169 |
|
6170 | <td class="description last"><p>The value for the "zIndex" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6171 | </tr>
|
6172 |
|
6173 |
|
6174 |
|
6175 | <tr>
|
6176 |
|
6177 | <td class="name"><code>disabled</code></td>
|
6178 |
|
6179 |
|
6180 | <td class="type">
|
6181 |
|
6182 |
|
6183 | <span class="param-type">boolean</span>
|
6184 |
|
6185 |
|
6186 |
|
6187 |
|
6188 | </td>
|
6189 |
|
6190 |
|
6191 | <td class="attributes">
|
6192 |
|
6193 | <optional><br>
|
6194 |
|
6195 |
|
6196 |
|
6197 | </td>
|
6198 |
|
6199 |
|
6200 |
|
6201 | <td class="default">
|
6202 |
|
6203 | false
|
6204 |
|
6205 | </td>
|
6206 |
|
6207 |
|
6208 | <td class="description last"><p>The value for the "disabled" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6209 | </tr>
|
6210 |
|
6211 |
|
6212 |
|
6213 | <tr>
|
6214 |
|
6215 | <td class="name"><code>data</code></td>
|
6216 |
|
6217 |
|
6218 | <td class="type">
|
6219 |
|
6220 |
|
6221 | <span class="param-type">object</span>
|
6222 |
|
6223 |
|
6224 |
|
6225 |
|
6226 | </td>
|
6227 |
|
6228 |
|
6229 | <td class="attributes">
|
6230 |
|
6231 | <optional><br>
|
6232 |
|
6233 |
|
6234 |
|
6235 | </td>
|
6236 |
|
6237 |
|
6238 |
|
6239 | <td class="default">
|
6240 |
|
6241 | { 'that' : CB_GraphicSprites.SPRITES_GROUPS_OBJECT, 'getThis' = function() { return this.that; } }
|
6242 |
|
6243 | </td>
|
6244 |
|
6245 |
|
6246 | <td class="description last"><p>Object with any additional data desired which can be any kind. It will always have a "that" property pointing to the <code>CB_GraphicSprites.SPRITES_GROUPS_OBJECT</code> object where it belongs to and a function in its "getThis" property returning the same value (added automatically). These properties ("that" and "getThis") cannot be overridden. The value given will also be used for the "data" property which will be used as default if not provided (or the provided one was wrong) in the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects (in the "spritesGroups" property), when creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects.</p></td>
|
6247 | </tr>
|
6248 |
|
6249 |
|
6250 |
|
6251 | <tr>
|
6252 |
|
6253 | <td class="name"><code>spritesGroups</code></td>
|
6254 |
|
6255 |
|
6256 | <td class="type">
|
6257 |
|
6258 |
|
6259 | <span class="param-type">array</span>
|
6260 |
|
6261 |
|
6262 |
|
6263 |
|
6264 | </td>
|
6265 |
|
6266 |
|
6267 | <td class="attributes">
|
6268 |
|
6269 | <optional><br>
|
6270 |
|
6271 |
|
6272 |
|
6273 | </td>
|
6274 |
|
6275 |
|
6276 |
|
6277 | <td class="default">
|
6278 |
|
6279 | []
|
6280 |
|
6281 | </td>
|
6282 |
|
6283 |
|
6284 | <td class="description last"><p>Numeric array containing <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects with all the sprites groups that are useful for creating the internal <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects. Recommended at least to provide one <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object in the first index.</p></td>
|
6285 | </tr>
|
6286 |
|
6287 |
|
6288 |
|
6289 | <tr>
|
6290 |
|
6291 | <td class="name"><code>parent</code></td>
|
6292 |
|
6293 |
|
6294 | <td class="type">
|
6295 |
|
6296 |
|
6297 | <span class="param-type">*</span>
|
6298 |
|
6299 |
|
6300 |
|
6301 |
|
6302 | </td>
|
6303 |
|
6304 |
|
6305 | <td class="attributes">
|
6306 |
|
6307 | <optional><br>
|
6308 |
|
6309 |
|
6310 |
|
6311 | </td>
|
6312 |
|
6313 |
|
6314 |
|
6315 | <td class="default">
|
6316 |
|
6317 | </td>
|
6318 |
|
6319 |
|
6320 | <td class="description last"><p>Property pointing to or containing its parent (also used as the <code>CB_GraphicSpritesScene.parent</code> property for the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object).</p></td>
|
6321 | </tr>
|
6322 |
|
6323 |
|
6324 |
|
6325 | <tr>
|
6326 |
|
6327 | <td class="name"><code>items</code></td>
|
6328 |
|
6329 |
|
6330 | <td class="type">
|
6331 |
|
6332 |
|
6333 | <span class="param-type">array</span>
|
6334 |
|
6335 |
|
6336 |
|
6337 |
|
6338 | </td>
|
6339 |
|
6340 |
|
6341 | <td class="attributes">
|
6342 |
|
6343 |
|
6344 |
|
6345 | </td>
|
6346 |
|
6347 |
|
6348 |
|
6349 | <td class="default">
|
6350 |
|
6351 | </td>
|
6352 |
|
6353 |
|
6354 | <td class="description last"><p>Read-only numeric array containing <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects created internally. Their "parent" property will be set to point the current <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object which contains them.</p></td>
|
6355 | </tr>
|
6356 |
|
6357 |
|
6358 |
|
6359 | <tr>
|
6360 |
|
6361 | <td class="name"><code>itemsByZIndex</code></td>
|
6362 |
|
6363 |
|
6364 | <td class="type">
|
6365 |
|
6366 |
|
6367 | <span class="param-type">array</span>
|
6368 |
|
6369 |
|
6370 |
|
6371 |
|
6372 | </td>
|
6373 |
|
6374 |
|
6375 | <td class="attributes">
|
6376 |
|
6377 |
|
6378 |
|
6379 | </td>
|
6380 |
|
6381 |
|
6382 |
|
6383 | <td class="default">
|
6384 |
|
6385 | </td>
|
6386 |
|
6387 |
|
6388 | <td class="description last"><p>Read-only property containing a numeric array of all the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects ordered by their z-index ("zIndex" property). It is updated automatically when the z-index of a sprite is set with its <a href="CB_GraphicSprites.html#setZIndex"><code>CB_GraphicSprites#setZIndex</code></a> method or when inserting/removing <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects through the <a href="CB_GraphicSpritesScene.html#insertSpritesGroups"><code>CB_GraphicSpritesScene#insertSpritesGroups</code></a>, <a href="CB_GraphicSpritesScene.html#insertSpritesGroup"><code>CB_GraphicSpritesScene#insertSpritesGroup</code></a>, <a href="CB_GraphicSpritesScene.html#removeSpritesGroup"><code>CB_GraphicSpritesScene#removeSpritesGroup</code></a> or <a href="CB_GraphicSpritesScene.html#removeSpritesGroupById"><code>CB_GraphicSpritesScene#removeSpritesGroupById</code></a> methods.</p></td>
|
6389 | </tr>
|
6390 |
|
6391 |
|
6392 |
|
6393 | <tr>
|
6394 |
|
6395 | <td class="name"><code>byReference_DEFAULT</code></td>
|
6396 |
|
6397 |
|
6398 | <td class="type">
|
6399 |
|
6400 |
|
6401 | <span class="param-type">boolean</span>
|
6402 |
|
6403 |
|
6404 |
|
6405 |
|
6406 | </td>
|
6407 |
|
6408 |
|
6409 | <td class="attributes">
|
6410 |
|
6411 | <optional><br>
|
6412 |
|
6413 |
|
6414 |
|
6415 | </td>
|
6416 |
|
6417 |
|
6418 |
|
6419 | <td class="default">
|
6420 |
|
6421 | false
|
6422 |
|
6423 | </td>
|
6424 |
|
6425 |
|
6426 | <td class="description last"><p>Default value to use as the "byReference" parameter for the constructor and for the <a href="CB_GraphicSpritesScene.html#insertSpritesGroups"><code>CB_GraphicSpritesScene#insertSpritesGroups</code></a> method. If a boolean value is not provided, it will be parsed to boolean (resulting undefined to be false).</p></td>
|
6427 | </tr>
|
6428 |
|
6429 |
|
6430 |
|
6431 | <tr>
|
6432 |
|
6433 | <td class="name"><code>container</code></td>
|
6434 |
|
6435 |
|
6436 | <td class="type">
|
6437 |
|
6438 |
|
6439 | <span class="param-type"><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></span>
|
6440 |
|
6441 |
|
6442 |
|
6443 |
|
6444 | </td>
|
6445 |
|
6446 |
|
6447 | <td class="attributes">
|
6448 |
|
6449 |
|
6450 |
|
6451 | </td>
|
6452 |
|
6453 |
|
6454 |
|
6455 | <td class="default">
|
6456 |
|
6457 | </td>
|
6458 |
|
6459 |
|
6460 | <td class="description last"><p>Read-only property pointing to the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object which contains it.</p></td>
|
6461 | </tr>
|
6462 |
|
6463 |
|
6464 |
|
6465 | <tr>
|
6466 |
|
6467 | <td class="name"><code>isSpritesGroups</code></td>
|
6468 |
|
6469 |
|
6470 | <td class="type">
|
6471 |
|
6472 |
|
6473 | <span class="param-type">boolean</span>
|
6474 |
|
6475 |
|
6476 |
|
6477 |
|
6478 | </td>
|
6479 |
|
6480 |
|
6481 | <td class="attributes">
|
6482 |
|
6483 |
|
6484 |
|
6485 | </td>
|
6486 |
|
6487 |
|
6488 |
|
6489 | <td class="default">
|
6490 |
|
6491 | </td>
|
6492 |
|
6493 |
|
6494 | <td class="description last"><p>Read-only property which is always set to true to help identify this type of object.</p></td>
|
6495 | </tr>
|
6496 |
|
6497 |
|
6498 |
|
6499 | <tr>
|
6500 |
|
6501 | <td class="name"><code>type</code></td>
|
6502 |
|
6503 |
|
6504 | <td class="type">
|
6505 |
|
6506 |
|
6507 | <span class="param-type">'spritesGroups'</span>
|
6508 |
|
6509 |
|
6510 |
|
6511 |
|
6512 | </td>
|
6513 |
|
6514 |
|
6515 | <td class="attributes">
|
6516 |
|
6517 |
|
6518 |
|
6519 | </td>
|
6520 |
|
6521 |
|
6522 |
|
6523 | <td class="default">
|
6524 |
|
6525 | </td>
|
6526 |
|
6527 |
|
6528 | <td class="description last"><p>Read-only property indicating the type of object (always "spritesGroups").</p></td>
|
6529 | </tr>
|
6530 |
|
6531 |
|
6532 | </tbody>
|
6533 | </table>
|
6534 | </dl>
|
6535 |
|
6536 |
|
6537 |
|
6538 |
|
6539 |
|
6540 |
|
6541 |
|
6542 |
|
6543 |
|
6544 |
|
6545 |
|
6546 |
|
6547 |
|
6548 |
|
6549 |
|
6550 |
|
6551 |
|
6552 |
|
6553 |
|
6554 |
|
6555 |
|
6556 |
|
6557 |
|
6558 |
|
6559 |
|
6560 |
|
6561 |
|
6562 |
|
6563 |
|
6564 |
|
6565 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6566 | <dd class="tag-source">
|
6567 | <ul class="dummy">
|
6568 | <li>
|
6569 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html">CrossBase/audiovisual/image/CB_GraphicSpritesScene.js</a>,
|
6570 | <a href="CrossBase_audiovisual_image_CB_GraphicSpritesScene.js.html#sunlight-1-line-8">line 8</a>
|
6571 | </li>
|
6572 | </ul>
|
6573 | </dd>
|
6574 |
|
6575 |
|
6576 |
|
6577 |
|
6578 |
|
6579 |
|
6580 |
|
6581 | </dl>
|
6582 |
|
6583 |
|
6584 |
|
6585 | <h5>Example</h5>
|
6586 |
|
6587 | <pre class="sunlight-highlight-javascript">{
|
6588 | //'my_sprites_scene_1':
|
6589 | id: "my_sprites_scene_1",
|
6590 | srcType: CB_GraphicSprites.SRC_TYPES.IMAGE,
|
6591 | srcLeft: 10,
|
6592 | srcTop: 20,
|
6593 | srcWidth: 64,
|
6594 | srcHeight: 32,
|
6595 | left: 10,
|
6596 | top: 20,
|
6597 | width: 64,
|
6598 | height: 32,
|
6599 | data: { datum_1: "value_1", datum_2: 2, datum_3: [ "a", "b", "c" ] },
|
6600 | //Sprites groups:
|
6601 | spritesGroups:
|
6602 | [
|
6603 | //'my_sprites_1':
|
6604 | {
|
6605 | id: "my_sprites_1",
|
6606 | src: "path/to/image.gif",
|
6607 | sprites:
|
6608 | [
|
6609 | //'my_sprite_1':
|
6610 | {
|
6611 | id: "my_sprite_1",
|
6612 | subSprites:
|
6613 | [
|
6614 | //'my_subsprite_1':
|
6615 | { id: "my_subsprite_1", srcLeft: 10, srcTop: 20, zIndex: 1 },
|
6616 | //'my_subsprite_2':
|
6617 | { id: "my_subsprite_2", srcLeft: 20, srcTop: 40, zIndex: 2 }
|
6618 | ]
|
6619 | },
|
6620 | //'my_sprite_2':
|
6621 | {
|
6622 | id: "my_sprite_2",
|
6623 | subSprites:
|
6624 | [
|
6625 | //'my_subsprite_3':
|
6626 | { id: "my_subsprite_3", srcLeft: 30, srcTop: 60, zIndex: 1 },
|
6627 | //'my_subsprite_4':
|
6628 | { id: "my_subsprite_4", srcLeft: 40, srcTop: 80, zIndex: 2 }
|
6629 | ]
|
6630 | }
|
6631 | ]
|
6632 | },
|
6633 | //'my_sprites_2':
|
6634 | {
|
6635 | id: "my_sprites_2",
|
6636 | src: "path/to/image2.gif",
|
6637 | sprites:
|
6638 | [
|
6639 | //'my_sprite_3':
|
6640 | {
|
6641 | id: "my_sprite_3",
|
6642 | subSprites:
|
6643 | [
|
6644 | //'my_subsprite_1':
|
6645 | { id: "my_subsprite_5", srcLeft: 10, srcTop: 20, zIndex: 1 },
|
6646 | //'my_subsprite_2':
|
6647 | { id: "my_subsprite_6", srcLeft: 20, srcTop: 40, zIndex: 2 }
|
6648 | ]
|
6649 | },
|
6650 | //'my_sprite_4':
|
6651 | {
|
6652 | id: "my_sprite_4",
|
6653 | subSprites:
|
6654 | [
|
6655 | //'my_subsprite_3':
|
6656 | { id: "my_subsprite_7", srcLeft: 30, srcTop: 60, zIndex: 1 },
|
6657 | //'my_subsprite_4':
|
6658 | { id: "my_subsprite_8", srcLeft: 40, srcTop: 80, zIndex: 2 }
|
6659 | ]
|
6660 | }
|
6661 | ]
|
6662 | }
|
6663 | ]
|
6664 | }
</pre>
|
6665 |
|
6666 |
|
6667 |
|
6668 | </dd>
|
6669 |
|
6670 | </dl>
|
6671 |
|
6672 |
|
6673 |
|
6674 | </article>
|
6675 |
|
6676 | </section>
|
6677 |
|
6678 |
|
6679 |
|
6680 |
|
6681 | </div>
|
6682 | </div>
|
6683 |
|
6684 | <div class="clearfix"></div>
|
6685 |
|
6686 |
|
6687 | <div class="col-md-3">
|
6688 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
6689 | </div>
|
6690 |
|
6691 |
|
6692 | </div>
|
6693 | </div>
|
6694 |
|
6695 |
|
6696 | <div class="modal fade" id="searchResults">
|
6697 | <div class="modal-dialog">
|
6698 | <div class="modal-content">
|
6699 | <div class="modal-header">
|
6700 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
6701 | <h4 class="modal-title">Search results</h4>
|
6702 | </div>
|
6703 | <div class="modal-body"></div>
|
6704 | <div class="modal-footer">
|
6705 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
6706 | </div>
|
6707 | </div>
|
6708 | </div>
|
6709 | </div>
|
6710 |
|
6711 |
|
6712 | <footer>
|
6713 |
|
6714 |
|
6715 | <span class="copyright">
|
6716 | <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
|
6717 | </span>
|
6718 |
|
6719 | <span class="jsdoc-message">
|
6720 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
6721 |
|
6722 | on Mon Feb 3rd 2020
|
6723 |
|
6724 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
6725 | </span>
|
6726 | </footer>
|
6727 |
|
6728 | <script src="scripts/docstrap.lib.js"></script>
|
6729 | <script src="scripts/toc.js"></script>
|
6730 |
|
6731 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
6732 |
|
6733 |
|
6734 | <script>
|
6735 | $( function () {
|
6736 | $( "[id*='$']" ).each( function () {
|
6737 | var $this = $( this );
|
6738 |
|
6739 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
6740 | } );
|
6741 |
|
6742 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
6743 | var $this = $( this );
|
6744 |
|
6745 | var example = $this.find( "code" );
|
6746 | exampleText = example.html();
|
6747 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
6748 | if ( lang && lang[1] ) {
|
6749 | exampleText = exampleText.replace( lang[0], "" );
|
6750 | example.html( exampleText );
|
6751 | lang = lang[1];
|
6752 | } else {
|
6753 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
6754 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
6755 | }
|
6756 |
|
6757 | if ( lang ) {
|
6758 |
|
6759 | $this
|
6760 | .addClass( "sunlight-highlight-" + lang )
|
6761 | .addClass( "linenums" )
|
6762 | .html( example.html() );
|
6763 |
|
6764 | }
|
6765 | } );
|
6766 |
|
6767 | Sunlight.highlightAll( {
|
6768 | lineNumbers : true,
|
6769 | showMenu : true,
|
6770 | enableDoclinks : true
|
6771 | } );
|
6772 |
|
6773 | $.catchAnchorLinks( {
|
6774 | navbarOffset: 10
|
6775 | } );
|
6776 | $( "#toc" ).toc( {
|
6777 | anchorName : function ( i, heading, prefix ) {
|
6778 | return $( heading ).attr( "id" ) || ( prefix + i );
|
6779 | },
|
6780 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
6781 | showAndHide : false,
|
6782 | smoothScrolling: true
|
6783 | } );
|
6784 |
|
6785 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
6786 | $( '.dropdown-toggle' ).dropdown();
|
6787 |
|
6788 | $( "table" ).each( function () {
|
6789 | var $this = $( this );
|
6790 | $this.addClass('table');
|
6791 | } );
|
6792 |
|
6793 | } );
|
6794 | </script>
|
6795 |
|
6796 |
|
6797 |
|
6798 |
|
6799 |
|
6800 | <script>
|
6801 | $( function () {
|
6802 | $( '#main' ).localScroll( {
|
6803 | offset : { top : 60 }
|
6804 | } );
|
6805 | $( "dt.name" ).each( function () {
|
6806 | var $this = $( this ).find("h4");
|
6807 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
6808 | var dt = $(this);
|
6809 | var children = dt.next( "dd" );
|
6810 |
|
6811 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
6812 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
6813 |
|
6814 |
|
6815 | children.hide();
|
6816 |
|
6817 | dt.children().on( "click", function () {
|
6818 | children = dt.next( "dd" );
|
6819 | children.slideToggle( "fast", function () {
|
6820 |
|
6821 | if ( children.is( ":visible" ) ) {
|
6822 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
6823 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
6824 | } else {
|
6825 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
6826 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
6827 | }
|
6828 | } );
|
6829 | } );
|
6830 |
|
6831 | } );
|
6832 | } );
|
6833 | </script>
|
6834 |
|
6835 |
|
6836 |
|
6837 |
|
6838 |
|
6839 |
|
6840 | <script type="text/javascript">
|
6841 | $(document).ready(function() {
|
6842 | SearcherDisplay.init();
|
6843 | });
|
6844 | </script>
|
6845 |
|
6846 |
|
6847 | </body>
|
6848 | </html> |
\ | No newline at end of file |