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 [printable] Class: CB_GraphicSprites</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.yeti.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 [printable]</a>
|
24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
25 | <span class="icon-bar"></span>
|
26 | <span class="icon-bar"></span>
|
27 | <span class="icon-bar"></span>
|
28 | </button>
|
29 | </div>
|
30 | <div class="navbar-collapse collapse" id="topNavigation">
|
31 | <ul class="nav navbar-nav">
|
32 |
|
33 | <li class="dropdown">
|
34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
35 | <ul class="dropdown-menu inline">
|
36 | <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
|
37 | </ul>
|
38 | </li>
|
39 |
|
40 | <li class="dropdown">
|
41 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
42 | <ul class="dropdown-menu inline">
|
43 | <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
|
44 | </ul>
|
45 | </li>
|
46 |
|
47 | <li class="dropdown">
|
48 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
49 | <ul class="dropdown-menu inline">
|
50 | <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
|
51 | </ul>
|
52 | </li>
|
53 |
|
54 | </ul>
|
55 |
|
56 | <div class="col-sm-3 col-md-3">
|
57 | <form class="navbar-form" role="search">
|
58 | <div class="input-group">
|
59 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
60 | <div class="input-group-btn">
|
61 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
62 | </div>
|
63 | </div>
|
64 | </form>
|
65 | </div>
|
66 |
|
67 | </div>
|
68 |
|
69 | </div>
|
70 | </div>
|
71 |
|
72 |
|
73 | <div class="container" id="toc-content" style="width:100%;">
|
74 | <div class="row" style="width:100%;">
|
75 |
|
76 |
|
77 | <div class="col-md-8" style="width:85%;">
|
78 |
|
79 | <div id="main">
|
80 |
|
81 |
|
82 |
|
83 | <h1 class="page-title">Class: CB_GraphicSprites</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 | CB_GraphicSprites
|
91 | </h2>
|
92 |
|
93 | <div class="class-description"><p>Class to manage a group of graphic sprites (2D or 3D).</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_GraphicSprites"><span class="type-signature"></span>new CB_GraphicSprites<span class="signature">( [spritesGroup] [, byReference])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html">CB_GraphicSprites</a>}</span></h4>
|
106 |
|
107 |
|
108 | </dt>
|
109 | <dd>
|
110 |
|
111 |
|
112 | <div class="description">
|
113 | <p>Class to manage a group of graphic sprites (2D or 3D).</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>spritesGroup</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_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_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 sprites. The information will be used for the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property. Used as the "spritesGroup" parameter when calling the <a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a> method internally.</p></td>
|
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 | !!<code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code>
|
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 default value when the "byReference" property is not given in the sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects). The value will be stored in the <a href="CB_GraphicSprites.html#byReference_DEFAULT"><code>CB_GraphicSprites#byReference_DEFAULT</code></a> property. If a boolean value is not provided, it will use the value of the <code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code> property of the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object (parsed to boolean).</p></td>
|
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_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
268 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-233">line 233</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 when the same sprite is received by parameter. The same with sub-sprites, receiving the sub-sprite by parameter. The same to remove the sprites group object, receiving a sprites group object by parameter. Only remove them if they match exactly.</li>
|
285 | </ul>
|
286 | </dd>
|
287 |
|
288 | </dl>
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 | <h5>Returns:</h5>
|
303 |
|
304 |
|
305 | <div class="param-desc">
|
306 | <p>Returns a new <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object.</p>
|
307 | </div>
|
308 |
|
309 |
|
310 |
|
311 | <dl>
|
312 | <dt>
|
313 | Type
|
314 | </dt>
|
315 | <dd>
|
316 |
|
317 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
318 |
|
319 |
|
320 |
|
321 | </dd>
|
322 | </dl>
|
323 |
|
324 |
|
325 |
|
326 |
|
327 |
|
328 | </dd>
|
329 |
|
330 |
|
331 | </div>
|
332 |
|
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 |
|
344 | <h3 class="subsection-title">Members</h3>
|
345 |
|
346 | <dl>
|
347 |
|
348 | <hr>
|
349 | <dt class="name" id="byReference_DEFAULT">
|
350 | <h4 id="byReference_DEFAULT"><span class="type-signature"></span>byReference_DEFAULT<span class="type-signature"> :boolean</span></h4>
|
351 |
|
352 |
|
353 | </dt>
|
354 | <dd>
|
355 |
|
356 | <div class="description">
|
357 | <p>This value will be used as the default value when the "byReference" property is not given in the sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects).</p>
|
358 | </div>
|
359 |
|
360 |
|
361 |
|
362 | <h5>Type:</h5>
|
363 | <ul>
|
364 | <li>
|
365 |
|
366 | <span class="param-type">boolean</span>
|
367 |
|
368 |
|
369 |
|
370 | </li>
|
371 | </ul>
|
372 |
|
373 |
|
374 |
|
375 | <dl class="details">
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
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 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
406 | <dd class="tag-source">
|
407 | <ul class="dummy">
|
408 | <li>
|
409 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
410 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-311">line 311</a>
|
411 | </li>
|
412 | </ul>
|
413 | </dd>
|
414 |
|
415 |
|
416 |
|
417 |
|
418 |
|
419 |
|
420 |
|
421 | </dl>
|
422 |
|
423 |
|
424 |
|
425 | </dd>
|
426 |
|
427 |
|
428 |
|
429 | <hr>
|
430 | <dt class="name" id="id">
|
431 | <h4 id="id"><span class="type-signature"><readonly> </span>id<span class="type-signature"> :string|*</span></h4>
|
432 |
|
433 |
|
434 | </dt>
|
435 | <dd>
|
436 |
|
437 | <div class="description">
|
438 | <p>Identifier of the sprites group object (the "id" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property) and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself (same one). It should be unique. It must be a value which evaluates to true. By default, it is generated automatically (with an internal counter).</p>
|
439 | </div>
|
440 |
|
441 |
|
442 |
|
443 | <h5>Type:</h5>
|
444 | <ul>
|
445 | <li>
|
446 |
|
447 | <span class="param-type">string</span>
|
448 | |
|
449 |
|
450 | <span class="param-type">*</span>
|
451 |
|
452 |
|
453 |
|
454 | </li>
|
455 | </ul>
|
456 |
|
457 |
|
458 |
|
459 | <dl class="details">
|
460 |
|
461 |
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 |
|
476 |
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 |
|
483 |
|
484 |
|
485 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
486 | <dd class="tag-default">
|
487 | <ul class="dummy">
|
488 | <li>'CB_GraphicSprites_' + CB_GraphicSprites._idUnique++</li>
|
489 | </ul>
|
490 | </dd>
|
491 |
|
492 |
|
493 |
|
494 |
|
495 |
|
496 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
497 | <dd class="tag-source">
|
498 | <ul class="dummy">
|
499 | <li>
|
500 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
501 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-246">line 246</a>
|
502 | </li>
|
503 | </ul>
|
504 | </dd>
|
505 |
|
506 |
|
507 |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 | </dl>
|
513 |
|
514 |
|
515 |
|
516 | </dd>
|
517 |
|
518 |
|
519 |
|
520 | <hr>
|
521 | <dt class="name" id="isSprites">
|
522 | <h4 id="isSprites"><span class="type-signature"><constant> </span>isSprites<span class="type-signature"> :boolean</span></h4>
|
523 |
|
524 |
|
525 | </dt>
|
526 | <dd>
|
527 |
|
528 | <div class="description">
|
529 | <p>Property which is always set to true to help identify this type of object.</p>
|
530 | </div>
|
531 |
|
532 |
|
533 |
|
534 | <h5>Type:</h5>
|
535 | <ul>
|
536 | <li>
|
537 |
|
538 | <span class="param-type">boolean</span>
|
539 |
|
540 |
|
541 |
|
542 | </li>
|
543 | </ul>
|
544 |
|
545 |
|
546 |
|
547 | <dl class="details">
|
548 |
|
549 |
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 |
|
565 |
|
566 |
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
574 | <dd class="tag-default">
|
575 | <ul class="dummy">
|
576 | <li>true</li>
|
577 | </ul>
|
578 | </dd>
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
585 | <dd class="tag-source">
|
586 | <ul class="dummy">
|
587 | <li>
|
588 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
589 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-326">line 326</a>
|
590 | </li>
|
591 | </ul>
|
592 | </dd>
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 | </dl>
|
601 |
|
602 |
|
603 |
|
604 | </dd>
|
605 |
|
606 |
|
607 |
|
608 | <hr>
|
609 | <dt class="name" id="parent">
|
610 | <h4 id="parent"><span class="type-signature"><readonly> </span>parent<span class="type-signature"> :*</span></h4>
|
611 |
|
612 |
|
613 | </dt>
|
614 | <dd>
|
615 |
|
616 | <div class="description">
|
617 | <p>Property pointing to or containing its parent. It could be a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object. It is the same as the "parent" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property.</p>
|
618 | </div>
|
619 |
|
620 |
|
621 |
|
622 | <h5>Type:</h5>
|
623 | <ul>
|
624 | <li>
|
625 |
|
626 | <span class="param-type">*</span>
|
627 |
|
628 |
|
629 |
|
630 | </li>
|
631 | </ul>
|
632 |
|
633 |
|
634 |
|
635 | <dl class="details">
|
636 |
|
637 |
|
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 |
|
664 |
|
665 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
666 | <dd class="tag-source">
|
667 | <ul class="dummy">
|
668 | <li>
|
669 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
670 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-255">line 255</a>
|
671 | </li>
|
672 | </ul>
|
673 | </dd>
|
674 |
|
675 |
|
676 |
|
677 |
|
678 |
|
679 |
|
680 |
|
681 | </dl>
|
682 |
|
683 |
|
684 |
|
685 | </dd>
|
686 |
|
687 |
|
688 |
|
689 | <hr>
|
690 | <dt class="name" id="pointer">
|
691 | <h4 id="pointer"><span class="type-signature"><readonly> </span>pointer<span class="type-signature"> :integer</span></h4>
|
692 |
|
693 |
|
694 | </dt>
|
695 | <dd>
|
696 |
|
697 | <div class="description">
|
698 | <p>Pointer with the position of the current sprite (belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array).</p>
|
699 | </div>
|
700 |
|
701 |
|
702 |
|
703 | <h5>Type:</h5>
|
704 | <ul>
|
705 | <li>
|
706 |
|
707 | <span class="param-type">integer</span>
|
708 |
|
709 |
|
710 |
|
711 | </li>
|
712 | </ul>
|
713 |
|
714 |
|
715 |
|
716 | <dl class="details">
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 |
|
736 |
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
747 | <dd class="tag-source">
|
748 | <ul class="dummy">
|
749 | <li>
|
750 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
751 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-282">line 282</a>
|
752 | </li>
|
753 | </ul>
|
754 | </dd>
|
755 |
|
756 |
|
757 |
|
758 |
|
759 |
|
760 |
|
761 |
|
762 | </dl>
|
763 |
|
764 |
|
765 |
|
766 | </dd>
|
767 |
|
768 |
|
769 |
|
770 | <hr>
|
771 | <dt class="name" id="pointerPrevious">
|
772 | <h4 id="pointerPrevious"><span class="type-signature"><readonly> </span>pointerPrevious<span class="type-signature"> :integer</span></h4>
|
773 |
|
774 |
|
775 | </dt>
|
776 | <dd>
|
777 |
|
778 | <div class="description">
|
779 | <p>Keeps the previous value of the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if any).</p>
|
780 | </div>
|
781 |
|
782 |
|
783 |
|
784 | <h5>Type:</h5>
|
785 | <ul>
|
786 | <li>
|
787 |
|
788 | <span class="param-type">integer</span>
|
789 |
|
790 |
|
791 |
|
792 | </li>
|
793 | </ul>
|
794 |
|
795 |
|
796 |
|
797 | <dl class="details">
|
798 |
|
799 |
|
800 |
|
801 |
|
802 |
|
803 |
|
804 |
|
805 |
|
806 |
|
807 |
|
808 |
|
809 |
|
810 |
|
811 |
|
812 |
|
813 |
|
814 |
|
815 |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
828 | <dd class="tag-source">
|
829 | <ul class="dummy">
|
830 | <li>
|
831 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
832 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-292">line 292</a>
|
833 | </li>
|
834 | </ul>
|
835 | </dd>
|
836 |
|
837 |
|
838 |
|
839 |
|
840 |
|
841 |
|
842 |
|
843 | </dl>
|
844 |
|
845 |
|
846 |
|
847 | </dd>
|
848 |
|
849 |
|
850 |
|
851 | <hr>
|
852 | <dt class="name" id="spritesGroup">
|
853 | <h4 id="spritesGroup"><span class="type-signature"><readonly> </span>spritesGroup<span class="type-signature"> :<a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span></h4>
|
854 |
|
855 |
|
856 | </dt>
|
857 | <dd>
|
858 |
|
859 | <div class="description">
|
860 | <p>Object with information about the sprites.</p>
|
861 | </div>
|
862 |
|
863 |
|
864 |
|
865 | <h5>Type:</h5>
|
866 | <ul>
|
867 | <li>
|
868 |
|
869 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
870 |
|
871 |
|
872 |
|
873 | </li>
|
874 | </ul>
|
875 |
|
876 |
|
877 |
|
878 | <dl class="details">
|
879 |
|
880 |
|
881 |
|
882 |
|
883 |
|
884 |
|
885 |
|
886 |
|
887 |
|
888 |
|
889 |
|
890 |
|
891 |
|
892 |
|
893 |
|
894 |
|
895 |
|
896 |
|
897 |
|
898 |
|
899 |
|
900 |
|
901 |
|
902 |
|
903 |
|
904 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
905 | <dd class="tag-default">
|
906 | <ul class="dummy">
|
907 | <li>{}</li>
|
908 | </ul>
|
909 | </dd>
|
910 |
|
911 |
|
912 |
|
913 |
|
914 |
|
915 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
916 | <dd class="tag-source">
|
917 | <ul class="dummy">
|
918 | <li>
|
919 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
920 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-273">line 273</a>
|
921 | </li>
|
922 | </ul>
|
923 | </dd>
|
924 |
|
925 |
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 | </dl>
|
932 |
|
933 |
|
934 |
|
935 | </dd>
|
936 |
|
937 |
|
938 |
|
939 | <hr>
|
940 | <dt class="name" id="time">
|
941 | <h4 id="time"><span class="type-signature"><readonly> </span>time<span class="type-signature"> :integer</span></h4>
|
942 |
|
943 |
|
944 | </dt>
|
945 | <dd>
|
946 |
|
947 | <div class="description">
|
948 | <p>Stores the time in milliseconds when the current sprite was started being pointed (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which will be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally).</p>
|
949 | </div>
|
950 |
|
951 |
|
952 |
|
953 | <h5>Type:</h5>
|
954 | <ul>
|
955 | <li>
|
956 |
|
957 | <span class="param-type">integer</span>
|
958 |
|
959 |
|
960 |
|
961 | </li>
|
962 | </ul>
|
963 |
|
964 |
|
965 |
|
966 | <dl class="details">
|
967 |
|
968 |
|
969 |
|
970 |
|
971 |
|
972 |
|
973 |
|
974 |
|
975 |
|
976 |
|
977 |
|
978 |
|
979 |
|
980 |
|
981 |
|
982 |
|
983 |
|
984 |
|
985 |
|
986 |
|
987 |
|
988 |
|
989 |
|
990 |
|
991 |
|
992 |
|
993 |
|
994 |
|
995 |
|
996 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
997 | <dd class="tag-source">
|
998 | <ul class="dummy">
|
999 | <li>
|
1000 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1001 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-302">line 302</a>
|
1002 | </li>
|
1003 | </ul>
|
1004 | </dd>
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 |
|
1010 |
|
1011 |
|
1012 | </dl>
|
1013 |
|
1014 |
|
1015 |
|
1016 | </dd>
|
1017 |
|
1018 |
|
1019 |
|
1020 | <hr>
|
1021 | <dt class="name" id="type">
|
1022 | <h4 id="type"><span class="type-signature"><constant> </span>type<span class="type-signature"> :string</span></h4>
|
1023 |
|
1024 |
|
1025 | </dt>
|
1026 | <dd>
|
1027 |
|
1028 | <div class="description">
|
1029 | <p>Indicates the type of object (always "sprites").</p>
|
1030 | </div>
|
1031 |
|
1032 |
|
1033 |
|
1034 | <h5>Type:</h5>
|
1035 | <ul>
|
1036 | <li>
|
1037 |
|
1038 | <span class="param-type">string</span>
|
1039 |
|
1040 |
|
1041 |
|
1042 | </li>
|
1043 | </ul>
|
1044 |
|
1045 |
|
1046 |
|
1047 | <dl class="details">
|
1048 |
|
1049 |
|
1050 |
|
1051 |
|
1052 |
|
1053 |
|
1054 |
|
1055 |
|
1056 |
|
1057 |
|
1058 |
|
1059 |
|
1060 |
|
1061 |
|
1062 |
|
1063 |
|
1064 |
|
1065 |
|
1066 |
|
1067 |
|
1068 |
|
1069 |
|
1070 |
|
1071 |
|
1072 |
|
1073 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1074 | <dd class="tag-default">
|
1075 | <ul class="dummy">
|
1076 | <li>sprites</li>
|
1077 | </ul>
|
1078 | </dd>
|
1079 |
|
1080 |
|
1081 |
|
1082 |
|
1083 |
|
1084 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1085 | <dd class="tag-source">
|
1086 | <ul class="dummy">
|
1087 | <li>
|
1088 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1089 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-335">line 335</a>
|
1090 | </li>
|
1091 | </ul>
|
1092 | </dd>
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 |
|
1100 | </dl>
|
1101 |
|
1102 |
|
1103 |
|
1104 | </dd>
|
1105 |
|
1106 |
|
1107 |
|
1108 | <hr>
|
1109 | <dt class="name" id="zIndex">
|
1110 | <h4 id="zIndex"><span class="type-signature"><readonly> </span>zIndex<span class="type-signature"> :number</span></h4>
|
1111 |
|
1112 |
|
1113 | </dt>
|
1114 | <dd>
|
1115 |
|
1116 | <div class="description">
|
1117 | <p>Z-index of the sprites group object (the "zIndex" property of the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property) and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself (same one). To change the value of this property, use the <a href="CB_GraphicSprites.html#setZIndex"><code>CB_GraphicSprites#setZIndex</code></a> method (which will call the <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally if there is a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> parent object). Only numeric values which are not zero (0) are allowed.</p>
|
1118 | </div>
|
1119 |
|
1120 |
|
1121 |
|
1122 | <h5>Type:</h5>
|
1123 | <ul>
|
1124 | <li>
|
1125 |
|
1126 | <span class="param-type">number</span>
|
1127 |
|
1128 |
|
1129 |
|
1130 | </li>
|
1131 | </ul>
|
1132 |
|
1133 |
|
1134 |
|
1135 | <dl class="details">
|
1136 |
|
1137 |
|
1138 |
|
1139 |
|
1140 |
|
1141 |
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 |
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 |
|
1159 |
|
1160 |
|
1161 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1162 | <dd class="tag-default">
|
1163 | <ul class="dummy">
|
1164 | <li>CB_GraphicSprites.ZINDEX_DEFAULT</li>
|
1165 | </ul>
|
1166 | </dd>
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 |
|
1172 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1173 | <dd class="tag-source">
|
1174 | <ul class="dummy">
|
1175 | <li>
|
1176 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1177 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-264">line 264</a>
|
1178 | </li>
|
1179 | </ul>
|
1180 | </dd>
|
1181 |
|
1182 |
|
1183 |
|
1184 |
|
1185 |
|
1186 |
|
1187 |
|
1188 | </dl>
|
1189 |
|
1190 |
|
1191 |
|
1192 | </dd>
|
1193 |
|
1194 |
|
1195 |
|
1196 | <hr>
|
1197 | <dt class="name" id=".HEIGHT_DEFAULT">
|
1198 | <h4 id=".HEIGHT_DEFAULT"><span class="type-signature"><static, constant> </span>HEIGHT_DEFAULT<span class="type-signature"> :number</span></h4>
|
1199 |
|
1200 |
|
1201 | </dt>
|
1202 | <dd>
|
1203 |
|
1204 | <div class="description">
|
1205 | <p>Default "height" of the destiny. Unit agnostic.</p>
|
1206 | </div>
|
1207 |
|
1208 |
|
1209 |
|
1210 | <h5>Type:</h5>
|
1211 | <ul>
|
1212 | <li>
|
1213 |
|
1214 | <span class="param-type">number</span>
|
1215 |
|
1216 |
|
1217 |
|
1218 | </li>
|
1219 | </ul>
|
1220 |
|
1221 |
|
1222 |
|
1223 | <dl class="details">
|
1224 |
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 |
|
1233 |
|
1234 |
|
1235 |
|
1236 |
|
1237 |
|
1238 |
|
1239 |
|
1240 |
|
1241 |
|
1242 |
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 |
|
1248 |
|
1249 |
|
1250 |
|
1251 |
|
1252 |
|
1253 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1254 | <dd class="tag-source">
|
1255 | <ul class="dummy">
|
1256 | <li>
|
1257 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1258 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-417">line 417</a>
|
1259 | </li>
|
1260 | </ul>
|
1261 | </dd>
|
1262 |
|
1263 |
|
1264 |
|
1265 |
|
1266 |
|
1267 |
|
1268 |
|
1269 | </dl>
|
1270 |
|
1271 |
|
1272 |
|
1273 | </dd>
|
1274 |
|
1275 |
|
1276 |
|
1277 | <hr>
|
1278 | <dt class="name" id=".HEIGHT_SOURCE_DEFAULT">
|
1279 | <h4 id=".HEIGHT_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>HEIGHT_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4>
|
1280 |
|
1281 |
|
1282 | </dt>
|
1283 | <dd>
|
1284 |
|
1285 | <div class="description">
|
1286 | <p>Default height ("srcHeight") of the original source. Unit agnostic.</p>
|
1287 | </div>
|
1288 |
|
1289 |
|
1290 |
|
1291 | <h5>Type:</h5>
|
1292 | <ul>
|
1293 | <li>
|
1294 |
|
1295 | <span class="param-type">number</span>
|
1296 |
|
1297 |
|
1298 |
|
1299 | </li>
|
1300 | </ul>
|
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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1331 | <dd class="tag-default">
|
1332 | <ul class="dummy">
|
1333 | <li>32</li>
|
1334 | </ul>
|
1335 | </dd>
|
1336 |
|
1337 |
|
1338 |
|
1339 |
|
1340 |
|
1341 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1342 | <dd class="tag-source">
|
1343 | <ul class="dummy">
|
1344 | <li>
|
1345 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1346 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-387">line 387</a>
|
1347 | </li>
|
1348 | </ul>
|
1349 | </dd>
|
1350 |
|
1351 |
|
1352 |
|
1353 |
|
1354 |
|
1355 |
|
1356 |
|
1357 | </dl>
|
1358 |
|
1359 |
|
1360 |
|
1361 | </dd>
|
1362 |
|
1363 |
|
1364 |
|
1365 | <hr>
|
1366 | <dt class="name" id=".LEFT_DEFAULT">
|
1367 | <h4 id=".LEFT_DEFAULT"><span class="type-signature"><static, constant> </span>LEFT_DEFAULT<span class="type-signature"> :number</span></h4>
|
1368 |
|
1369 |
|
1370 | </dt>
|
1371 | <dd>
|
1372 |
|
1373 | <div class="description">
|
1374 | <p>Default "left" (horizontal position) in the destiny. Unit agnostic.</p>
|
1375 | </div>
|
1376 |
|
1377 |
|
1378 |
|
1379 | <h5>Type:</h5>
|
1380 | <ul>
|
1381 | <li>
|
1382 |
|
1383 | <span class="param-type">number</span>
|
1384 |
|
1385 |
|
1386 |
|
1387 | </li>
|
1388 | </ul>
|
1389 |
|
1390 |
|
1391 |
|
1392 | <dl class="details">
|
1393 |
|
1394 |
|
1395 |
|
1396 |
|
1397 |
|
1398 |
|
1399 |
|
1400 |
|
1401 |
|
1402 |
|
1403 |
|
1404 |
|
1405 |
|
1406 |
|
1407 |
|
1408 |
|
1409 |
|
1410 |
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 |
|
1416 |
|
1417 |
|
1418 |
|
1419 |
|
1420 |
|
1421 |
|
1422 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1423 | <dd class="tag-source">
|
1424 | <ul class="dummy">
|
1425 | <li>
|
1426 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1427 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-425">line 425</a>
|
1428 | </li>
|
1429 | </ul>
|
1430 | </dd>
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 |
|
1437 |
|
1438 | </dl>
|
1439 |
|
1440 |
|
1441 |
|
1442 | </dd>
|
1443 |
|
1444 |
|
1445 |
|
1446 | <hr>
|
1447 | <dt class="name" id=".LEFT_SOURCE_DEFAULT">
|
1448 | <h4 id=".LEFT_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>LEFT_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4>
|
1449 |
|
1450 |
|
1451 | </dt>
|
1452 | <dd>
|
1453 |
|
1454 | <div class="description">
|
1455 | <p>Default left ("srcLeft", horizontal position) in the original source. Unit agnostic.</p>
|
1456 | </div>
|
1457 |
|
1458 |
|
1459 |
|
1460 | <h5>Type:</h5>
|
1461 | <ul>
|
1462 | <li>
|
1463 |
|
1464 | <span class="param-type">number</span>
|
1465 |
|
1466 |
|
1467 |
|
1468 | </li>
|
1469 | </ul>
|
1470 |
|
1471 |
|
1472 |
|
1473 | <dl class="details">
|
1474 |
|
1475 |
|
1476 |
|
1477 |
|
1478 |
|
1479 |
|
1480 |
|
1481 |
|
1482 |
|
1483 |
|
1484 |
|
1485 |
|
1486 |
|
1487 |
|
1488 |
|
1489 |
|
1490 |
|
1491 |
|
1492 |
|
1493 |
|
1494 |
|
1495 |
|
1496 |
|
1497 |
|
1498 |
|
1499 |
|
1500 |
|
1501 |
|
1502 |
|
1503 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1504 | <dd class="tag-source">
|
1505 | <ul class="dummy">
|
1506 | <li>
|
1507 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1508 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-395">line 395</a>
|
1509 | </li>
|
1510 | </ul>
|
1511 | </dd>
|
1512 |
|
1513 |
|
1514 |
|
1515 |
|
1516 |
|
1517 |
|
1518 |
|
1519 | </dl>
|
1520 |
|
1521 |
|
1522 |
|
1523 | </dd>
|
1524 |
|
1525 |
|
1526 |
|
1527 | <hr>
|
1528 | <dt class="name" id=".SRC_TYPES">
|
1529 | <h4 id=".SRC_TYPES"><span class="type-signature"><static, constant> </span>SRC_TYPES<span class="type-signature"> :object</span></h4>
|
1530 |
|
1531 |
|
1532 | </dt>
|
1533 | <dd>
|
1534 |
|
1535 | <div class="description">
|
1536 | <p>Object with some "srcType". Each property of this object belong to one source type, having an integer as value which represents it. You can define more source types here.</p>
|
1537 | </div>
|
1538 |
|
1539 |
|
1540 |
|
1541 | <h5>Type:</h5>
|
1542 | <ul>
|
1543 | <li>
|
1544 |
|
1545 | <span class="param-type">object</span>
|
1546 |
|
1547 |
|
1548 |
|
1549 | </li>
|
1550 | </ul>
|
1551 |
|
1552 |
|
1553 |
|
1554 | <dl class="details">
|
1555 |
|
1556 |
|
1557 |
|
1558 |
|
1559 |
|
1560 |
|
1561 |
|
1562 |
|
1563 |
|
1564 |
|
1565 |
|
1566 |
|
1567 |
|
1568 |
|
1569 |
|
1570 |
|
1571 |
|
1572 |
|
1573 |
|
1574 |
|
1575 |
|
1576 |
|
1577 |
|
1578 |
|
1579 |
|
1580 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1581 | <dd class="tag-default">
|
1582 | <ul class="dummy">
|
1583 | <li>{"DEFAULT":0,"IMAGE":0,"TEXT":1,"SEGMENT":2,"PIXEL":3,"RECTANGLE":4,"CIRCLE":5,"ARC":6,"ELLIPSE":7,"TRIANGLE":8,"BEZIER_CURVE":9,"QUADRATIC_BEZIER_CURVE":10,"BITMAP":11,"MAP":12}</li>
|
1584 | </ul>
|
1585 | </dd>
|
1586 |
|
1587 |
|
1588 |
|
1589 |
|
1590 |
|
1591 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1592 | <dd class="tag-source">
|
1593 | <ul class="dummy">
|
1594 | <li>
|
1595 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1596 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-344">line 344</a>
|
1597 | </li>
|
1598 | </ul>
|
1599 | </dd>
|
1600 |
|
1601 |
|
1602 |
|
1603 |
|
1604 |
|
1605 |
|
1606 |
|
1607 | </dl>
|
1608 |
|
1609 |
|
1610 |
|
1611 | </dd>
|
1612 |
|
1613 |
|
1614 |
|
1615 | <hr>
|
1616 | <dt class="name" id=".SRC_TYPES_DEFAULT">
|
1617 | <h4 id=".SRC_TYPES_DEFAULT"><span class="type-signature"><static, constant> </span>SRC_TYPES_DEFAULT<span class="type-signature"> :integer</span></h4>
|
1618 |
|
1619 |
|
1620 | </dt>
|
1621 | <dd>
|
1622 |
|
1623 | <div class="description">
|
1624 | <p>Default "srcType", the type of the original source.</p>
|
1625 | </div>
|
1626 |
|
1627 |
|
1628 |
|
1629 | <h5>Type:</h5>
|
1630 | <ul>
|
1631 | <li>
|
1632 |
|
1633 | <span class="param-type">integer</span>
|
1634 |
|
1635 |
|
1636 |
|
1637 | </li>
|
1638 | </ul>
|
1639 |
|
1640 |
|
1641 |
|
1642 | <dl class="details">
|
1643 |
|
1644 |
|
1645 |
|
1646 |
|
1647 |
|
1648 |
|
1649 |
|
1650 |
|
1651 |
|
1652 |
|
1653 |
|
1654 |
|
1655 |
|
1656 |
|
1657 |
|
1658 |
|
1659 |
|
1660 |
|
1661 |
|
1662 |
|
1663 |
|
1664 |
|
1665 |
|
1666 |
|
1667 |
|
1668 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1669 | <dd class="tag-default">
|
1670 | <ul class="dummy">
|
1671 | <li><code>CB_GraphicSprites.SRC_TYPES.IMAGE</code></li>
|
1672 | </ul>
|
1673 | </dd>
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1680 | <dd class="tag-source">
|
1681 | <ul class="dummy">
|
1682 | <li>
|
1683 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1684 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-372">line 372</a>
|
1685 | </li>
|
1686 | </ul>
|
1687 | </dd>
|
1688 |
|
1689 |
|
1690 |
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 | </dl>
|
1696 |
|
1697 |
|
1698 |
|
1699 | </dd>
|
1700 |
|
1701 |
|
1702 |
|
1703 | <hr>
|
1704 | <dt class="name" id=".TOP_DEFAULT">
|
1705 | <h4 id=".TOP_DEFAULT"><span class="type-signature"><static, constant> </span>TOP_DEFAULT<span class="type-signature"> :number</span></h4>
|
1706 |
|
1707 |
|
1708 | </dt>
|
1709 | <dd>
|
1710 |
|
1711 | <div class="description">
|
1712 | <p>Default "top" (vertical position) in the destiny. Unit agnostic.</p>
|
1713 | </div>
|
1714 |
|
1715 |
|
1716 |
|
1717 | <h5>Type:</h5>
|
1718 | <ul>
|
1719 | <li>
|
1720 |
|
1721 | <span class="param-type">number</span>
|
1722 |
|
1723 |
|
1724 |
|
1725 | </li>
|
1726 | </ul>
|
1727 |
|
1728 |
|
1729 |
|
1730 | <dl class="details">
|
1731 |
|
1732 |
|
1733 |
|
1734 |
|
1735 |
|
1736 |
|
1737 |
|
1738 |
|
1739 |
|
1740 |
|
1741 |
|
1742 |
|
1743 |
|
1744 |
|
1745 |
|
1746 |
|
1747 |
|
1748 |
|
1749 |
|
1750 |
|
1751 |
|
1752 |
|
1753 |
|
1754 |
|
1755 |
|
1756 |
|
1757 |
|
1758 |
|
1759 |
|
1760 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1761 | <dd class="tag-source">
|
1762 | <ul class="dummy">
|
1763 | <li>
|
1764 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1765 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-432">line 432</a>
|
1766 | </li>
|
1767 | </ul>
|
1768 | </dd>
|
1769 |
|
1770 |
|
1771 |
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 | </dl>
|
1777 |
|
1778 |
|
1779 |
|
1780 | </dd>
|
1781 |
|
1782 |
|
1783 |
|
1784 | <hr>
|
1785 | <dt class="name" id=".TOP_SOURCE_DEFAULT">
|
1786 | <h4 id=".TOP_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>TOP_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4>
|
1787 |
|
1788 |
|
1789 | </dt>
|
1790 | <dd>
|
1791 |
|
1792 | <div class="description">
|
1793 | <p>Default top ("srcTop", vertical position) in the original source. Unit agnostic.</p>
|
1794 | </div>
|
1795 |
|
1796 |
|
1797 |
|
1798 | <h5>Type:</h5>
|
1799 | <ul>
|
1800 | <li>
|
1801 |
|
1802 | <span class="param-type">number</span>
|
1803 |
|
1804 |
|
1805 |
|
1806 | </li>
|
1807 | </ul>
|
1808 |
|
1809 |
|
1810 |
|
1811 | <dl class="details">
|
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 |
|
1837 |
|
1838 |
|
1839 |
|
1840 |
|
1841 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1842 | <dd class="tag-source">
|
1843 | <ul class="dummy">
|
1844 | <li>
|
1845 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1846 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-402">line 402</a>
|
1847 | </li>
|
1848 | </ul>
|
1849 | </dd>
|
1850 |
|
1851 |
|
1852 |
|
1853 |
|
1854 |
|
1855 |
|
1856 |
|
1857 | </dl>
|
1858 |
|
1859 |
|
1860 |
|
1861 | </dd>
|
1862 |
|
1863 |
|
1864 |
|
1865 | <hr>
|
1866 | <dt class="name" id=".WIDTH_DEFAULT">
|
1867 | <h4 id=".WIDTH_DEFAULT"><span class="type-signature"><static, constant> </span>WIDTH_DEFAULT<span class="type-signature"> :number</span></h4>
|
1868 |
|
1869 |
|
1870 | </dt>
|
1871 | <dd>
|
1872 |
|
1873 | <div class="description">
|
1874 | <p>Default "width" of the destiny. Unit agnostic.</p>
|
1875 | </div>
|
1876 |
|
1877 |
|
1878 |
|
1879 | <h5>Type:</h5>
|
1880 | <ul>
|
1881 | <li>
|
1882 |
|
1883 | <span class="param-type">number</span>
|
1884 |
|
1885 |
|
1886 |
|
1887 | </li>
|
1888 | </ul>
|
1889 |
|
1890 |
|
1891 |
|
1892 | <dl class="details">
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 |
|
1899 |
|
1900 |
|
1901 |
|
1902 |
|
1903 |
|
1904 |
|
1905 |
|
1906 |
|
1907 |
|
1908 |
|
1909 |
|
1910 |
|
1911 |
|
1912 |
|
1913 |
|
1914 |
|
1915 |
|
1916 |
|
1917 |
|
1918 |
|
1919 |
|
1920 |
|
1921 |
|
1922 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1923 | <dd class="tag-source">
|
1924 | <ul class="dummy">
|
1925 | <li>
|
1926 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
1927 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-410">line 410</a>
|
1928 | </li>
|
1929 | </ul>
|
1930 | </dd>
|
1931 |
|
1932 |
|
1933 |
|
1934 |
|
1935 |
|
1936 |
|
1937 |
|
1938 | </dl>
|
1939 |
|
1940 |
|
1941 |
|
1942 | </dd>
|
1943 |
|
1944 |
|
1945 |
|
1946 | <hr>
|
1947 | <dt class="name" id=".WIDTH_SOURCE_DEFAULT">
|
1948 | <h4 id=".WIDTH_SOURCE_DEFAULT"><span class="type-signature"><static, constant> </span>WIDTH_SOURCE_DEFAULT<span class="type-signature"> :number</span></h4>
|
1949 |
|
1950 |
|
1951 | </dt>
|
1952 | <dd>
|
1953 |
|
1954 | <div class="description">
|
1955 | <p>Default width ("srcWidth") of the original source. Unit agnostic.</p>
|
1956 | </div>
|
1957 |
|
1958 |
|
1959 |
|
1960 | <h5>Type:</h5>
|
1961 | <ul>
|
1962 | <li>
|
1963 |
|
1964 | <span class="param-type">number</span>
|
1965 |
|
1966 |
|
1967 |
|
1968 | </li>
|
1969 | </ul>
|
1970 |
|
1971 |
|
1972 |
|
1973 | <dl class="details">
|
1974 |
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 |
|
1980 |
|
1981 |
|
1982 |
|
1983 |
|
1984 |
|
1985 |
|
1986 |
|
1987 |
|
1988 |
|
1989 |
|
1990 |
|
1991 |
|
1992 |
|
1993 |
|
1994 |
|
1995 |
|
1996 |
|
1997 |
|
1998 |
|
1999 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
2000 | <dd class="tag-default">
|
2001 | <ul class="dummy">
|
2002 | <li>32</li>
|
2003 | </ul>
|
2004 | </dd>
|
2005 |
|
2006 |
|
2007 |
|
2008 |
|
2009 |
|
2010 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2011 | <dd class="tag-source">
|
2012 | <ul class="dummy">
|
2013 | <li>
|
2014 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2015 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-380">line 380</a>
|
2016 | </li>
|
2017 | </ul>
|
2018 | </dd>
|
2019 |
|
2020 |
|
2021 |
|
2022 |
|
2023 |
|
2024 |
|
2025 |
|
2026 | </dl>
|
2027 |
|
2028 |
|
2029 |
|
2030 | </dd>
|
2031 |
|
2032 |
|
2033 |
|
2034 | <hr>
|
2035 | <dt class="name" id=".ZINDEX_DEFAULT">
|
2036 | <h4 id=".ZINDEX_DEFAULT"><span class="type-signature"><static, constant> </span>ZINDEX_DEFAULT<span class="type-signature"> :number</span></h4>
|
2037 |
|
2038 |
|
2039 | </dt>
|
2040 | <dd>
|
2041 |
|
2042 | <div class="description">
|
2043 | <p>Default "zIndex" in the destiny.</p>
|
2044 | </div>
|
2045 |
|
2046 |
|
2047 |
|
2048 | <h5>Type:</h5>
|
2049 | <ul>
|
2050 | <li>
|
2051 |
|
2052 | <span class="param-type">number</span>
|
2053 |
|
2054 |
|
2055 |
|
2056 | </li>
|
2057 | </ul>
|
2058 |
|
2059 |
|
2060 |
|
2061 | <dl class="details">
|
2062 |
|
2063 |
|
2064 |
|
2065 |
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 |
|
2071 |
|
2072 |
|
2073 |
|
2074 |
|
2075 |
|
2076 |
|
2077 |
|
2078 |
|
2079 |
|
2080 |
|
2081 |
|
2082 |
|
2083 |
|
2084 |
|
2085 |
|
2086 |
|
2087 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
2088 | <dd class="tag-default">
|
2089 | <ul class="dummy">
|
2090 | <li>1</li>
|
2091 | </ul>
|
2092 | </dd>
|
2093 |
|
2094 |
|
2095 |
|
2096 |
|
2097 |
|
2098 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2099 | <dd class="tag-source">
|
2100 | <ul class="dummy">
|
2101 | <li>
|
2102 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2103 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-440">line 440</a>
|
2104 | </li>
|
2105 | </ul>
|
2106 | </dd>
|
2107 |
|
2108 |
|
2109 |
|
2110 |
|
2111 |
|
2112 |
|
2113 |
|
2114 | </dl>
|
2115 |
|
2116 |
|
2117 |
|
2118 | </dd>
|
2119 |
|
2120 |
|
2121 |
|
2122 | <hr>
|
2123 | <dt class="name" id=".filterProperties_DEFAULT_PROPERTIES">
|
2124 | <h4 id=".filterProperties_DEFAULT_PROPERTIES"><span class="type-signature"><static, constant> </span>filterProperties_DEFAULT_PROPERTIES<span class="type-signature"> :<a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span></h4>
|
2125 |
|
2126 |
|
2127 | </dt>
|
2128 | <dd>
|
2129 |
|
2130 | <div class="description">
|
2131 | <p>Object used as the default value for the "propertiesToKeepObject" parameter if not provided when calling the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function.</p>
|
2132 | </div>
|
2133 |
|
2134 |
|
2135 |
|
2136 | <h5>Type:</h5>
|
2137 | <ul>
|
2138 | <li>
|
2139 |
|
2140 | <span class="param-type"><a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span>
|
2141 |
|
2142 |
|
2143 |
|
2144 | </li>
|
2145 | </ul>
|
2146 |
|
2147 |
|
2148 |
|
2149 | <dl class="details">
|
2150 |
|
2151 |
|
2152 |
|
2153 |
|
2154 |
|
2155 |
|
2156 |
|
2157 |
|
2158 |
|
2159 |
|
2160 |
|
2161 |
|
2162 |
|
2163 |
|
2164 |
|
2165 |
|
2166 |
|
2167 |
|
2168 |
|
2169 |
|
2170 |
|
2171 |
|
2172 |
|
2173 |
|
2174 |
|
2175 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
2176 | <dd class="tag-default">
|
2177 | <ul class="dummy">
|
2178 | <li>{"spritesScene":"","spritesGroups":"","sprites":"","spritesGroup":"","sprite":"","subSprite":""}</li>
|
2179 | </ul>
|
2180 | </dd>
|
2181 |
|
2182 |
|
2183 |
|
2184 |
|
2185 |
|
2186 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2187 | <dd class="tag-source">
|
2188 | <ul class="dummy">
|
2189 | <li>
|
2190 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2191 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1887">line 1887</a>
|
2192 | </li>
|
2193 | </ul>
|
2194 | </dd>
|
2195 |
|
2196 |
|
2197 |
|
2198 |
|
2199 |
|
2200 |
|
2201 |
|
2202 | </dl>
|
2203 |
|
2204 |
|
2205 |
|
2206 | </dd>
|
2207 |
|
2208 | </dl>
|
2209 |
|
2210 |
|
2211 |
|
2212 | <h3 class="subsection-title">Methods</h3>
|
2213 |
|
2214 | <dl>
|
2215 |
|
2216 | <hr>
|
2217 | <dt>
|
2218 | <h4 class="name" id="current"><span class="type-signature"></span>current<span class="signature">()</span><span class="type-signature"></span></h4>
|
2219 |
|
2220 |
|
2221 | </dt>
|
2222 | <dd>
|
2223 |
|
2224 |
|
2225 | <div class="description">
|
2226 | <p>Alias for <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a>.</p>
|
2227 | </div>
|
2228 |
|
2229 |
|
2230 |
|
2231 |
|
2232 |
|
2233 |
|
2234 |
|
2235 |
|
2236 |
|
2237 |
|
2238 | <dl class="details">
|
2239 |
|
2240 |
|
2241 |
|
2242 |
|
2243 |
|
2244 |
|
2245 |
|
2246 |
|
2247 |
|
2248 |
|
2249 |
|
2250 |
|
2251 |
|
2252 |
|
2253 |
|
2254 |
|
2255 |
|
2256 |
|
2257 |
|
2258 |
|
2259 |
|
2260 |
|
2261 |
|
2262 |
|
2263 |
|
2264 |
|
2265 |
|
2266 |
|
2267 |
|
2268 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2269 | <dd class="tag-source">
|
2270 | <ul class="dummy">
|
2271 | <li>
|
2272 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2273 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1361">line 1361</a>
|
2274 | </li>
|
2275 | </ul>
|
2276 | </dd>
|
2277 |
|
2278 |
|
2279 |
|
2280 |
|
2281 |
|
2282 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
2283 | <dd class="tag-see">
|
2284 | <ul>
|
2285 | <li><a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a></li>
|
2286 | </ul>
|
2287 | </dd>
|
2288 |
|
2289 |
|
2290 |
|
2291 | </dl>
|
2292 |
|
2293 |
|
2294 |
|
2295 |
|
2296 |
|
2297 |
|
2298 |
|
2299 |
|
2300 |
|
2301 |
|
2302 |
|
2303 |
|
2304 |
|
2305 |
|
2306 |
|
2307 | </dd>
|
2308 |
|
2309 |
|
2310 |
|
2311 | <hr>
|
2312 | <dt>
|
2313 | <h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">()</span><span class="type-signature"></span></h4>
|
2314 |
|
2315 |
|
2316 | </dt>
|
2317 | <dd>
|
2318 |
|
2319 |
|
2320 | <div class="description">
|
2321 | <p>Destroys the graphic sprites object (removing all the sprites and their sub-sprites, etc.) and frees memory.</p>
|
2322 | </div>
|
2323 |
|
2324 |
|
2325 |
|
2326 |
|
2327 |
|
2328 |
|
2329 |
|
2330 |
|
2331 |
|
2332 |
|
2333 | <dl class="details">
|
2334 |
|
2335 |
|
2336 |
|
2337 |
|
2338 |
|
2339 |
|
2340 |
|
2341 |
|
2342 |
|
2343 |
|
2344 |
|
2345 |
|
2346 |
|
2347 |
|
2348 |
|
2349 |
|
2350 |
|
2351 |
|
2352 |
|
2353 |
|
2354 |
|
2355 |
|
2356 |
|
2357 |
|
2358 |
|
2359 |
|
2360 |
|
2361 |
|
2362 |
|
2363 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2364 | <dd class="tag-source">
|
2365 | <ul class="dummy">
|
2366 | <li>
|
2367 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2368 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-462">line 462</a>
|
2369 | </li>
|
2370 | </ul>
|
2371 | </dd>
|
2372 |
|
2373 |
|
2374 |
|
2375 |
|
2376 |
|
2377 |
|
2378 |
|
2379 | </dl>
|
2380 |
|
2381 |
|
2382 |
|
2383 |
|
2384 |
|
2385 |
|
2386 |
|
2387 |
|
2388 |
|
2389 |
|
2390 |
|
2391 |
|
2392 |
|
2393 |
|
2394 |
|
2395 | </dd>
|
2396 |
|
2397 |
|
2398 |
|
2399 | <hr>
|
2400 | <dt>
|
2401 | <h4 class="name" id="executeAll"><span class="type-signature"></span>executeAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
2402 |
|
2403 |
|
2404 | </dt>
|
2405 | <dd>
|
2406 |
|
2407 |
|
2408 | <div class="description">
|
2409 | <p>Alias for <a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a>.</p>
|
2410 | </div>
|
2411 |
|
2412 |
|
2413 |
|
2414 |
|
2415 |
|
2416 |
|
2417 |
|
2418 |
|
2419 |
|
2420 |
|
2421 | <dl class="details">
|
2422 |
|
2423 |
|
2424 |
|
2425 |
|
2426 |
|
2427 |
|
2428 |
|
2429 |
|
2430 |
|
2431 |
|
2432 |
|
2433 |
|
2434 |
|
2435 |
|
2436 |
|
2437 |
|
2438 |
|
2439 |
|
2440 |
|
2441 |
|
2442 |
|
2443 |
|
2444 |
|
2445 |
|
2446 |
|
2447 |
|
2448 |
|
2449 |
|
2450 |
|
2451 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2452 | <dd class="tag-source">
|
2453 | <ul class="dummy">
|
2454 | <li>
|
2455 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2456 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1219">line 1219</a>
|
2457 | </li>
|
2458 | </ul>
|
2459 | </dd>
|
2460 |
|
2461 |
|
2462 |
|
2463 |
|
2464 |
|
2465 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
2466 | <dd class="tag-see">
|
2467 | <ul>
|
2468 | <li><a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a></li>
|
2469 | </ul>
|
2470 | </dd>
|
2471 |
|
2472 |
|
2473 |
|
2474 | </dl>
|
2475 |
|
2476 |
|
2477 |
|
2478 |
|
2479 |
|
2480 |
|
2481 |
|
2482 |
|
2483 |
|
2484 |
|
2485 |
|
2486 |
|
2487 |
|
2488 |
|
2489 |
|
2490 | </dd>
|
2491 |
|
2492 |
|
2493 |
|
2494 | <hr>
|
2495 | <dt>
|
2496 | <h4 class="name" id="executeFunctionAll"><span class="type-signature"></span>executeFunctionAll<span class="signature">(functionEach [, orderedByZIndex] [, delayBetweenEach] [, sprites] [, returnSetTimeoutsArray] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> → {integer|array}</span></h4>
|
2497 |
|
2498 |
|
2499 | </dt>
|
2500 | <dd>
|
2501 |
|
2502 |
|
2503 | <div class="description">
|
2504 | <p>Performs a desired action, using the provided function, on all the existing sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or on the desired ones (if provided). Calls the <a href="CB_Arrays.html#.executeFunctionAll"><code>CB_Arrays.executeFunctionAll</code></a> function internally and returns its returning value.</p>
|
2505 | </div>
|
2506 |
|
2507 |
|
2508 |
|
2509 |
|
2510 |
|
2511 |
|
2512 |
|
2513 |
|
2514 | <h5>Parameters:</h5>
|
2515 |
|
2516 |
|
2517 | <table class="params table table-striped">
|
2518 | <thead>
|
2519 | <tr>
|
2520 |
|
2521 | <th style="width:12%; min-width:110px;">Name</th>
|
2522 |
|
2523 |
|
2524 | <th style="width:12%; min-width:110px;">Type</th>
|
2525 |
|
2526 |
|
2527 | <th style="width:12%; min-width:110px;">Argument</th>
|
2528 |
|
2529 |
|
2530 |
|
2531 | <th style="width:12%; min-width:110px;">Default</th>
|
2532 |
|
2533 |
|
2534 | <th class="last" style="min-width:310px;">Description</th>
|
2535 | </tr>
|
2536 | </thead>
|
2537 |
|
2538 | <tbody>
|
2539 |
|
2540 |
|
2541 | <tr>
|
2542 |
|
2543 | <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>
|
2544 |
|
2545 |
|
2546 | <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;">
|
2547 |
|
2548 |
|
2549 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
|
2550 |
|
2551 |
|
2552 |
|
2553 |
|
2554 | </td>
|
2555 |
|
2556 |
|
2557 | <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;">
|
2558 |
|
2559 |
|
2560 |
|
2561 |
|
2562 |
|
2563 | </td>
|
2564 |
|
2565 |
|
2566 |
|
2567 | <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;">
|
2568 |
|
2569 | </td>
|
2570 |
|
2571 |
|
2572 | <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 sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). As the first parameter it receives the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object of the "sprites" being looped, as the second parameter the position of this <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object in the "sprites" array provided (or, if not provided, in the array returned by the <a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</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#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object itself.</p></td>
|
2573 | </tr>
|
2574 |
|
2575 |
|
2576 |
|
2577 | <tr>
|
2578 |
|
2579 | <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>
|
2580 |
|
2581 |
|
2582 | <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;">
|
2583 |
|
2584 |
|
2585 | <span class="param-type">boolean</span>
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 | </td>
|
2591 |
|
2592 |
|
2593 | <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;">
|
2594 |
|
2595 | <optional><br>
|
2596 |
|
2597 |
|
2598 |
|
2599 |
|
2600 |
|
2601 | </td>
|
2602 |
|
2603 |
|
2604 |
|
2605 | <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;">
|
2606 |
|
2607 | false
|
2608 |
|
2609 | </td>
|
2610 |
|
2611 |
|
2612 | <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 sprites sorted by their z-index (ascending order).</p></td>
|
2613 | </tr>
|
2614 |
|
2615 |
|
2616 |
|
2617 | <tr>
|
2618 |
|
2619 | <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>
|
2620 |
|
2621 |
|
2622 | <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;">
|
2623 |
|
2624 |
|
2625 | <span class="param-type">number</span>
|
2626 | |
|
2627 |
|
2628 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
|
2629 |
|
2630 |
|
2631 |
|
2632 |
|
2633 | </td>
|
2634 |
|
2635 |
|
2636 | <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;">
|
2637 |
|
2638 | <optional><br>
|
2639 |
|
2640 |
|
2641 |
|
2642 |
|
2643 |
|
2644 | </td>
|
2645 |
|
2646 |
|
2647 |
|
2648 | <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;">
|
2649 |
|
2650 | 0
|
2651 |
|
2652 | </td>
|
2653 |
|
2654 |
|
2655 | <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#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
2656 | </tr>
|
2657 |
|
2658 |
|
2659 |
|
2660 | <tr>
|
2661 |
|
2662 | <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>sprites</code></td>
|
2663 |
|
2664 |
|
2665 | <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;">
|
2666 |
|
2667 |
|
2668 | <span class="param-type">array</span>
|
2669 |
|
2670 |
|
2671 |
|
2672 |
|
2673 | </td>
|
2674 |
|
2675 |
|
2676 | <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;">
|
2677 |
|
2678 | <optional><br>
|
2679 |
|
2680 |
|
2681 |
|
2682 |
|
2683 |
|
2684 | </td>
|
2685 |
|
2686 |
|
2687 |
|
2688 | <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;">
|
2689 |
|
2690 | <a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</code></a>()
|
2691 |
|
2692 | </td>
|
2693 |
|
2694 |
|
2695 | <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 sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) that we want to loop. It should contain only <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects which are already in the current <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object. If not provided, it will use all the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects contained in the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object.</p></td>
|
2696 | </tr>
|
2697 |
|
2698 |
|
2699 |
|
2700 | <tr>
|
2701 |
|
2702 | <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>
|
2703 |
|
2704 |
|
2705 | <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;">
|
2706 |
|
2707 |
|
2708 | <span class="param-type">boolean</span>
|
2709 |
|
2710 |
|
2711 |
|
2712 |
|
2713 | </td>
|
2714 |
|
2715 |
|
2716 | <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;">
|
2717 |
|
2718 | <optional><br>
|
2719 |
|
2720 |
|
2721 |
|
2722 |
|
2723 |
|
2724 | </td>
|
2725 |
|
2726 |
|
2727 |
|
2728 | <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;">
|
2729 |
|
2730 | false
|
2731 |
|
2732 | </td>
|
2733 |
|
2734 |
|
2735 | <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>
|
2736 | </tr>
|
2737 |
|
2738 |
|
2739 |
|
2740 | <tr>
|
2741 |
|
2742 | <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>
|
2743 |
|
2744 |
|
2745 | <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;">
|
2746 |
|
2747 |
|
2748 | <span class="param-type">boolean</span>
|
2749 |
|
2750 |
|
2751 |
|
2752 |
|
2753 | </td>
|
2754 |
|
2755 |
|
2756 | <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;">
|
2757 |
|
2758 | <optional><br>
|
2759 |
|
2760 |
|
2761 |
|
2762 |
|
2763 |
|
2764 | </td>
|
2765 |
|
2766 |
|
2767 |
|
2768 | <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;">
|
2769 |
|
2770 | false
|
2771 |
|
2772 | </td>
|
2773 |
|
2774 |
|
2775 | <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>
|
2776 | </tr>
|
2777 |
|
2778 |
|
2779 |
|
2780 | <tr>
|
2781 |
|
2782 | <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>
|
2783 |
|
2784 |
|
2785 | <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;">
|
2786 |
|
2787 |
|
2788 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_FINISH_CALLBACK">CB_Arrays.executeFunctionAll_ON_FINISH_CALLBACK</a></span>
|
2789 |
|
2790 |
|
2791 |
|
2792 |
|
2793 | </td>
|
2794 |
|
2795 |
|
2796 | <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;">
|
2797 |
|
2798 | <optional><br>
|
2799 |
|
2800 |
|
2801 |
|
2802 |
|
2803 |
|
2804 | </td>
|
2805 |
|
2806 |
|
2807 |
|
2808 | <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;">
|
2809 |
|
2810 | </td>
|
2811 |
|
2812 |
|
2813 | <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>
|
2814 | </tr>
|
2815 |
|
2816 |
|
2817 | </tbody>
|
2818 | </table>
|
2819 |
|
2820 |
|
2821 |
|
2822 |
|
2823 | <dl class="details">
|
2824 |
|
2825 |
|
2826 |
|
2827 |
|
2828 |
|
2829 |
|
2830 |
|
2831 |
|
2832 |
|
2833 |
|
2834 |
|
2835 |
|
2836 |
|
2837 |
|
2838 |
|
2839 |
|
2840 |
|
2841 |
|
2842 |
|
2843 |
|
2844 |
|
2845 |
|
2846 |
|
2847 |
|
2848 |
|
2849 |
|
2850 |
|
2851 |
|
2852 |
|
2853 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2854 | <dd class="tag-source">
|
2855 | <ul class="dummy">
|
2856 | <li>
|
2857 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
2858 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1247">line 1247</a>
|
2859 | </li>
|
2860 | </ul>
|
2861 | </dd>
|
2862 |
|
2863 |
|
2864 |
|
2865 |
|
2866 |
|
2867 |
|
2868 |
|
2869 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
2870 | <dd class="tag-todo">
|
2871 | <ul>
|
2872 | <li>Think about only allowing <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects (in the "sprites" parameter) which are already in the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> (identify them by their ID), to avoid problems.</li>
|
2873 | </ul>
|
2874 | </dd>
|
2875 |
|
2876 | </dl>
|
2877 |
|
2878 |
|
2879 |
|
2880 |
|
2881 |
|
2882 |
|
2883 |
|
2884 |
|
2885 |
|
2886 |
|
2887 |
|
2888 |
|
2889 |
|
2890 | <h5>Returns:</h5>
|
2891 |
|
2892 |
|
2893 | <div class="param-desc">
|
2894 | <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#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects given in the "sprites" 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#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</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>
|
2895 | </div>
|
2896 |
|
2897 |
|
2898 |
|
2899 | <dl>
|
2900 | <dt>
|
2901 | Type
|
2902 | </dt>
|
2903 | <dd>
|
2904 |
|
2905 | <span class="param-type">integer</span>
|
2906 | |
|
2907 |
|
2908 | <span class="param-type">array</span>
|
2909 |
|
2910 |
|
2911 |
|
2912 | </dd>
|
2913 | </dl>
|
2914 |
|
2915 |
|
2916 |
|
2917 |
|
2918 |
|
2919 | </dd>
|
2920 |
|
2921 |
|
2922 |
|
2923 | <hr>
|
2924 | <dt>
|
2925 | <h4 class="name" id="executeFunctionAllSubSprites"><span class="type-signature"></span>executeFunctionAllSubSprites<span class="signature">(functionEach [, orderedByZIndex] [, delayBetweenEach] [, sprite] [, returnSetTimeoutsArray] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> → {integer|array}</span></h4>
|
2926 |
|
2927 |
|
2928 | </dt>
|
2929 | <dd>
|
2930 |
|
2931 |
|
2932 | <div class="description">
|
2933 | <p>Performs a desired action, using the provided function, on all the existing sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects) from a given sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). Calls the <a href="CB_Arrays.html#.executeFunctionAll"><code>CB_Arrays.executeFunctionAll</code></a> function internally and returns its returning value.</p>
|
2934 | </div>
|
2935 |
|
2936 |
|
2937 |
|
2938 |
|
2939 |
|
2940 |
|
2941 |
|
2942 |
|
2943 | <h5>Parameters:</h5>
|
2944 |
|
2945 |
|
2946 | <table class="params table table-striped">
|
2947 | <thead>
|
2948 | <tr>
|
2949 |
|
2950 | <th style="width:12%; min-width:110px;">Name</th>
|
2951 |
|
2952 |
|
2953 | <th style="width:12%; min-width:110px;">Type</th>
|
2954 |
|
2955 |
|
2956 | <th style="width:12%; min-width:110px;">Argument</th>
|
2957 |
|
2958 |
|
2959 |
|
2960 | <th style="width:12%; min-width:110px;">Default</th>
|
2961 |
|
2962 |
|
2963 | <th class="last" style="min-width:310px;">Description</th>
|
2964 | </tr>
|
2965 | </thead>
|
2966 |
|
2967 | <tbody>
|
2968 |
|
2969 |
|
2970 | <tr>
|
2971 |
|
2972 | <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>
|
2973 |
|
2974 |
|
2975 | <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;">
|
2976 |
|
2977 |
|
2978 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 | </td>
|
2984 |
|
2985 |
|
2986 | <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;">
|
2987 |
|
2988 |
|
2989 |
|
2990 |
|
2991 |
|
2992 | </td>
|
2993 |
|
2994 |
|
2995 |
|
2996 | <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;">
|
2997 |
|
2998 | </td>
|
2999 |
|
3000 |
|
3001 | <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 sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) from the given sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). As the first parameter it receives the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object of the sub-sprites being looped, as the second parameter the position of this <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object in the "subSprites" property of the sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) provided (which is an array), 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#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object itself.</p></td>
|
3002 | </tr>
|
3003 |
|
3004 |
|
3005 |
|
3006 | <tr>
|
3007 |
|
3008 | <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>
|
3009 |
|
3010 |
|
3011 | <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;">
|
3012 |
|
3013 |
|
3014 | <span class="param-type">boolean</span>
|
3015 |
|
3016 |
|
3017 |
|
3018 |
|
3019 | </td>
|
3020 |
|
3021 |
|
3022 | <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;">
|
3023 |
|
3024 | <optional><br>
|
3025 |
|
3026 |
|
3027 |
|
3028 |
|
3029 |
|
3030 | </td>
|
3031 |
|
3032 |
|
3033 |
|
3034 | <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;">
|
3035 |
|
3036 | false
|
3037 |
|
3038 | </td>
|
3039 |
|
3040 |
|
3041 | <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 sub-sprites sorted by their z-index (ascending order).</p></td>
|
3042 | </tr>
|
3043 |
|
3044 |
|
3045 |
|
3046 | <tr>
|
3047 |
|
3048 | <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>
|
3049 |
|
3050 |
|
3051 | <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;">
|
3052 |
|
3053 |
|
3054 | <span class="param-type">number</span>
|
3055 | |
|
3056 |
|
3057 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
|
3058 |
|
3059 |
|
3060 |
|
3061 |
|
3062 | </td>
|
3063 |
|
3064 |
|
3065 | <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;">
|
3066 |
|
3067 | <optional><br>
|
3068 |
|
3069 |
|
3070 |
|
3071 |
|
3072 |
|
3073 | </td>
|
3074 |
|
3075 |
|
3076 |
|
3077 | <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;">
|
3078 |
|
3079 | 0
|
3080 |
|
3081 | </td>
|
3082 |
|
3083 |
|
3084 | <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#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object).</p></td>
|
3085 | </tr>
|
3086 |
|
3087 |
|
3088 |
|
3089 | <tr>
|
3090 |
|
3091 | <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>sprite</code></td>
|
3092 |
|
3093 |
|
3094 | <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;">
|
3095 |
|
3096 |
|
3097 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
3098 |
|
3099 |
|
3100 |
|
3101 |
|
3102 | </td>
|
3103 |
|
3104 |
|
3105 | <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;">
|
3106 |
|
3107 | <optional><br>
|
3108 |
|
3109 |
|
3110 |
|
3111 |
|
3112 |
|
3113 | </td>
|
3114 |
|
3115 |
|
3116 |
|
3117 | <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;">
|
3118 |
|
3119 | CB_GraphicSprites#getCurrent()
|
3120 |
|
3121 | </td>
|
3122 |
|
3123 |
|
3124 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite and its sub-sprites. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
3125 | </tr>
|
3126 |
|
3127 |
|
3128 |
|
3129 | <tr>
|
3130 |
|
3131 | <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>
|
3132 |
|
3133 |
|
3134 | <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;">
|
3135 |
|
3136 |
|
3137 | <span class="param-type">boolean</span>
|
3138 |
|
3139 |
|
3140 |
|
3141 |
|
3142 | </td>
|
3143 |
|
3144 |
|
3145 | <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;">
|
3146 |
|
3147 | <optional><br>
|
3148 |
|
3149 |
|
3150 |
|
3151 |
|
3152 |
|
3153 | </td>
|
3154 |
|
3155 |
|
3156 |
|
3157 | <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;">
|
3158 |
|
3159 | false
|
3160 |
|
3161 | </td>
|
3162 |
|
3163 |
|
3164 | <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>
|
3165 | </tr>
|
3166 |
|
3167 |
|
3168 |
|
3169 | <tr>
|
3170 |
|
3171 | <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>
|
3172 |
|
3173 |
|
3174 | <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;">
|
3175 |
|
3176 |
|
3177 | <span class="param-type">boolean</span>
|
3178 |
|
3179 |
|
3180 |
|
3181 |
|
3182 | </td>
|
3183 |
|
3184 |
|
3185 | <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;">
|
3186 |
|
3187 | <optional><br>
|
3188 |
|
3189 |
|
3190 |
|
3191 |
|
3192 |
|
3193 | </td>
|
3194 |
|
3195 |
|
3196 |
|
3197 | <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;">
|
3198 |
|
3199 | false
|
3200 |
|
3201 | </td>
|
3202 |
|
3203 |
|
3204 | <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>
|
3205 | </tr>
|
3206 |
|
3207 |
|
3208 |
|
3209 | <tr>
|
3210 |
|
3211 | <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>
|
3212 |
|
3213 |
|
3214 | <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;">
|
3215 |
|
3216 |
|
3217 | <span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_FINISH_CALLBACK">CB_Arrays.executeFunctionAll_ON_FINISH_CALLBACK</a></span>
|
3218 |
|
3219 |
|
3220 |
|
3221 |
|
3222 | </td>
|
3223 |
|
3224 |
|
3225 | <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;">
|
3226 |
|
3227 | <optional><br>
|
3228 |
|
3229 |
|
3230 |
|
3231 |
|
3232 |
|
3233 | </td>
|
3234 |
|
3235 |
|
3236 |
|
3237 | <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;">
|
3238 |
|
3239 | </td>
|
3240 |
|
3241 |
|
3242 | <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>
|
3243 | </tr>
|
3244 |
|
3245 |
|
3246 | </tbody>
|
3247 | </table>
|
3248 |
|
3249 |
|
3250 |
|
3251 |
|
3252 | <dl class="details">
|
3253 |
|
3254 |
|
3255 |
|
3256 |
|
3257 |
|
3258 |
|
3259 |
|
3260 |
|
3261 |
|
3262 |
|
3263 |
|
3264 |
|
3265 |
|
3266 |
|
3267 |
|
3268 |
|
3269 |
|
3270 |
|
3271 |
|
3272 |
|
3273 |
|
3274 |
|
3275 |
|
3276 |
|
3277 |
|
3278 |
|
3279 |
|
3280 |
|
3281 |
|
3282 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3283 | <dd class="tag-source">
|
3284 | <ul class="dummy">
|
3285 | <li>
|
3286 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3287 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1276">line 1276</a>
|
3288 | </li>
|
3289 | </ul>
|
3290 | </dd>
|
3291 |
|
3292 |
|
3293 |
|
3294 |
|
3295 |
|
3296 |
|
3297 |
|
3298 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
3299 | <dd class="tag-todo">
|
3300 | <ul>
|
3301 | <li>Think about only allowing <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects (in the "sprite" parameter) which are already in the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> (identify them by their ID), to avoid problems.</li>
|
3302 | </ul>
|
3303 | </dd>
|
3304 |
|
3305 | </dl>
|
3306 |
|
3307 |
|
3308 |
|
3309 |
|
3310 |
|
3311 |
|
3312 |
|
3313 |
|
3314 |
|
3315 |
|
3316 |
|
3317 |
|
3318 |
|
3319 | <h5>Returns:</h5>
|
3320 |
|
3321 |
|
3322 | <div class="param-desc">
|
3323 | <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 existing <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects in the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). 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#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a>. 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>
|
3324 | </div>
|
3325 |
|
3326 |
|
3327 |
|
3328 | <dl>
|
3329 | <dt>
|
3330 | Type
|
3331 | </dt>
|
3332 | <dd>
|
3333 |
|
3334 | <span class="param-type">integer</span>
|
3335 | |
|
3336 |
|
3337 | <span class="param-type">array</span>
|
3338 |
|
3339 |
|
3340 |
|
3341 | </dd>
|
3342 | </dl>
|
3343 |
|
3344 |
|
3345 |
|
3346 |
|
3347 |
|
3348 | </dd>
|
3349 |
|
3350 |
|
3351 |
|
3352 | <hr>
|
3353 | <dt>
|
3354 | <h4 class="name" id="forEach"><span class="type-signature"></span>forEach<span class="signature">()</span><span class="type-signature"></span></h4>
|
3355 |
|
3356 |
|
3357 | </dt>
|
3358 | <dd>
|
3359 |
|
3360 |
|
3361 | <div class="description">
|
3362 | <p>Alias for <a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a>.</p>
|
3363 | </div>
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 | <dl class="details">
|
3375 |
|
3376 |
|
3377 |
|
3378 |
|
3379 |
|
3380 |
|
3381 |
|
3382 |
|
3383 |
|
3384 |
|
3385 |
|
3386 |
|
3387 |
|
3388 |
|
3389 |
|
3390 |
|
3391 |
|
3392 |
|
3393 |
|
3394 |
|
3395 |
|
3396 |
|
3397 |
|
3398 |
|
3399 |
|
3400 |
|
3401 |
|
3402 |
|
3403 |
|
3404 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3405 | <dd class="tag-source">
|
3406 | <ul class="dummy">
|
3407 | <li>
|
3408 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3409 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1224">line 1224</a>
|
3410 | </li>
|
3411 | </ul>
|
3412 | </dd>
|
3413 |
|
3414 |
|
3415 |
|
3416 |
|
3417 |
|
3418 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3419 | <dd class="tag-see">
|
3420 | <ul>
|
3421 | <li><a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a></li>
|
3422 | </ul>
|
3423 | </dd>
|
3424 |
|
3425 |
|
3426 |
|
3427 | </dl>
|
3428 |
|
3429 |
|
3430 |
|
3431 |
|
3432 |
|
3433 |
|
3434 |
|
3435 |
|
3436 |
|
3437 |
|
3438 |
|
3439 |
|
3440 |
|
3441 |
|
3442 |
|
3443 | </dd>
|
3444 |
|
3445 |
|
3446 |
|
3447 | <hr>
|
3448 | <dt>
|
3449 | <h4 class="name" id="forEachSprite"><span class="type-signature"></span>forEachSprite<span class="signature">()</span><span class="type-signature"></span></h4>
|
3450 |
|
3451 |
|
3452 | </dt>
|
3453 | <dd>
|
3454 |
|
3455 |
|
3456 | <div class="description">
|
3457 | <p>Alias for <a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a>.</p>
|
3458 | </div>
|
3459 |
|
3460 |
|
3461 |
|
3462 |
|
3463 |
|
3464 |
|
3465 |
|
3466 |
|
3467 |
|
3468 |
|
3469 | <dl class="details">
|
3470 |
|
3471 |
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 |
|
3479 |
|
3480 |
|
3481 |
|
3482 |
|
3483 |
|
3484 |
|
3485 |
|
3486 |
|
3487 |
|
3488 |
|
3489 |
|
3490 |
|
3491 |
|
3492 |
|
3493 |
|
3494 |
|
3495 |
|
3496 |
|
3497 |
|
3498 |
|
3499 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3500 | <dd class="tag-source">
|
3501 | <ul class="dummy">
|
3502 | <li>
|
3503 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3504 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1229">line 1229</a>
|
3505 | </li>
|
3506 | </ul>
|
3507 | </dd>
|
3508 |
|
3509 |
|
3510 |
|
3511 |
|
3512 |
|
3513 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3514 | <dd class="tag-see">
|
3515 | <ul>
|
3516 | <li><a href="CB_GraphicSprites.html#executeFunctionAll"><code>CB_GraphicSprites#executeFunctionAll</code></a></li>
|
3517 | </ul>
|
3518 | </dd>
|
3519 |
|
3520 |
|
3521 |
|
3522 | </dl>
|
3523 |
|
3524 |
|
3525 |
|
3526 |
|
3527 |
|
3528 |
|
3529 |
|
3530 |
|
3531 |
|
3532 |
|
3533 |
|
3534 |
|
3535 |
|
3536 |
|
3537 |
|
3538 | </dd>
|
3539 |
|
3540 |
|
3541 |
|
3542 | <hr>
|
3543 | <dt>
|
3544 | <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">()</span><span class="type-signature"></span></h4>
|
3545 |
|
3546 |
|
3547 | </dt>
|
3548 | <dd>
|
3549 |
|
3550 |
|
3551 | <div class="description">
|
3552 | <p>Alias for <a href="CB_GraphicSprites.html#getSprite"><code>CB_GraphicSprites#getSprite</code></a>.</p>
|
3553 | </div>
|
3554 |
|
3555 |
|
3556 |
|
3557 |
|
3558 |
|
3559 |
|
3560 |
|
3561 |
|
3562 |
|
3563 |
|
3564 | <dl class="details">
|
3565 |
|
3566 |
|
3567 |
|
3568 |
|
3569 |
|
3570 |
|
3571 |
|
3572 |
|
3573 |
|
3574 |
|
3575 |
|
3576 |
|
3577 |
|
3578 |
|
3579 |
|
3580 |
|
3581 |
|
3582 |
|
3583 |
|
3584 |
|
3585 |
|
3586 |
|
3587 |
|
3588 |
|
3589 |
|
3590 |
|
3591 |
|
3592 |
|
3593 |
|
3594 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3595 | <dd class="tag-source">
|
3596 | <ul class="dummy">
|
3597 | <li>
|
3598 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3599 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1069">line 1069</a>
|
3600 | </li>
|
3601 | </ul>
|
3602 | </dd>
|
3603 |
|
3604 |
|
3605 |
|
3606 |
|
3607 |
|
3608 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3609 | <dd class="tag-see">
|
3610 | <ul>
|
3611 | <li><a href="CB_GraphicSprites.html#getSprite"><code>CB_GraphicSprites#getSprite</code></a></li>
|
3612 | </ul>
|
3613 | </dd>
|
3614 |
|
3615 |
|
3616 |
|
3617 | </dl>
|
3618 |
|
3619 |
|
3620 |
|
3621 |
|
3622 |
|
3623 |
|
3624 |
|
3625 |
|
3626 |
|
3627 |
|
3628 |
|
3629 |
|
3630 |
|
3631 |
|
3632 |
|
3633 | </dd>
|
3634 |
|
3635 |
|
3636 |
|
3637 | <hr>
|
3638 | <dt>
|
3639 | <h4 class="name" id="getAll"><span class="type-signature"></span>getAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
3640 |
|
3641 |
|
3642 | </dt>
|
3643 | <dd>
|
3644 |
|
3645 |
|
3646 | <div class="description">
|
3647 | <p>Alias for <a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</code></a>.</p>
|
3648 | </div>
|
3649 |
|
3650 |
|
3651 |
|
3652 |
|
3653 |
|
3654 |
|
3655 |
|
3656 |
|
3657 |
|
3658 |
|
3659 | <dl class="details">
|
3660 |
|
3661 |
|
3662 |
|
3663 |
|
3664 |
|
3665 |
|
3666 |
|
3667 |
|
3668 |
|
3669 |
|
3670 |
|
3671 |
|
3672 |
|
3673 |
|
3674 |
|
3675 |
|
3676 |
|
3677 |
|
3678 |
|
3679 |
|
3680 |
|
3681 |
|
3682 |
|
3683 |
|
3684 |
|
3685 |
|
3686 |
|
3687 |
|
3688 |
|
3689 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3690 | <dd class="tag-source">
|
3691 | <ul class="dummy">
|
3692 | <li>
|
3693 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3694 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1035">line 1035</a>
|
3695 | </li>
|
3696 | </ul>
|
3697 | </dd>
|
3698 |
|
3699 |
|
3700 |
|
3701 |
|
3702 |
|
3703 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3704 | <dd class="tag-see">
|
3705 | <ul>
|
3706 | <li><a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</code></a></li>
|
3707 | </ul>
|
3708 | </dd>
|
3709 |
|
3710 |
|
3711 |
|
3712 | </dl>
|
3713 |
|
3714 |
|
3715 |
|
3716 |
|
3717 |
|
3718 |
|
3719 |
|
3720 |
|
3721 |
|
3722 |
|
3723 |
|
3724 |
|
3725 |
|
3726 |
|
3727 |
|
3728 | </dd>
|
3729 |
|
3730 |
|
3731 |
|
3732 | <hr>
|
3733 | <dt>
|
3734 | <h4 class="name" id="getById"><span class="type-signature"></span>getById<span class="signature">()</span><span class="type-signature"></span></h4>
|
3735 |
|
3736 |
|
3737 | </dt>
|
3738 | <dd>
|
3739 |
|
3740 |
|
3741 | <div class="description">
|
3742 | <p>Alias for <a href="CB_GraphicSprites.html#getSpriteById"><code>CB_GraphicSprites#getSpriteById</code></a>.</p>
|
3743 | </div>
|
3744 |
|
3745 |
|
3746 |
|
3747 |
|
3748 |
|
3749 |
|
3750 |
|
3751 |
|
3752 |
|
3753 |
|
3754 | <dl class="details">
|
3755 |
|
3756 |
|
3757 |
|
3758 |
|
3759 |
|
3760 |
|
3761 |
|
3762 |
|
3763 |
|
3764 |
|
3765 |
|
3766 |
|
3767 |
|
3768 |
|
3769 |
|
3770 |
|
3771 |
|
3772 |
|
3773 |
|
3774 |
|
3775 |
|
3776 |
|
3777 |
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3785 | <dd class="tag-source">
|
3786 | <ul class="dummy">
|
3787 | <li>
|
3788 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
3789 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1090">line 1090</a>
|
3790 | </li>
|
3791 | </ul>
|
3792 | </dd>
|
3793 |
|
3794 |
|
3795 |
|
3796 |
|
3797 |
|
3798 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3799 | <dd class="tag-see">
|
3800 | <ul>
|
3801 | <li><a href="CB_GraphicSprites.html#getSpriteById"><code>CB_GraphicSprites#getSpriteById</code></a></li>
|
3802 | </ul>
|
3803 | </dd>
|
3804 |
|
3805 |
|
3806 |
|
3807 | </dl>
|
3808 |
|
3809 |
|
3810 |
|
3811 |
|
3812 |
|
3813 |
|
3814 |
|
3815 |
|
3816 |
|
3817 |
|
3818 |
|
3819 |
|
3820 |
|
3821 |
|
3822 |
|
3823 | </dd>
|
3824 |
|
3825 |
|
3826 |
|
3827 | <hr>
|
3828 | <dt>
|
3829 | <h4 class="name" id="getCopy"><span class="type-signature"></span>getCopy<span class="signature">( [avoidCopyingPointer] [, avoidCopyingTimes] [, clearReferences] [, filterProperties] [, propertiesToKeepObject])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html">CB_GraphicSprites</a>}</span></h4>
|
3830 |
|
3831 |
|
3832 | </dt>
|
3833 | <dd>
|
3834 |
|
3835 |
|
3836 | <div class="description">
|
3837 | <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>
|
3838 | </div>
|
3839 |
|
3840 |
|
3841 |
|
3842 |
|
3843 |
|
3844 |
|
3845 |
|
3846 |
|
3847 | <h5>Parameters:</h5>
|
3848 |
|
3849 |
|
3850 | <table class="params table table-striped">
|
3851 | <thead>
|
3852 | <tr>
|
3853 |
|
3854 | <th style="width:12%; min-width:110px;">Name</th>
|
3855 |
|
3856 |
|
3857 | <th style="width:12%; min-width:110px;">Type</th>
|
3858 |
|
3859 |
|
3860 | <th style="width:12%; min-width:110px;">Argument</th>
|
3861 |
|
3862 |
|
3863 |
|
3864 | <th style="width:12%; min-width:110px;">Default</th>
|
3865 |
|
3866 |
|
3867 | <th class="last" style="min-width:310px;">Description</th>
|
3868 | </tr>
|
3869 | </thead>
|
3870 |
|
3871 | <tbody>
|
3872 |
|
3873 |
|
3874 | <tr>
|
3875 |
|
3876 | <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>avoidCopyingPointer</code></td>
|
3877 |
|
3878 |
|
3879 | <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;">
|
3880 |
|
3881 |
|
3882 | <span class="param-type">boolean</span>
|
3883 |
|
3884 |
|
3885 |
|
3886 |
|
3887 | </td>
|
3888 |
|
3889 |
|
3890 | <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;">
|
3891 |
|
3892 | <optional><br>
|
3893 |
|
3894 |
|
3895 |
|
3896 |
|
3897 |
|
3898 | </td>
|
3899 |
|
3900 |
|
3901 |
|
3902 | <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;">
|
3903 |
|
3904 | false
|
3905 |
|
3906 | </td>
|
3907 |
|
3908 |
|
3909 | <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 the object.</p></td>
|
3910 | </tr>
|
3911 |
|
3912 |
|
3913 |
|
3914 | <tr>
|
3915 |
|
3916 | <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>
|
3917 |
|
3918 |
|
3919 | <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;">
|
3920 |
|
3921 |
|
3922 | <span class="param-type">boolean</span>
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 | </td>
|
3928 |
|
3929 |
|
3930 | <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;">
|
3931 |
|
3932 | <optional><br>
|
3933 |
|
3934 |
|
3935 |
|
3936 |
|
3937 |
|
3938 | </td>
|
3939 |
|
3940 |
|
3941 |
|
3942 | <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;">
|
3943 |
|
3944 | false
|
3945 |
|
3946 | </td>
|
3947 |
|
3948 |
|
3949 | <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 property of the object nor the "time" property of each of its sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects).</p></td>
|
3950 | </tr>
|
3951 |
|
3952 |
|
3953 |
|
3954 | <tr>
|
3955 |
|
3956 | <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>
|
3957 |
|
3958 |
|
3959 | <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;">
|
3960 |
|
3961 |
|
3962 | <span class="param-type">boolean</span>
|
3963 |
|
3964 |
|
3965 |
|
3966 |
|
3967 | </td>
|
3968 |
|
3969 |
|
3970 | <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;">
|
3971 |
|
3972 | <optional><br>
|
3973 |
|
3974 |
|
3975 |
|
3976 |
|
3977 |
|
3978 | </td>
|
3979 |
|
3980 |
|
3981 |
|
3982 | <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;">
|
3983 |
|
3984 | false
|
3985 |
|
3986 | </td>
|
3987 |
|
3988 |
|
3989 | <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>
|
3990 | </tr>
|
3991 |
|
3992 |
|
3993 |
|
3994 | <tr>
|
3995 |
|
3996 | <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>
|
3997 |
|
3998 |
|
3999 | <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;">
|
4000 |
|
4001 |
|
4002 | <span class="param-type">boolean</span>
|
4003 |
|
4004 |
|
4005 |
|
4006 |
|
4007 | </td>
|
4008 |
|
4009 |
|
4010 | <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;">
|
4011 |
|
4012 | <optional><br>
|
4013 |
|
4014 |
|
4015 |
|
4016 |
|
4017 |
|
4018 | </td>
|
4019 |
|
4020 |
|
4021 |
|
4022 | <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;">
|
4023 |
|
4024 | false
|
4025 |
|
4026 | </td>
|
4027 |
|
4028 |
|
4029 | <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>
|
4030 | </tr>
|
4031 |
|
4032 |
|
4033 |
|
4034 | <tr>
|
4035 |
|
4036 | <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>
|
4037 |
|
4038 |
|
4039 | <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;">
|
4040 |
|
4041 |
|
4042 | <span class="param-type"><a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span>
|
4043 |
|
4044 |
|
4045 |
|
4046 |
|
4047 | </td>
|
4048 |
|
4049 |
|
4050 | <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;">
|
4051 |
|
4052 | <optional><br>
|
4053 |
|
4054 |
|
4055 |
|
4056 |
|
4057 |
|
4058 | </td>
|
4059 |
|
4060 |
|
4061 |
|
4062 | <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;">
|
4063 |
|
4064 | CB_GraphicSprites.filterProperties_DEFAULT_PROPERTIES
|
4065 |
|
4066 | </td>
|
4067 |
|
4068 |
|
4069 | <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>
|
4070 | </tr>
|
4071 |
|
4072 |
|
4073 | </tbody>
|
4074 | </table>
|
4075 |
|
4076 |
|
4077 |
|
4078 |
|
4079 | <dl class="details">
|
4080 |
|
4081 |
|
4082 |
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 |
|
4088 |
|
4089 |
|
4090 |
|
4091 |
|
4092 |
|
4093 |
|
4094 |
|
4095 |
|
4096 |
|
4097 |
|
4098 |
|
4099 |
|
4100 |
|
4101 |
|
4102 |
|
4103 |
|
4104 |
|
4105 |
|
4106 |
|
4107 |
|
4108 |
|
4109 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4110 | <dd class="tag-source">
|
4111 | <ul class="dummy">
|
4112 | <li>
|
4113 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4114 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1760">line 1760</a>
|
4115 | </li>
|
4116 | </ul>
|
4117 | </dd>
|
4118 |
|
4119 |
|
4120 |
|
4121 |
|
4122 |
|
4123 |
|
4124 |
|
4125 | </dl>
|
4126 |
|
4127 |
|
4128 |
|
4129 |
|
4130 |
|
4131 |
|
4132 |
|
4133 |
|
4134 |
|
4135 |
|
4136 |
|
4137 |
|
4138 |
|
4139 | <h5>Returns:</h5>
|
4140 |
|
4141 |
|
4142 | <div class="param-desc">
|
4143 | <p>Returns a copy of this object with the same attributes (all sub-objects will be a copy, not the same reference).</p>
|
4144 | </div>
|
4145 |
|
4146 |
|
4147 |
|
4148 | <dl>
|
4149 | <dt>
|
4150 | Type
|
4151 | </dt>
|
4152 | <dd>
|
4153 |
|
4154 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
4155 |
|
4156 |
|
4157 |
|
4158 | </dd>
|
4159 | </dl>
|
4160 |
|
4161 |
|
4162 |
|
4163 |
|
4164 |
|
4165 | </dd>
|
4166 |
|
4167 |
|
4168 |
|
4169 | <hr>
|
4170 | <dt>
|
4171 | <h4 class="name" id="getCurrent"><span class="type-signature"></span>getCurrent<span class="signature">()</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|null}</span></h4>
|
4172 |
|
4173 |
|
4174 | </dt>
|
4175 | <dd>
|
4176 |
|
4177 |
|
4178 | <div class="description">
|
4179 | <p>Gets the sprite (a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) which is being currently pointed (by the pointer set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property).</p>
|
4180 | </div>
|
4181 |
|
4182 |
|
4183 |
|
4184 |
|
4185 |
|
4186 |
|
4187 |
|
4188 |
|
4189 |
|
4190 |
|
4191 | <dl class="details">
|
4192 |
|
4193 |
|
4194 |
|
4195 |
|
4196 |
|
4197 |
|
4198 |
|
4199 |
|
4200 |
|
4201 |
|
4202 |
|
4203 |
|
4204 |
|
4205 |
|
4206 |
|
4207 |
|
4208 |
|
4209 |
|
4210 |
|
4211 |
|
4212 |
|
4213 |
|
4214 |
|
4215 |
|
4216 |
|
4217 |
|
4218 |
|
4219 |
|
4220 |
|
4221 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4222 | <dd class="tag-source">
|
4223 | <ul class="dummy">
|
4224 | <li>
|
4225 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4226 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1371">line 1371</a>
|
4227 | </li>
|
4228 | </ul>
|
4229 | </dd>
|
4230 |
|
4231 |
|
4232 |
|
4233 |
|
4234 |
|
4235 |
|
4236 |
|
4237 | </dl>
|
4238 |
|
4239 |
|
4240 |
|
4241 |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 |
|
4250 |
|
4251 | <h5>Returns:</h5>
|
4252 |
|
4253 |
|
4254 | <div class="param-desc">
|
4255 | <p>Returns the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which is currently pointed by the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property). Returns null if not found.</p>
|
4256 | </div>
|
4257 |
|
4258 |
|
4259 |
|
4260 | <dl>
|
4261 | <dt>
|
4262 | Type
|
4263 | </dt>
|
4264 | <dd>
|
4265 |
|
4266 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
4267 | |
|
4268 |
|
4269 | <span class="param-type">null</span>
|
4270 |
|
4271 |
|
4272 |
|
4273 | </dd>
|
4274 | </dl>
|
4275 |
|
4276 |
|
4277 |
|
4278 |
|
4279 |
|
4280 | </dd>
|
4281 |
|
4282 |
|
4283 |
|
4284 | <hr>
|
4285 | <dt>
|
4286 | <h4 class="name" id="getCurrentPosition"><span class="type-signature"></span>getCurrentPosition<span class="signature">()</span><span class="type-signature"></span></h4>
|
4287 |
|
4288 |
|
4289 | </dt>
|
4290 | <dd>
|
4291 |
|
4292 |
|
4293 | <div class="description">
|
4294 | <p>Alias for <a href="CB_GraphicSprites.html#getPointer"><code>CB_GraphicSprites#getPointer</code></a>.</p>
|
4295 | </div>
|
4296 |
|
4297 |
|
4298 |
|
4299 |
|
4300 |
|
4301 |
|
4302 |
|
4303 |
|
4304 |
|
4305 |
|
4306 | <dl class="details">
|
4307 |
|
4308 |
|
4309 |
|
4310 |
|
4311 |
|
4312 |
|
4313 |
|
4314 |
|
4315 |
|
4316 |
|
4317 |
|
4318 |
|
4319 |
|
4320 |
|
4321 |
|
4322 |
|
4323 |
|
4324 |
|
4325 |
|
4326 |
|
4327 |
|
4328 |
|
4329 |
|
4330 |
|
4331 |
|
4332 |
|
4333 |
|
4334 |
|
4335 |
|
4336 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4337 | <dd class="tag-source">
|
4338 | <ul class="dummy">
|
4339 | <li>
|
4340 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4341 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1298">line 1298</a>
|
4342 | </li>
|
4343 | </ul>
|
4344 | </dd>
|
4345 |
|
4346 |
|
4347 |
|
4348 |
|
4349 |
|
4350 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4351 | <dd class="tag-see">
|
4352 | <ul>
|
4353 | <li><a href="CB_GraphicSprites.html#getPointer"><code>CB_GraphicSprites#getPointer</code></a></li>
|
4354 | </ul>
|
4355 | </dd>
|
4356 |
|
4357 |
|
4358 |
|
4359 | </dl>
|
4360 |
|
4361 |
|
4362 |
|
4363 |
|
4364 |
|
4365 |
|
4366 |
|
4367 |
|
4368 |
|
4369 |
|
4370 |
|
4371 |
|
4372 |
|
4373 |
|
4374 |
|
4375 | </dd>
|
4376 |
|
4377 |
|
4378 |
|
4379 | <hr>
|
4380 | <dt>
|
4381 | <h4 class="name" id="getIndexById"><span class="type-signature"></span>getIndexById<span class="signature">()</span><span class="type-signature"></span></h4>
|
4382 |
|
4383 |
|
4384 | </dt>
|
4385 | <dd>
|
4386 |
|
4387 |
|
4388 | <div class="description">
|
4389 | <p>Alias for <a href="CB_GraphicSprites.html#getSpriteIndexById"><code>CB_GraphicSprites#getSpriteIndexById</code></a>.</p>
|
4390 | </div>
|
4391 |
|
4392 |
|
4393 |
|
4394 |
|
4395 |
|
4396 |
|
4397 |
|
4398 |
|
4399 |
|
4400 |
|
4401 | <dl class="details">
|
4402 |
|
4403 |
|
4404 |
|
4405 |
|
4406 |
|
4407 |
|
4408 |
|
4409 |
|
4410 |
|
4411 |
|
4412 |
|
4413 |
|
4414 |
|
4415 |
|
4416 |
|
4417 |
|
4418 |
|
4419 |
|
4420 |
|
4421 |
|
4422 |
|
4423 |
|
4424 |
|
4425 |
|
4426 |
|
4427 |
|
4428 |
|
4429 |
|
4430 |
|
4431 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4432 | <dd class="tag-source">
|
4433 | <ul class="dummy">
|
4434 | <li>
|
4435 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4436 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1109">line 1109</a>
|
4437 | </li>
|
4438 | </ul>
|
4439 | </dd>
|
4440 |
|
4441 |
|
4442 |
|
4443 |
|
4444 |
|
4445 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4446 | <dd class="tag-see">
|
4447 | <ul>
|
4448 | <li><a href="CB_GraphicSprites.html#getSpriteIndexById"><code>CB_GraphicSprites#getSpriteIndexById</code></a></li>
|
4449 | </ul>
|
4450 | </dd>
|
4451 |
|
4452 |
|
4453 |
|
4454 | </dl>
|
4455 |
|
4456 |
|
4457 |
|
4458 |
|
4459 |
|
4460 |
|
4461 |
|
4462 |
|
4463 |
|
4464 |
|
4465 |
|
4466 |
|
4467 |
|
4468 |
|
4469 |
|
4470 | </dd>
|
4471 |
|
4472 |
|
4473 |
|
4474 | <hr>
|
4475 | <dt>
|
4476 | <h4 class="name" id="getPointer"><span class="type-signature"></span>getPointer<span class="signature">()</span><span class="type-signature"> → {integer}</span></h4>
|
4477 |
|
4478 |
|
4479 | </dt>
|
4480 | <dd>
|
4481 |
|
4482 |
|
4483 | <div class="description">
|
4484 | <p>Gets the current position of the pointer. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). Internally, it uses the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property.</p>
|
4485 | </div>
|
4486 |
|
4487 |
|
4488 |
|
4489 |
|
4490 |
|
4491 |
|
4492 |
|
4493 |
|
4494 |
|
4495 |
|
4496 | <dl class="details">
|
4497 |
|
4498 |
|
4499 |
|
4500 |
|
4501 |
|
4502 |
|
4503 |
|
4504 |
|
4505 |
|
4506 |
|
4507 |
|
4508 |
|
4509 |
|
4510 |
|
4511 |
|
4512 |
|
4513 |
|
4514 |
|
4515 |
|
4516 |
|
4517 |
|
4518 |
|
4519 |
|
4520 |
|
4521 |
|
4522 |
|
4523 |
|
4524 |
|
4525 |
|
4526 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4527 | <dd class="tag-source">
|
4528 | <ul class="dummy">
|
4529 | <li>
|
4530 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4531 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1308">line 1308</a>
|
4532 | </li>
|
4533 | </ul>
|
4534 | </dd>
|
4535 |
|
4536 |
|
4537 |
|
4538 |
|
4539 |
|
4540 |
|
4541 |
|
4542 | </dl>
|
4543 |
|
4544 |
|
4545 |
|
4546 |
|
4547 |
|
4548 |
|
4549 |
|
4550 |
|
4551 |
|
4552 |
|
4553 |
|
4554 |
|
4555 |
|
4556 | <h5>Returns:</h5>
|
4557 |
|
4558 |
|
4559 | <div class="param-desc">
|
4560 | <p>Returns the position where the pointer is currently pointing to. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). If not found, returns zero (0) by default.</p>
|
4561 | </div>
|
4562 |
|
4563 |
|
4564 |
|
4565 | <dl>
|
4566 | <dt>
|
4567 | Type
|
4568 | </dt>
|
4569 | <dd>
|
4570 |
|
4571 | <span class="param-type">integer</span>
|
4572 |
|
4573 |
|
4574 |
|
4575 | </dd>
|
4576 | </dl>
|
4577 |
|
4578 |
|
4579 |
|
4580 |
|
4581 |
|
4582 | </dd>
|
4583 |
|
4584 |
|
4585 |
|
4586 | <hr>
|
4587 | <dt>
|
4588 | <h4 class="name" id="getPointerPrevious"><span class="type-signature"></span>getPointerPrevious<span class="signature">()</span><span class="type-signature"> → {integer}</span></h4>
|
4589 |
|
4590 |
|
4591 | </dt>
|
4592 | <dd>
|
4593 |
|
4594 |
|
4595 | <div class="description">
|
4596 | <p>Gets the previous position of the pointer. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). Internally, it uses the <a href="CB_GraphicSprites.html#pointerPrevious"><code>CB_GraphicSprites#pointerPrevious</code></a> property.</p>
|
4597 | </div>
|
4598 |
|
4599 |
|
4600 |
|
4601 |
|
4602 |
|
4603 |
|
4604 |
|
4605 |
|
4606 |
|
4607 |
|
4608 | <dl class="details">
|
4609 |
|
4610 |
|
4611 |
|
4612 |
|
4613 |
|
4614 |
|
4615 |
|
4616 |
|
4617 |
|
4618 |
|
4619 |
|
4620 |
|
4621 |
|
4622 |
|
4623 |
|
4624 |
|
4625 |
|
4626 |
|
4627 |
|
4628 |
|
4629 |
|
4630 |
|
4631 |
|
4632 |
|
4633 |
|
4634 |
|
4635 |
|
4636 |
|
4637 |
|
4638 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4639 | <dd class="tag-source">
|
4640 | <ul class="dummy">
|
4641 | <li>
|
4642 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4643 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1292">line 1292</a>
|
4644 | </li>
|
4645 | </ul>
|
4646 | </dd>
|
4647 |
|
4648 |
|
4649 |
|
4650 |
|
4651 |
|
4652 |
|
4653 |
|
4654 | </dl>
|
4655 |
|
4656 |
|
4657 |
|
4658 |
|
4659 |
|
4660 |
|
4661 |
|
4662 |
|
4663 |
|
4664 |
|
4665 |
|
4666 |
|
4667 |
|
4668 | <h5>Returns:</h5>
|
4669 |
|
4670 |
|
4671 | <div class="param-desc">
|
4672 | <p>Returns the position where the pointer was previously pointing to. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). If not found, returns -1 by default.</p>
|
4673 | </div>
|
4674 |
|
4675 |
|
4676 |
|
4677 | <dl>
|
4678 | <dt>
|
4679 | Type
|
4680 | </dt>
|
4681 | <dd>
|
4682 |
|
4683 | <span class="param-type">integer</span>
|
4684 |
|
4685 |
|
4686 |
|
4687 | </dd>
|
4688 | </dl>
|
4689 |
|
4690 |
|
4691 |
|
4692 |
|
4693 |
|
4694 | </dd>
|
4695 |
|
4696 |
|
4697 |
|
4698 | <hr>
|
4699 | <dt>
|
4700 | <h4 class="name" id="getPrevious"><span class="type-signature"></span>getPrevious<span class="signature">()</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|null}</span></h4>
|
4701 |
|
4702 |
|
4703 | </dt>
|
4704 | <dd>
|
4705 |
|
4706 |
|
4707 | <div class="description">
|
4708 | <p>Gets the sprite (a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) which was previously pointed (by the previous value of the pointer set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property, whose value is now in the <a href="CB_GraphicSprites.html#pointerPrevious"><code>CB_GraphicSprites#pointerPrevious</code></a> property).</p>
|
4709 | </div>
|
4710 |
|
4711 |
|
4712 |
|
4713 |
|
4714 |
|
4715 |
|
4716 |
|
4717 |
|
4718 |
|
4719 |
|
4720 | <dl class="details">
|
4721 |
|
4722 |
|
4723 |
|
4724 |
|
4725 |
|
4726 |
|
4727 |
|
4728 |
|
4729 |
|
4730 |
|
4731 |
|
4732 |
|
4733 |
|
4734 |
|
4735 |
|
4736 |
|
4737 |
|
4738 |
|
4739 |
|
4740 |
|
4741 |
|
4742 |
|
4743 |
|
4744 |
|
4745 |
|
4746 |
|
4747 |
|
4748 |
|
4749 |
|
4750 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4751 | <dd class="tag-source">
|
4752 | <ul class="dummy">
|
4753 | <li>
|
4754 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4755 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1349">line 1349</a>
|
4756 | </li>
|
4757 | </ul>
|
4758 | </dd>
|
4759 |
|
4760 |
|
4761 |
|
4762 |
|
4763 |
|
4764 |
|
4765 |
|
4766 | </dl>
|
4767 |
|
4768 |
|
4769 |
|
4770 |
|
4771 |
|
4772 |
|
4773 |
|
4774 |
|
4775 |
|
4776 |
|
4777 |
|
4778 |
|
4779 |
|
4780 | <h5>Returns:</h5>
|
4781 |
|
4782 |
|
4783 | <div class="param-desc">
|
4784 | <p>Returns the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which was previously pointed by the pointer (by the previous value of the pointer set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property, whose value is now in the <a href="CB_GraphicSprites.html#pointerPrevious"><code>CB_GraphicSprites#pointerPrevious</code></a> property). Returns null if not found.</p>
|
4785 | </div>
|
4786 |
|
4787 |
|
4788 |
|
4789 | <dl>
|
4790 | <dt>
|
4791 | Type
|
4792 | </dt>
|
4793 | <dd>
|
4794 |
|
4795 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
4796 | |
|
4797 |
|
4798 | <span class="param-type">null</span>
|
4799 |
|
4800 |
|
4801 |
|
4802 | </dd>
|
4803 | </dl>
|
4804 |
|
4805 |
|
4806 |
|
4807 |
|
4808 |
|
4809 | </dd>
|
4810 |
|
4811 |
|
4812 |
|
4813 | <hr>
|
4814 | <dt>
|
4815 | <h4 class="name" id="getPreviousPosition"><span class="type-signature"></span>getPreviousPosition<span class="signature">()</span><span class="type-signature"></span></h4>
|
4816 |
|
4817 |
|
4818 | </dt>
|
4819 | <dd>
|
4820 |
|
4821 |
|
4822 | <div class="description">
|
4823 | <p>Alias for <a href="CB_GraphicSprites.html#getPointerPrevious"><code>CB_GraphicSprites#getPointerPrevious</code></a>.</p>
|
4824 | </div>
|
4825 |
|
4826 |
|
4827 |
|
4828 |
|
4829 |
|
4830 |
|
4831 |
|
4832 |
|
4833 |
|
4834 |
|
4835 | <dl class="details">
|
4836 |
|
4837 |
|
4838 |
|
4839 |
|
4840 |
|
4841 |
|
4842 |
|
4843 |
|
4844 |
|
4845 |
|
4846 |
|
4847 |
|
4848 |
|
4849 |
|
4850 |
|
4851 |
|
4852 |
|
4853 |
|
4854 |
|
4855 |
|
4856 |
|
4857 |
|
4858 |
|
4859 |
|
4860 |
|
4861 |
|
4862 |
|
4863 |
|
4864 |
|
4865 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4866 | <dd class="tag-source">
|
4867 | <ul class="dummy">
|
4868 | <li>
|
4869 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
4870 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1282">line 1282</a>
|
4871 | </li>
|
4872 | </ul>
|
4873 | </dd>
|
4874 |
|
4875 |
|
4876 |
|
4877 |
|
4878 |
|
4879 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
4880 | <dd class="tag-see">
|
4881 | <ul>
|
4882 | <li><a href="CB_GraphicSprites.html#getPointerPrevious"><code>CB_GraphicSprites#getPointerPrevious</code></a></li>
|
4883 | </ul>
|
4884 | </dd>
|
4885 |
|
4886 |
|
4887 |
|
4888 | </dl>
|
4889 |
|
4890 |
|
4891 |
|
4892 |
|
4893 |
|
4894 |
|
4895 |
|
4896 |
|
4897 |
|
4898 |
|
4899 |
|
4900 |
|
4901 |
|
4902 |
|
4903 |
|
4904 | </dd>
|
4905 |
|
4906 |
|
4907 |
|
4908 | <hr>
|
4909 | <dt>
|
4910 | <h4 class="name" id="getSprite"><span class="type-signature"></span>getSprite<span class="signature">( [index] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|*}</span></h4>
|
4911 |
|
4912 |
|
4913 | </dt>
|
4914 | <dd>
|
4915 |
|
4916 |
|
4917 | <div class="description">
|
4918 | <p>Gets a desired sprite object through its index (its position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array). Faster than getting it through its identifier with the <a href="CB_GraphicSprites.html#getSpriteById"><code>CB_GraphicSprites#getSpriteById</code></a> method.</p>
|
4919 | </div>
|
4920 |
|
4921 |
|
4922 |
|
4923 |
|
4924 |
|
4925 |
|
4926 |
|
4927 |
|
4928 | <h5>Parameters:</h5>
|
4929 |
|
4930 |
|
4931 | <table class="params table table-striped">
|
4932 | <thead>
|
4933 | <tr>
|
4934 |
|
4935 | <th style="width:12%; min-width:110px;">Name</th>
|
4936 |
|
4937 |
|
4938 | <th style="width:12%; min-width:110px;">Type</th>
|
4939 |
|
4940 |
|
4941 | <th style="width:12%; min-width:110px;">Argument</th>
|
4942 |
|
4943 |
|
4944 |
|
4945 | <th style="width:12%; min-width:110px;">Default</th>
|
4946 |
|
4947 |
|
4948 | <th class="last" style="min-width:310px;">Description</th>
|
4949 | </tr>
|
4950 | </thead>
|
4951 |
|
4952 | <tbody>
|
4953 |
|
4954 |
|
4955 | <tr>
|
4956 |
|
4957 | <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>
|
4958 |
|
4959 |
|
4960 | <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;">
|
4961 |
|
4962 |
|
4963 | <span class="param-type">integer</span>
|
4964 |
|
4965 |
|
4966 |
|
4967 |
|
4968 | </td>
|
4969 |
|
4970 |
|
4971 | <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;">
|
4972 |
|
4973 | <optional><br>
|
4974 |
|
4975 |
|
4976 |
|
4977 |
|
4978 |
|
4979 | </td>
|
4980 |
|
4981 |
|
4982 |
|
4983 | <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;">
|
4984 |
|
4985 | 0
|
4986 |
|
4987 | </td>
|
4988 |
|
4989 |
|
4990 | <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 sprite must be located (its position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array).</p></td>
|
4991 | </tr>
|
4992 |
|
4993 |
|
4994 |
|
4995 | <tr>
|
4996 |
|
4997 | <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>
|
4998 |
|
4999 |
|
5000 | <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;">
|
5001 |
|
5002 |
|
5003 | <span class="param-type">*</span>
|
5004 |
|
5005 |
|
5006 |
|
5007 |
|
5008 | </td>
|
5009 |
|
5010 |
|
5011 | <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;">
|
5012 |
|
5013 | <optional><br>
|
5014 |
|
5015 |
|
5016 |
|
5017 |
|
5018 |
|
5019 | </td>
|
5020 |
|
5021 |
|
5022 |
|
5023 | <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;">
|
5024 |
|
5025 | </td>
|
5026 |
|
5027 |
|
5028 | <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>
|
5029 | </tr>
|
5030 |
|
5031 |
|
5032 | </tbody>
|
5033 | </table>
|
5034 |
|
5035 |
|
5036 |
|
5037 |
|
5038 | <dl class="details">
|
5039 |
|
5040 |
|
5041 |
|
5042 |
|
5043 |
|
5044 |
|
5045 |
|
5046 |
|
5047 |
|
5048 |
|
5049 |
|
5050 |
|
5051 |
|
5052 |
|
5053 |
|
5054 |
|
5055 |
|
5056 |
|
5057 |
|
5058 |
|
5059 |
|
5060 |
|
5061 |
|
5062 |
|
5063 |
|
5064 |
|
5065 |
|
5066 |
|
5067 |
|
5068 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5069 | <dd class="tag-source">
|
5070 | <ul class="dummy">
|
5071 | <li>
|
5072 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5073 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1081">line 1081</a>
|
5074 | </li>
|
5075 | </ul>
|
5076 | </dd>
|
5077 |
|
5078 |
|
5079 |
|
5080 |
|
5081 |
|
5082 |
|
5083 |
|
5084 | </dl>
|
5085 |
|
5086 |
|
5087 |
|
5088 |
|
5089 |
|
5090 |
|
5091 |
|
5092 |
|
5093 |
|
5094 |
|
5095 |
|
5096 |
|
5097 |
|
5098 | <h5>Returns:</h5>
|
5099 |
|
5100 |
|
5101 | <div class="param-desc">
|
5102 | <p>Returns a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
5103 | </div>
|
5104 |
|
5105 |
|
5106 |
|
5107 | <dl>
|
5108 | <dt>
|
5109 | Type
|
5110 | </dt>
|
5111 | <dd>
|
5112 |
|
5113 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
5114 | |
|
5115 |
|
5116 | <span class="param-type">*</span>
|
5117 |
|
5118 |
|
5119 |
|
5120 | </dd>
|
5121 | </dl>
|
5122 |
|
5123 |
|
5124 |
|
5125 |
|
5126 |
|
5127 | </dd>
|
5128 |
|
5129 |
|
5130 |
|
5131 | <hr>
|
5132 | <dt>
|
5133 | <h4 class="name" id="getSpriteById"><span class="type-signature"></span>getSpriteById<span class="signature">( [id] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|*}</span></h4>
|
5134 |
|
5135 |
|
5136 | </dt>
|
5137 | <dd>
|
5138 |
|
5139 |
|
5140 | <div class="description">
|
5141 | <p>Gets a desired sprite object through its identifier. Slower than getting it through its index with the <a href="CB_GraphicSprites.html#getSprite"><code>CB_GraphicSprites#getSprite</code></a> method.</p>
|
5142 | </div>
|
5143 |
|
5144 |
|
5145 |
|
5146 |
|
5147 |
|
5148 |
|
5149 |
|
5150 |
|
5151 | <h5>Parameters:</h5>
|
5152 |
|
5153 |
|
5154 | <table class="params table table-striped">
|
5155 | <thead>
|
5156 | <tr>
|
5157 |
|
5158 | <th style="width:12%; min-width:110px;">Name</th>
|
5159 |
|
5160 |
|
5161 | <th style="width:12%; min-width:110px;">Type</th>
|
5162 |
|
5163 |
|
5164 | <th style="width:12%; min-width:110px;">Argument</th>
|
5165 |
|
5166 |
|
5167 |
|
5168 |
|
5169 | <th class="last" style="min-width:310px;">Description</th>
|
5170 | </tr>
|
5171 | </thead>
|
5172 |
|
5173 | <tbody>
|
5174 |
|
5175 |
|
5176 | <tr>
|
5177 |
|
5178 | <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>
|
5179 |
|
5180 |
|
5181 | <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;">
|
5182 |
|
5183 |
|
5184 | <span class="param-type">string</span>
|
5185 | |
|
5186 |
|
5187 | <span class="param-type">*</span>
|
5188 |
|
5189 |
|
5190 |
|
5191 |
|
5192 | </td>
|
5193 |
|
5194 |
|
5195 | <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;">
|
5196 |
|
5197 | <optional><br>
|
5198 |
|
5199 |
|
5200 |
|
5201 |
|
5202 |
|
5203 | </td>
|
5204 |
|
5205 |
|
5206 |
|
5207 |
|
5208 | <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 sprite that we want to get.</p></td>
|
5209 | </tr>
|
5210 |
|
5211 |
|
5212 |
|
5213 | <tr>
|
5214 |
|
5215 | <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>
|
5216 |
|
5217 |
|
5218 | <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;">
|
5219 |
|
5220 |
|
5221 | <span class="param-type">*</span>
|
5222 |
|
5223 |
|
5224 |
|
5225 |
|
5226 | </td>
|
5227 |
|
5228 |
|
5229 | <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;">
|
5230 |
|
5231 | <optional><br>
|
5232 |
|
5233 |
|
5234 |
|
5235 |
|
5236 |
|
5237 | </td>
|
5238 |
|
5239 |
|
5240 |
|
5241 |
|
5242 | <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>
|
5243 | </tr>
|
5244 |
|
5245 |
|
5246 | </tbody>
|
5247 | </table>
|
5248 |
|
5249 |
|
5250 |
|
5251 |
|
5252 | <dl class="details">
|
5253 |
|
5254 |
|
5255 |
|
5256 |
|
5257 |
|
5258 |
|
5259 |
|
5260 |
|
5261 |
|
5262 |
|
5263 |
|
5264 |
|
5265 |
|
5266 |
|
5267 |
|
5268 |
|
5269 |
|
5270 |
|
5271 |
|
5272 |
|
5273 |
|
5274 |
|
5275 |
|
5276 |
|
5277 |
|
5278 |
|
5279 |
|
5280 |
|
5281 |
|
5282 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5283 | <dd class="tag-source">
|
5284 | <ul class="dummy">
|
5285 | <li>
|
5286 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5287 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1102">line 1102</a>
|
5288 | </li>
|
5289 | </ul>
|
5290 | </dd>
|
5291 |
|
5292 |
|
5293 |
|
5294 |
|
5295 |
|
5296 |
|
5297 |
|
5298 | </dl>
|
5299 |
|
5300 |
|
5301 |
|
5302 |
|
5303 |
|
5304 |
|
5305 |
|
5306 |
|
5307 |
|
5308 |
|
5309 |
|
5310 |
|
5311 |
|
5312 | <h5>Returns:</h5>
|
5313 |
|
5314 |
|
5315 | <div class="param-desc">
|
5316 | <p>Returns a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
5317 | </div>
|
5318 |
|
5319 |
|
5320 |
|
5321 | <dl>
|
5322 | <dt>
|
5323 | Type
|
5324 | </dt>
|
5325 | <dd>
|
5326 |
|
5327 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
5328 | |
|
5329 |
|
5330 | <span class="param-type">*</span>
|
5331 |
|
5332 |
|
5333 |
|
5334 | </dd>
|
5335 | </dl>
|
5336 |
|
5337 |
|
5338 |
|
5339 |
|
5340 |
|
5341 | </dd>
|
5342 |
|
5343 |
|
5344 |
|
5345 | <hr>
|
5346 | <dt>
|
5347 | <h4 class="name" id="getSpriteIndexById"><span class="type-signature"></span>getSpriteIndexById<span class="signature">( [id])</span><span class="type-signature"> → {integer}</span></h4>
|
5348 |
|
5349 |
|
5350 | </dt>
|
5351 | <dd>
|
5352 |
|
5353 |
|
5354 | <div class="description">
|
5355 | <p>Gets the index (the position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array) of a desired sprite by its identifier.</p>
|
5356 | </div>
|
5357 |
|
5358 |
|
5359 |
|
5360 |
|
5361 |
|
5362 |
|
5363 |
|
5364 |
|
5365 | <h5>Parameters:</h5>
|
5366 |
|
5367 |
|
5368 | <table class="params table table-striped">
|
5369 | <thead>
|
5370 | <tr>
|
5371 |
|
5372 | <th style="width:12%; min-width:110px;">Name</th>
|
5373 |
|
5374 |
|
5375 | <th style="width:12%; min-width:110px;">Type</th>
|
5376 |
|
5377 |
|
5378 | <th style="width:12%; min-width:110px;">Argument</th>
|
5379 |
|
5380 |
|
5381 |
|
5382 |
|
5383 | <th class="last" style="min-width:310px;">Description</th>
|
5384 | </tr>
|
5385 | </thead>
|
5386 |
|
5387 | <tbody>
|
5388 |
|
5389 |
|
5390 | <tr>
|
5391 |
|
5392 | <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>
|
5393 |
|
5394 |
|
5395 | <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;">
|
5396 |
|
5397 |
|
5398 | <span class="param-type">string</span>
|
5399 | |
|
5400 |
|
5401 | <span class="param-type">*</span>
|
5402 |
|
5403 |
|
5404 |
|
5405 |
|
5406 | </td>
|
5407 |
|
5408 |
|
5409 | <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;">
|
5410 |
|
5411 | <optional><br>
|
5412 |
|
5413 |
|
5414 |
|
5415 |
|
5416 |
|
5417 | </td>
|
5418 |
|
5419 |
|
5420 |
|
5421 |
|
5422 | <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 sprite whose index we want to get.</p></td>
|
5423 | </tr>
|
5424 |
|
5425 |
|
5426 | </tbody>
|
5427 | </table>
|
5428 |
|
5429 |
|
5430 |
|
5431 |
|
5432 | <dl class="details">
|
5433 |
|
5434 |
|
5435 |
|
5436 |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 |
|
5442 |
|
5443 |
|
5444 |
|
5445 |
|
5446 |
|
5447 |
|
5448 |
|
5449 |
|
5450 |
|
5451 |
|
5452 |
|
5453 |
|
5454 |
|
5455 |
|
5456 |
|
5457 |
|
5458 |
|
5459 |
|
5460 |
|
5461 |
|
5462 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5463 | <dd class="tag-source">
|
5464 | <ul class="dummy">
|
5465 | <li>
|
5466 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5467 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1121">line 1121</a>
|
5468 | </li>
|
5469 | </ul>
|
5470 | </dd>
|
5471 |
|
5472 |
|
5473 |
|
5474 |
|
5475 |
|
5476 |
|
5477 |
|
5478 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
5479 | <dd class="tag-todo">
|
5480 | <ul>
|
5481 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
5482 | </ul>
|
5483 | </dd>
|
5484 |
|
5485 | </dl>
|
5486 |
|
5487 |
|
5488 |
|
5489 |
|
5490 |
|
5491 |
|
5492 |
|
5493 |
|
5494 |
|
5495 |
|
5496 |
|
5497 |
|
5498 |
|
5499 | <h5>Returns:</h5>
|
5500 |
|
5501 |
|
5502 | <div class="param-desc">
|
5503 | <p>Returns the index (the position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array) of the desired sprite or -1 if not found.</p>
|
5504 | </div>
|
5505 |
|
5506 |
|
5507 |
|
5508 | <dl>
|
5509 | <dt>
|
5510 | Type
|
5511 | </dt>
|
5512 | <dd>
|
5513 |
|
5514 | <span class="param-type">integer</span>
|
5515 |
|
5516 |
|
5517 |
|
5518 | </dd>
|
5519 | </dl>
|
5520 |
|
5521 |
|
5522 |
|
5523 |
|
5524 |
|
5525 | </dd>
|
5526 |
|
5527 |
|
5528 |
|
5529 | <hr>
|
5530 | <dt>
|
5531 | <h4 class="name" id="getSprites"><span class="type-signature"></span>getSprites<span class="signature">( [orderedByZIndex] [, returnValueOnFail])</span><span class="type-signature"> → {array|*}</span></h4>
|
5532 |
|
5533 |
|
5534 | </dt>
|
5535 | <dd>
|
5536 |
|
5537 |
|
5538 | <div class="description">
|
5539 | <p>Gets all the sprites (the "sprites" property of the internal <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object, if any).</p>
|
5540 | </div>
|
5541 |
|
5542 |
|
5543 |
|
5544 |
|
5545 |
|
5546 |
|
5547 |
|
5548 |
|
5549 | <h5>Parameters:</h5>
|
5550 |
|
5551 |
|
5552 | <table class="params table table-striped">
|
5553 | <thead>
|
5554 | <tr>
|
5555 |
|
5556 | <th style="width:12%; min-width:110px;">Name</th>
|
5557 |
|
5558 |
|
5559 | <th style="width:12%; min-width:110px;">Type</th>
|
5560 |
|
5561 |
|
5562 | <th style="width:12%; min-width:110px;">Argument</th>
|
5563 |
|
5564 |
|
5565 |
|
5566 | <th style="width:12%; min-width:110px;">Default</th>
|
5567 |
|
5568 |
|
5569 | <th class="last" style="min-width:310px;">Description</th>
|
5570 | </tr>
|
5571 | </thead>
|
5572 |
|
5573 | <tbody>
|
5574 |
|
5575 |
|
5576 | <tr>
|
5577 |
|
5578 | <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>
|
5579 |
|
5580 |
|
5581 | <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;">
|
5582 |
|
5583 |
|
5584 | <span class="param-type">boolean</span>
|
5585 |
|
5586 |
|
5587 |
|
5588 |
|
5589 | </td>
|
5590 |
|
5591 |
|
5592 | <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;">
|
5593 |
|
5594 | <optional><br>
|
5595 |
|
5596 |
|
5597 |
|
5598 |
|
5599 |
|
5600 | </td>
|
5601 |
|
5602 |
|
5603 |
|
5604 | <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;">
|
5605 |
|
5606 | false
|
5607 |
|
5608 | </td>
|
5609 |
|
5610 |
|
5611 | <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 sprites sorted by their z-index (ascending order).</p></td>
|
5612 | </tr>
|
5613 |
|
5614 |
|
5615 |
|
5616 | <tr>
|
5617 |
|
5618 | <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>
|
5619 |
|
5620 |
|
5621 | <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;">
|
5622 |
|
5623 |
|
5624 | <span class="param-type">*</span>
|
5625 |
|
5626 |
|
5627 |
|
5628 |
|
5629 | </td>
|
5630 |
|
5631 |
|
5632 | <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;">
|
5633 |
|
5634 | <optional><br>
|
5635 |
|
5636 |
|
5637 |
|
5638 |
|
5639 |
|
5640 | </td>
|
5641 |
|
5642 |
|
5643 |
|
5644 | <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;">
|
5645 |
|
5646 | </td>
|
5647 |
|
5648 |
|
5649 | <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>
|
5650 | </tr>
|
5651 |
|
5652 |
|
5653 | </tbody>
|
5654 | </table>
|
5655 |
|
5656 |
|
5657 |
|
5658 |
|
5659 | <dl class="details">
|
5660 |
|
5661 |
|
5662 |
|
5663 |
|
5664 |
|
5665 |
|
5666 |
|
5667 |
|
5668 |
|
5669 |
|
5670 |
|
5671 |
|
5672 |
|
5673 |
|
5674 |
|
5675 |
|
5676 |
|
5677 |
|
5678 |
|
5679 |
|
5680 |
|
5681 |
|
5682 |
|
5683 |
|
5684 |
|
5685 |
|
5686 |
|
5687 |
|
5688 |
|
5689 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5690 | <dd class="tag-source">
|
5691 | <ul class="dummy">
|
5692 | <li>
|
5693 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5694 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1052">line 1052</a>
|
5695 | </li>
|
5696 | </ul>
|
5697 | </dd>
|
5698 |
|
5699 |
|
5700 |
|
5701 |
|
5702 |
|
5703 |
|
5704 |
|
5705 | </dl>
|
5706 |
|
5707 |
|
5708 |
|
5709 |
|
5710 |
|
5711 |
|
5712 |
|
5713 |
|
5714 |
|
5715 |
|
5716 |
|
5717 |
|
5718 |
|
5719 | <h5>Returns:</h5>
|
5720 |
|
5721 |
|
5722 | <div class="param-desc">
|
5723 | <p>Returns an array with all the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects or the value of "returnValueOnFail" otherwise.</p>
|
5724 | </div>
|
5725 |
|
5726 |
|
5727 |
|
5728 | <dl>
|
5729 | <dt>
|
5730 | Type
|
5731 | </dt>
|
5732 | <dd>
|
5733 |
|
5734 | <span class="param-type">array</span>
|
5735 | |
|
5736 |
|
5737 | <span class="param-type">*</span>
|
5738 |
|
5739 |
|
5740 |
|
5741 | </dd>
|
5742 | </dl>
|
5743 |
|
5744 |
|
5745 |
|
5746 |
|
5747 |
|
5748 | </dd>
|
5749 |
|
5750 |
|
5751 |
|
5752 | <hr>
|
5753 | <dt>
|
5754 | <h4 class="name" id="getSpritesAll"><span class="type-signature"></span>getSpritesAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
5755 |
|
5756 |
|
5757 | </dt>
|
5758 | <dd>
|
5759 |
|
5760 |
|
5761 | <div class="description">
|
5762 | <p>Alias for <a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</code></a>.</p>
|
5763 | </div>
|
5764 |
|
5765 |
|
5766 |
|
5767 |
|
5768 |
|
5769 |
|
5770 |
|
5771 |
|
5772 |
|
5773 |
|
5774 | <dl class="details">
|
5775 |
|
5776 |
|
5777 |
|
5778 |
|
5779 |
|
5780 |
|
5781 |
|
5782 |
|
5783 |
|
5784 |
|
5785 |
|
5786 |
|
5787 |
|
5788 |
|
5789 |
|
5790 |
|
5791 |
|
5792 |
|
5793 |
|
5794 |
|
5795 |
|
5796 |
|
5797 |
|
5798 |
|
5799 |
|
5800 |
|
5801 |
|
5802 |
|
5803 |
|
5804 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5805 | <dd class="tag-source">
|
5806 | <ul class="dummy">
|
5807 | <li>
|
5808 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5809 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1040">line 1040</a>
|
5810 | </li>
|
5811 | </ul>
|
5812 | </dd>
|
5813 |
|
5814 |
|
5815 |
|
5816 |
|
5817 |
|
5818 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
5819 | <dd class="tag-see">
|
5820 | <ul>
|
5821 | <li><a href="CB_GraphicSprites.html#getSprites"><code>CB_GraphicSprites#getSprites</code></a></li>
|
5822 | </ul>
|
5823 | </dd>
|
5824 |
|
5825 |
|
5826 |
|
5827 | </dl>
|
5828 |
|
5829 |
|
5830 |
|
5831 |
|
5832 |
|
5833 |
|
5834 |
|
5835 |
|
5836 |
|
5837 |
|
5838 |
|
5839 |
|
5840 |
|
5841 |
|
5842 |
|
5843 | </dd>
|
5844 |
|
5845 |
|
5846 |
|
5847 | <hr>
|
5848 | <dt>
|
5849 | <h4 class="name" id="getSpritesGroup"><span class="type-signature"></span>getSpritesGroup<span class="signature">( [returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a>|*}</span></h4>
|
5850 |
|
5851 |
|
5852 | </dt>
|
5853 | <dd>
|
5854 |
|
5855 |
|
5856 | <div class="description">
|
5857 | <p>Gets the sprites group object (the internal <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object, if any).</p>
|
5858 | </div>
|
5859 |
|
5860 |
|
5861 |
|
5862 |
|
5863 |
|
5864 |
|
5865 |
|
5866 |
|
5867 | <h5>Parameters:</h5>
|
5868 |
|
5869 |
|
5870 | <table class="params table table-striped">
|
5871 | <thead>
|
5872 | <tr>
|
5873 |
|
5874 | <th style="width:12%; min-width:110px;">Name</th>
|
5875 |
|
5876 |
|
5877 | <th style="width:12%; min-width:110px;">Type</th>
|
5878 |
|
5879 |
|
5880 | <th style="width:12%; min-width:110px;">Argument</th>
|
5881 |
|
5882 |
|
5883 |
|
5884 |
|
5885 | <th class="last" style="min-width:310px;">Description</th>
|
5886 | </tr>
|
5887 | </thead>
|
5888 |
|
5889 | <tbody>
|
5890 |
|
5891 |
|
5892 | <tr>
|
5893 |
|
5894 | <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>
|
5895 |
|
5896 |
|
5897 | <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;">
|
5898 |
|
5899 |
|
5900 | <span class="param-type">*</span>
|
5901 |
|
5902 |
|
5903 |
|
5904 |
|
5905 | </td>
|
5906 |
|
5907 |
|
5908 | <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;">
|
5909 |
|
5910 | <optional><br>
|
5911 |
|
5912 |
|
5913 |
|
5914 |
|
5915 |
|
5916 | </td>
|
5917 |
|
5918 |
|
5919 |
|
5920 |
|
5921 | <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>
|
5922 | </tr>
|
5923 |
|
5924 |
|
5925 | </tbody>
|
5926 | </table>
|
5927 |
|
5928 |
|
5929 |
|
5930 |
|
5931 | <dl class="details">
|
5932 |
|
5933 |
|
5934 |
|
5935 |
|
5936 |
|
5937 |
|
5938 |
|
5939 |
|
5940 |
|
5941 |
|
5942 |
|
5943 |
|
5944 |
|
5945 |
|
5946 |
|
5947 |
|
5948 |
|
5949 |
|
5950 |
|
5951 |
|
5952 |
|
5953 |
|
5954 |
|
5955 |
|
5956 |
|
5957 |
|
5958 |
|
5959 |
|
5960 |
|
5961 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5962 | <dd class="tag-source">
|
5963 | <ul class="dummy">
|
5964 | <li>
|
5965 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
5966 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1029">line 1029</a>
|
5967 | </li>
|
5968 | </ul>
|
5969 | </dd>
|
5970 |
|
5971 |
|
5972 |
|
5973 |
|
5974 |
|
5975 |
|
5976 |
|
5977 | </dl>
|
5978 |
|
5979 |
|
5980 |
|
5981 |
|
5982 |
|
5983 |
|
5984 |
|
5985 |
|
5986 |
|
5987 |
|
5988 |
|
5989 |
|
5990 |
|
5991 | <h5>Returns:</h5>
|
5992 |
|
5993 |
|
5994 | <div class="param-desc">
|
5995 | <p>Returns a <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object with all the sprites or the value of "returnValueOnFail" otherwise.</p>
|
5996 | </div>
|
5997 |
|
5998 |
|
5999 |
|
6000 | <dl>
|
6001 | <dt>
|
6002 | Type
|
6003 | </dt>
|
6004 | <dd>
|
6005 |
|
6006 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
6007 | |
|
6008 |
|
6009 | <span class="param-type">*</span>
|
6010 |
|
6011 |
|
6012 |
|
6013 | </dd>
|
6014 | </dl>
|
6015 |
|
6016 |
|
6017 |
|
6018 |
|
6019 |
|
6020 | </dd>
|
6021 |
|
6022 |
|
6023 |
|
6024 | <hr>
|
6025 | <dt>
|
6026 | <h4 class="name" id="getSubSprite"><span class="type-signature"></span>getSubSprite<span class="signature">( [index] [, sprite] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a>|*}</span></h4>
|
6027 |
|
6028 |
|
6029 | </dt>
|
6030 | <dd>
|
6031 |
|
6032 |
|
6033 | <div class="description">
|
6034 | <p>Gets a desired sub-sprite object through its index (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). Faster than getting it through its identifier with the <a href="CB_GraphicSprites.html#getSubSpriteById"><code>CB_GraphicSprites#getSubSpriteById</code></a> method.</p>
|
6035 | </div>
|
6036 |
|
6037 |
|
6038 |
|
6039 |
|
6040 |
|
6041 |
|
6042 |
|
6043 |
|
6044 | <h5>Parameters:</h5>
|
6045 |
|
6046 |
|
6047 | <table class="params table table-striped">
|
6048 | <thead>
|
6049 | <tr>
|
6050 |
|
6051 | <th style="width:12%; min-width:110px;">Name</th>
|
6052 |
|
6053 |
|
6054 | <th style="width:12%; min-width:110px;">Type</th>
|
6055 |
|
6056 |
|
6057 | <th style="width:12%; min-width:110px;">Argument</th>
|
6058 |
|
6059 |
|
6060 |
|
6061 | <th style="width:12%; min-width:110px;">Default</th>
|
6062 |
|
6063 |
|
6064 | <th class="last" style="min-width:310px;">Description</th>
|
6065 | </tr>
|
6066 | </thead>
|
6067 |
|
6068 | <tbody>
|
6069 |
|
6070 |
|
6071 | <tr>
|
6072 |
|
6073 | <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>
|
6074 |
|
6075 |
|
6076 | <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;">
|
6077 |
|
6078 |
|
6079 | <span class="param-type">integer</span>
|
6080 |
|
6081 |
|
6082 |
|
6083 |
|
6084 | </td>
|
6085 |
|
6086 |
|
6087 | <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;">
|
6088 |
|
6089 | <optional><br>
|
6090 |
|
6091 |
|
6092 |
|
6093 |
|
6094 |
|
6095 | </td>
|
6096 |
|
6097 |
|
6098 |
|
6099 | <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;">
|
6100 |
|
6101 | 0
|
6102 |
|
6103 | </td>
|
6104 |
|
6105 |
|
6106 | <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 sub-sprite must be located (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
6107 | </tr>
|
6108 |
|
6109 |
|
6110 |
|
6111 | <tr>
|
6112 |
|
6113 | <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>sprite</code></td>
|
6114 |
|
6115 |
|
6116 | <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;">
|
6117 |
|
6118 |
|
6119 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
6120 |
|
6121 |
|
6122 |
|
6123 |
|
6124 | </td>
|
6125 |
|
6126 |
|
6127 | <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;">
|
6128 |
|
6129 | <optional><br>
|
6130 |
|
6131 |
|
6132 |
|
6133 |
|
6134 |
|
6135 | </td>
|
6136 |
|
6137 |
|
6138 |
|
6139 | <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;">
|
6140 |
|
6141 | CB_GraphicSprites#getCurrent()
|
6142 |
|
6143 | </td>
|
6144 |
|
6145 |
|
6146 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite and its sub-sprites. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
6147 | </tr>
|
6148 |
|
6149 |
|
6150 |
|
6151 | <tr>
|
6152 |
|
6153 | <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>
|
6154 |
|
6155 |
|
6156 | <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;">
|
6157 |
|
6158 |
|
6159 | <span class="param-type">*</span>
|
6160 |
|
6161 |
|
6162 |
|
6163 |
|
6164 | </td>
|
6165 |
|
6166 |
|
6167 | <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;">
|
6168 |
|
6169 | <optional><br>
|
6170 |
|
6171 |
|
6172 |
|
6173 |
|
6174 |
|
6175 | </td>
|
6176 |
|
6177 |
|
6178 |
|
6179 | <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;">
|
6180 |
|
6181 | </td>
|
6182 |
|
6183 |
|
6184 | <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>
|
6185 | </tr>
|
6186 |
|
6187 |
|
6188 | </tbody>
|
6189 | </table>
|
6190 |
|
6191 |
|
6192 |
|
6193 |
|
6194 | <dl class="details">
|
6195 |
|
6196 |
|
6197 |
|
6198 |
|
6199 |
|
6200 |
|
6201 |
|
6202 |
|
6203 |
|
6204 |
|
6205 |
|
6206 |
|
6207 |
|
6208 |
|
6209 |
|
6210 |
|
6211 |
|
6212 |
|
6213 |
|
6214 |
|
6215 |
|
6216 |
|
6217 |
|
6218 |
|
6219 |
|
6220 |
|
6221 |
|
6222 |
|
6223 |
|
6224 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6225 | <dd class="tag-source">
|
6226 | <ul class="dummy">
|
6227 | <li>
|
6228 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
6229 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1170">line 1170</a>
|
6230 | </li>
|
6231 | </ul>
|
6232 | </dd>
|
6233 |
|
6234 |
|
6235 |
|
6236 |
|
6237 |
|
6238 |
|
6239 |
|
6240 | </dl>
|
6241 |
|
6242 |
|
6243 |
|
6244 |
|
6245 |
|
6246 |
|
6247 |
|
6248 |
|
6249 |
|
6250 |
|
6251 |
|
6252 |
|
6253 |
|
6254 | <h5>Returns:</h5>
|
6255 |
|
6256 |
|
6257 | <div class="param-desc">
|
6258 | <p>Returns a <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
6259 | </div>
|
6260 |
|
6261 |
|
6262 |
|
6263 | <dl>
|
6264 | <dt>
|
6265 | Type
|
6266 | </dt>
|
6267 | <dd>
|
6268 |
|
6269 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
6270 | |
|
6271 |
|
6272 | <span class="param-type">*</span>
|
6273 |
|
6274 |
|
6275 |
|
6276 | </dd>
|
6277 | </dl>
|
6278 |
|
6279 |
|
6280 |
|
6281 |
|
6282 |
|
6283 | </dd>
|
6284 |
|
6285 |
|
6286 |
|
6287 | <hr>
|
6288 | <dt>
|
6289 | <h4 class="name" id="getSubSpriteById"><span class="type-signature"></span>getSubSpriteById<span class="signature">( [id] [, sprite] [, returnValueOnFail])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a>|*}</span></h4>
|
6290 |
|
6291 |
|
6292 | </dt>
|
6293 | <dd>
|
6294 |
|
6295 |
|
6296 | <div class="description">
|
6297 | <p>Gets a desired sub-sprite object through its identifier from the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object. Slower than getting it through its index with the <a href="CB_GraphicSprites.html#getSubSprite"><code>CB_GraphicSprites#getSubSprite</code></a> method.</p>
|
6298 | </div>
|
6299 |
|
6300 |
|
6301 |
|
6302 |
|
6303 |
|
6304 |
|
6305 |
|
6306 |
|
6307 | <h5>Parameters:</h5>
|
6308 |
|
6309 |
|
6310 | <table class="params table table-striped">
|
6311 | <thead>
|
6312 | <tr>
|
6313 |
|
6314 | <th style="width:12%; min-width:110px;">Name</th>
|
6315 |
|
6316 |
|
6317 | <th style="width:12%; min-width:110px;">Type</th>
|
6318 |
|
6319 |
|
6320 | <th style="width:12%; min-width:110px;">Argument</th>
|
6321 |
|
6322 |
|
6323 |
|
6324 | <th style="width:12%; min-width:110px;">Default</th>
|
6325 |
|
6326 |
|
6327 | <th class="last" style="min-width:310px;">Description</th>
|
6328 | </tr>
|
6329 | </thead>
|
6330 |
|
6331 | <tbody>
|
6332 |
|
6333 |
|
6334 | <tr>
|
6335 |
|
6336 | <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>
|
6337 |
|
6338 |
|
6339 | <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;">
|
6340 |
|
6341 |
|
6342 | <span class="param-type">string</span>
|
6343 | |
|
6344 |
|
6345 | <span class="param-type">*</span>
|
6346 |
|
6347 |
|
6348 |
|
6349 |
|
6350 | </td>
|
6351 |
|
6352 |
|
6353 | <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;">
|
6354 |
|
6355 | <optional><br>
|
6356 |
|
6357 |
|
6358 |
|
6359 |
|
6360 |
|
6361 | </td>
|
6362 |
|
6363 |
|
6364 |
|
6365 | <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;">
|
6366 |
|
6367 | </td>
|
6368 |
|
6369 |
|
6370 | <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 sub-sprite that we want to get.</p></td>
|
6371 | </tr>
|
6372 |
|
6373 |
|
6374 |
|
6375 | <tr>
|
6376 |
|
6377 | <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>sprite</code></td>
|
6378 |
|
6379 |
|
6380 | <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;">
|
6381 |
|
6382 |
|
6383 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
6384 |
|
6385 |
|
6386 |
|
6387 |
|
6388 | </td>
|
6389 |
|
6390 |
|
6391 | <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;">
|
6392 |
|
6393 | <optional><br>
|
6394 |
|
6395 |
|
6396 |
|
6397 |
|
6398 |
|
6399 | </td>
|
6400 |
|
6401 |
|
6402 |
|
6403 | <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;">
|
6404 |
|
6405 | CB_GraphicSprites#getCurrent()
|
6406 |
|
6407 | </td>
|
6408 |
|
6409 |
|
6410 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite and its sub-sprites. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
6411 | </tr>
|
6412 |
|
6413 |
|
6414 |
|
6415 | <tr>
|
6416 |
|
6417 | <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>
|
6418 |
|
6419 |
|
6420 | <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;">
|
6421 |
|
6422 |
|
6423 | <span class="param-type">*</span>
|
6424 |
|
6425 |
|
6426 |
|
6427 |
|
6428 | </td>
|
6429 |
|
6430 |
|
6431 | <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;">
|
6432 |
|
6433 | <optional><br>
|
6434 |
|
6435 |
|
6436 |
|
6437 |
|
6438 |
|
6439 | </td>
|
6440 |
|
6441 |
|
6442 |
|
6443 | <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;">
|
6444 |
|
6445 | </td>
|
6446 |
|
6447 |
|
6448 | <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>
|
6449 | </tr>
|
6450 |
|
6451 |
|
6452 | </tbody>
|
6453 | </table>
|
6454 |
|
6455 |
|
6456 |
|
6457 |
|
6458 | <dl class="details">
|
6459 |
|
6460 |
|
6461 |
|
6462 |
|
6463 |
|
6464 |
|
6465 |
|
6466 |
|
6467 |
|
6468 |
|
6469 |
|
6470 |
|
6471 |
|
6472 |
|
6473 |
|
6474 |
|
6475 |
|
6476 |
|
6477 |
|
6478 |
|
6479 |
|
6480 |
|
6481 |
|
6482 |
|
6483 |
|
6484 |
|
6485 |
|
6486 |
|
6487 |
|
6488 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6489 | <dd class="tag-source">
|
6490 | <ul class="dummy">
|
6491 | <li>
|
6492 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
6493 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1188">line 1188</a>
|
6494 | </li>
|
6495 | </ul>
|
6496 | </dd>
|
6497 |
|
6498 |
|
6499 |
|
6500 |
|
6501 |
|
6502 |
|
6503 |
|
6504 | </dl>
|
6505 |
|
6506 |
|
6507 |
|
6508 |
|
6509 |
|
6510 |
|
6511 |
|
6512 |
|
6513 |
|
6514 |
|
6515 |
|
6516 |
|
6517 |
|
6518 | <h5>Returns:</h5>
|
6519 |
|
6520 |
|
6521 | <div class="param-desc">
|
6522 | <p>Returns a <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object if found or the value of "returnValueOnFail" otherwise.</p>
|
6523 | </div>
|
6524 |
|
6525 |
|
6526 |
|
6527 | <dl>
|
6528 | <dt>
|
6529 | Type
|
6530 | </dt>
|
6531 | <dd>
|
6532 |
|
6533 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
6534 | |
|
6535 |
|
6536 | <span class="param-type">*</span>
|
6537 |
|
6538 |
|
6539 |
|
6540 | </dd>
|
6541 | </dl>
|
6542 |
|
6543 |
|
6544 |
|
6545 |
|
6546 |
|
6547 | </dd>
|
6548 |
|
6549 |
|
6550 |
|
6551 | <hr>
|
6552 | <dt>
|
6553 | <h4 class="name" id="getSubSpriteIndexById"><span class="type-signature"></span>getSubSpriteIndexById<span class="signature">( [id] [, sprite])</span><span class="type-signature"> → {integer}</span></h4>
|
6554 |
|
6555 |
|
6556 | </dt>
|
6557 | <dd>
|
6558 |
|
6559 |
|
6560 | <div class="description">
|
6561 | <p>Gets the index (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) of a desired sub-sprite by its identifier.</p>
|
6562 | </div>
|
6563 |
|
6564 |
|
6565 |
|
6566 |
|
6567 |
|
6568 |
|
6569 |
|
6570 |
|
6571 | <h5>Parameters:</h5>
|
6572 |
|
6573 |
|
6574 | <table class="params table table-striped">
|
6575 | <thead>
|
6576 | <tr>
|
6577 |
|
6578 | <th style="width:12%; min-width:110px;">Name</th>
|
6579 |
|
6580 |
|
6581 | <th style="width:12%; min-width:110px;">Type</th>
|
6582 |
|
6583 |
|
6584 | <th style="width:12%; min-width:110px;">Argument</th>
|
6585 |
|
6586 |
|
6587 |
|
6588 | <th style="width:12%; min-width:110px;">Default</th>
|
6589 |
|
6590 |
|
6591 | <th class="last" style="min-width:310px;">Description</th>
|
6592 | </tr>
|
6593 | </thead>
|
6594 |
|
6595 | <tbody>
|
6596 |
|
6597 |
|
6598 | <tr>
|
6599 |
|
6600 | <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>
|
6601 |
|
6602 |
|
6603 | <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;">
|
6604 |
|
6605 |
|
6606 | <span class="param-type">string</span>
|
6607 | |
|
6608 |
|
6609 | <span class="param-type">*</span>
|
6610 |
|
6611 |
|
6612 |
|
6613 |
|
6614 | </td>
|
6615 |
|
6616 |
|
6617 | <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;">
|
6618 |
|
6619 | <optional><br>
|
6620 |
|
6621 |
|
6622 |
|
6623 |
|
6624 |
|
6625 | </td>
|
6626 |
|
6627 |
|
6628 |
|
6629 | <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;">
|
6630 |
|
6631 | </td>
|
6632 |
|
6633 |
|
6634 | <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 sub-sprite whose index we want to get.</p></td>
|
6635 | </tr>
|
6636 |
|
6637 |
|
6638 |
|
6639 | <tr>
|
6640 |
|
6641 | <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>sprite</code></td>
|
6642 |
|
6643 |
|
6644 | <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;">
|
6645 |
|
6646 |
|
6647 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
6648 |
|
6649 |
|
6650 |
|
6651 |
|
6652 | </td>
|
6653 |
|
6654 |
|
6655 | <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;">
|
6656 |
|
6657 | <optional><br>
|
6658 |
|
6659 |
|
6660 |
|
6661 |
|
6662 |
|
6663 | </td>
|
6664 |
|
6665 |
|
6666 |
|
6667 | <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;">
|
6668 |
|
6669 | CB_GraphicSprites#getCurrent()
|
6670 |
|
6671 | </td>
|
6672 |
|
6673 |
|
6674 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite and its sub-sprites. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
6675 | </tr>
|
6676 |
|
6677 |
|
6678 | </tbody>
|
6679 | </table>
|
6680 |
|
6681 |
|
6682 |
|
6683 |
|
6684 | <dl class="details">
|
6685 |
|
6686 |
|
6687 |
|
6688 |
|
6689 |
|
6690 |
|
6691 |
|
6692 |
|
6693 |
|
6694 |
|
6695 |
|
6696 |
|
6697 |
|
6698 |
|
6699 |
|
6700 |
|
6701 |
|
6702 |
|
6703 |
|
6704 |
|
6705 |
|
6706 |
|
6707 |
|
6708 |
|
6709 |
|
6710 |
|
6711 |
|
6712 |
|
6713 |
|
6714 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6715 | <dd class="tag-source">
|
6716 | <ul class="dummy">
|
6717 | <li>
|
6718 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
6719 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1204">line 1204</a>
|
6720 | </li>
|
6721 | </ul>
|
6722 | </dd>
|
6723 |
|
6724 |
|
6725 |
|
6726 |
|
6727 |
|
6728 |
|
6729 |
|
6730 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
6731 | <dd class="tag-todo">
|
6732 | <ul>
|
6733 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
6734 | </ul>
|
6735 | </dd>
|
6736 |
|
6737 | </dl>
|
6738 |
|
6739 |
|
6740 |
|
6741 |
|
6742 |
|
6743 |
|
6744 |
|
6745 |
|
6746 |
|
6747 |
|
6748 |
|
6749 |
|
6750 |
|
6751 | <h5>Returns:</h5>
|
6752 |
|
6753 |
|
6754 | <div class="param-desc">
|
6755 | <p>Returns the index (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) of the desired sub-sprite or -1 if not found.</p>
|
6756 | </div>
|
6757 |
|
6758 |
|
6759 |
|
6760 | <dl>
|
6761 | <dt>
|
6762 | Type
|
6763 | </dt>
|
6764 | <dd>
|
6765 |
|
6766 | <span class="param-type">integer</span>
|
6767 |
|
6768 |
|
6769 |
|
6770 | </dd>
|
6771 | </dl>
|
6772 |
|
6773 |
|
6774 |
|
6775 |
|
6776 |
|
6777 | </dd>
|
6778 |
|
6779 |
|
6780 |
|
6781 | <hr>
|
6782 | <dt>
|
6783 | <h4 class="name" id="getSubSprites"><span class="type-signature"></span>getSubSprites<span class="signature">( [sprite] [, orderedByZIndex] [, returnValueOnFail])</span><span class="type-signature"> → {array|*}</span></h4>
|
6784 |
|
6785 |
|
6786 | </dt>
|
6787 | <dd>
|
6788 |
|
6789 |
|
6790 | <div class="description">
|
6791 | <p>Gets an array with all the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects of a given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object.</p>
|
6792 | </div>
|
6793 |
|
6794 |
|
6795 |
|
6796 |
|
6797 |
|
6798 |
|
6799 |
|
6800 |
|
6801 | <h5>Parameters:</h5>
|
6802 |
|
6803 |
|
6804 | <table class="params table table-striped">
|
6805 | <thead>
|
6806 | <tr>
|
6807 |
|
6808 | <th style="width:12%; min-width:110px;">Name</th>
|
6809 |
|
6810 |
|
6811 | <th style="width:12%; min-width:110px;">Type</th>
|
6812 |
|
6813 |
|
6814 | <th style="width:12%; min-width:110px;">Argument</th>
|
6815 |
|
6816 |
|
6817 |
|
6818 | <th style="width:12%; min-width:110px;">Default</th>
|
6819 |
|
6820 |
|
6821 | <th class="last" style="min-width:310px;">Description</th>
|
6822 | </tr>
|
6823 | </thead>
|
6824 |
|
6825 | <tbody>
|
6826 |
|
6827 |
|
6828 | <tr>
|
6829 |
|
6830 | <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>sprite</code></td>
|
6831 |
|
6832 |
|
6833 | <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;">
|
6834 |
|
6835 |
|
6836 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
6837 |
|
6838 |
|
6839 |
|
6840 |
|
6841 | </td>
|
6842 |
|
6843 |
|
6844 | <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;">
|
6845 |
|
6846 | <optional><br>
|
6847 |
|
6848 |
|
6849 |
|
6850 |
|
6851 |
|
6852 | </td>
|
6853 |
|
6854 |
|
6855 |
|
6856 | <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;">
|
6857 |
|
6858 | CB_GraphicSprites#getCurrent()
|
6859 |
|
6860 | </td>
|
6861 |
|
6862 |
|
6863 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite and its sub-sprites. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
6864 | </tr>
|
6865 |
|
6866 |
|
6867 |
|
6868 | <tr>
|
6869 |
|
6870 | <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>
|
6871 |
|
6872 |
|
6873 | <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;">
|
6874 |
|
6875 |
|
6876 | <span class="param-type">boolean</span>
|
6877 |
|
6878 |
|
6879 |
|
6880 |
|
6881 | </td>
|
6882 |
|
6883 |
|
6884 | <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;">
|
6885 |
|
6886 | <optional><br>
|
6887 |
|
6888 |
|
6889 |
|
6890 |
|
6891 |
|
6892 | </td>
|
6893 |
|
6894 |
|
6895 |
|
6896 | <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;">
|
6897 |
|
6898 | false
|
6899 |
|
6900 | </td>
|
6901 |
|
6902 |
|
6903 | <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 sub-sprites sorted by their z-index (ascending order).</p></td>
|
6904 | </tr>
|
6905 |
|
6906 |
|
6907 |
|
6908 | <tr>
|
6909 |
|
6910 | <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>
|
6911 |
|
6912 |
|
6913 | <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;">
|
6914 |
|
6915 |
|
6916 | <span class="param-type">*</span>
|
6917 |
|
6918 |
|
6919 |
|
6920 |
|
6921 | </td>
|
6922 |
|
6923 |
|
6924 | <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;">
|
6925 |
|
6926 | <optional><br>
|
6927 |
|
6928 |
|
6929 |
|
6930 |
|
6931 |
|
6932 | </td>
|
6933 |
|
6934 |
|
6935 |
|
6936 | <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;">
|
6937 |
|
6938 | </td>
|
6939 |
|
6940 |
|
6941 | <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>
|
6942 | </tr>
|
6943 |
|
6944 |
|
6945 | </tbody>
|
6946 | </table>
|
6947 |
|
6948 |
|
6949 |
|
6950 |
|
6951 | <dl class="details">
|
6952 |
|
6953 |
|
6954 |
|
6955 |
|
6956 |
|
6957 |
|
6958 |
|
6959 |
|
6960 |
|
6961 |
|
6962 |
|
6963 |
|
6964 |
|
6965 |
|
6966 |
|
6967 |
|
6968 |
|
6969 |
|
6970 |
|
6971 |
|
6972 |
|
6973 |
|
6974 |
|
6975 |
|
6976 |
|
6977 |
|
6978 |
|
6979 |
|
6980 |
|
6981 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6982 | <dd class="tag-source">
|
6983 | <ul class="dummy">
|
6984 | <li>
|
6985 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
6986 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1143">line 1143</a>
|
6987 | </li>
|
6988 | </ul>
|
6989 | </dd>
|
6990 |
|
6991 |
|
6992 |
|
6993 |
|
6994 |
|
6995 |
|
6996 |
|
6997 | </dl>
|
6998 |
|
6999 |
|
7000 |
|
7001 |
|
7002 |
|
7003 |
|
7004 |
|
7005 |
|
7006 |
|
7007 |
|
7008 |
|
7009 |
|
7010 |
|
7011 | <h5>Returns:</h5>
|
7012 |
|
7013 |
|
7014 | <div class="param-desc">
|
7015 | <p>Returns an array with all the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object or the value of "returnValueOnFail" otherwise.</p>
|
7016 | </div>
|
7017 |
|
7018 |
|
7019 |
|
7020 | <dl>
|
7021 | <dt>
|
7022 | Type
|
7023 | </dt>
|
7024 | <dd>
|
7025 |
|
7026 | <span class="param-type">array</span>
|
7027 | |
|
7028 |
|
7029 | <span class="param-type">*</span>
|
7030 |
|
7031 |
|
7032 |
|
7033 | </dd>
|
7034 | </dl>
|
7035 |
|
7036 |
|
7037 |
|
7038 |
|
7039 |
|
7040 | </dd>
|
7041 |
|
7042 |
|
7043 |
|
7044 | <hr>
|
7045 | <dt>
|
7046 | <h4 class="name" id="getTime"><span class="type-signature"></span>getTime<span class="signature">( [returnValueOnFail] [, parentTimeFallback])</span><span class="type-signature"> → {number}</span></h4>
|
7047 |
|
7048 |
|
7049 | </dt>
|
7050 | <dd>
|
7051 |
|
7052 |
|
7053 | <div class="description">
|
7054 | <p>Gets the time in milliseconds when the current sprite or a sub-sprite started being pointed (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which was obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally).</p>
|
7055 | </div>
|
7056 |
|
7057 |
|
7058 |
|
7059 |
|
7060 |
|
7061 |
|
7062 |
|
7063 |
|
7064 | <h5>Parameters:</h5>
|
7065 |
|
7066 |
|
7067 | <table class="params table table-striped">
|
7068 | <thead>
|
7069 | <tr>
|
7070 |
|
7071 | <th style="width:12%; min-width:110px;">Name</th>
|
7072 |
|
7073 |
|
7074 | <th style="width:12%; min-width:110px;">Type</th>
|
7075 |
|
7076 |
|
7077 | <th style="width:12%; min-width:110px;">Argument</th>
|
7078 |
|
7079 |
|
7080 |
|
7081 | <th style="width:12%; min-width:110px;">Default</th>
|
7082 |
|
7083 |
|
7084 | <th class="last" style="min-width:310px;">Description</th>
|
7085 | </tr>
|
7086 | </thead>
|
7087 |
|
7088 | <tbody>
|
7089 |
|
7090 |
|
7091 | <tr>
|
7092 |
|
7093 | <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>
|
7094 |
|
7095 |
|
7096 | <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;">
|
7097 |
|
7098 |
|
7099 | <span class="param-type">*</span>
|
7100 |
|
7101 |
|
7102 |
|
7103 |
|
7104 | </td>
|
7105 |
|
7106 |
|
7107 | <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;">
|
7108 |
|
7109 | <optional><br>
|
7110 |
|
7111 |
|
7112 |
|
7113 |
|
7114 |
|
7115 | </td>
|
7116 |
|
7117 |
|
7118 |
|
7119 | <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;">
|
7120 |
|
7121 | </td>
|
7122 |
|
7123 |
|
7124 | <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>
|
7125 | </tr>
|
7126 |
|
7127 |
|
7128 |
|
7129 | <tr>
|
7130 |
|
7131 | <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>parentTimeFallback</code></td>
|
7132 |
|
7133 |
|
7134 | <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;">
|
7135 |
|
7136 |
|
7137 | <span class="param-type">boolean</span>
|
7138 |
|
7139 |
|
7140 |
|
7141 |
|
7142 | </td>
|
7143 |
|
7144 |
|
7145 | <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;">
|
7146 |
|
7147 | <optional><br>
|
7148 |
|
7149 |
|
7150 |
|
7151 |
|
7152 |
|
7153 | </td>
|
7154 |
|
7155 |
|
7156 |
|
7157 | <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;">
|
7158 |
|
7159 | false
|
7160 |
|
7161 | </td>
|
7162 |
|
7163 |
|
7164 | <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 the "time" property of "this" is not found, it will try to get the "time" property of "this.time" before returning "returnValueOnFail".</p></td>
|
7165 | </tr>
|
7166 |
|
7167 |
|
7168 | </tbody>
|
7169 | </table>
|
7170 |
|
7171 |
|
7172 |
|
7173 |
|
7174 | <dl class="details">
|
7175 |
|
7176 |
|
7177 |
|
7178 |
|
7179 |
|
7180 |
|
7181 |
|
7182 |
|
7183 |
|
7184 |
|
7185 |
|
7186 |
|
7187 |
|
7188 |
|
7189 |
|
7190 |
|
7191 |
|
7192 |
|
7193 |
|
7194 |
|
7195 |
|
7196 |
|
7197 |
|
7198 |
|
7199 |
|
7200 |
|
7201 |
|
7202 |
|
7203 |
|
7204 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7205 | <dd class="tag-source">
|
7206 | <ul class="dummy">
|
7207 | <li>
|
7208 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
7209 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1674">line 1674</a>
|
7210 | </li>
|
7211 | </ul>
|
7212 | </dd>
|
7213 |
|
7214 |
|
7215 |
|
7216 |
|
7217 |
|
7218 |
|
7219 |
|
7220 | </dl>
|
7221 |
|
7222 |
|
7223 |
|
7224 |
|
7225 |
|
7226 |
|
7227 |
|
7228 |
|
7229 |
|
7230 |
|
7231 |
|
7232 |
|
7233 |
|
7234 | <h5>Returns:</h5>
|
7235 |
|
7236 |
|
7237 | <div class="param-desc">
|
7238 | <p>Returns the time in milliseconds when the current sprite or a sub-sprite started being pointed (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which was obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally). If it could not be found, it will return "returnValueOnFail".</p>
|
7239 | </div>
|
7240 |
|
7241 |
|
7242 |
|
7243 | <dl>
|
7244 | <dt>
|
7245 | Type
|
7246 | </dt>
|
7247 | <dd>
|
7248 |
|
7249 | <span class="param-type">number</span>
|
7250 |
|
7251 |
|
7252 |
|
7253 | </dd>
|
7254 | </dl>
|
7255 |
|
7256 |
|
7257 |
|
7258 |
|
7259 |
|
7260 | </dd>
|
7261 |
|
7262 |
|
7263 |
|
7264 | <hr>
|
7265 | <dt>
|
7266 | <h4 class="name" id="getTimeElapsed"><span class="type-signature"></span>getTimeElapsed<span class="signature">( [timeToCompare] [, parentTimeFallback])</span><span class="type-signature"> → {number}</span></h4>
|
7267 |
|
7268 |
|
7269 | </dt>
|
7270 | <dd>
|
7271 |
|
7272 |
|
7273 | <div class="description">
|
7274 | <p>Tells how many milliseconds elapsed since the current sprite or a sub-sprite was or will be pointed (checking the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property), comparing with the time given in milliseconds (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function) or with the current one if none is given.</p>
|
7275 | </div>
|
7276 |
|
7277 |
|
7278 |
|
7279 |
|
7280 |
|
7281 |
|
7282 |
|
7283 |
|
7284 | <h5>Parameters:</h5>
|
7285 |
|
7286 |
|
7287 | <table class="params table table-striped">
|
7288 | <thead>
|
7289 | <tr>
|
7290 |
|
7291 | <th style="width:12%; min-width:110px;">Name</th>
|
7292 |
|
7293 |
|
7294 | <th style="width:12%; min-width:110px;">Type</th>
|
7295 |
|
7296 |
|
7297 | <th style="width:12%; min-width:110px;">Argument</th>
|
7298 |
|
7299 |
|
7300 |
|
7301 | <th style="width:12%; min-width:110px;">Default</th>
|
7302 |
|
7303 |
|
7304 | <th class="last" style="min-width:310px;">Description</th>
|
7305 | </tr>
|
7306 | </thead>
|
7307 |
|
7308 | <tbody>
|
7309 |
|
7310 |
|
7311 | <tr>
|
7312 |
|
7313 | <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>timeToCompare</code></td>
|
7314 |
|
7315 |
|
7316 | <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;">
|
7317 |
|
7318 |
|
7319 | <span class="param-type">number</span>
|
7320 |
|
7321 |
|
7322 |
|
7323 |
|
7324 | </td>
|
7325 |
|
7326 |
|
7327 | <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;">
|
7328 |
|
7329 | <optional><br>
|
7330 |
|
7331 |
|
7332 |
|
7333 |
|
7334 |
|
7335 | </td>
|
7336 |
|
7337 |
|
7338 |
|
7339 | <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;">
|
7340 |
|
7341 | CB_Device.getTiming()
|
7342 |
|
7343 | </td>
|
7344 |
|
7345 |
|
7346 | <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 time (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function) that we want to compare to (normally, it will be a newer time than the one stored in the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property). It must be a positive number (or zero). If not provided, it will use the current time (by calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally).</p></td>
|
7347 | </tr>
|
7348 |
|
7349 |
|
7350 |
|
7351 | <tr>
|
7352 |
|
7353 | <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>parentTimeFallback</code></td>
|
7354 |
|
7355 |
|
7356 | <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;">
|
7357 |
|
7358 |
|
7359 | <span class="param-type">boolean</span>
|
7360 |
|
7361 |
|
7362 |
|
7363 |
|
7364 | </td>
|
7365 |
|
7366 |
|
7367 | <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;">
|
7368 |
|
7369 | <optional><br>
|
7370 |
|
7371 |
|
7372 |
|
7373 |
|
7374 |
|
7375 | </td>
|
7376 |
|
7377 |
|
7378 |
|
7379 | <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;">
|
7380 |
|
7381 | false
|
7382 |
|
7383 | </td>
|
7384 |
|
7385 |
|
7386 | <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 the "time" property of "this" is not found, it will try to get the "time" property of "this.time" before using "returnValueOnFail".</p></td>
|
7387 | </tr>
|
7388 |
|
7389 |
|
7390 | </tbody>
|
7391 | </table>
|
7392 |
|
7393 |
|
7394 |
|
7395 |
|
7396 | <dl class="details">
|
7397 |
|
7398 |
|
7399 |
|
7400 |
|
7401 |
|
7402 |
|
7403 |
|
7404 |
|
7405 |
|
7406 |
|
7407 |
|
7408 |
|
7409 |
|
7410 |
|
7411 |
|
7412 |
|
7413 |
|
7414 |
|
7415 |
|
7416 |
|
7417 |
|
7418 |
|
7419 |
|
7420 |
|
7421 |
|
7422 |
|
7423 |
|
7424 |
|
7425 |
|
7426 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7427 | <dd class="tag-source">
|
7428 | <ul class="dummy">
|
7429 | <li>
|
7430 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
7431 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1688">line 1688</a>
|
7432 | </li>
|
7433 | </ul>
|
7434 | </dd>
|
7435 |
|
7436 |
|
7437 |
|
7438 |
|
7439 |
|
7440 |
|
7441 |
|
7442 | </dl>
|
7443 |
|
7444 |
|
7445 |
|
7446 |
|
7447 |
|
7448 |
|
7449 |
|
7450 |
|
7451 |
|
7452 |
|
7453 |
|
7454 |
|
7455 |
|
7456 | <h5>Returns:</h5>
|
7457 |
|
7458 |
|
7459 | <div class="param-desc">
|
7460 | <p>Returns how many milliseconds elapsed since the current sprite or a sub-sprite was or will be pointed, comparing with the time given (in milliseconds) or with the current one if none was given. This is just the given "timeToCompare" minus the returning value of calling the <a href="CB_GraphicSprites.html#getTime"><code>CB_GraphicSprites#getTime</code></a> method.</p>
|
7461 | </div>
|
7462 |
|
7463 |
|
7464 |
|
7465 | <dl>
|
7466 | <dt>
|
7467 | Type
|
7468 | </dt>
|
7469 | <dd>
|
7470 |
|
7471 | <span class="param-type">number</span>
|
7472 |
|
7473 |
|
7474 |
|
7475 | </dd>
|
7476 | </dl>
|
7477 |
|
7478 |
|
7479 |
|
7480 |
|
7481 |
|
7482 | </dd>
|
7483 |
|
7484 |
|
7485 |
|
7486 | <hr>
|
7487 | <dt>
|
7488 | <h4 class="name" id="getZIndex"><span class="type-signature"></span>getZIndex<span class="signature">( [returnValueOnFail])</span><span class="type-signature"> → {number}</span></h4>
|
7489 |
|
7490 |
|
7491 | </dt>
|
7492 | <dd>
|
7493 |
|
7494 |
|
7495 | <div class="description">
|
7496 | <p>Gets the z-index ("zIndex" property) of the sprites group object (and the {@CB_GraphicSprites} object itself).</p>
|
7497 | </div>
|
7498 |
|
7499 |
|
7500 |
|
7501 |
|
7502 |
|
7503 |
|
7504 |
|
7505 |
|
7506 | <h5>Parameters:</h5>
|
7507 |
|
7508 |
|
7509 | <table class="params table table-striped">
|
7510 | <thead>
|
7511 | <tr>
|
7512 |
|
7513 | <th style="width:12%; min-width:110px;">Name</th>
|
7514 |
|
7515 |
|
7516 | <th style="width:12%; min-width:110px;">Type</th>
|
7517 |
|
7518 |
|
7519 | <th style="width:12%; min-width:110px;">Argument</th>
|
7520 |
|
7521 |
|
7522 |
|
7523 |
|
7524 | <th class="last" style="min-width:310px;">Description</th>
|
7525 | </tr>
|
7526 | </thead>
|
7527 |
|
7528 | <tbody>
|
7529 |
|
7530 |
|
7531 | <tr>
|
7532 |
|
7533 | <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>
|
7534 |
|
7535 |
|
7536 | <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;">
|
7537 |
|
7538 |
|
7539 | <span class="param-type">*</span>
|
7540 |
|
7541 |
|
7542 |
|
7543 |
|
7544 | </td>
|
7545 |
|
7546 |
|
7547 | <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;">
|
7548 |
|
7549 | <optional><br>
|
7550 |
|
7551 |
|
7552 |
|
7553 |
|
7554 |
|
7555 | </td>
|
7556 |
|
7557 |
|
7558 |
|
7559 |
|
7560 | <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>
|
7561 | </tr>
|
7562 |
|
7563 |
|
7564 | </tbody>
|
7565 | </table>
|
7566 |
|
7567 |
|
7568 |
|
7569 |
|
7570 | <dl class="details">
|
7571 |
|
7572 |
|
7573 |
|
7574 |
|
7575 |
|
7576 |
|
7577 |
|
7578 |
|
7579 |
|
7580 |
|
7581 |
|
7582 |
|
7583 |
|
7584 |
|
7585 |
|
7586 |
|
7587 |
|
7588 |
|
7589 |
|
7590 |
|
7591 |
|
7592 |
|
7593 |
|
7594 |
|
7595 |
|
7596 |
|
7597 |
|
7598 |
|
7599 |
|
7600 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7601 | <dd class="tag-source">
|
7602 | <ul class="dummy">
|
7603 | <li>
|
7604 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
7605 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1429">line 1429</a>
|
7606 | </li>
|
7607 | </ul>
|
7608 | </dd>
|
7609 |
|
7610 |
|
7611 |
|
7612 |
|
7613 |
|
7614 |
|
7615 |
|
7616 | </dl>
|
7617 |
|
7618 |
|
7619 |
|
7620 |
|
7621 |
|
7622 |
|
7623 |
|
7624 |
|
7625 |
|
7626 |
|
7627 |
|
7628 |
|
7629 |
|
7630 | <h5>Returns:</h5>
|
7631 |
|
7632 |
|
7633 | <div class="param-desc">
|
7634 | <p>Returns the z-index ("zIndex") of the sprites group object (and the {@CB_GraphicSprites} object itself). If not found, returns the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or "returnValueOnFail" otherwise.</p>
|
7635 | </div>
|
7636 |
|
7637 |
|
7638 |
|
7639 | <dl>
|
7640 | <dt>
|
7641 | Type
|
7642 | </dt>
|
7643 | <dd>
|
7644 |
|
7645 | <span class="param-type">number</span>
|
7646 |
|
7647 |
|
7648 |
|
7649 | </dd>
|
7650 | </dl>
|
7651 |
|
7652 |
|
7653 |
|
7654 |
|
7655 |
|
7656 | </dd>
|
7657 |
|
7658 |
|
7659 |
|
7660 | <hr>
|
7661 | <dt>
|
7662 | <h4 class="name" id="getZIndexSprite"><span class="type-signature"></span>getZIndexSprite<span class="signature">( [sprite] [, returnValueOnFail])</span><span class="type-signature"> → {number}</span></h4>
|
7663 |
|
7664 |
|
7665 | </dt>
|
7666 | <dd>
|
7667 |
|
7668 |
|
7669 | <div class="description">
|
7670 | <p>Gets the z-index ("zIndex" property) of a given sprite object.</p>
|
7671 | </div>
|
7672 |
|
7673 |
|
7674 |
|
7675 |
|
7676 |
|
7677 |
|
7678 |
|
7679 |
|
7680 | <h5>Parameters:</h5>
|
7681 |
|
7682 |
|
7683 | <table class="params table table-striped">
|
7684 | <thead>
|
7685 | <tr>
|
7686 |
|
7687 | <th style="width:12%; min-width:110px;">Name</th>
|
7688 |
|
7689 |
|
7690 | <th style="width:12%; min-width:110px;">Type</th>
|
7691 |
|
7692 |
|
7693 | <th style="width:12%; min-width:110px;">Argument</th>
|
7694 |
|
7695 |
|
7696 |
|
7697 | <th style="width:12%; min-width:110px;">Default</th>
|
7698 |
|
7699 |
|
7700 | <th class="last" style="min-width:310px;">Description</th>
|
7701 | </tr>
|
7702 | </thead>
|
7703 |
|
7704 | <tbody>
|
7705 |
|
7706 |
|
7707 | <tr>
|
7708 |
|
7709 | <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>sprite</code></td>
|
7710 |
|
7711 |
|
7712 | <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;">
|
7713 |
|
7714 |
|
7715 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
7716 |
|
7717 |
|
7718 |
|
7719 |
|
7720 | </td>
|
7721 |
|
7722 |
|
7723 | <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;">
|
7724 |
|
7725 | <optional><br>
|
7726 |
|
7727 |
|
7728 |
|
7729 |
|
7730 |
|
7731 | </td>
|
7732 |
|
7733 |
|
7734 |
|
7735 | <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;">
|
7736 |
|
7737 | CB_GraphicSprites#getCurrent()
|
7738 |
|
7739 | </td>
|
7740 |
|
7741 |
|
7742 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
7743 | </tr>
|
7744 |
|
7745 |
|
7746 |
|
7747 | <tr>
|
7748 |
|
7749 | <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>
|
7750 |
|
7751 |
|
7752 | <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;">
|
7753 |
|
7754 |
|
7755 | <span class="param-type">*</span>
|
7756 |
|
7757 |
|
7758 |
|
7759 |
|
7760 | </td>
|
7761 |
|
7762 |
|
7763 | <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;">
|
7764 |
|
7765 | <optional><br>
|
7766 |
|
7767 |
|
7768 |
|
7769 |
|
7770 |
|
7771 | </td>
|
7772 |
|
7773 |
|
7774 |
|
7775 | <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;">
|
7776 |
|
7777 | </td>
|
7778 |
|
7779 |
|
7780 | <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>
|
7781 | </tr>
|
7782 |
|
7783 |
|
7784 | </tbody>
|
7785 | </table>
|
7786 |
|
7787 |
|
7788 |
|
7789 |
|
7790 | <dl class="details">
|
7791 |
|
7792 |
|
7793 |
|
7794 |
|
7795 |
|
7796 |
|
7797 |
|
7798 |
|
7799 |
|
7800 |
|
7801 |
|
7802 |
|
7803 |
|
7804 |
|
7805 |
|
7806 |
|
7807 |
|
7808 |
|
7809 |
|
7810 |
|
7811 |
|
7812 |
|
7813 |
|
7814 |
|
7815 |
|
7816 |
|
7817 |
|
7818 |
|
7819 |
|
7820 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7821 | <dd class="tag-source">
|
7822 | <ul class="dummy">
|
7823 | <li>
|
7824 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
7825 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1460">line 1460</a>
|
7826 | </li>
|
7827 | </ul>
|
7828 | </dd>
|
7829 |
|
7830 |
|
7831 |
|
7832 |
|
7833 |
|
7834 |
|
7835 |
|
7836 | </dl>
|
7837 |
|
7838 |
|
7839 |
|
7840 |
|
7841 |
|
7842 |
|
7843 |
|
7844 |
|
7845 |
|
7846 |
|
7847 |
|
7848 |
|
7849 |
|
7850 | <h5>Returns:</h5>
|
7851 |
|
7852 |
|
7853 | <div class="param-desc">
|
7854 | <p>Returns the z-index ("zIndex") of the given sprite. If not found, returns the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or "returnValueOnFail" otherwise.</p>
|
7855 | </div>
|
7856 |
|
7857 |
|
7858 |
|
7859 | <dl>
|
7860 | <dt>
|
7861 | Type
|
7862 | </dt>
|
7863 | <dd>
|
7864 |
|
7865 | <span class="param-type">number</span>
|
7866 |
|
7867 |
|
7868 |
|
7869 | </dd>
|
7870 | </dl>
|
7871 |
|
7872 |
|
7873 |
|
7874 |
|
7875 |
|
7876 | </dd>
|
7877 |
|
7878 |
|
7879 |
|
7880 | <hr>
|
7881 | <dt>
|
7882 | <h4 class="name" id="getZIndexSubSprite"><span class="type-signature"></span>getZIndexSubSprite<span class="signature">(subSprite [, returnValueOnFail])</span><span class="type-signature"> → {number}</span></h4>
|
7883 |
|
7884 |
|
7885 | </dt>
|
7886 | <dd>
|
7887 |
|
7888 |
|
7889 | <div class="description">
|
7890 | <p>Gets the z-index ("zIndex" property) of a given sub-sprite object.</p>
|
7891 | </div>
|
7892 |
|
7893 |
|
7894 |
|
7895 |
|
7896 |
|
7897 |
|
7898 |
|
7899 |
|
7900 | <h5>Parameters:</h5>
|
7901 |
|
7902 |
|
7903 | <table class="params table table-striped">
|
7904 | <thead>
|
7905 | <tr>
|
7906 |
|
7907 | <th style="width:12%; min-width:110px;">Name</th>
|
7908 |
|
7909 |
|
7910 | <th style="width:12%; min-width:110px;">Type</th>
|
7911 |
|
7912 |
|
7913 | <th style="width:12%; min-width:110px;">Argument</th>
|
7914 |
|
7915 |
|
7916 |
|
7917 |
|
7918 | <th class="last" style="min-width:310px;">Description</th>
|
7919 | </tr>
|
7920 | </thead>
|
7921 |
|
7922 | <tbody>
|
7923 |
|
7924 |
|
7925 | <tr>
|
7926 |
|
7927 | <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>subSprite</code></td>
|
7928 |
|
7929 |
|
7930 | <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;">
|
7931 |
|
7932 |
|
7933 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
7934 |
|
7935 |
|
7936 |
|
7937 |
|
7938 | </td>
|
7939 |
|
7940 |
|
7941 | <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;">
|
7942 |
|
7943 |
|
7944 |
|
7945 |
|
7946 |
|
7947 | </td>
|
7948 |
|
7949 |
|
7950 |
|
7951 |
|
7952 | <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 <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object which contains the sub-sprite.</p></td>
|
7953 | </tr>
|
7954 |
|
7955 |
|
7956 |
|
7957 | <tr>
|
7958 |
|
7959 | <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>
|
7960 |
|
7961 |
|
7962 | <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;">
|
7963 |
|
7964 |
|
7965 | <span class="param-type">*</span>
|
7966 |
|
7967 |
|
7968 |
|
7969 |
|
7970 | </td>
|
7971 |
|
7972 |
|
7973 | <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;">
|
7974 |
|
7975 | <optional><br>
|
7976 |
|
7977 |
|
7978 |
|
7979 |
|
7980 |
|
7981 | </td>
|
7982 |
|
7983 |
|
7984 |
|
7985 |
|
7986 | <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>
|
7987 | </tr>
|
7988 |
|
7989 |
|
7990 | </tbody>
|
7991 | </table>
|
7992 |
|
7993 |
|
7994 |
|
7995 |
|
7996 | <dl class="details">
|
7997 |
|
7998 |
|
7999 |
|
8000 |
|
8001 |
|
8002 |
|
8003 |
|
8004 |
|
8005 |
|
8006 |
|
8007 |
|
8008 |
|
8009 |
|
8010 |
|
8011 |
|
8012 |
|
8013 |
|
8014 |
|
8015 |
|
8016 |
|
8017 |
|
8018 |
|
8019 |
|
8020 |
|
8021 |
|
8022 |
|
8023 |
|
8024 |
|
8025 |
|
8026 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8027 | <dd class="tag-source">
|
8028 | <ul class="dummy">
|
8029 | <li>
|
8030 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8031 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1495">line 1495</a>
|
8032 | </li>
|
8033 | </ul>
|
8034 | </dd>
|
8035 |
|
8036 |
|
8037 |
|
8038 |
|
8039 |
|
8040 |
|
8041 |
|
8042 | </dl>
|
8043 |
|
8044 |
|
8045 |
|
8046 |
|
8047 |
|
8048 |
|
8049 |
|
8050 |
|
8051 |
|
8052 |
|
8053 |
|
8054 |
|
8055 |
|
8056 | <h5>Returns:</h5>
|
8057 |
|
8058 |
|
8059 | <div class="param-desc">
|
8060 | <p>Returns the z-index ("zIndex") of the given sub-sprite. If not found, returns the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or "returnValueOnFail" otherwise.</p>
|
8061 | </div>
|
8062 |
|
8063 |
|
8064 |
|
8065 | <dl>
|
8066 | <dt>
|
8067 | Type
|
8068 | </dt>
|
8069 | <dd>
|
8070 |
|
8071 | <span class="param-type">number</span>
|
8072 |
|
8073 |
|
8074 |
|
8075 | </dd>
|
8076 | </dl>
|
8077 |
|
8078 |
|
8079 |
|
8080 |
|
8081 |
|
8082 | </dd>
|
8083 |
|
8084 |
|
8085 |
|
8086 | <hr>
|
8087 | <dt>
|
8088 | <h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">()</span><span class="type-signature"></span></h4>
|
8089 |
|
8090 |
|
8091 | </dt>
|
8092 | <dd>
|
8093 |
|
8094 |
|
8095 | <div class="description">
|
8096 | <p>Alias for <a href="CB_GraphicSprites.html#insertSprite"><code>CB_GraphicSprites#insertSprite</code></a>.</p>
|
8097 | </div>
|
8098 |
|
8099 |
|
8100 |
|
8101 |
|
8102 |
|
8103 |
|
8104 |
|
8105 |
|
8106 |
|
8107 |
|
8108 | <dl class="details">
|
8109 |
|
8110 |
|
8111 |
|
8112 |
|
8113 |
|
8114 |
|
8115 |
|
8116 |
|
8117 |
|
8118 |
|
8119 |
|
8120 |
|
8121 |
|
8122 |
|
8123 |
|
8124 |
|
8125 |
|
8126 |
|
8127 |
|
8128 |
|
8129 |
|
8130 |
|
8131 |
|
8132 |
|
8133 |
|
8134 |
|
8135 |
|
8136 |
|
8137 |
|
8138 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8139 | <dd class="tag-source">
|
8140 | <ul class="dummy">
|
8141 | <li>
|
8142 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8143 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-645">line 645</a>
|
8144 | </li>
|
8145 | </ul>
|
8146 | </dd>
|
8147 |
|
8148 |
|
8149 |
|
8150 |
|
8151 |
|
8152 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
8153 | <dd class="tag-see">
|
8154 | <ul>
|
8155 | <li><a href="CB_GraphicSprites.html#insertSprite"><code>CB_GraphicSprites#insertSprite</code></a></li>
|
8156 | </ul>
|
8157 | </dd>
|
8158 |
|
8159 |
|
8160 |
|
8161 | </dl>
|
8162 |
|
8163 |
|
8164 |
|
8165 |
|
8166 |
|
8167 |
|
8168 |
|
8169 |
|
8170 |
|
8171 |
|
8172 |
|
8173 |
|
8174 |
|
8175 |
|
8176 |
|
8177 | </dd>
|
8178 |
|
8179 |
|
8180 |
|
8181 | <hr>
|
8182 | <dt>
|
8183 | <h4 class="name" id="insertSprite"><span class="type-signature"></span>insertSprite<span class="signature">( [sprite] [, avoidUpdatingSpritesByZIndex])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>}</span></h4>
|
8184 |
|
8185 |
|
8186 | </dt>
|
8187 | <dd>
|
8188 |
|
8189 |
|
8190 | <div class="description">
|
8191 | <p>Adds the desired graphic sprite. Calls <a href="CB_GraphicSprites.html#insertSubSprites"><code>CB_GraphicSprites#insertSubSprites</code></a> internally. If a sprite with the same identifier already exists, it will be replaced by the new one in its same position.</p>
|
8192 | </div>
|
8193 |
|
8194 |
|
8195 |
|
8196 |
|
8197 |
|
8198 |
|
8199 |
|
8200 |
|
8201 | <h5>Parameters:</h5>
|
8202 |
|
8203 |
|
8204 | <table class="params table table-striped">
|
8205 | <thead>
|
8206 | <tr>
|
8207 |
|
8208 | <th style="width:12%; min-width:110px;">Name</th>
|
8209 |
|
8210 |
|
8211 | <th style="width:12%; min-width:110px;">Type</th>
|
8212 |
|
8213 |
|
8214 | <th style="width:12%; min-width:110px;">Argument</th>
|
8215 |
|
8216 |
|
8217 |
|
8218 | <th style="width:12%; min-width:110px;">Default</th>
|
8219 |
|
8220 |
|
8221 | <th class="last" style="min-width:310px;">Description</th>
|
8222 | </tr>
|
8223 | </thead>
|
8224 |
|
8225 | <tbody>
|
8226 |
|
8227 |
|
8228 | <tr>
|
8229 |
|
8230 | <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>sprite</code></td>
|
8231 |
|
8232 |
|
8233 | <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;">
|
8234 |
|
8235 |
|
8236 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
8237 |
|
8238 |
|
8239 |
|
8240 |
|
8241 | </td>
|
8242 |
|
8243 |
|
8244 | <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;">
|
8245 |
|
8246 | <optional><br>
|
8247 |
|
8248 |
|
8249 |
|
8250 |
|
8251 |
|
8252 | </td>
|
8253 |
|
8254 |
|
8255 |
|
8256 | <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;">
|
8257 |
|
8258 | </td>
|
8259 |
|
8260 |
|
8261 | <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 sprite. It will be stored inside the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property.</p></td>
|
8262 | </tr>
|
8263 |
|
8264 |
|
8265 |
|
8266 | <tr>
|
8267 |
|
8268 | <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>avoidUpdatingSpritesByZIndex</code></td>
|
8269 |
|
8270 |
|
8271 | <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;">
|
8272 |
|
8273 |
|
8274 | <span class="param-type">boolean</span>
|
8275 |
|
8276 |
|
8277 |
|
8278 |
|
8279 | </td>
|
8280 |
|
8281 |
|
8282 | <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;">
|
8283 |
|
8284 | <optional><br>
|
8285 |
|
8286 |
|
8287 |
|
8288 |
|
8289 |
|
8290 | </td>
|
8291 |
|
8292 |
|
8293 |
|
8294 | <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;">
|
8295 |
|
8296 | false
|
8297 |
|
8298 | </td>
|
8299 |
|
8300 |
|
8301 | <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_GraphicSprites#updateSpritesByZIndex} method internally. Internal usage recommended only.</p></td>
|
8302 | </tr>
|
8303 |
|
8304 |
|
8305 | </tbody>
|
8306 | </table>
|
8307 |
|
8308 |
|
8309 |
|
8310 |
|
8311 | <dl class="details">
|
8312 |
|
8313 |
|
8314 |
|
8315 |
|
8316 |
|
8317 |
|
8318 |
|
8319 |
|
8320 |
|
8321 |
|
8322 |
|
8323 |
|
8324 |
|
8325 |
|
8326 |
|
8327 |
|
8328 |
|
8329 |
|
8330 |
|
8331 |
|
8332 |
|
8333 |
|
8334 |
|
8335 |
|
8336 |
|
8337 |
|
8338 |
|
8339 |
|
8340 |
|
8341 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8342 | <dd class="tag-source">
|
8343 | <ul class="dummy">
|
8344 | <li>
|
8345 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8346 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-657">line 657</a>
|
8347 | </li>
|
8348 | </ul>
|
8349 | </dd>
|
8350 |
|
8351 |
|
8352 |
|
8353 |
|
8354 |
|
8355 |
|
8356 |
|
8357 | </dl>
|
8358 |
|
8359 |
|
8360 |
|
8361 |
|
8362 |
|
8363 |
|
8364 |
|
8365 |
|
8366 |
|
8367 |
|
8368 |
|
8369 |
|
8370 |
|
8371 | <h5>Returns:</h5>
|
8372 |
|
8373 |
|
8374 | <div class="param-desc">
|
8375 | <p>Returns the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object 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).</p>
|
8376 | </div>
|
8377 |
|
8378 |
|
8379 |
|
8380 | <dl>
|
8381 | <dt>
|
8382 | Type
|
8383 | </dt>
|
8384 | <dd>
|
8385 |
|
8386 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
8387 |
|
8388 |
|
8389 |
|
8390 | </dd>
|
8391 | </dl>
|
8392 |
|
8393 |
|
8394 |
|
8395 |
|
8396 |
|
8397 | </dd>
|
8398 |
|
8399 |
|
8400 |
|
8401 | <hr>
|
8402 | <dt>
|
8403 | <h4 class="name" id="insertSprites"><span class="type-signature"></span>insertSprites<span class="signature">( [spritesGroup] [, byReference])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a>}</span></h4>
|
8404 |
|
8405 |
|
8406 | </dt>
|
8407 | <dd>
|
8408 |
|
8409 |
|
8410 | <div class="description">
|
8411 | <p>Adds the desired group of graphic sprites. Calls the <a href="CB_GraphicSprites.html#insertSprite"><code>CB_GraphicSprites#insertSprite</code></a> and <a href="CB_GraphicSprites.html#updateSpritesByZIndex"><code>CB_GraphicSprites#updateSpritesByZIndex</code></a> methods internally.</p>
|
8412 | </div>
|
8413 |
|
8414 |
|
8415 |
|
8416 |
|
8417 |
|
8418 |
|
8419 |
|
8420 |
|
8421 | <h5>Parameters:</h5>
|
8422 |
|
8423 |
|
8424 | <table class="params table table-striped">
|
8425 | <thead>
|
8426 | <tr>
|
8427 |
|
8428 | <th style="width:12%; min-width:110px;">Name</th>
|
8429 |
|
8430 |
|
8431 | <th style="width:12%; min-width:110px;">Type</th>
|
8432 |
|
8433 |
|
8434 | <th style="width:12%; min-width:110px;">Argument</th>
|
8435 |
|
8436 |
|
8437 |
|
8438 | <th style="width:12%; min-width:110px;">Default</th>
|
8439 |
|
8440 |
|
8441 | <th class="last" style="min-width:310px;">Description</th>
|
8442 | </tr>
|
8443 | </thead>
|
8444 |
|
8445 | <tbody>
|
8446 |
|
8447 |
|
8448 | <tr>
|
8449 |
|
8450 | <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>
|
8451 |
|
8452 |
|
8453 | <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;">
|
8454 |
|
8455 |
|
8456 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
8457 |
|
8458 |
|
8459 |
|
8460 |
|
8461 | </td>
|
8462 |
|
8463 |
|
8464 | <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;">
|
8465 |
|
8466 | <optional><br>
|
8467 |
|
8468 |
|
8469 |
|
8470 |
|
8471 |
|
8472 | </td>
|
8473 |
|
8474 |
|
8475 |
|
8476 | <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;">
|
8477 |
|
8478 | </td>
|
8479 |
|
8480 |
|
8481 | <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. They will be stored in the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property.</p></td>
|
8482 | </tr>
|
8483 |
|
8484 |
|
8485 |
|
8486 | <tr>
|
8487 |
|
8488 | <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>
|
8489 |
|
8490 |
|
8491 | <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;">
|
8492 |
|
8493 |
|
8494 | <span class="param-type">boolean</span>
|
8495 |
|
8496 |
|
8497 |
|
8498 |
|
8499 | </td>
|
8500 |
|
8501 |
|
8502 | <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;">
|
8503 |
|
8504 | <optional><br>
|
8505 |
|
8506 |
|
8507 |
|
8508 |
|
8509 |
|
8510 | </td>
|
8511 |
|
8512 |
|
8513 |
|
8514 | <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;">
|
8515 |
|
8516 | !!<code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code>
|
8517 |
|
8518 | </td>
|
8519 |
|
8520 |
|
8521 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>This value will be used as the default value when the "byReference" property is not given in the sprites (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects) or sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects). The value will be stored in the <a href="CB_GraphicSprites.html#byReference_DEFAULT"><code>CB_GraphicSprites#byReference_DEFAULT</code></a> property. If a boolean value is not provided, it will use the value of the <code>CB_GraphicSprites.SPRITES_OBJECT.byReference_DEFAULT</code> property of the given <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object (parsed to boolean).</p></td>
|
8522 | </tr>
|
8523 |
|
8524 |
|
8525 | </tbody>
|
8526 | </table>
|
8527 |
|
8528 |
|
8529 |
|
8530 |
|
8531 | <dl class="details">
|
8532 |
|
8533 |
|
8534 |
|
8535 |
|
8536 |
|
8537 |
|
8538 |
|
8539 |
|
8540 |
|
8541 |
|
8542 |
|
8543 |
|
8544 |
|
8545 |
|
8546 |
|
8547 |
|
8548 |
|
8549 |
|
8550 |
|
8551 |
|
8552 |
|
8553 |
|
8554 |
|
8555 |
|
8556 |
|
8557 |
|
8558 |
|
8559 |
|
8560 |
|
8561 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8562 | <dd class="tag-source">
|
8563 | <ul class="dummy">
|
8564 | <li>
|
8565 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8566 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-507">line 507</a>
|
8567 | </li>
|
8568 | </ul>
|
8569 | </dd>
|
8570 |
|
8571 |
|
8572 |
|
8573 |
|
8574 |
|
8575 |
|
8576 |
|
8577 | </dl>
|
8578 |
|
8579 |
|
8580 |
|
8581 |
|
8582 |
|
8583 |
|
8584 |
|
8585 |
|
8586 |
|
8587 |
|
8588 |
|
8589 |
|
8590 |
|
8591 | <h5>Returns:</h5>
|
8592 |
|
8593 |
|
8594 | <div class="param-desc">
|
8595 | <p>Returns the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property after updating it.</p>
|
8596 | </div>
|
8597 |
|
8598 |
|
8599 |
|
8600 | <dl>
|
8601 | <dt>
|
8602 | Type
|
8603 | </dt>
|
8604 | <dd>
|
8605 |
|
8606 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
8607 |
|
8608 |
|
8609 |
|
8610 | </dd>
|
8611 | </dl>
|
8612 |
|
8613 |
|
8614 |
|
8615 |
|
8616 |
|
8617 | </dd>
|
8618 |
|
8619 |
|
8620 |
|
8621 | <hr>
|
8622 | <dt>
|
8623 | <h4 class="name" id="insertSpritesGroup"><span class="type-signature"></span>insertSpritesGroup<span class="signature">()</span><span class="type-signature"></span></h4>
|
8624 |
|
8625 |
|
8626 | </dt>
|
8627 | <dd>
|
8628 |
|
8629 |
|
8630 | <div class="description">
|
8631 | <p>Alias for <a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a>.</p>
|
8632 | </div>
|
8633 |
|
8634 |
|
8635 |
|
8636 |
|
8637 |
|
8638 |
|
8639 |
|
8640 |
|
8641 |
|
8642 |
|
8643 | <dl class="details">
|
8644 |
|
8645 |
|
8646 |
|
8647 |
|
8648 |
|
8649 |
|
8650 |
|
8651 |
|
8652 |
|
8653 |
|
8654 |
|
8655 |
|
8656 |
|
8657 |
|
8658 |
|
8659 |
|
8660 |
|
8661 |
|
8662 |
|
8663 |
|
8664 |
|
8665 |
|
8666 |
|
8667 |
|
8668 |
|
8669 |
|
8670 |
|
8671 |
|
8672 |
|
8673 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8674 | <dd class="tag-source">
|
8675 | <ul class="dummy">
|
8676 | <li>
|
8677 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8678 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-495">line 495</a>
|
8679 | </li>
|
8680 | </ul>
|
8681 | </dd>
|
8682 |
|
8683 |
|
8684 |
|
8685 |
|
8686 |
|
8687 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
8688 | <dd class="tag-see">
|
8689 | <ul>
|
8690 | <li><a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a></li>
|
8691 | </ul>
|
8692 | </dd>
|
8693 |
|
8694 |
|
8695 |
|
8696 | </dl>
|
8697 |
|
8698 |
|
8699 |
|
8700 |
|
8701 |
|
8702 |
|
8703 |
|
8704 |
|
8705 |
|
8706 |
|
8707 |
|
8708 |
|
8709 |
|
8710 |
|
8711 |
|
8712 | </dd>
|
8713 |
|
8714 |
|
8715 |
|
8716 | <hr>
|
8717 | <dt>
|
8718 | <h4 class="name" id="insertSubSprite"><span class="type-signature"></span>insertSubSprite<span class="signature">(subSprite, sprite [, avoidUpdatingSubSpritesByZIndex])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a>}</span></h4>
|
8719 |
|
8720 |
|
8721 | </dt>
|
8722 | <dd>
|
8723 |
|
8724 |
|
8725 | <div class="description">
|
8726 | <p>Adds the given sub-sprite to the desired sprite. If a sub-sprite with the same identifier already exists, it will be replaced by the new one in its same position.</p>
|
8727 | </div>
|
8728 |
|
8729 |
|
8730 |
|
8731 |
|
8732 |
|
8733 |
|
8734 |
|
8735 |
|
8736 | <h5>Parameters:</h5>
|
8737 |
|
8738 |
|
8739 | <table class="params table table-striped">
|
8740 | <thead>
|
8741 | <tr>
|
8742 |
|
8743 | <th style="width:12%; min-width:110px;">Name</th>
|
8744 |
|
8745 |
|
8746 | <th style="width:12%; min-width:110px;">Type</th>
|
8747 |
|
8748 |
|
8749 | <th style="width:12%; min-width:110px;">Argument</th>
|
8750 |
|
8751 |
|
8752 |
|
8753 | <th style="width:12%; min-width:110px;">Default</th>
|
8754 |
|
8755 |
|
8756 | <th class="last" style="min-width:310px;">Description</th>
|
8757 | </tr>
|
8758 | </thead>
|
8759 |
|
8760 | <tbody>
|
8761 |
|
8762 |
|
8763 | <tr>
|
8764 |
|
8765 | <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>subSprite</code></td>
|
8766 |
|
8767 |
|
8768 | <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;">
|
8769 |
|
8770 |
|
8771 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
8772 |
|
8773 |
|
8774 |
|
8775 |
|
8776 | </td>
|
8777 |
|
8778 |
|
8779 | <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;">
|
8780 |
|
8781 |
|
8782 |
|
8783 |
|
8784 |
|
8785 | </td>
|
8786 |
|
8787 |
|
8788 |
|
8789 | <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;">
|
8790 |
|
8791 | </td>
|
8792 |
|
8793 |
|
8794 | <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 sub-sprite. It will be stored inside the given sprite.</p></td>
|
8795 | </tr>
|
8796 |
|
8797 |
|
8798 |
|
8799 | <tr>
|
8800 |
|
8801 | <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>sprite</code></td>
|
8802 |
|
8803 |
|
8804 | <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;">
|
8805 |
|
8806 |
|
8807 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
8808 |
|
8809 |
|
8810 |
|
8811 |
|
8812 | </td>
|
8813 |
|
8814 |
|
8815 | <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;">
|
8816 |
|
8817 |
|
8818 |
|
8819 |
|
8820 |
|
8821 | </td>
|
8822 |
|
8823 |
|
8824 |
|
8825 | <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;">
|
8826 |
|
8827 | </td>
|
8828 |
|
8829 |
|
8830 | <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 sprite.</p></td>
|
8831 | </tr>
|
8832 |
|
8833 |
|
8834 |
|
8835 | <tr>
|
8836 |
|
8837 | <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>avoidUpdatingSubSpritesByZIndex</code></td>
|
8838 |
|
8839 |
|
8840 | <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;">
|
8841 |
|
8842 |
|
8843 | <span class="param-type">boolean</span>
|
8844 |
|
8845 |
|
8846 |
|
8847 |
|
8848 | </td>
|
8849 |
|
8850 |
|
8851 | <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;">
|
8852 |
|
8853 | <optional><br>
|
8854 |
|
8855 |
|
8856 |
|
8857 |
|
8858 |
|
8859 | </td>
|
8860 |
|
8861 |
|
8862 |
|
8863 | <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;">
|
8864 |
|
8865 | false
|
8866 |
|
8867 | </td>
|
8868 |
|
8869 |
|
8870 | <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_GraphicSprites#updateSubSpritesByZIndex} method internally. Internal usage recommended only.</p></td>
|
8871 | </tr>
|
8872 |
|
8873 |
|
8874 | </tbody>
|
8875 | </table>
|
8876 |
|
8877 |
|
8878 |
|
8879 |
|
8880 | <dl class="details">
|
8881 |
|
8882 |
|
8883 |
|
8884 |
|
8885 |
|
8886 |
|
8887 |
|
8888 |
|
8889 |
|
8890 |
|
8891 |
|
8892 |
|
8893 |
|
8894 |
|
8895 |
|
8896 |
|
8897 |
|
8898 |
|
8899 |
|
8900 |
|
8901 |
|
8902 |
|
8903 |
|
8904 |
|
8905 |
|
8906 |
|
8907 |
|
8908 |
|
8909 |
|
8910 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8911 | <dd class="tag-source">
|
8912 | <ul class="dummy">
|
8913 | <li>
|
8914 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
8915 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-937">line 937</a>
|
8916 | </li>
|
8917 | </ul>
|
8918 | </dd>
|
8919 |
|
8920 |
|
8921 |
|
8922 |
|
8923 |
|
8924 |
|
8925 |
|
8926 | </dl>
|
8927 |
|
8928 |
|
8929 |
|
8930 |
|
8931 |
|
8932 |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 |
|
8939 |
|
8940 | <h5>Returns:</h5>
|
8941 |
|
8942 |
|
8943 | <div class="param-desc">
|
8944 | <p>Returns the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object 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).</p>
|
8945 | </div>
|
8946 |
|
8947 |
|
8948 |
|
8949 | <dl>
|
8950 | <dt>
|
8951 | Type
|
8952 | </dt>
|
8953 | <dd>
|
8954 |
|
8955 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
8956 |
|
8957 |
|
8958 |
|
8959 | </dd>
|
8960 | </dl>
|
8961 |
|
8962 |
|
8963 |
|
8964 |
|
8965 |
|
8966 | </dd>
|
8967 |
|
8968 |
|
8969 |
|
8970 | <hr>
|
8971 | <dt>
|
8972 | <h4 class="name" id="insertSubSprites"><span class="type-signature"></span>insertSubSprites<span class="signature">(subSprites [, sprite])</span><span class="type-signature"> → {array}</span></h4>
|
8973 |
|
8974 |
|
8975 | </dt>
|
8976 | <dd>
|
8977 |
|
8978 |
|
8979 | <div class="description">
|
8980 | <p>Adds the given sub-sprites to the desired sprite. Calls the <a href="CB_GraphicSprites.html#insertSubSprite"><code>CB_GraphicSprites#insertSubSprite</code></a> and <a href="CB_GraphicSprites.html#updateSubSpritesByZIndex"><code>CB_GraphicSprites#updateSubSpritesByZIndex</code></a> methods internally.</p>
|
8981 | </div>
|
8982 |
|
8983 |
|
8984 |
|
8985 |
|
8986 |
|
8987 |
|
8988 |
|
8989 |
|
8990 | <h5>Parameters:</h5>
|
8991 |
|
8992 |
|
8993 | <table class="params table table-striped">
|
8994 | <thead>
|
8995 | <tr>
|
8996 |
|
8997 | <th style="width:12%; min-width:110px;">Name</th>
|
8998 |
|
8999 |
|
9000 | <th style="width:12%; min-width:110px;">Type</th>
|
9001 |
|
9002 |
|
9003 | <th style="width:12%; min-width:110px;">Argument</th>
|
9004 |
|
9005 |
|
9006 |
|
9007 | <th style="width:12%; min-width:110px;">Default</th>
|
9008 |
|
9009 |
|
9010 | <th class="last" style="min-width:310px;">Description</th>
|
9011 | </tr>
|
9012 | </thead>
|
9013 |
|
9014 | <tbody>
|
9015 |
|
9016 |
|
9017 | <tr>
|
9018 |
|
9019 | <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>subSprites</code></td>
|
9020 |
|
9021 |
|
9022 | <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;">
|
9023 |
|
9024 |
|
9025 | <span class="param-type">array</span>
|
9026 |
|
9027 |
|
9028 |
|
9029 |
|
9030 | </td>
|
9031 |
|
9032 |
|
9033 | <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;">
|
9034 |
|
9035 |
|
9036 |
|
9037 |
|
9038 |
|
9039 | </td>
|
9040 |
|
9041 |
|
9042 |
|
9043 | <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;">
|
9044 |
|
9045 | </td>
|
9046 |
|
9047 |
|
9048 | <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>Numeric array with the desired sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects). They will be stored inside the given sprite.</p></td>
|
9049 | </tr>
|
9050 |
|
9051 |
|
9052 |
|
9053 | <tr>
|
9054 |
|
9055 | <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>sprite</code></td>
|
9056 |
|
9057 |
|
9058 | <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;">
|
9059 |
|
9060 |
|
9061 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
9062 |
|
9063 |
|
9064 |
|
9065 |
|
9066 | </td>
|
9067 |
|
9068 |
|
9069 | <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;">
|
9070 |
|
9071 | <optional><br>
|
9072 |
|
9073 |
|
9074 |
|
9075 |
|
9076 |
|
9077 | </td>
|
9078 |
|
9079 |
|
9080 |
|
9081 | <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;">
|
9082 |
|
9083 | CB_GraphicSprites#getCurrent()
|
9084 |
|
9085 | </td>
|
9086 |
|
9087 |
|
9088 | <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 sprite. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
9089 | </tr>
|
9090 |
|
9091 |
|
9092 | </tbody>
|
9093 | </table>
|
9094 |
|
9095 |
|
9096 |
|
9097 |
|
9098 | <dl class="details">
|
9099 |
|
9100 |
|
9101 |
|
9102 |
|
9103 |
|
9104 |
|
9105 |
|
9106 |
|
9107 |
|
9108 |
|
9109 |
|
9110 |
|
9111 |
|
9112 |
|
9113 |
|
9114 |
|
9115 |
|
9116 |
|
9117 |
|
9118 |
|
9119 |
|
9120 |
|
9121 |
|
9122 |
|
9123 |
|
9124 |
|
9125 |
|
9126 |
|
9127 |
|
9128 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9129 | <dd class="tag-source">
|
9130 | <ul class="dummy">
|
9131 | <li>
|
9132 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9133 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-795">line 795</a>
|
9134 | </li>
|
9135 | </ul>
|
9136 | </dd>
|
9137 |
|
9138 |
|
9139 |
|
9140 |
|
9141 |
|
9142 |
|
9143 |
|
9144 | </dl>
|
9145 |
|
9146 |
|
9147 |
|
9148 |
|
9149 |
|
9150 |
|
9151 |
|
9152 |
|
9153 |
|
9154 |
|
9155 |
|
9156 |
|
9157 |
|
9158 | <h5>Returns:</h5>
|
9159 |
|
9160 |
|
9161 | <div class="param-desc">
|
9162 | <p>Returns an array with the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects which have been inserted (they could have been modified/sanitized from the given one and some missing properties or those which were wrong could have been inherited).</p>
|
9163 | </div>
|
9164 |
|
9165 |
|
9166 |
|
9167 | <dl>
|
9168 | <dt>
|
9169 | Type
|
9170 | </dt>
|
9171 | <dd>
|
9172 |
|
9173 | <span class="param-type">array</span>
|
9174 |
|
9175 |
|
9176 |
|
9177 | </dd>
|
9178 | </dl>
|
9179 |
|
9180 |
|
9181 |
|
9182 |
|
9183 |
|
9184 | </dd>
|
9185 |
|
9186 |
|
9187 |
|
9188 | <hr>
|
9189 | <dt>
|
9190 | <h4 class="name" id="isDisabled"><span class="type-signature"></span>isDisabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
9191 |
|
9192 |
|
9193 | </dt>
|
9194 | <dd>
|
9195 |
|
9196 |
|
9197 | <div class="description">
|
9198 | <p>Tells whether the sprites group object (and the {@CB_GraphicSprites} object itself) is disabled or not. Internally, it checks the "<code>CB_GraphicSprites.spritesGroup</code>.disabled" property.</p>
|
9199 | </div>
|
9200 |
|
9201 |
|
9202 |
|
9203 |
|
9204 |
|
9205 |
|
9206 |
|
9207 |
|
9208 |
|
9209 |
|
9210 | <dl class="details">
|
9211 |
|
9212 |
|
9213 |
|
9214 |
|
9215 |
|
9216 |
|
9217 |
|
9218 |
|
9219 |
|
9220 |
|
9221 |
|
9222 |
|
9223 |
|
9224 |
|
9225 |
|
9226 |
|
9227 |
|
9228 |
|
9229 |
|
9230 |
|
9231 |
|
9232 |
|
9233 |
|
9234 |
|
9235 |
|
9236 |
|
9237 |
|
9238 |
|
9239 |
|
9240 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9241 | <dd class="tag-source">
|
9242 | <ul class="dummy">
|
9243 | <li>
|
9244 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9245 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1526">line 1526</a>
|
9246 | </li>
|
9247 | </ul>
|
9248 | </dd>
|
9249 |
|
9250 |
|
9251 |
|
9252 |
|
9253 |
|
9254 |
|
9255 |
|
9256 | </dl>
|
9257 |
|
9258 |
|
9259 |
|
9260 |
|
9261 |
|
9262 |
|
9263 |
|
9264 |
|
9265 |
|
9266 |
|
9267 |
|
9268 |
|
9269 |
|
9270 | <h5>Returns:</h5>
|
9271 |
|
9272 |
|
9273 | <div class="param-desc">
|
9274 | <p>Returns whether the sprites group object (and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself) is disabled or not.</p>
|
9275 | </div>
|
9276 |
|
9277 |
|
9278 |
|
9279 | <dl>
|
9280 | <dt>
|
9281 | Type
|
9282 | </dt>
|
9283 | <dd>
|
9284 |
|
9285 | <span class="param-type">boolean</span>
|
9286 |
|
9287 |
|
9288 |
|
9289 | </dd>
|
9290 | </dl>
|
9291 |
|
9292 |
|
9293 |
|
9294 |
|
9295 |
|
9296 | </dd>
|
9297 |
|
9298 |
|
9299 |
|
9300 | <hr>
|
9301 | <dt>
|
9302 | <h4 class="name" id="isDisabledSprite"><span class="type-signature"></span>isDisabledSprite<span class="signature">( [sprite])</span><span class="type-signature"> → {boolean}</span></h4>
|
9303 |
|
9304 |
|
9305 | </dt>
|
9306 | <dd>
|
9307 |
|
9308 |
|
9309 | <div class="description">
|
9310 | <p>Tells whether the given sprite is disabled or not. Internally, it checks its "disabled" property and also the "<code>CB_GraphicSprites.spritesGroup</code>.disabled" property (calling the <a href="CB_GraphicSprites.html#isDisabled"><code>CB_GraphicSprites#isDisabled</code></a> method internally). A sprite is considered disabled if its sprites group parent is also disabled.</p>
|
9311 | </div>
|
9312 |
|
9313 |
|
9314 |
|
9315 |
|
9316 |
|
9317 |
|
9318 |
|
9319 |
|
9320 | <h5>Parameters:</h5>
|
9321 |
|
9322 |
|
9323 | <table class="params table table-striped">
|
9324 | <thead>
|
9325 | <tr>
|
9326 |
|
9327 | <th style="width:12%; min-width:110px;">Name</th>
|
9328 |
|
9329 |
|
9330 | <th style="width:12%; min-width:110px;">Type</th>
|
9331 |
|
9332 |
|
9333 | <th style="width:12%; min-width:110px;">Argument</th>
|
9334 |
|
9335 |
|
9336 |
|
9337 | <th style="width:12%; min-width:110px;">Default</th>
|
9338 |
|
9339 |
|
9340 | <th class="last" style="min-width:310px;">Description</th>
|
9341 | </tr>
|
9342 | </thead>
|
9343 |
|
9344 | <tbody>
|
9345 |
|
9346 |
|
9347 | <tr>
|
9348 |
|
9349 | <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>sprite</code></td>
|
9350 |
|
9351 |
|
9352 | <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;">
|
9353 |
|
9354 |
|
9355 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
9356 |
|
9357 |
|
9358 |
|
9359 |
|
9360 | </td>
|
9361 |
|
9362 |
|
9363 | <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;">
|
9364 |
|
9365 | <optional><br>
|
9366 |
|
9367 |
|
9368 |
|
9369 |
|
9370 |
|
9371 | </td>
|
9372 |
|
9373 |
|
9374 |
|
9375 | <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;">
|
9376 |
|
9377 | CB_GraphicSprites#getCurrent()
|
9378 |
|
9379 | </td>
|
9380 |
|
9381 |
|
9382 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
9383 | </tr>
|
9384 |
|
9385 |
|
9386 | </tbody>
|
9387 | </table>
|
9388 |
|
9389 |
|
9390 |
|
9391 |
|
9392 | <dl class="details">
|
9393 |
|
9394 |
|
9395 |
|
9396 |
|
9397 |
|
9398 |
|
9399 |
|
9400 |
|
9401 |
|
9402 |
|
9403 |
|
9404 |
|
9405 |
|
9406 |
|
9407 |
|
9408 |
|
9409 |
|
9410 |
|
9411 |
|
9412 |
|
9413 |
|
9414 |
|
9415 |
|
9416 |
|
9417 |
|
9418 |
|
9419 |
|
9420 |
|
9421 |
|
9422 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9423 | <dd class="tag-source">
|
9424 | <ul class="dummy">
|
9425 | <li>
|
9426 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9427 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1558">line 1558</a>
|
9428 | </li>
|
9429 | </ul>
|
9430 | </dd>
|
9431 |
|
9432 |
|
9433 |
|
9434 |
|
9435 |
|
9436 |
|
9437 |
|
9438 | </dl>
|
9439 |
|
9440 |
|
9441 |
|
9442 |
|
9443 |
|
9444 |
|
9445 |
|
9446 |
|
9447 |
|
9448 |
|
9449 |
|
9450 |
|
9451 |
|
9452 | <h5>Returns:</h5>
|
9453 |
|
9454 |
|
9455 | <div class="param-desc">
|
9456 | <p>Returns whether the sprite is disabled or not. A sprite is considered disabled if its sprites group parent is also disabled.</p>
|
9457 | </div>
|
9458 |
|
9459 |
|
9460 |
|
9461 | <dl>
|
9462 | <dt>
|
9463 | Type
|
9464 | </dt>
|
9465 | <dd>
|
9466 |
|
9467 | <span class="param-type">boolean</span>
|
9468 |
|
9469 |
|
9470 |
|
9471 | </dd>
|
9472 | </dl>
|
9473 |
|
9474 |
|
9475 |
|
9476 |
|
9477 |
|
9478 | </dd>
|
9479 |
|
9480 |
|
9481 |
|
9482 | <hr>
|
9483 | <dt>
|
9484 | <h4 class="name" id="isDisabledSubSprite"><span class="type-signature"></span>isDisabledSubSprite<span class="signature">(subSprite)</span><span class="type-signature"> → {boolean}</span></h4>
|
9485 |
|
9486 |
|
9487 | </dt>
|
9488 | <dd>
|
9489 |
|
9490 |
|
9491 | <div class="description">
|
9492 | <p>Tells whether the given sub-sprite is disabled or not. Internally, it checks its "disabled" property and also whether its sprite parent is disabled (calling the <a href="CB_GraphicSprites.html#isDisabledSprite"><code>CB_GraphicSprites#isDisabledSprite</code></a> method internally, for its sprite parent). A sub-sprite is considered disabled if its sprite parent is disabled (a sprite is considered disabled if its sprites group parent is also disabled).</p>
|
9493 | </div>
|
9494 |
|
9495 |
|
9496 |
|
9497 |
|
9498 |
|
9499 |
|
9500 |
|
9501 |
|
9502 | <h5>Parameters:</h5>
|
9503 |
|
9504 |
|
9505 | <table class="params table table-striped">
|
9506 | <thead>
|
9507 | <tr>
|
9508 |
|
9509 | <th style="width:12%; min-width:110px;">Name</th>
|
9510 |
|
9511 |
|
9512 | <th style="width:12%; min-width:110px;">Type</th>
|
9513 |
|
9514 |
|
9515 |
|
9516 |
|
9517 |
|
9518 | <th class="last" style="min-width:310px;">Description</th>
|
9519 | </tr>
|
9520 | </thead>
|
9521 |
|
9522 | <tbody>
|
9523 |
|
9524 |
|
9525 | <tr>
|
9526 |
|
9527 | <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>subSprite</code></td>
|
9528 |
|
9529 |
|
9530 | <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;">
|
9531 |
|
9532 |
|
9533 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
9534 |
|
9535 |
|
9536 |
|
9537 |
|
9538 | </td>
|
9539 |
|
9540 |
|
9541 |
|
9542 |
|
9543 |
|
9544 | <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 <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object which contains the sub-sprite.</p></td>
|
9545 | </tr>
|
9546 |
|
9547 |
|
9548 | </tbody>
|
9549 | </table>
|
9550 |
|
9551 |
|
9552 |
|
9553 |
|
9554 | <dl class="details">
|
9555 |
|
9556 |
|
9557 |
|
9558 |
|
9559 |
|
9560 |
|
9561 |
|
9562 |
|
9563 |
|
9564 |
|
9565 |
|
9566 |
|
9567 |
|
9568 |
|
9569 |
|
9570 |
|
9571 |
|
9572 |
|
9573 |
|
9574 |
|
9575 |
|
9576 |
|
9577 |
|
9578 |
|
9579 |
|
9580 |
|
9581 |
|
9582 |
|
9583 |
|
9584 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9585 | <dd class="tag-source">
|
9586 | <ul class="dummy">
|
9587 | <li>
|
9588 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9589 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1607">line 1607</a>
|
9590 | </li>
|
9591 | </ul>
|
9592 | </dd>
|
9593 |
|
9594 |
|
9595 |
|
9596 |
|
9597 |
|
9598 |
|
9599 |
|
9600 | </dl>
|
9601 |
|
9602 |
|
9603 |
|
9604 |
|
9605 |
|
9606 |
|
9607 |
|
9608 |
|
9609 |
|
9610 |
|
9611 |
|
9612 |
|
9613 |
|
9614 | <h5>Returns:</h5>
|
9615 |
|
9616 |
|
9617 | <div class="param-desc">
|
9618 | <p>Returns whether the sub-sprite is disabled or not. A sub-sprite is considered disabled if its sprite parent is disabled (a sprite is considered disabled if its sprites group parent is also disabled).</p>
|
9619 | </div>
|
9620 |
|
9621 |
|
9622 |
|
9623 | <dl>
|
9624 | <dt>
|
9625 | Type
|
9626 | </dt>
|
9627 | <dd>
|
9628 |
|
9629 | <span class="param-type">boolean</span>
|
9630 |
|
9631 |
|
9632 |
|
9633 | </dd>
|
9634 | </dl>
|
9635 |
|
9636 |
|
9637 |
|
9638 |
|
9639 |
|
9640 | </dd>
|
9641 |
|
9642 |
|
9643 |
|
9644 | <hr>
|
9645 | <dt>
|
9646 | <h4 class="name" id="next"><span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"></span></h4>
|
9647 |
|
9648 |
|
9649 | </dt>
|
9650 | <dd>
|
9651 |
|
9652 |
|
9653 | <div class="description">
|
9654 | <p>Alias for <a href="CB_GraphicSprites.html#setNext"><code>CB_GraphicSprites#setNext</code></a>.</p>
|
9655 | </div>
|
9656 |
|
9657 |
|
9658 |
|
9659 |
|
9660 |
|
9661 |
|
9662 |
|
9663 |
|
9664 |
|
9665 |
|
9666 | <dl class="details">
|
9667 |
|
9668 |
|
9669 |
|
9670 |
|
9671 |
|
9672 |
|
9673 |
|
9674 |
|
9675 |
|
9676 |
|
9677 |
|
9678 |
|
9679 |
|
9680 |
|
9681 |
|
9682 |
|
9683 |
|
9684 |
|
9685 |
|
9686 |
|
9687 |
|
9688 |
|
9689 |
|
9690 |
|
9691 |
|
9692 |
|
9693 |
|
9694 |
|
9695 |
|
9696 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9697 | <dd class="tag-source">
|
9698 | <ul class="dummy">
|
9699 | <li>
|
9700 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9701 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1402">line 1402</a>
|
9702 | </li>
|
9703 | </ul>
|
9704 | </dd>
|
9705 |
|
9706 |
|
9707 |
|
9708 |
|
9709 |
|
9710 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9711 | <dd class="tag-see">
|
9712 | <ul>
|
9713 | <li><a href="CB_GraphicSprites.html#setNext"><code>CB_GraphicSprites#setNext</code></a></li>
|
9714 | </ul>
|
9715 | </dd>
|
9716 |
|
9717 |
|
9718 |
|
9719 | </dl>
|
9720 |
|
9721 |
|
9722 |
|
9723 |
|
9724 |
|
9725 |
|
9726 |
|
9727 |
|
9728 |
|
9729 |
|
9730 |
|
9731 |
|
9732 |
|
9733 |
|
9734 |
|
9735 | </dd>
|
9736 |
|
9737 |
|
9738 |
|
9739 | <hr>
|
9740 | <dt>
|
9741 | <h4 class="name" id="now"><span class="type-signature"></span>now<span class="signature">()</span><span class="type-signature"></span></h4>
|
9742 |
|
9743 |
|
9744 | </dt>
|
9745 | <dd>
|
9746 |
|
9747 |
|
9748 | <div class="description">
|
9749 | <p>Alias for <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a>.</p>
|
9750 | </div>
|
9751 |
|
9752 |
|
9753 |
|
9754 |
|
9755 |
|
9756 |
|
9757 |
|
9758 |
|
9759 |
|
9760 |
|
9761 | <dl class="details">
|
9762 |
|
9763 |
|
9764 |
|
9765 |
|
9766 |
|
9767 |
|
9768 |
|
9769 |
|
9770 |
|
9771 |
|
9772 |
|
9773 |
|
9774 |
|
9775 |
|
9776 |
|
9777 |
|
9778 |
|
9779 |
|
9780 |
|
9781 |
|
9782 |
|
9783 |
|
9784 |
|
9785 |
|
9786 |
|
9787 |
|
9788 |
|
9789 |
|
9790 |
|
9791 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9792 | <dd class="tag-source">
|
9793 | <ul class="dummy">
|
9794 | <li>
|
9795 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9796 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1356">line 1356</a>
|
9797 | </li>
|
9798 | </ul>
|
9799 | </dd>
|
9800 |
|
9801 |
|
9802 |
|
9803 |
|
9804 |
|
9805 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9806 | <dd class="tag-see">
|
9807 | <ul>
|
9808 | <li><a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a></li>
|
9809 | </ul>
|
9810 | </dd>
|
9811 |
|
9812 |
|
9813 |
|
9814 | </dl>
|
9815 |
|
9816 |
|
9817 |
|
9818 |
|
9819 |
|
9820 |
|
9821 |
|
9822 |
|
9823 |
|
9824 |
|
9825 |
|
9826 |
|
9827 |
|
9828 |
|
9829 |
|
9830 | </dd>
|
9831 |
|
9832 |
|
9833 |
|
9834 | <hr>
|
9835 | <dt>
|
9836 | <h4 class="name" id="previous"><span class="type-signature"></span>previous<span class="signature">()</span><span class="type-signature"></span></h4>
|
9837 |
|
9838 |
|
9839 | </dt>
|
9840 | <dd>
|
9841 |
|
9842 |
|
9843 | <div class="description">
|
9844 | <p>Alias for <a href="CB_GraphicSprites.html#setPrevious"><code>CB_GraphicSprites#setPrevious</code></a>.</p>
|
9845 | </div>
|
9846 |
|
9847 |
|
9848 |
|
9849 |
|
9850 |
|
9851 |
|
9852 |
|
9853 |
|
9854 |
|
9855 |
|
9856 | <dl class="details">
|
9857 |
|
9858 |
|
9859 |
|
9860 |
|
9861 |
|
9862 |
|
9863 |
|
9864 |
|
9865 |
|
9866 |
|
9867 |
|
9868 |
|
9869 |
|
9870 |
|
9871 |
|
9872 |
|
9873 |
|
9874 |
|
9875 |
|
9876 |
|
9877 |
|
9878 |
|
9879 |
|
9880 |
|
9881 |
|
9882 |
|
9883 |
|
9884 |
|
9885 |
|
9886 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9887 | <dd class="tag-source">
|
9888 | <ul class="dummy">
|
9889 | <li>
|
9890 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9891 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1377">line 1377</a>
|
9892 | </li>
|
9893 | </ul>
|
9894 | </dd>
|
9895 |
|
9896 |
|
9897 |
|
9898 |
|
9899 |
|
9900 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9901 | <dd class="tag-see">
|
9902 | <ul>
|
9903 | <li><a href="CB_GraphicSprites.html#setPrevious"><code>CB_GraphicSprites#setPrevious</code></a></li>
|
9904 | </ul>
|
9905 | </dd>
|
9906 |
|
9907 |
|
9908 |
|
9909 | </dl>
|
9910 |
|
9911 |
|
9912 |
|
9913 |
|
9914 |
|
9915 |
|
9916 |
|
9917 |
|
9918 |
|
9919 |
|
9920 |
|
9921 |
|
9922 |
|
9923 |
|
9924 |
|
9925 | </dd>
|
9926 |
|
9927 |
|
9928 |
|
9929 | <hr>
|
9930 | <dt>
|
9931 | <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">()</span><span class="type-signature"></span></h4>
|
9932 |
|
9933 |
|
9934 | </dt>
|
9935 | <dd>
|
9936 |
|
9937 |
|
9938 | <div class="description">
|
9939 | <p>Alias for <a href="CB_GraphicSprites.html#removeSprite"><code>CB_GraphicSprites#removeSprite</code></a>.</p>
|
9940 | </div>
|
9941 |
|
9942 |
|
9943 |
|
9944 |
|
9945 |
|
9946 |
|
9947 |
|
9948 |
|
9949 |
|
9950 |
|
9951 | <dl class="details">
|
9952 |
|
9953 |
|
9954 |
|
9955 |
|
9956 |
|
9957 |
|
9958 |
|
9959 |
|
9960 |
|
9961 |
|
9962 |
|
9963 |
|
9964 |
|
9965 |
|
9966 |
|
9967 |
|
9968 |
|
9969 |
|
9970 |
|
9971 |
|
9972 |
|
9973 |
|
9974 |
|
9975 |
|
9976 |
|
9977 |
|
9978 |
|
9979 |
|
9980 |
|
9981 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9982 | <dd class="tag-source">
|
9983 | <ul class="dummy">
|
9984 | <li>
|
9985 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
9986 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-588">line 588</a>
|
9987 | </li>
|
9988 | </ul>
|
9989 | </dd>
|
9990 |
|
9991 |
|
9992 |
|
9993 |
|
9994 |
|
9995 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9996 | <dd class="tag-see">
|
9997 | <ul>
|
9998 | <li><a href="CB_GraphicSprites.html#removeSprite"><code>CB_GraphicSprites#removeSprite</code></a></li>
|
9999 | </ul>
|
10000 | </dd>
|
10001 |
|
10002 |
|
10003 |
|
10004 | </dl>
|
10005 |
|
10006 |
|
10007 |
|
10008 |
|
10009 |
|
10010 |
|
10011 |
|
10012 |
|
10013 |
|
10014 |
|
10015 |
|
10016 |
|
10017 |
|
10018 |
|
10019 |
|
10020 | </dd>
|
10021 |
|
10022 |
|
10023 |
|
10024 | <hr>
|
10025 | <dt>
|
10026 | <h4 class="name" id="removeAll"><span class="type-signature"></span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
10027 |
|
10028 |
|
10029 | </dt>
|
10030 | <dd>
|
10031 |
|
10032 |
|
10033 | <div class="description">
|
10034 | <p>Alias for <a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a>.</p>
|
10035 | </div>
|
10036 |
|
10037 |
|
10038 |
|
10039 |
|
10040 |
|
10041 |
|
10042 |
|
10043 |
|
10044 |
|
10045 |
|
10046 | <dl class="details">
|
10047 |
|
10048 |
|
10049 |
|
10050 |
|
10051 |
|
10052 |
|
10053 |
|
10054 |
|
10055 |
|
10056 |
|
10057 |
|
10058 |
|
10059 |
|
10060 |
|
10061 |
|
10062 |
|
10063 |
|
10064 |
|
10065 |
|
10066 |
|
10067 |
|
10068 |
|
10069 |
|
10070 |
|
10071 |
|
10072 |
|
10073 |
|
10074 |
|
10075 |
|
10076 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10077 | <dd class="tag-source">
|
10078 | <ul class="dummy">
|
10079 | <li>
|
10080 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10081 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-469">line 469</a>
|
10082 | </li>
|
10083 | </ul>
|
10084 | </dd>
|
10085 |
|
10086 |
|
10087 |
|
10088 |
|
10089 |
|
10090 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
10091 | <dd class="tag-see">
|
10092 | <ul>
|
10093 | <li><a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a></li>
|
10094 | </ul>
|
10095 | </dd>
|
10096 |
|
10097 |
|
10098 |
|
10099 | </dl>
|
10100 |
|
10101 |
|
10102 |
|
10103 |
|
10104 |
|
10105 |
|
10106 |
|
10107 |
|
10108 |
|
10109 |
|
10110 |
|
10111 |
|
10112 |
|
10113 |
|
10114 |
|
10115 | </dd>
|
10116 |
|
10117 |
|
10118 |
|
10119 | <hr>
|
10120 | <dt>
|
10121 | <h4 class="name" id="removeById"><span class="type-signature"></span>removeById<span class="signature">()</span><span class="type-signature"></span></h4>
|
10122 |
|
10123 |
|
10124 | </dt>
|
10125 | <dd>
|
10126 |
|
10127 |
|
10128 | <div class="description">
|
10129 | <p>Alias for <a href="CB_GraphicSprites.html#removeSpriteById"><code>CB_GraphicSprites#removeSpriteById</code></a>.</p>
|
10130 | </div>
|
10131 |
|
10132 |
|
10133 |
|
10134 |
|
10135 |
|
10136 |
|
10137 |
|
10138 |
|
10139 |
|
10140 |
|
10141 | <dl class="details">
|
10142 |
|
10143 |
|
10144 |
|
10145 |
|
10146 |
|
10147 |
|
10148 |
|
10149 |
|
10150 |
|
10151 |
|
10152 |
|
10153 |
|
10154 |
|
10155 |
|
10156 |
|
10157 |
|
10158 |
|
10159 |
|
10160 |
|
10161 |
|
10162 |
|
10163 |
|
10164 |
|
10165 |
|
10166 |
|
10167 |
|
10168 |
|
10169 |
|
10170 |
|
10171 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10172 | <dd class="tag-source">
|
10173 | <ul class="dummy">
|
10174 | <li>
|
10175 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10176 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-616">line 616</a>
|
10177 | </li>
|
10178 | </ul>
|
10179 | </dd>
|
10180 |
|
10181 |
|
10182 |
|
10183 |
|
10184 |
|
10185 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
10186 | <dd class="tag-see">
|
10187 | <ul>
|
10188 | <li><a href="CB_GraphicSprites.html#removeSpriteById"><code>CB_GraphicSprites#removeSpriteById</code></a></li>
|
10189 | </ul>
|
10190 | </dd>
|
10191 |
|
10192 |
|
10193 |
|
10194 | </dl>
|
10195 |
|
10196 |
|
10197 |
|
10198 |
|
10199 |
|
10200 |
|
10201 |
|
10202 |
|
10203 |
|
10204 |
|
10205 |
|
10206 |
|
10207 |
|
10208 |
|
10209 |
|
10210 | </dd>
|
10211 |
|
10212 |
|
10213 |
|
10214 | <hr>
|
10215 | <dt>
|
10216 | <h4 class="name" id="removeSprite"><span class="type-signature"></span>removeSprite<span class="signature">( [index])</span><span class="type-signature"> → {boolean}</span></h4>
|
10217 |
|
10218 |
|
10219 | </dt>
|
10220 | <dd>
|
10221 |
|
10222 |
|
10223 | <div class="description">
|
10224 | <p>Removes a sprite by its index (its position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array). Calls the <a href="CB_GraphicSprites.html#updateSpritesByZIndex"><code>CB_GraphicSprites#updateSpritesByZIndex</code></a> method internally.</p>
|
10225 | </div>
|
10226 |
|
10227 |
|
10228 |
|
10229 |
|
10230 |
|
10231 |
|
10232 |
|
10233 |
|
10234 | <h5>Parameters:</h5>
|
10235 |
|
10236 |
|
10237 | <table class="params table table-striped">
|
10238 | <thead>
|
10239 | <tr>
|
10240 |
|
10241 | <th style="width:12%; min-width:110px;">Name</th>
|
10242 |
|
10243 |
|
10244 | <th style="width:12%; min-width:110px;">Type</th>
|
10245 |
|
10246 |
|
10247 | <th style="width:12%; min-width:110px;">Argument</th>
|
10248 |
|
10249 |
|
10250 |
|
10251 | <th style="width:12%; min-width:110px;">Default</th>
|
10252 |
|
10253 |
|
10254 | <th class="last" style="min-width:310px;">Description</th>
|
10255 | </tr>
|
10256 | </thead>
|
10257 |
|
10258 | <tbody>
|
10259 |
|
10260 |
|
10261 | <tr>
|
10262 |
|
10263 | <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>
|
10264 |
|
10265 |
|
10266 | <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;">
|
10267 |
|
10268 |
|
10269 | <span class="param-type">integer</span>
|
10270 |
|
10271 |
|
10272 |
|
10273 |
|
10274 | </td>
|
10275 |
|
10276 |
|
10277 | <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;">
|
10278 |
|
10279 | <optional><br>
|
10280 |
|
10281 |
|
10282 |
|
10283 |
|
10284 |
|
10285 | </td>
|
10286 |
|
10287 |
|
10288 |
|
10289 | <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;">
|
10290 |
|
10291 | 0
|
10292 |
|
10293 | </td>
|
10294 |
|
10295 |
|
10296 | <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 sprite is located (its position in the <code>CB_GraphicSprites#spritesGroup.sprites</code> array).</p></td>
|
10297 | </tr>
|
10298 |
|
10299 |
|
10300 | </tbody>
|
10301 | </table>
|
10302 |
|
10303 |
|
10304 |
|
10305 |
|
10306 | <dl class="details">
|
10307 |
|
10308 |
|
10309 |
|
10310 |
|
10311 |
|
10312 |
|
10313 |
|
10314 |
|
10315 |
|
10316 |
|
10317 |
|
10318 |
|
10319 |
|
10320 |
|
10321 |
|
10322 |
|
10323 |
|
10324 |
|
10325 |
|
10326 |
|
10327 |
|
10328 |
|
10329 |
|
10330 |
|
10331 |
|
10332 |
|
10333 |
|
10334 |
|
10335 |
|
10336 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10337 | <dd class="tag-source">
|
10338 | <ul class="dummy">
|
10339 | <li>
|
10340 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10341 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-599">line 599</a>
|
10342 | </li>
|
10343 | </ul>
|
10344 | </dd>
|
10345 |
|
10346 |
|
10347 |
|
10348 |
|
10349 |
|
10350 |
|
10351 |
|
10352 | </dl>
|
10353 |
|
10354 |
|
10355 |
|
10356 |
|
10357 |
|
10358 |
|
10359 |
|
10360 |
|
10361 |
|
10362 |
|
10363 |
|
10364 |
|
10365 |
|
10366 | <h5>Returns:</h5>
|
10367 |
|
10368 |
|
10369 | <div class="param-desc">
|
10370 | <p>Returns true if the sprite has been deleted or false otherwise.</p>
|
10371 | </div>
|
10372 |
|
10373 |
|
10374 |
|
10375 | <dl>
|
10376 | <dt>
|
10377 | Type
|
10378 | </dt>
|
10379 | <dd>
|
10380 |
|
10381 | <span class="param-type">boolean</span>
|
10382 |
|
10383 |
|
10384 |
|
10385 | </dd>
|
10386 | </dl>
|
10387 |
|
10388 |
|
10389 |
|
10390 |
|
10391 |
|
10392 | </dd>
|
10393 |
|
10394 |
|
10395 |
|
10396 | <hr>
|
10397 | <dt>
|
10398 | <h4 class="name" id="removeSpriteById"><span class="type-signature"></span>removeSpriteById<span class="signature">( [id])</span><span class="type-signature"> → {boolean}</span></h4>
|
10399 |
|
10400 |
|
10401 | </dt>
|
10402 | <dd>
|
10403 |
|
10404 |
|
10405 | <div class="description">
|
10406 | <p>Removes a sprite by its identifier. Calls the <a href="CB_GraphicSprites.html#updateSpritesByZIndex"><code>CB_GraphicSprites#updateSpritesByZIndex</code></a> method internally.</p>
|
10407 | </div>
|
10408 |
|
10409 |
|
10410 |
|
10411 |
|
10412 |
|
10413 |
|
10414 |
|
10415 |
|
10416 | <h5>Parameters:</h5>
|
10417 |
|
10418 |
|
10419 | <table class="params table table-striped">
|
10420 | <thead>
|
10421 | <tr>
|
10422 |
|
10423 | <th style="width:12%; min-width:110px;">Name</th>
|
10424 |
|
10425 |
|
10426 | <th style="width:12%; min-width:110px;">Type</th>
|
10427 |
|
10428 |
|
10429 | <th style="width:12%; min-width:110px;">Argument</th>
|
10430 |
|
10431 |
|
10432 |
|
10433 |
|
10434 | <th class="last" style="min-width:310px;">Description</th>
|
10435 | </tr>
|
10436 | </thead>
|
10437 |
|
10438 | <tbody>
|
10439 |
|
10440 |
|
10441 | <tr>
|
10442 |
|
10443 | <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>
|
10444 |
|
10445 |
|
10446 | <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;">
|
10447 |
|
10448 |
|
10449 | <span class="param-type">string</span>
|
10450 | |
|
10451 |
|
10452 | <span class="param-type">*</span>
|
10453 |
|
10454 |
|
10455 |
|
10456 |
|
10457 | </td>
|
10458 |
|
10459 |
|
10460 | <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;">
|
10461 |
|
10462 | <optional><br>
|
10463 |
|
10464 |
|
10465 |
|
10466 |
|
10467 |
|
10468 | </td>
|
10469 |
|
10470 |
|
10471 |
|
10472 |
|
10473 | <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 sprite.</p></td>
|
10474 | </tr>
|
10475 |
|
10476 |
|
10477 | </tbody>
|
10478 | </table>
|
10479 |
|
10480 |
|
10481 |
|
10482 |
|
10483 | <dl class="details">
|
10484 |
|
10485 |
|
10486 |
|
10487 |
|
10488 |
|
10489 |
|
10490 |
|
10491 |
|
10492 |
|
10493 |
|
10494 |
|
10495 |
|
10496 |
|
10497 |
|
10498 |
|
10499 |
|
10500 |
|
10501 |
|
10502 |
|
10503 |
|
10504 |
|
10505 |
|
10506 |
|
10507 |
|
10508 |
|
10509 |
|
10510 |
|
10511 |
|
10512 |
|
10513 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10514 | <dd class="tag-source">
|
10515 | <ul class="dummy">
|
10516 | <li>
|
10517 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10518 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-628">line 628</a>
|
10519 | </li>
|
10520 | </ul>
|
10521 | </dd>
|
10522 |
|
10523 |
|
10524 |
|
10525 |
|
10526 |
|
10527 |
|
10528 |
|
10529 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
10530 | <dd class="tag-todo">
|
10531 | <ul>
|
10532 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
10533 | </ul>
|
10534 | </dd>
|
10535 |
|
10536 | </dl>
|
10537 |
|
10538 |
|
10539 |
|
10540 |
|
10541 |
|
10542 |
|
10543 |
|
10544 |
|
10545 |
|
10546 |
|
10547 |
|
10548 |
|
10549 |
|
10550 | <h5>Returns:</h5>
|
10551 |
|
10552 |
|
10553 | <div class="param-desc">
|
10554 | <p>Returns true if the sprite has been deleted or false otherwise.</p>
|
10555 | </div>
|
10556 |
|
10557 |
|
10558 |
|
10559 | <dl>
|
10560 | <dt>
|
10561 | Type
|
10562 | </dt>
|
10563 | <dd>
|
10564 |
|
10565 | <span class="param-type">boolean</span>
|
10566 |
|
10567 |
|
10568 |
|
10569 | </dd>
|
10570 | </dl>
|
10571 |
|
10572 |
|
10573 |
|
10574 |
|
10575 |
|
10576 | </dd>
|
10577 |
|
10578 |
|
10579 |
|
10580 | <hr>
|
10581 | <dt>
|
10582 | <h4 class="name" id="removeSprites"><span class="type-signature"></span>removeSprites<span class="signature">()</span><span class="type-signature"></span></h4>
|
10583 |
|
10584 |
|
10585 | </dt>
|
10586 | <dd>
|
10587 |
|
10588 |
|
10589 | <div class="description">
|
10590 | <p>Removes all the sprites by clearing the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> property.</p>
|
10591 | </div>
|
10592 |
|
10593 |
|
10594 |
|
10595 |
|
10596 |
|
10597 |
|
10598 |
|
10599 |
|
10600 |
|
10601 |
|
10602 | <dl class="details">
|
10603 |
|
10604 |
|
10605 |
|
10606 |
|
10607 |
|
10608 |
|
10609 |
|
10610 |
|
10611 |
|
10612 |
|
10613 |
|
10614 |
|
10615 |
|
10616 |
|
10617 |
|
10618 |
|
10619 |
|
10620 |
|
10621 |
|
10622 |
|
10623 |
|
10624 |
|
10625 |
|
10626 |
|
10627 |
|
10628 |
|
10629 |
|
10630 |
|
10631 |
|
10632 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10633 | <dd class="tag-source">
|
10634 | <ul class="dummy">
|
10635 | <li>
|
10636 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10637 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-488">line 488</a>
|
10638 | </li>
|
10639 | </ul>
|
10640 | </dd>
|
10641 |
|
10642 |
|
10643 |
|
10644 |
|
10645 |
|
10646 |
|
10647 |
|
10648 | </dl>
|
10649 |
|
10650 |
|
10651 |
|
10652 |
|
10653 |
|
10654 |
|
10655 |
|
10656 |
|
10657 |
|
10658 |
|
10659 |
|
10660 |
|
10661 |
|
10662 |
|
10663 |
|
10664 | </dd>
|
10665 |
|
10666 |
|
10667 |
|
10668 | <hr>
|
10669 | <dt>
|
10670 | <h4 class="name" id="removeSpritesAll"><span class="type-signature"></span>removeSpritesAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
10671 |
|
10672 |
|
10673 | </dt>
|
10674 | <dd>
|
10675 |
|
10676 |
|
10677 | <div class="description">
|
10678 | <p>Alias for <a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a>.</p>
|
10679 | </div>
|
10680 |
|
10681 |
|
10682 |
|
10683 |
|
10684 |
|
10685 |
|
10686 |
|
10687 |
|
10688 |
|
10689 |
|
10690 | <dl class="details">
|
10691 |
|
10692 |
|
10693 |
|
10694 |
|
10695 |
|
10696 |
|
10697 |
|
10698 |
|
10699 |
|
10700 |
|
10701 |
|
10702 |
|
10703 |
|
10704 |
|
10705 |
|
10706 |
|
10707 |
|
10708 |
|
10709 |
|
10710 |
|
10711 |
|
10712 |
|
10713 |
|
10714 |
|
10715 |
|
10716 |
|
10717 |
|
10718 |
|
10719 |
|
10720 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10721 | <dd class="tag-source">
|
10722 | <ul class="dummy">
|
10723 | <li>
|
10724 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10725 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-479">line 479</a>
|
10726 | </li>
|
10727 | </ul>
|
10728 | </dd>
|
10729 |
|
10730 |
|
10731 |
|
10732 |
|
10733 |
|
10734 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
10735 | <dd class="tag-see">
|
10736 | <ul>
|
10737 | <li><a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a></li>
|
10738 | </ul>
|
10739 | </dd>
|
10740 |
|
10741 |
|
10742 |
|
10743 | </dl>
|
10744 |
|
10745 |
|
10746 |
|
10747 |
|
10748 |
|
10749 |
|
10750 |
|
10751 |
|
10752 |
|
10753 |
|
10754 |
|
10755 |
|
10756 |
|
10757 |
|
10758 |
|
10759 | </dd>
|
10760 |
|
10761 |
|
10762 |
|
10763 | <hr>
|
10764 | <dt>
|
10765 | <h4 class="name" id="removeSpritesGroup"><span class="type-signature"></span>removeSpritesGroup<span class="signature">()</span><span class="type-signature"></span></h4>
|
10766 |
|
10767 |
|
10768 | </dt>
|
10769 | <dd>
|
10770 |
|
10771 |
|
10772 | <div class="description">
|
10773 | <p>Alias for <a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a>.</p>
|
10774 | </div>
|
10775 |
|
10776 |
|
10777 |
|
10778 |
|
10779 |
|
10780 |
|
10781 |
|
10782 |
|
10783 |
|
10784 |
|
10785 | <dl class="details">
|
10786 |
|
10787 |
|
10788 |
|
10789 |
|
10790 |
|
10791 |
|
10792 |
|
10793 |
|
10794 |
|
10795 |
|
10796 |
|
10797 |
|
10798 |
|
10799 |
|
10800 |
|
10801 |
|
10802 |
|
10803 |
|
10804 |
|
10805 |
|
10806 |
|
10807 |
|
10808 |
|
10809 |
|
10810 |
|
10811 |
|
10812 |
|
10813 |
|
10814 |
|
10815 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10816 | <dd class="tag-source">
|
10817 | <ul class="dummy">
|
10818 | <li>
|
10819 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
10820 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-474">line 474</a>
|
10821 | </li>
|
10822 | </ul>
|
10823 | </dd>
|
10824 |
|
10825 |
|
10826 |
|
10827 |
|
10828 |
|
10829 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
10830 | <dd class="tag-see">
|
10831 | <ul>
|
10832 | <li><a href="CB_GraphicSprites.html#removeSprites"><code>CB_GraphicSprites#removeSprites</code></a></li>
|
10833 | </ul>
|
10834 | </dd>
|
10835 |
|
10836 |
|
10837 |
|
10838 | </dl>
|
10839 |
|
10840 |
|
10841 |
|
10842 |
|
10843 |
|
10844 |
|
10845 |
|
10846 |
|
10847 |
|
10848 |
|
10849 |
|
10850 |
|
10851 |
|
10852 |
|
10853 |
|
10854 | </dd>
|
10855 |
|
10856 |
|
10857 |
|
10858 | <hr>
|
10859 | <dt>
|
10860 | <h4 class="name" id="removeSubSprite"><span class="type-signature"></span>removeSubSprite<span class="signature">( [index] [, sprite])</span><span class="type-signature"> → {boolean}</span></h4>
|
10861 |
|
10862 |
|
10863 | </dt>
|
10864 | <dd>
|
10865 |
|
10866 |
|
10867 | <div class="description">
|
10868 | <p>Removes a sub-sprite from a given sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) by its index (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object). Calls the <a href="CB_GraphicSprites.html#updateSubSpritesByZIndex"><code>CB_GraphicSprites#updateSubSpritesByZIndex</code></a> method internally.</p>
|
10869 | </div>
|
10870 |
|
10871 |
|
10872 |
|
10873 |
|
10874 |
|
10875 |
|
10876 |
|
10877 |
|
10878 | <h5>Parameters:</h5>
|
10879 |
|
10880 |
|
10881 | <table class="params table table-striped">
|
10882 | <thead>
|
10883 | <tr>
|
10884 |
|
10885 | <th style="width:12%; min-width:110px;">Name</th>
|
10886 |
|
10887 |
|
10888 | <th style="width:12%; min-width:110px;">Type</th>
|
10889 |
|
10890 |
|
10891 | <th style="width:12%; min-width:110px;">Argument</th>
|
10892 |
|
10893 |
|
10894 |
|
10895 | <th style="width:12%; min-width:110px;">Default</th>
|
10896 |
|
10897 |
|
10898 | <th class="last" style="min-width:310px;">Description</th>
|
10899 | </tr>
|
10900 | </thead>
|
10901 |
|
10902 | <tbody>
|
10903 |
|
10904 |
|
10905 | <tr>
|
10906 |
|
10907 | <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>
|
10908 |
|
10909 |
|
10910 | <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;">
|
10911 |
|
10912 |
|
10913 | <span class="param-type">integer</span>
|
10914 |
|
10915 |
|
10916 |
|
10917 |
|
10918 | </td>
|
10919 |
|
10920 |
|
10921 | <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;">
|
10922 |
|
10923 | <optional><br>
|
10924 |
|
10925 |
|
10926 |
|
10927 |
|
10928 |
|
10929 | </td>
|
10930 |
|
10931 |
|
10932 |
|
10933 | <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;">
|
10934 |
|
10935 | 0
|
10936 |
|
10937 | </td>
|
10938 |
|
10939 |
|
10940 | <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 sub-sprite is located (its position in the array which is in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
10941 | </tr>
|
10942 |
|
10943 |
|
10944 |
|
10945 | <tr>
|
10946 |
|
10947 | <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>sprite</code></td>
|
10948 |
|
10949 |
|
10950 | <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;">
|
10951 |
|
10952 |
|
10953 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
10954 |
|
10955 |
|
10956 |
|
10957 |
|
10958 | </td>
|
10959 |
|
10960 |
|
10961 | <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;">
|
10962 |
|
10963 | <optional><br>
|
10964 |
|
10965 |
|
10966 |
|
10967 |
|
10968 |
|
10969 | </td>
|
10970 |
|
10971 |
|
10972 |
|
10973 | <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;">
|
10974 |
|
10975 | CB_GraphicSprites#getCurrent()
|
10976 |
|
10977 | </td>
|
10978 |
|
10979 |
|
10980 | <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 sprite whose sub-sprites we want to remove. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
10981 | </tr>
|
10982 |
|
10983 |
|
10984 | </tbody>
|
10985 | </table>
|
10986 |
|
10987 |
|
10988 |
|
10989 |
|
10990 | <dl class="details">
|
10991 |
|
10992 |
|
10993 |
|
10994 |
|
10995 |
|
10996 |
|
10997 |
|
10998 |
|
10999 |
|
11000 |
|
11001 |
|
11002 |
|
11003 |
|
11004 |
|
11005 |
|
11006 |
|
11007 |
|
11008 |
|
11009 |
|
11010 |
|
11011 |
|
11012 |
|
11013 |
|
11014 |
|
11015 |
|
11016 |
|
11017 |
|
11018 |
|
11019 |
|
11020 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11021 | <dd class="tag-source">
|
11022 | <ul class="dummy">
|
11023 | <li>
|
11024 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11025 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-852">line 852</a>
|
11026 | </li>
|
11027 | </ul>
|
11028 | </dd>
|
11029 |
|
11030 |
|
11031 |
|
11032 |
|
11033 |
|
11034 |
|
11035 |
|
11036 | </dl>
|
11037 |
|
11038 |
|
11039 |
|
11040 |
|
11041 |
|
11042 |
|
11043 |
|
11044 |
|
11045 |
|
11046 |
|
11047 |
|
11048 |
|
11049 |
|
11050 | <h5>Returns:</h5>
|
11051 |
|
11052 |
|
11053 | <div class="param-desc">
|
11054 | <p>Returns true if the sub-sprite has been deleted or false otherwise.</p>
|
11055 | </div>
|
11056 |
|
11057 |
|
11058 |
|
11059 | <dl>
|
11060 | <dt>
|
11061 | Type
|
11062 | </dt>
|
11063 | <dd>
|
11064 |
|
11065 | <span class="param-type">boolean</span>
|
11066 |
|
11067 |
|
11068 |
|
11069 | </dd>
|
11070 | </dl>
|
11071 |
|
11072 |
|
11073 |
|
11074 |
|
11075 |
|
11076 | </dd>
|
11077 |
|
11078 |
|
11079 |
|
11080 | <hr>
|
11081 | <dt>
|
11082 | <h4 class="name" id="removeSubSpriteById"><span class="type-signature"></span>removeSubSpriteById<span class="signature">( [id] [, sprite])</span><span class="type-signature"> → {boolean}</span></h4>
|
11083 |
|
11084 |
|
11085 | </dt>
|
11086 | <dd>
|
11087 |
|
11088 |
|
11089 | <div class="description">
|
11090 | <p>Removes a sub-sprite from a given sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) by its identifier. Calls the <a href="CB_GraphicSprites.html#updateSubSpritesByZIndex"><code>CB_GraphicSprites#updateSubSpritesByZIndex</code></a> method internally.</p>
|
11091 | </div>
|
11092 |
|
11093 |
|
11094 |
|
11095 |
|
11096 |
|
11097 |
|
11098 |
|
11099 |
|
11100 | <h5>Parameters:</h5>
|
11101 |
|
11102 |
|
11103 | <table class="params table table-striped">
|
11104 | <thead>
|
11105 | <tr>
|
11106 |
|
11107 | <th style="width:12%; min-width:110px;">Name</th>
|
11108 |
|
11109 |
|
11110 | <th style="width:12%; min-width:110px;">Type</th>
|
11111 |
|
11112 |
|
11113 | <th style="width:12%; min-width:110px;">Argument</th>
|
11114 |
|
11115 |
|
11116 |
|
11117 | <th style="width:12%; min-width:110px;">Default</th>
|
11118 |
|
11119 |
|
11120 | <th class="last" style="min-width:310px;">Description</th>
|
11121 | </tr>
|
11122 | </thead>
|
11123 |
|
11124 | <tbody>
|
11125 |
|
11126 |
|
11127 | <tr>
|
11128 |
|
11129 | <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>
|
11130 |
|
11131 |
|
11132 | <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;">
|
11133 |
|
11134 |
|
11135 | <span class="param-type">string</span>
|
11136 | |
|
11137 |
|
11138 | <span class="param-type">*</span>
|
11139 |
|
11140 |
|
11141 |
|
11142 |
|
11143 | </td>
|
11144 |
|
11145 |
|
11146 | <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;">
|
11147 |
|
11148 | <optional><br>
|
11149 |
|
11150 |
|
11151 |
|
11152 |
|
11153 |
|
11154 | </td>
|
11155 |
|
11156 |
|
11157 |
|
11158 | <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;">
|
11159 |
|
11160 | </td>
|
11161 |
|
11162 |
|
11163 | <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 sprite.</p></td>
|
11164 | </tr>
|
11165 |
|
11166 |
|
11167 |
|
11168 | <tr>
|
11169 |
|
11170 | <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>sprite</code></td>
|
11171 |
|
11172 |
|
11173 | <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;">
|
11174 |
|
11175 |
|
11176 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
11177 |
|
11178 |
|
11179 |
|
11180 |
|
11181 | </td>
|
11182 |
|
11183 |
|
11184 | <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;">
|
11185 |
|
11186 | <optional><br>
|
11187 |
|
11188 |
|
11189 |
|
11190 |
|
11191 |
|
11192 | </td>
|
11193 |
|
11194 |
|
11195 |
|
11196 | <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;">
|
11197 |
|
11198 | CB_GraphicSprites#getCurrent
|
11199 |
|
11200 | </td>
|
11201 |
|
11202 |
|
11203 | <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 sprite whose sub-sprites we want to remove.</p></td>
|
11204 | </tr>
|
11205 |
|
11206 |
|
11207 | </tbody>
|
11208 | </table>
|
11209 |
|
11210 |
|
11211 |
|
11212 |
|
11213 | <dl class="details">
|
11214 |
|
11215 |
|
11216 |
|
11217 |
|
11218 |
|
11219 |
|
11220 |
|
11221 |
|
11222 |
|
11223 |
|
11224 |
|
11225 |
|
11226 |
|
11227 |
|
11228 |
|
11229 |
|
11230 |
|
11231 |
|
11232 |
|
11233 |
|
11234 |
|
11235 |
|
11236 |
|
11237 |
|
11238 |
|
11239 |
|
11240 |
|
11241 |
|
11242 |
|
11243 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11244 | <dd class="tag-source">
|
11245 | <ul class="dummy">
|
11246 | <li>
|
11247 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11248 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-896">line 896</a>
|
11249 | </li>
|
11250 | </ul>
|
11251 | </dd>
|
11252 |
|
11253 |
|
11254 |
|
11255 |
|
11256 |
|
11257 |
|
11258 |
|
11259 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
11260 | <dd class="tag-todo">
|
11261 | <ul>
|
11262 | <li>Optimize it (perhaps using a cache matching the IDs with their position, maybe using the "position" or "positionByZIndex" properties).</li>
|
11263 | </ul>
|
11264 | </dd>
|
11265 |
|
11266 | </dl>
|
11267 |
|
11268 |
|
11269 |
|
11270 |
|
11271 |
|
11272 |
|
11273 |
|
11274 |
|
11275 |
|
11276 |
|
11277 |
|
11278 |
|
11279 |
|
11280 | <h5>Returns:</h5>
|
11281 |
|
11282 |
|
11283 | <div class="param-desc">
|
11284 | <p>Returns true if the sub-sprite has been deleted or false otherwise.</p>
|
11285 | </div>
|
11286 |
|
11287 |
|
11288 |
|
11289 | <dl>
|
11290 | <dt>
|
11291 | Type
|
11292 | </dt>
|
11293 | <dd>
|
11294 |
|
11295 | <span class="param-type">boolean</span>
|
11296 |
|
11297 |
|
11298 |
|
11299 | </dd>
|
11300 | </dl>
|
11301 |
|
11302 |
|
11303 |
|
11304 |
|
11305 |
|
11306 | </dd>
|
11307 |
|
11308 |
|
11309 |
|
11310 | <hr>
|
11311 | <dt>
|
11312 | <h4 class="name" id="removeSubSprites"><span class="type-signature"></span>removeSubSprites<span class="signature">( [sprite])</span><span class="type-signature"> → {boolean}</span></h4>
|
11313 |
|
11314 |
|
11315 | </dt>
|
11316 | <dd>
|
11317 |
|
11318 |
|
11319 | <div class="description">
|
11320 | <p>Removes all the sub-sprites from a given sprite (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) by clearing its "subSprites" property (leaving an empty array).</p>
|
11321 | </div>
|
11322 |
|
11323 |
|
11324 |
|
11325 |
|
11326 |
|
11327 |
|
11328 |
|
11329 |
|
11330 | <h5>Parameters:</h5>
|
11331 |
|
11332 |
|
11333 | <table class="params table table-striped">
|
11334 | <thead>
|
11335 | <tr>
|
11336 |
|
11337 | <th style="width:12%; min-width:110px;">Name</th>
|
11338 |
|
11339 |
|
11340 | <th style="width:12%; min-width:110px;">Type</th>
|
11341 |
|
11342 |
|
11343 | <th style="width:12%; min-width:110px;">Argument</th>
|
11344 |
|
11345 |
|
11346 |
|
11347 | <th style="width:12%; min-width:110px;">Default</th>
|
11348 |
|
11349 |
|
11350 | <th class="last" style="min-width:310px;">Description</th>
|
11351 | </tr>
|
11352 | </thead>
|
11353 |
|
11354 | <tbody>
|
11355 |
|
11356 |
|
11357 | <tr>
|
11358 |
|
11359 | <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>sprite</code></td>
|
11360 |
|
11361 |
|
11362 | <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;">
|
11363 |
|
11364 |
|
11365 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
11366 |
|
11367 |
|
11368 |
|
11369 |
|
11370 | </td>
|
11371 |
|
11372 |
|
11373 | <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;">
|
11374 |
|
11375 | <optional><br>
|
11376 |
|
11377 |
|
11378 |
|
11379 |
|
11380 |
|
11381 | </td>
|
11382 |
|
11383 |
|
11384 |
|
11385 | <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;">
|
11386 |
|
11387 | CB_GraphicSprites#getCurrent()
|
11388 |
|
11389 | </td>
|
11390 |
|
11391 |
|
11392 | <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 sprite whose sub-sprites we want to remove. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
11393 | </tr>
|
11394 |
|
11395 |
|
11396 | </tbody>
|
11397 | </table>
|
11398 |
|
11399 |
|
11400 |
|
11401 |
|
11402 | <dl class="details">
|
11403 |
|
11404 |
|
11405 |
|
11406 |
|
11407 |
|
11408 |
|
11409 |
|
11410 |
|
11411 |
|
11412 |
|
11413 |
|
11414 |
|
11415 |
|
11416 |
|
11417 |
|
11418 |
|
11419 |
|
11420 |
|
11421 |
|
11422 |
|
11423 |
|
11424 |
|
11425 |
|
11426 |
|
11427 |
|
11428 |
|
11429 |
|
11430 |
|
11431 |
|
11432 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11433 | <dd class="tag-source">
|
11434 | <ul class="dummy">
|
11435 | <li>
|
11436 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11437 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-769">line 769</a>
|
11438 | </li>
|
11439 | </ul>
|
11440 | </dd>
|
11441 |
|
11442 |
|
11443 |
|
11444 |
|
11445 |
|
11446 |
|
11447 |
|
11448 | </dl>
|
11449 |
|
11450 |
|
11451 |
|
11452 |
|
11453 |
|
11454 |
|
11455 |
|
11456 |
|
11457 |
|
11458 |
|
11459 |
|
11460 |
|
11461 |
|
11462 | <h5>Returns:</h5>
|
11463 |
|
11464 |
|
11465 | <div class="param-desc">
|
11466 | <p>Returns true if the sub-sprites have been deleted or false otherwise.</p>
|
11467 | </div>
|
11468 |
|
11469 |
|
11470 |
|
11471 | <dl>
|
11472 | <dt>
|
11473 | Type
|
11474 | </dt>
|
11475 | <dd>
|
11476 |
|
11477 | <span class="param-type">boolean</span>
|
11478 |
|
11479 |
|
11480 |
|
11481 | </dd>
|
11482 | </dl>
|
11483 |
|
11484 |
|
11485 |
|
11486 |
|
11487 |
|
11488 | </dd>
|
11489 |
|
11490 |
|
11491 |
|
11492 | <hr>
|
11493 | <dt>
|
11494 | <h4 class="name" id="removeSubSpritesAll"><span class="type-signature"></span>removeSubSpritesAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
11495 |
|
11496 |
|
11497 | </dt>
|
11498 | <dd>
|
11499 |
|
11500 |
|
11501 | <div class="description">
|
11502 | <p>Alias for <a href="CB_GraphicSprites.html#removeSubSprites"><code>CB_GraphicSprites#removeSubSprites</code></a>.</p>
|
11503 | </div>
|
11504 |
|
11505 |
|
11506 |
|
11507 |
|
11508 |
|
11509 |
|
11510 |
|
11511 |
|
11512 |
|
11513 |
|
11514 | <dl class="details">
|
11515 |
|
11516 |
|
11517 |
|
11518 |
|
11519 |
|
11520 |
|
11521 |
|
11522 |
|
11523 |
|
11524 |
|
11525 |
|
11526 |
|
11527 |
|
11528 |
|
11529 |
|
11530 |
|
11531 |
|
11532 |
|
11533 |
|
11534 |
|
11535 |
|
11536 |
|
11537 |
|
11538 |
|
11539 |
|
11540 |
|
11541 |
|
11542 |
|
11543 |
|
11544 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11545 | <dd class="tag-source">
|
11546 | <ul class="dummy">
|
11547 | <li>
|
11548 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11549 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-758">line 758</a>
|
11550 | </li>
|
11551 | </ul>
|
11552 | </dd>
|
11553 |
|
11554 |
|
11555 |
|
11556 |
|
11557 |
|
11558 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
11559 | <dd class="tag-see">
|
11560 | <ul>
|
11561 | <li><a href="CB_GraphicSprites.html#removeSubSprites"><code>CB_GraphicSprites#removeSubSprites</code></a></li>
|
11562 | </ul>
|
11563 | </dd>
|
11564 |
|
11565 |
|
11566 |
|
11567 | </dl>
|
11568 |
|
11569 |
|
11570 |
|
11571 |
|
11572 |
|
11573 |
|
11574 |
|
11575 |
|
11576 |
|
11577 |
|
11578 |
|
11579 |
|
11580 |
|
11581 |
|
11582 |
|
11583 | </dd>
|
11584 |
|
11585 |
|
11586 |
|
11587 | <hr>
|
11588 | <dt>
|
11589 | <h4 class="name" id="setCurrentPosition"><span class="type-signature"></span>setCurrentPosition<span class="signature">()</span><span class="type-signature"></span></h4>
|
11590 |
|
11591 |
|
11592 | </dt>
|
11593 | <dd>
|
11594 |
|
11595 |
|
11596 | <div class="description">
|
11597 | <p>Alias for <a href="CB_GraphicSprites.html#setPointer"><code>CB_GraphicSprites#setPointer</code></a>.</p>
|
11598 | </div>
|
11599 |
|
11600 |
|
11601 |
|
11602 |
|
11603 |
|
11604 |
|
11605 |
|
11606 |
|
11607 |
|
11608 |
|
11609 | <dl class="details">
|
11610 |
|
11611 |
|
11612 |
|
11613 |
|
11614 |
|
11615 |
|
11616 |
|
11617 |
|
11618 |
|
11619 |
|
11620 |
|
11621 |
|
11622 |
|
11623 |
|
11624 |
|
11625 |
|
11626 |
|
11627 |
|
11628 |
|
11629 |
|
11630 |
|
11631 |
|
11632 |
|
11633 |
|
11634 |
|
11635 |
|
11636 |
|
11637 |
|
11638 |
|
11639 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11640 | <dd class="tag-source">
|
11641 | <ul class="dummy">
|
11642 | <li>
|
11643 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11644 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1314">line 1314</a>
|
11645 | </li>
|
11646 | </ul>
|
11647 | </dd>
|
11648 |
|
11649 |
|
11650 |
|
11651 |
|
11652 |
|
11653 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
11654 | <dd class="tag-see">
|
11655 | <ul>
|
11656 | <li><a href="CB_GraphicSprites.html#setPointer"><code>CB_GraphicSprites#setPointer</code></a></li>
|
11657 | </ul>
|
11658 | </dd>
|
11659 |
|
11660 |
|
11661 |
|
11662 | </dl>
|
11663 |
|
11664 |
|
11665 |
|
11666 |
|
11667 |
|
11668 |
|
11669 |
|
11670 |
|
11671 |
|
11672 |
|
11673 |
|
11674 |
|
11675 |
|
11676 |
|
11677 |
|
11678 | </dd>
|
11679 |
|
11680 |
|
11681 |
|
11682 | <hr>
|
11683 | <dt>
|
11684 | <h4 class="name" id="setDisabled"><span class="type-signature"></span>setDisabled<span class="signature">( [disabled] [, affectChildren])</span><span class="type-signature"></span></h4>
|
11685 |
|
11686 |
|
11687 | </dt>
|
11688 | <dd>
|
11689 |
|
11690 |
|
11691 | <div class="description">
|
11692 | <p>Sets whether the sprites group object (and the {@CB_GraphicSprites} object itself) is disabled or enabled. Internally, it edits the "<code>CB_GraphicSprites.spritesGroup</code>.disabled" property.</p>
|
11693 | </div>
|
11694 |
|
11695 |
|
11696 |
|
11697 |
|
11698 |
|
11699 |
|
11700 |
|
11701 |
|
11702 | <h5>Parameters:</h5>
|
11703 |
|
11704 |
|
11705 | <table class="params table table-striped">
|
11706 | <thead>
|
11707 | <tr>
|
11708 |
|
11709 | <th style="width:12%; min-width:110px;">Name</th>
|
11710 |
|
11711 |
|
11712 | <th style="width:12%; min-width:110px;">Type</th>
|
11713 |
|
11714 |
|
11715 | <th style="width:12%; min-width:110px;">Argument</th>
|
11716 |
|
11717 |
|
11718 |
|
11719 | <th style="width:12%; min-width:110px;">Default</th>
|
11720 |
|
11721 |
|
11722 | <th class="last" style="min-width:310px;">Description</th>
|
11723 | </tr>
|
11724 | </thead>
|
11725 |
|
11726 | <tbody>
|
11727 |
|
11728 |
|
11729 | <tr>
|
11730 |
|
11731 | <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>disabled</code></td>
|
11732 |
|
11733 |
|
11734 | <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;">
|
11735 |
|
11736 |
|
11737 | <span class="param-type">boolean</span>
|
11738 |
|
11739 |
|
11740 |
|
11741 |
|
11742 | </td>
|
11743 |
|
11744 |
|
11745 | <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;">
|
11746 |
|
11747 | <optional><br>
|
11748 |
|
11749 |
|
11750 |
|
11751 |
|
11752 |
|
11753 | </td>
|
11754 |
|
11755 |
|
11756 |
|
11757 | <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;">
|
11758 |
|
11759 | false
|
11760 |
|
11761 | </td>
|
11762 |
|
11763 |
|
11764 | <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>Set to true to disable it or false to enable it.</p></td>
|
11765 | </tr>
|
11766 |
|
11767 |
|
11768 |
|
11769 | <tr>
|
11770 |
|
11771 | <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>affectChildren</code></td>
|
11772 |
|
11773 |
|
11774 | <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;">
|
11775 |
|
11776 |
|
11777 | <span class="param-type">boolean</span>
|
11778 |
|
11779 |
|
11780 |
|
11781 |
|
11782 | </td>
|
11783 |
|
11784 |
|
11785 | <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;">
|
11786 |
|
11787 | <optional><br>
|
11788 |
|
11789 |
|
11790 |
|
11791 |
|
11792 |
|
11793 | </td>
|
11794 |
|
11795 |
|
11796 |
|
11797 | <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;">
|
11798 |
|
11799 | disabled
|
11800 |
|
11801 | </td>
|
11802 |
|
11803 |
|
11804 | <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 this parameter is set to true, it will also modify the "disabled" property of all the sprites and their sub-sprites. By default, it is false if the "disabled" parameter is set to false or it is true otherwise.</p></td>
|
11805 | </tr>
|
11806 |
|
11807 |
|
11808 | </tbody>
|
11809 | </table>
|
11810 |
|
11811 |
|
11812 |
|
11813 |
|
11814 | <dl class="details">
|
11815 |
|
11816 |
|
11817 |
|
11818 |
|
11819 |
|
11820 |
|
11821 |
|
11822 |
|
11823 |
|
11824 |
|
11825 |
|
11826 |
|
11827 |
|
11828 |
|
11829 |
|
11830 |
|
11831 |
|
11832 |
|
11833 |
|
11834 |
|
11835 |
|
11836 |
|
11837 |
|
11838 |
|
11839 |
|
11840 |
|
11841 |
|
11842 |
|
11843 |
|
11844 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11845 | <dd class="tag-source">
|
11846 | <ul class="dummy">
|
11847 | <li>
|
11848 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
11849 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1538">line 1538</a>
|
11850 | </li>
|
11851 | </ul>
|
11852 | </dd>
|
11853 |
|
11854 |
|
11855 |
|
11856 |
|
11857 |
|
11858 |
|
11859 |
|
11860 | </dl>
|
11861 |
|
11862 |
|
11863 |
|
11864 |
|
11865 |
|
11866 |
|
11867 |
|
11868 |
|
11869 |
|
11870 |
|
11871 |
|
11872 |
|
11873 |
|
11874 |
|
11875 |
|
11876 | </dd>
|
11877 |
|
11878 |
|
11879 |
|
11880 | <hr>
|
11881 | <dt>
|
11882 | <h4 class="name" id="setDisabledSprite"><span class="type-signature"></span>setDisabledSprite<span class="signature">( [sprite] [, disabled] [, affectSubSprites] [, affectParent] [, affectParentChildren])</span><span class="type-signature"></span></h4>
|
11883 |
|
11884 |
|
11885 | </dt>
|
11886 | <dd>
|
11887 |
|
11888 |
|
11889 | <div class="description">
|
11890 | <p>Sets a given sprite disabled or enabled. Internally, it edits its "disabled" property.</p>
|
11891 | </div>
|
11892 |
|
11893 |
|
11894 |
|
11895 |
|
11896 |
|
11897 |
|
11898 |
|
11899 |
|
11900 | <h5>Parameters:</h5>
|
11901 |
|
11902 |
|
11903 | <table class="params table table-striped">
|
11904 | <thead>
|
11905 | <tr>
|
11906 |
|
11907 | <th style="width:12%; min-width:110px;">Name</th>
|
11908 |
|
11909 |
|
11910 | <th style="width:12%; min-width:110px;">Type</th>
|
11911 |
|
11912 |
|
11913 | <th style="width:12%; min-width:110px;">Argument</th>
|
11914 |
|
11915 |
|
11916 |
|
11917 | <th style="width:12%; min-width:110px;">Default</th>
|
11918 |
|
11919 |
|
11920 | <th class="last" style="min-width:310px;">Description</th>
|
11921 | </tr>
|
11922 | </thead>
|
11923 |
|
11924 | <tbody>
|
11925 |
|
11926 |
|
11927 | <tr>
|
11928 |
|
11929 | <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>sprite</code></td>
|
11930 |
|
11931 |
|
11932 | <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;">
|
11933 |
|
11934 |
|
11935 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
11936 |
|
11937 |
|
11938 |
|
11939 |
|
11940 | </td>
|
11941 |
|
11942 |
|
11943 | <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;">
|
11944 |
|
11945 | <optional><br>
|
11946 |
|
11947 |
|
11948 |
|
11949 |
|
11950 |
|
11951 | </td>
|
11952 |
|
11953 |
|
11954 |
|
11955 | <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;">
|
11956 |
|
11957 | CB_GraphicSprites#getCurrent()
|
11958 |
|
11959 | </td>
|
11960 |
|
11961 |
|
11962 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
11963 | </tr>
|
11964 |
|
11965 |
|
11966 |
|
11967 | <tr>
|
11968 |
|
11969 | <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>disabled</code></td>
|
11970 |
|
11971 |
|
11972 | <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;">
|
11973 |
|
11974 |
|
11975 | <span class="param-type">boolean</span>
|
11976 |
|
11977 |
|
11978 |
|
11979 |
|
11980 | </td>
|
11981 |
|
11982 |
|
11983 | <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;">
|
11984 |
|
11985 | <optional><br>
|
11986 |
|
11987 |
|
11988 |
|
11989 |
|
11990 |
|
11991 | </td>
|
11992 |
|
11993 |
|
11994 |
|
11995 | <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;">
|
11996 |
|
11997 | false
|
11998 |
|
11999 | </td>
|
12000 |
|
12001 |
|
12002 | <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>Set to true to disable it or false to enable it.</p></td>
|
12003 | </tr>
|
12004 |
|
12005 |
|
12006 |
|
12007 | <tr>
|
12008 |
|
12009 | <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>affectSubSprites</code></td>
|
12010 |
|
12011 |
|
12012 | <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;">
|
12013 |
|
12014 |
|
12015 | <span class="param-type">boolean</span>
|
12016 |
|
12017 |
|
12018 |
|
12019 |
|
12020 | </td>
|
12021 |
|
12022 |
|
12023 | <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;">
|
12024 |
|
12025 | <optional><br>
|
12026 |
|
12027 |
|
12028 |
|
12029 |
|
12030 |
|
12031 | </td>
|
12032 |
|
12033 |
|
12034 |
|
12035 | <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;">
|
12036 |
|
12037 | disabled
|
12038 |
|
12039 | </td>
|
12040 |
|
12041 |
|
12042 | <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 this parameter is set to true, it will also modify the "disabled" property of all the sub-sprites of the given sprite. This parameter will be ignored if the "affectParent" parameter is set to true (as all existing sprites and sub-sprites in the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object will be affected anyway). By default, it is false if the "disabled" parameter is set to false or it is true otherwise.</p></td>
|
12043 | </tr>
|
12044 |
|
12045 |
|
12046 |
|
12047 | <tr>
|
12048 |
|
12049 | <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>affectParent</code></td>
|
12050 |
|
12051 |
|
12052 | <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;">
|
12053 |
|
12054 |
|
12055 | <span class="param-type">boolean</span>
|
12056 |
|
12057 |
|
12058 |
|
12059 |
|
12060 | </td>
|
12061 |
|
12062 |
|
12063 | <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;">
|
12064 |
|
12065 | <optional><br>
|
12066 |
|
12067 |
|
12068 |
|
12069 |
|
12070 |
|
12071 | </td>
|
12072 |
|
12073 |
|
12074 |
|
12075 | <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;">
|
12076 |
|
12077 | affectParentChildren|!disabled
|
12078 |
|
12079 | </td>
|
12080 |
|
12081 |
|
12082 | <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 this parameter is set to true, it will also modify the "disabled" property of the sprites group object (which is considered the status of the whole {@CB_GraphicSprites} object). By default, it is true if either the "affectParentChildren" parameter is set to true or the "disabled" parameter is set to false and it is false otherwise.</p></td>
|
12083 | </tr>
|
12084 |
|
12085 |
|
12086 |
|
12087 | <tr>
|
12088 |
|
12089 | <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>affectParentChildren</code></td>
|
12090 |
|
12091 |
|
12092 | <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;">
|
12093 |
|
12094 |
|
12095 | <span class="param-type">boolean</span>
|
12096 |
|
12097 |
|
12098 |
|
12099 |
|
12100 | </td>
|
12101 |
|
12102 |
|
12103 | <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;">
|
12104 |
|
12105 | <optional><br>
|
12106 |
|
12107 |
|
12108 |
|
12109 |
|
12110 |
|
12111 | </td>
|
12112 |
|
12113 |
|
12114 |
|
12115 | <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;">
|
12116 |
|
12117 | !disabled
|
12118 |
|
12119 | </td>
|
12120 |
|
12121 |
|
12122 | <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 to also affect the sprites and sub-sprites of the sprites group object (which is considered the status of the whole {@CB_GraphicSprites} object) or not. If it is set to true and the "affectParent" is also set to true, it will also modify the "disabled" property of all the existing sprites and sub-sprites in the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object. This parameter is ignored if the "affectParent" parameter is set to false. By default, it is false if the "disabled" parameter is set to true or it is false otherwise.</p></td>
|
12123 | </tr>
|
12124 |
|
12125 |
|
12126 | </tbody>
|
12127 | </table>
|
12128 |
|
12129 |
|
12130 |
|
12131 |
|
12132 | <dl class="details">
|
12133 |
|
12134 |
|
12135 |
|
12136 |
|
12137 |
|
12138 |
|
12139 |
|
12140 |
|
12141 |
|
12142 |
|
12143 |
|
12144 |
|
12145 |
|
12146 |
|
12147 |
|
12148 |
|
12149 |
|
12150 |
|
12151 |
|
12152 |
|
12153 |
|
12154 |
|
12155 |
|
12156 |
|
12157 |
|
12158 |
|
12159 |
|
12160 |
|
12161 |
|
12162 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12163 | <dd class="tag-source">
|
12164 | <ul class="dummy">
|
12165 | <li>
|
12166 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
12167 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1574">line 1574</a>
|
12168 | </li>
|
12169 | </ul>
|
12170 | </dd>
|
12171 |
|
12172 |
|
12173 |
|
12174 |
|
12175 |
|
12176 |
|
12177 |
|
12178 | </dl>
|
12179 |
|
12180 |
|
12181 |
|
12182 |
|
12183 |
|
12184 |
|
12185 |
|
12186 |
|
12187 |
|
12188 |
|
12189 |
|
12190 |
|
12191 |
|
12192 |
|
12193 |
|
12194 | </dd>
|
12195 |
|
12196 |
|
12197 |
|
12198 | <hr>
|
12199 | <dt>
|
12200 | <h4 class="name" id="setDisabledSubSprite"><span class="type-signature"></span>setDisabledSubSprite<span class="signature">(subSprite [, disabled] [, affectParents] [, affectParentsChildren])</span><span class="type-signature"></span></h4>
|
12201 |
|
12202 |
|
12203 | </dt>
|
12204 | <dd>
|
12205 |
|
12206 |
|
12207 | <div class="description">
|
12208 | <p>Sets a given sub-sprite disabled or enabled. Internally, it edits its "disabled" property.</p>
|
12209 | </div>
|
12210 |
|
12211 |
|
12212 |
|
12213 |
|
12214 |
|
12215 |
|
12216 |
|
12217 |
|
12218 | <h5>Parameters:</h5>
|
12219 |
|
12220 |
|
12221 | <table class="params table table-striped">
|
12222 | <thead>
|
12223 | <tr>
|
12224 |
|
12225 | <th style="width:12%; min-width:110px;">Name</th>
|
12226 |
|
12227 |
|
12228 | <th style="width:12%; min-width:110px;">Type</th>
|
12229 |
|
12230 |
|
12231 | <th style="width:12%; min-width:110px;">Argument</th>
|
12232 |
|
12233 |
|
12234 |
|
12235 | <th style="width:12%; min-width:110px;">Default</th>
|
12236 |
|
12237 |
|
12238 | <th class="last" style="min-width:310px;">Description</th>
|
12239 | </tr>
|
12240 | </thead>
|
12241 |
|
12242 | <tbody>
|
12243 |
|
12244 |
|
12245 | <tr>
|
12246 |
|
12247 | <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>subSprite</code></td>
|
12248 |
|
12249 |
|
12250 | <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;">
|
12251 |
|
12252 |
|
12253 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
12254 |
|
12255 |
|
12256 |
|
12257 |
|
12258 | </td>
|
12259 |
|
12260 |
|
12261 | <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;">
|
12262 |
|
12263 |
|
12264 |
|
12265 |
|
12266 |
|
12267 | </td>
|
12268 |
|
12269 |
|
12270 |
|
12271 | <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;">
|
12272 |
|
12273 | </td>
|
12274 |
|
12275 |
|
12276 | <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 <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object which contains the sub-sprite.</p></td>
|
12277 | </tr>
|
12278 |
|
12279 |
|
12280 |
|
12281 | <tr>
|
12282 |
|
12283 | <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>disabled</code></td>
|
12284 |
|
12285 |
|
12286 | <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;">
|
12287 |
|
12288 |
|
12289 | <span class="param-type">boolean</span>
|
12290 |
|
12291 |
|
12292 |
|
12293 |
|
12294 | </td>
|
12295 |
|
12296 |
|
12297 | <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;">
|
12298 |
|
12299 | <optional><br>
|
12300 |
|
12301 |
|
12302 |
|
12303 |
|
12304 |
|
12305 | </td>
|
12306 |
|
12307 |
|
12308 |
|
12309 | <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;">
|
12310 |
|
12311 | false
|
12312 |
|
12313 | </td>
|
12314 |
|
12315 |
|
12316 | <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>Set to true to disable it or false to enable it.</p></td>
|
12317 | </tr>
|
12318 |
|
12319 |
|
12320 |
|
12321 | <tr>
|
12322 |
|
12323 | <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>affectParents</code></td>
|
12324 |
|
12325 |
|
12326 | <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;">
|
12327 |
|
12328 |
|
12329 | <span class="param-type">boolean</span>
|
12330 |
|
12331 |
|
12332 |
|
12333 |
|
12334 | </td>
|
12335 |
|
12336 |
|
12337 | <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;">
|
12338 |
|
12339 | <optional><br>
|
12340 |
|
12341 |
|
12342 |
|
12343 |
|
12344 |
|
12345 | </td>
|
12346 |
|
12347 |
|
12348 |
|
12349 | <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;">
|
12350 |
|
12351 | affectParentsChildren|!disabled
|
12352 |
|
12353 | </td>
|
12354 |
|
12355 |
|
12356 | <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 this parameter is set to true, it will also modify the "disabled" property of the sprite parent and of the sprites group object (which is considered the status of the whole {@CB_GraphicSprites} object). By default, it is true if either the "affectParentChildren" parameter is set to true or the "disabled" parameter is set to false and it is false otherwise.</p></td>
|
12357 | </tr>
|
12358 |
|
12359 |
|
12360 |
|
12361 | <tr>
|
12362 |
|
12363 | <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>affectParentsChildren</code></td>
|
12364 |
|
12365 |
|
12366 | <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;">
|
12367 |
|
12368 |
|
12369 | <span class="param-type">boolean</span>
|
12370 |
|
12371 |
|
12372 |
|
12373 |
|
12374 | </td>
|
12375 |
|
12376 |
|
12377 | <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;">
|
12378 |
|
12379 | <optional><br>
|
12380 |
|
12381 |
|
12382 |
|
12383 |
|
12384 |
|
12385 | </td>
|
12386 |
|
12387 |
|
12388 |
|
12389 | <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;">
|
12390 |
|
12391 | !disabled
|
12392 |
|
12393 | </td>
|
12394 |
|
12395 |
|
12396 | <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 to also affect the sprites and sub-sprites of the sprite parent and its sprites group object (which is considered the status of the whole {@CB_GraphicSprites} object) or not. If it is set to true and the "affectParents" is also set to true, it will also modify the "disabled" property of all the existing sprites and sub-sprites in the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object. This parameter is ignored if the "affectParents" parameter is set to false. By default, it is false if the "disabled" parameter is set to true or it is false otherwise.</p></td>
|
12397 | </tr>
|
12398 |
|
12399 |
|
12400 | </tbody>
|
12401 | </table>
|
12402 |
|
12403 |
|
12404 |
|
12405 |
|
12406 | <dl class="details">
|
12407 |
|
12408 |
|
12409 |
|
12410 |
|
12411 |
|
12412 |
|
12413 |
|
12414 |
|
12415 |
|
12416 |
|
12417 |
|
12418 |
|
12419 |
|
12420 |
|
12421 |
|
12422 |
|
12423 |
|
12424 |
|
12425 |
|
12426 |
|
12427 |
|
12428 |
|
12429 |
|
12430 |
|
12431 |
|
12432 |
|
12433 |
|
12434 |
|
12435 |
|
12436 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12437 | <dd class="tag-source">
|
12438 | <ul class="dummy">
|
12439 | <li>
|
12440 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
12441 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1622">line 1622</a>
|
12442 | </li>
|
12443 | </ul>
|
12444 | </dd>
|
12445 |
|
12446 |
|
12447 |
|
12448 |
|
12449 |
|
12450 |
|
12451 |
|
12452 | </dl>
|
12453 |
|
12454 |
|
12455 |
|
12456 |
|
12457 |
|
12458 |
|
12459 |
|
12460 |
|
12461 |
|
12462 |
|
12463 |
|
12464 |
|
12465 |
|
12466 |
|
12467 |
|
12468 | </dd>
|
12469 |
|
12470 |
|
12471 |
|
12472 | <hr>
|
12473 | <dt>
|
12474 | <h4 class="name" id="setNext"><span class="type-signature"></span>setNext<span class="signature">( [loop])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|null}</span></h4>
|
12475 |
|
12476 |
|
12477 | </dt>
|
12478 | <dd>
|
12479 |
|
12480 |
|
12481 | <div class="description">
|
12482 | <p>Makes the pointer to advance to the next position (if possible) and returns the sprite located there (if any). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite) and it will be returned if found. Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will also update the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds).</p>
|
12483 | </div>
|
12484 |
|
12485 |
|
12486 |
|
12487 |
|
12488 |
|
12489 |
|
12490 |
|
12491 |
|
12492 | <h5>Parameters:</h5>
|
12493 |
|
12494 |
|
12495 | <table class="params table table-striped">
|
12496 | <thead>
|
12497 | <tr>
|
12498 |
|
12499 | <th style="width:12%; min-width:110px;">Name</th>
|
12500 |
|
12501 |
|
12502 | <th style="width:12%; min-width:110px;">Type</th>
|
12503 |
|
12504 |
|
12505 | <th style="width:12%; min-width:110px;">Argument</th>
|
12506 |
|
12507 |
|
12508 |
|
12509 | <th style="width:12%; min-width:110px;">Default</th>
|
12510 |
|
12511 |
|
12512 | <th class="last" style="min-width:310px;">Description</th>
|
12513 | </tr>
|
12514 | </thead>
|
12515 |
|
12516 | <tbody>
|
12517 |
|
12518 |
|
12519 | <tr>
|
12520 |
|
12521 | <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>loop</code></td>
|
12522 |
|
12523 |
|
12524 | <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;">
|
12525 |
|
12526 |
|
12527 | <span class="param-type">boolean</span>
|
12528 |
|
12529 |
|
12530 |
|
12531 |
|
12532 | </td>
|
12533 |
|
12534 |
|
12535 | <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;">
|
12536 |
|
12537 | <optional><br>
|
12538 |
|
12539 |
|
12540 |
|
12541 |
|
12542 |
|
12543 | </td>
|
12544 |
|
12545 |
|
12546 |
|
12547 | <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;">
|
12548 |
|
12549 | false
|
12550 |
|
12551 | </td>
|
12552 |
|
12553 |
|
12554 | <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 false and the next position is greater than the current number of sprites, it will return null. Otherwise, if set to true and the position is greater than the current number of sprites, it will modify the position making it cycle (from the end to the beginning). This parameter is ignored when the position has not reached the limit.</p></td>
|
12555 | </tr>
|
12556 |
|
12557 |
|
12558 | </tbody>
|
12559 | </table>
|
12560 |
|
12561 |
|
12562 |
|
12563 |
|
12564 | <dl class="details">
|
12565 |
|
12566 |
|
12567 |
|
12568 |
|
12569 |
|
12570 |
|
12571 |
|
12572 |
|
12573 |
|
12574 |
|
12575 |
|
12576 |
|
12577 |
|
12578 |
|
12579 |
|
12580 |
|
12581 |
|
12582 |
|
12583 |
|
12584 |
|
12585 |
|
12586 |
|
12587 |
|
12588 |
|
12589 |
|
12590 |
|
12591 |
|
12592 |
|
12593 |
|
12594 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12595 | <dd class="tag-source">
|
12596 | <ul class="dummy">
|
12597 | <li>
|
12598 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
12599 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1413">line 1413</a>
|
12600 | </li>
|
12601 | </ul>
|
12602 | </dd>
|
12603 |
|
12604 |
|
12605 |
|
12606 |
|
12607 |
|
12608 |
|
12609 |
|
12610 | </dl>
|
12611 |
|
12612 |
|
12613 |
|
12614 |
|
12615 |
|
12616 |
|
12617 |
|
12618 |
|
12619 |
|
12620 |
|
12621 |
|
12622 |
|
12623 |
|
12624 | <h5>Returns:</h5>
|
12625 |
|
12626 |
|
12627 | <div class="param-desc">
|
12628 | <p>Makes it to point to the next <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object (making it the current one) and returns it. Returns null if it cannot be found.</p>
|
12629 | </div>
|
12630 |
|
12631 |
|
12632 |
|
12633 | <dl>
|
12634 | <dt>
|
12635 | Type
|
12636 | </dt>
|
12637 | <dd>
|
12638 |
|
12639 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
12640 | |
|
12641 |
|
12642 | <span class="param-type">null</span>
|
12643 |
|
12644 |
|
12645 |
|
12646 | </dd>
|
12647 | </dl>
|
12648 |
|
12649 |
|
12650 |
|
12651 |
|
12652 |
|
12653 | </dd>
|
12654 |
|
12655 |
|
12656 |
|
12657 | <hr>
|
12658 | <dt>
|
12659 | <h4 class="name" id="setPointer"><span class="type-signature"></span>setPointer<span class="signature">( [position] [, loop])</span><span class="type-signature"> → {integer}</span></h4>
|
12660 |
|
12661 |
|
12662 | </dt>
|
12663 | <dd>
|
12664 |
|
12665 |
|
12666 | <div class="description">
|
12667 | <p>Sets the pointer to the desired position (if possible). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will also reset the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds).</p>
|
12668 | </div>
|
12669 |
|
12670 |
|
12671 |
|
12672 |
|
12673 |
|
12674 |
|
12675 |
|
12676 |
|
12677 | <h5>Parameters:</h5>
|
12678 |
|
12679 |
|
12680 | <table class="params table table-striped">
|
12681 | <thead>
|
12682 | <tr>
|
12683 |
|
12684 | <th style="width:12%; min-width:110px;">Name</th>
|
12685 |
|
12686 |
|
12687 | <th style="width:12%; min-width:110px;">Type</th>
|
12688 |
|
12689 |
|
12690 | <th style="width:12%; min-width:110px;">Argument</th>
|
12691 |
|
12692 |
|
12693 |
|
12694 | <th style="width:12%; min-width:110px;">Default</th>
|
12695 |
|
12696 |
|
12697 | <th class="last" style="min-width:310px;">Description</th>
|
12698 | </tr>
|
12699 | </thead>
|
12700 |
|
12701 | <tbody>
|
12702 |
|
12703 |
|
12704 | <tr>
|
12705 |
|
12706 | <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>position</code></td>
|
12707 |
|
12708 |
|
12709 | <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;">
|
12710 |
|
12711 |
|
12712 | <span class="param-type">integer</span>
|
12713 |
|
12714 |
|
12715 |
|
12716 |
|
12717 | </td>
|
12718 |
|
12719 |
|
12720 | <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;">
|
12721 |
|
12722 | <optional><br>
|
12723 |
|
12724 |
|
12725 |
|
12726 |
|
12727 |
|
12728 | </td>
|
12729 |
|
12730 |
|
12731 |
|
12732 | <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;">
|
12733 |
|
12734 | 0|CB_GraphicSprites#spritesGroup.sprites.length-1|position%CB_GraphicSprites#spritesGroup.sprites.length
|
12735 |
|
12736 | </td>
|
12737 |
|
12738 |
|
12739 | <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 position that we want the pointer to use. The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite).</p></td>
|
12740 | </tr>
|
12741 |
|
12742 |
|
12743 |
|
12744 | <tr>
|
12745 |
|
12746 | <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>loop</code></td>
|
12747 |
|
12748 |
|
12749 | <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;">
|
12750 |
|
12751 |
|
12752 | <span class="param-type">boolean</span>
|
12753 |
|
12754 |
|
12755 |
|
12756 |
|
12757 | </td>
|
12758 |
|
12759 |
|
12760 | <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;">
|
12761 |
|
12762 | <optional><br>
|
12763 |
|
12764 |
|
12765 |
|
12766 |
|
12767 |
|
12768 | </td>
|
12769 |
|
12770 |
|
12771 |
|
12772 | <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;">
|
12773 |
|
12774 | false
|
12775 |
|
12776 | </td>
|
12777 |
|
12778 |
|
12779 | <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 false and the "position" given is greater than the current number of sprites, the "position" used will be the one which belongs to the last sprite. If set to false and the "position" given is lower than zero, the "position" used will be zero (the first position). Otherwise, if set to true and the "position" given is greater than the current number of sprites or lower than zero, it will modify the given "position" making it cycle (from the end to the beginning) treating always the "position" as a positive number. This parameter is ignored when the given "position" has not reached the limit.</p></td>
|
12780 | </tr>
|
12781 |
|
12782 |
|
12783 | </tbody>
|
12784 | </table>
|
12785 |
|
12786 |
|
12787 |
|
12788 |
|
12789 | <dl class="details">
|
12790 |
|
12791 |
|
12792 |
|
12793 |
|
12794 |
|
12795 |
|
12796 |
|
12797 |
|
12798 |
|
12799 |
|
12800 |
|
12801 |
|
12802 |
|
12803 |
|
12804 |
|
12805 |
|
12806 |
|
12807 |
|
12808 |
|
12809 |
|
12810 |
|
12811 |
|
12812 |
|
12813 |
|
12814 |
|
12815 |
|
12816 |
|
12817 |
|
12818 |
|
12819 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12820 | <dd class="tag-source">
|
12821 | <ul class="dummy">
|
12822 | <li>
|
12823 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
12824 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1326">line 1326</a>
|
12825 | </li>
|
12826 | </ul>
|
12827 | </dd>
|
12828 |
|
12829 |
|
12830 |
|
12831 |
|
12832 |
|
12833 |
|
12834 |
|
12835 | </dl>
|
12836 |
|
12837 |
|
12838 |
|
12839 |
|
12840 |
|
12841 |
|
12842 |
|
12843 |
|
12844 |
|
12845 |
|
12846 |
|
12847 |
|
12848 |
|
12849 | <h5>Returns:</h5>
|
12850 |
|
12851 |
|
12852 | <div class="param-desc">
|
12853 | <p>Returns the position where the pointer is currently pointing to. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite).</p>
|
12854 | </div>
|
12855 |
|
12856 |
|
12857 |
|
12858 | <dl>
|
12859 | <dt>
|
12860 | Type
|
12861 | </dt>
|
12862 | <dd>
|
12863 |
|
12864 | <span class="param-type">integer</span>
|
12865 |
|
12866 |
|
12867 |
|
12868 | </dd>
|
12869 | </dl>
|
12870 |
|
12871 |
|
12872 |
|
12873 |
|
12874 |
|
12875 | </dd>
|
12876 |
|
12877 |
|
12878 |
|
12879 | <hr>
|
12880 | <dt>
|
12881 | <h4 class="name" id="setPrevious"><span class="type-signature"></span>setPrevious<span class="signature">( [loop])</span><span class="type-signature"> → {<a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a>|null}</span></h4>
|
12882 |
|
12883 |
|
12884 | </dt>
|
12885 | <dd>
|
12886 |
|
12887 |
|
12888 | <div class="description">
|
12889 | <p>Makes the pointer to go back to the previous position (if possible) and returns the sprite located there (if any). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite) and it will be returned if found. Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will update also the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds).</p>
|
12890 | </div>
|
12891 |
|
12892 |
|
12893 |
|
12894 |
|
12895 |
|
12896 |
|
12897 |
|
12898 |
|
12899 | <h5>Parameters:</h5>
|
12900 |
|
12901 |
|
12902 | <table class="params table table-striped">
|
12903 | <thead>
|
12904 | <tr>
|
12905 |
|
12906 | <th style="width:12%; min-width:110px;">Name</th>
|
12907 |
|
12908 |
|
12909 | <th style="width:12%; min-width:110px;">Type</th>
|
12910 |
|
12911 |
|
12912 | <th style="width:12%; min-width:110px;">Argument</th>
|
12913 |
|
12914 |
|
12915 |
|
12916 | <th style="width:12%; min-width:110px;">Default</th>
|
12917 |
|
12918 |
|
12919 | <th class="last" style="min-width:310px;">Description</th>
|
12920 | </tr>
|
12921 | </thead>
|
12922 |
|
12923 | <tbody>
|
12924 |
|
12925 |
|
12926 | <tr>
|
12927 |
|
12928 | <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>loop</code></td>
|
12929 |
|
12930 |
|
12931 | <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;">
|
12932 |
|
12933 |
|
12934 | <span class="param-type">boolean</span>
|
12935 |
|
12936 |
|
12937 |
|
12938 |
|
12939 | </td>
|
12940 |
|
12941 |
|
12942 | <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;">
|
12943 |
|
12944 | <optional><br>
|
12945 |
|
12946 |
|
12947 |
|
12948 |
|
12949 |
|
12950 | </td>
|
12951 |
|
12952 |
|
12953 |
|
12954 | <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;">
|
12955 |
|
12956 | false
|
12957 |
|
12958 | </td>
|
12959 |
|
12960 |
|
12961 | <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 false and the previous position is lower than zero, it will return null. Otherwise, if set to true and the position is lower than zero, it will modify the position making it cycle (from the beginning to the end). This parameter is ignored when the position has not reached the limit.</p></td>
|
12962 | </tr>
|
12963 |
|
12964 |
|
12965 | </tbody>
|
12966 | </table>
|
12967 |
|
12968 |
|
12969 |
|
12970 |
|
12971 | <dl class="details">
|
12972 |
|
12973 |
|
12974 |
|
12975 |
|
12976 |
|
12977 |
|
12978 |
|
12979 |
|
12980 |
|
12981 |
|
12982 |
|
12983 |
|
12984 |
|
12985 |
|
12986 |
|
12987 |
|
12988 |
|
12989 |
|
12990 |
|
12991 |
|
12992 |
|
12993 |
|
12994 |
|
12995 |
|
12996 |
|
12997 |
|
12998 |
|
12999 |
|
13000 |
|
13001 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13002 | <dd class="tag-source">
|
13003 | <ul class="dummy">
|
13004 | <li>
|
13005 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
13006 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1388">line 1388</a>
|
13007 | </li>
|
13008 | </ul>
|
13009 | </dd>
|
13010 |
|
13011 |
|
13012 |
|
13013 |
|
13014 |
|
13015 |
|
13016 |
|
13017 | </dl>
|
13018 |
|
13019 |
|
13020 |
|
13021 |
|
13022 |
|
13023 |
|
13024 |
|
13025 |
|
13026 |
|
13027 |
|
13028 |
|
13029 |
|
13030 |
|
13031 | <h5>Returns:</h5>
|
13032 |
|
13033 |
|
13034 | <div class="param-desc">
|
13035 | <p>Makes it to point to the previous <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object (making it the current one) and returns it. Returns null if it cannot be found.</p>
|
13036 | </div>
|
13037 |
|
13038 |
|
13039 |
|
13040 | <dl>
|
13041 | <dt>
|
13042 | Type
|
13043 | </dt>
|
13044 | <dd>
|
13045 |
|
13046 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
13047 | |
|
13048 |
|
13049 | <span class="param-type">null</span>
|
13050 |
|
13051 |
|
13052 |
|
13053 | </dd>
|
13054 | </dl>
|
13055 |
|
13056 |
|
13057 |
|
13058 |
|
13059 |
|
13060 | </dd>
|
13061 |
|
13062 |
|
13063 |
|
13064 | <hr>
|
13065 | <dt>
|
13066 | <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>
|
13067 |
|
13068 |
|
13069 | </dt>
|
13070 | <dd>
|
13071 |
|
13072 |
|
13073 | <div class="description">
|
13074 | <p>Sets the desired value of a given property name to the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object as well to its children elements (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> and <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects).</p>
|
13075 | </div>
|
13076 |
|
13077 |
|
13078 |
|
13079 |
|
13080 |
|
13081 |
|
13082 |
|
13083 |
|
13084 | <h5>Parameters:</h5>
|
13085 |
|
13086 |
|
13087 | <table class="params table table-striped">
|
13088 | <thead>
|
13089 | <tr>
|
13090 |
|
13091 | <th style="width:12%; min-width:110px;">Name</th>
|
13092 |
|
13093 |
|
13094 | <th style="width:12%; min-width:110px;">Type</th>
|
13095 |
|
13096 |
|
13097 | <th style="width:12%; min-width:110px;">Argument</th>
|
13098 |
|
13099 |
|
13100 |
|
13101 | <th style="width:12%; min-width:110px;">Default</th>
|
13102 |
|
13103 |
|
13104 | <th class="last" style="min-width:310px;">Description</th>
|
13105 | </tr>
|
13106 | </thead>
|
13107 |
|
13108 | <tbody>
|
13109 |
|
13110 |
|
13111 | <tr>
|
13112 |
|
13113 | <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>
|
13114 |
|
13115 |
|
13116 | <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;">
|
13117 |
|
13118 |
|
13119 | <span class="param-type">number</span>
|
13120 |
|
13121 |
|
13122 |
|
13123 |
|
13124 | </td>
|
13125 |
|
13126 |
|
13127 | <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;">
|
13128 |
|
13129 |
|
13130 |
|
13131 |
|
13132 |
|
13133 | </td>
|
13134 |
|
13135 |
|
13136 |
|
13137 | <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;">
|
13138 |
|
13139 | </td>
|
13140 |
|
13141 |
|
13142 | <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.</p></td>
|
13143 | </tr>
|
13144 |
|
13145 |
|
13146 |
|
13147 | <tr>
|
13148 |
|
13149 | <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>
|
13150 |
|
13151 |
|
13152 | <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;">
|
13153 |
|
13154 |
|
13155 | <span class="param-type">*</span>
|
13156 |
|
13157 |
|
13158 |
|
13159 |
|
13160 | </td>
|
13161 |
|
13162 |
|
13163 | <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;">
|
13164 |
|
13165 | <optional><br>
|
13166 |
|
13167 |
|
13168 |
|
13169 |
|
13170 |
|
13171 | </td>
|
13172 |
|
13173 |
|
13174 |
|
13175 | <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;">
|
13176 |
|
13177 | </td>
|
13178 |
|
13179 |
|
13180 | <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.</p></td>
|
13181 | </tr>
|
13182 |
|
13183 |
|
13184 |
|
13185 | <tr>
|
13186 |
|
13187 | <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>
|
13188 |
|
13189 |
|
13190 | <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;">
|
13191 |
|
13192 |
|
13193 | <span class="param-type">boolean</span>
|
13194 |
|
13195 |
|
13196 |
|
13197 |
|
13198 | </td>
|
13199 |
|
13200 |
|
13201 | <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;">
|
13202 |
|
13203 | <optional><br>
|
13204 |
|
13205 |
|
13206 |
|
13207 |
|
13208 |
|
13209 | </td>
|
13210 |
|
13211 |
|
13212 |
|
13213 | <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;">
|
13214 |
|
13215 | false
|
13216 |
|
13217 | </td>
|
13218 |
|
13219 |
|
13220 | <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 (and also the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object).</p></td>
|
13221 | </tr>
|
13222 |
|
13223 |
|
13224 | </tbody>
|
13225 | </table>
|
13226 |
|
13227 |
|
13228 |
|
13229 |
|
13230 | <dl class="details">
|
13231 |
|
13232 |
|
13233 |
|
13234 |
|
13235 |
|
13236 |
|
13237 |
|
13238 |
|
13239 |
|
13240 |
|
13241 |
|
13242 |
|
13243 |
|
13244 |
|
13245 |
|
13246 |
|
13247 |
|
13248 |
|
13249 |
|
13250 |
|
13251 |
|
13252 |
|
13253 |
|
13254 |
|
13255 |
|
13256 |
|
13257 |
|
13258 |
|
13259 |
|
13260 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13261 | <dd class="tag-source">
|
13262 | <ul class="dummy">
|
13263 | <li>
|
13264 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
13265 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1704">line 1704</a>
|
13266 | </li>
|
13267 | </ul>
|
13268 | </dd>
|
13269 |
|
13270 |
|
13271 |
|
13272 |
|
13273 |
|
13274 |
|
13275 |
|
13276 | </dl>
|
13277 |
|
13278 |
|
13279 |
|
13280 |
|
13281 |
|
13282 |
|
13283 |
|
13284 |
|
13285 |
|
13286 |
|
13287 |
|
13288 |
|
13289 |
|
13290 | <h5>Returns:</h5>
|
13291 |
|
13292 |
|
13293 | <div class="param-desc">
|
13294 | <p>Returns the number of elements affected (counting the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object).</p>
|
13295 | </div>
|
13296 |
|
13297 |
|
13298 |
|
13299 | <dl>
|
13300 | <dt>
|
13301 | Type
|
13302 | </dt>
|
13303 | <dd>
|
13304 |
|
13305 | <span class="param-type">integer</span>
|
13306 |
|
13307 |
|
13308 |
|
13309 | </dd>
|
13310 | </dl>
|
13311 |
|
13312 |
|
13313 |
|
13314 |
|
13315 |
|
13316 | </dd>
|
13317 |
|
13318 |
|
13319 |
|
13320 | <hr>
|
13321 | <dt>
|
13322 | <h4 class="name" id="setTime"><span class="type-signature"></span>setTime<span class="signature">( [time] [, updateTimeCurrentSprite] [, updateTimeCurrentSpriteSubSprites])</span><span class="type-signature"> → {number}</span></h4>
|
13323 |
|
13324 |
|
13325 | </dt>
|
13326 | <dd>
|
13327 |
|
13328 |
|
13329 | <div class="description">
|
13330 | <p>Sets (updates) the time in milliseconds when the current sprite or a sub-sprite started being pointed.</p>
|
13331 | </div>
|
13332 |
|
13333 |
|
13334 |
|
13335 |
|
13336 |
|
13337 |
|
13338 |
|
13339 |
|
13340 | <h5>Parameters:</h5>
|
13341 |
|
13342 |
|
13343 | <table class="params table table-striped">
|
13344 | <thead>
|
13345 | <tr>
|
13346 |
|
13347 | <th style="width:12%; min-width:110px;">Name</th>
|
13348 |
|
13349 |
|
13350 | <th style="width:12%; min-width:110px;">Type</th>
|
13351 |
|
13352 |
|
13353 | <th style="width:12%; min-width:110px;">Argument</th>
|
13354 |
|
13355 |
|
13356 |
|
13357 | <th style="width:12%; min-width:110px;">Default</th>
|
13358 |
|
13359 |
|
13360 | <th class="last" style="min-width:310px;">Description</th>
|
13361 | </tr>
|
13362 | </thead>
|
13363 |
|
13364 | <tbody>
|
13365 |
|
13366 |
|
13367 | <tr>
|
13368 |
|
13369 | <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>time</code></td>
|
13370 |
|
13371 |
|
13372 | <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;">
|
13373 |
|
13374 |
|
13375 | <span class="param-type">number</span>
|
13376 |
|
13377 |
|
13378 |
|
13379 |
|
13380 | </td>
|
13381 |
|
13382 |
|
13383 | <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;">
|
13384 |
|
13385 | <optional><br>
|
13386 |
|
13387 |
|
13388 |
|
13389 |
|
13390 |
|
13391 | </td>
|
13392 |
|
13393 |
|
13394 |
|
13395 | <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;">
|
13396 |
|
13397 | CB_Device.getTiming()
|
13398 |
|
13399 | </td>
|
13400 |
|
13401 |
|
13402 | <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 time that we want to set, in milliseconds (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function). It must be a positive number (or zero). If not provided, it will use the current time (by calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally).</p></td>
|
13403 | </tr>
|
13404 |
|
13405 |
|
13406 |
|
13407 | <tr>
|
13408 |
|
13409 | <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>updateTimeCurrentSprite</code></td>
|
13410 |
|
13411 |
|
13412 | <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;">
|
13413 |
|
13414 |
|
13415 | <span class="param-type">boolean</span>
|
13416 |
|
13417 |
|
13418 |
|
13419 |
|
13420 | </td>
|
13421 |
|
13422 |
|
13423 | <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;">
|
13424 |
|
13425 | <optional><br>
|
13426 |
|
13427 |
|
13428 |
|
13429 |
|
13430 |
|
13431 | </td>
|
13432 |
|
13433 |
|
13434 |
|
13435 | <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;">
|
13436 |
|
13437 | false
|
13438 |
|
13439 | </td>
|
13440 |
|
13441 |
|
13442 | <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 also update the "time" property of the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which is currently pointed by the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property).</p></td>
|
13443 | </tr>
|
13444 |
|
13445 |
|
13446 |
|
13447 | <tr>
|
13448 |
|
13449 | <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>updateTimeCurrentSpriteSubSprites</code></td>
|
13450 |
|
13451 |
|
13452 | <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;">
|
13453 |
|
13454 |
|
13455 | <span class="param-type">boolean</span>
|
13456 |
|
13457 |
|
13458 |
|
13459 |
|
13460 | </td>
|
13461 |
|
13462 |
|
13463 | <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;">
|
13464 |
|
13465 | <optional><br>
|
13466 |
|
13467 |
|
13468 |
|
13469 |
|
13470 |
|
13471 | </td>
|
13472 |
|
13473 |
|
13474 |
|
13475 | <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;">
|
13476 |
|
13477 | false
|
13478 |
|
13479 | </td>
|
13480 |
|
13481 |
|
13482 | <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 and the "updateTimeCurrentSprite" is set to true, it will also update the "time" property of the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects that belong to the sprite which is currently pointed by the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property). This parameter is ignored if the "updateTimeCurrentSprite" parameter is set to false.</p></td>
|
13483 | </tr>
|
13484 |
|
13485 |
|
13486 | </tbody>
|
13487 | </table>
|
13488 |
|
13489 |
|
13490 |
|
13491 |
|
13492 | <dl class="details">
|
13493 |
|
13494 |
|
13495 |
|
13496 |
|
13497 |
|
13498 |
|
13499 |
|
13500 |
|
13501 |
|
13502 |
|
13503 |
|
13504 |
|
13505 |
|
13506 |
|
13507 |
|
13508 |
|
13509 |
|
13510 |
|
13511 |
|
13512 |
|
13513 |
|
13514 |
|
13515 |
|
13516 |
|
13517 |
|
13518 |
|
13519 |
|
13520 |
|
13521 |
|
13522 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13523 | <dd class="tag-source">
|
13524 | <ul class="dummy">
|
13525 | <li>
|
13526 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
13527 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1646">line 1646</a>
|
13528 | </li>
|
13529 | </ul>
|
13530 | </dd>
|
13531 |
|
13532 |
|
13533 |
|
13534 |
|
13535 |
|
13536 |
|
13537 |
|
13538 | </dl>
|
13539 |
|
13540 |
|
13541 |
|
13542 |
|
13543 |
|
13544 |
|
13545 |
|
13546 |
|
13547 |
|
13548 |
|
13549 |
|
13550 |
|
13551 |
|
13552 | <h5>Returns:</h5>
|
13553 |
|
13554 |
|
13555 | <div class="param-desc">
|
13556 | <p>Returns the time in milliseconds when the current sprite or a sub-sprite started being pointed (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function).</p>
|
13557 | </div>
|
13558 |
|
13559 |
|
13560 |
|
13561 | <dl>
|
13562 | <dt>
|
13563 | Type
|
13564 | </dt>
|
13565 | <dd>
|
13566 |
|
13567 | <span class="param-type">number</span>
|
13568 |
|
13569 |
|
13570 |
|
13571 | </dd>
|
13572 | </dl>
|
13573 |
|
13574 |
|
13575 |
|
13576 |
|
13577 |
|
13578 | </dd>
|
13579 |
|
13580 |
|
13581 |
|
13582 | <hr>
|
13583 | <dt>
|
13584 | <h4 class="name" id="setZIndex"><span class="type-signature"></span>setZIndex<span class="signature">( [zIndex])</span><span class="type-signature"> → {number}</span></h4>
|
13585 |
|
13586 |
|
13587 | </dt>
|
13588 | <dd>
|
13589 |
|
13590 |
|
13591 | <div class="description">
|
13592 | <p>Sets the desired z-index ("zIndex" property) of the sprites group object (and the {@CB_GraphicSprites} object itself). If there is a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> parent object (set in the <code>CB_GraphicSprites.parent</code> property), it will also call its <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally.</p>
|
13593 | </div>
|
13594 |
|
13595 |
|
13596 |
|
13597 |
|
13598 |
|
13599 |
|
13600 |
|
13601 |
|
13602 | <h5>Parameters:</h5>
|
13603 |
|
13604 |
|
13605 | <table class="params table table-striped">
|
13606 | <thead>
|
13607 | <tr>
|
13608 |
|
13609 | <th style="width:12%; min-width:110px;">Name</th>
|
13610 |
|
13611 |
|
13612 | <th style="width:12%; min-width:110px;">Type</th>
|
13613 |
|
13614 |
|
13615 | <th style="width:12%; min-width:110px;">Argument</th>
|
13616 |
|
13617 |
|
13618 |
|
13619 | <th style="width:12%; min-width:110px;">Default</th>
|
13620 |
|
13621 |
|
13622 | <th class="last" style="min-width:310px;">Description</th>
|
13623 | </tr>
|
13624 | </thead>
|
13625 |
|
13626 | <tbody>
|
13627 |
|
13628 |
|
13629 | <tr>
|
13630 |
|
13631 | <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>zIndex</code></td>
|
13632 |
|
13633 |
|
13634 | <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;">
|
13635 |
|
13636 |
|
13637 | <span class="param-type">number</span>
|
13638 |
|
13639 |
|
13640 |
|
13641 |
|
13642 | </td>
|
13643 |
|
13644 |
|
13645 | <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;">
|
13646 |
|
13647 | <optional><br>
|
13648 |
|
13649 |
|
13650 |
|
13651 |
|
13652 |
|
13653 | </td>
|
13654 |
|
13655 |
|
13656 |
|
13657 | <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;">
|
13658 |
|
13659 | parseFloat(zIndex)||CB_GraphicSprites.ZINDEX_DEFAULT||1
|
13660 |
|
13661 | </td>
|
13662 |
|
13663 |
|
13664 | <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 z-index value we want. It must be a number but never zero (0). If no valid number is given, it will use the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or 1 otherwise.</p></td>
|
13665 | </tr>
|
13666 |
|
13667 |
|
13668 | </tbody>
|
13669 | </table>
|
13670 |
|
13671 |
|
13672 |
|
13673 |
|
13674 | <dl class="details">
|
13675 |
|
13676 |
|
13677 |
|
13678 |
|
13679 |
|
13680 |
|
13681 |
|
13682 |
|
13683 |
|
13684 |
|
13685 |
|
13686 |
|
13687 |
|
13688 |
|
13689 |
|
13690 |
|
13691 |
|
13692 |
|
13693 |
|
13694 |
|
13695 |
|
13696 |
|
13697 |
|
13698 |
|
13699 |
|
13700 |
|
13701 |
|
13702 |
|
13703 |
|
13704 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13705 | <dd class="tag-source">
|
13706 | <ul class="dummy">
|
13707 | <li>
|
13708 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
13709 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1441">line 1441</a>
|
13710 | </li>
|
13711 | </ul>
|
13712 | </dd>
|
13713 |
|
13714 |
|
13715 |
|
13716 |
|
13717 |
|
13718 |
|
13719 |
|
13720 | </dl>
|
13721 |
|
13722 |
|
13723 |
|
13724 |
|
13725 |
|
13726 |
|
13727 |
|
13728 |
|
13729 |
|
13730 |
|
13731 |
|
13732 |
|
13733 |
|
13734 | <h5>Returns:</h5>
|
13735 |
|
13736 |
|
13737 | <div class="param-desc">
|
13738 | <p>Returns the z-index ("zIndex") of the sprites group object (and the {@CB_GraphicSprites} object itself) after setting it (it could have been sanitized).</p>
|
13739 | </div>
|
13740 |
|
13741 |
|
13742 |
|
13743 | <dl>
|
13744 | <dt>
|
13745 | Type
|
13746 | </dt>
|
13747 | <dd>
|
13748 |
|
13749 | <span class="param-type">number</span>
|
13750 |
|
13751 |
|
13752 |
|
13753 | </dd>
|
13754 | </dl>
|
13755 |
|
13756 |
|
13757 |
|
13758 |
|
13759 |
|
13760 | </dd>
|
13761 |
|
13762 |
|
13763 |
|
13764 | <hr>
|
13765 | <dt>
|
13766 | <h4 class="name" id="setZIndexSprite"><span class="type-signature"></span>setZIndexSprite<span class="signature">( [sprite] [, zIndex])</span><span class="type-signature"> → {number}</span></h4>
|
13767 |
|
13768 |
|
13769 | </dt>
|
13770 | <dd>
|
13771 |
|
13772 |
|
13773 | <div class="description">
|
13774 | <p>Sets the desired z-index ("zIndex") of the given sprite object. Calls the <a href="CB_GraphicSprites.html#updateSpritesByZIndex"><code>CB_GraphicSprites#updateSpritesByZIndex</code></a> method internally.</p>
|
13775 | </div>
|
13776 |
|
13777 |
|
13778 |
|
13779 |
|
13780 |
|
13781 |
|
13782 |
|
13783 |
|
13784 | <h5>Parameters:</h5>
|
13785 |
|
13786 |
|
13787 | <table class="params table table-striped">
|
13788 | <thead>
|
13789 | <tr>
|
13790 |
|
13791 | <th style="width:12%; min-width:110px;">Name</th>
|
13792 |
|
13793 |
|
13794 | <th style="width:12%; min-width:110px;">Type</th>
|
13795 |
|
13796 |
|
13797 | <th style="width:12%; min-width:110px;">Argument</th>
|
13798 |
|
13799 |
|
13800 |
|
13801 | <th style="width:12%; min-width:110px;">Default</th>
|
13802 |
|
13803 |
|
13804 | <th class="last" style="min-width:310px;">Description</th>
|
13805 | </tr>
|
13806 | </thead>
|
13807 |
|
13808 | <tbody>
|
13809 |
|
13810 |
|
13811 | <tr>
|
13812 |
|
13813 | <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>sprite</code></td>
|
13814 |
|
13815 |
|
13816 | <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;">
|
13817 |
|
13818 |
|
13819 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
13820 |
|
13821 |
|
13822 |
|
13823 |
|
13824 | </td>
|
13825 |
|
13826 |
|
13827 | <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;">
|
13828 |
|
13829 | <optional><br>
|
13830 |
|
13831 |
|
13832 |
|
13833 |
|
13834 |
|
13835 | </td>
|
13836 |
|
13837 |
|
13838 |
|
13839 | <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;">
|
13840 |
|
13841 | CB_GraphicSprites#getCurrent()
|
13842 |
|
13843 | </td>
|
13844 |
|
13845 |
|
13846 | <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 <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which contains the sprite. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
13847 | </tr>
|
13848 |
|
13849 |
|
13850 |
|
13851 | <tr>
|
13852 |
|
13853 | <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>zIndex</code></td>
|
13854 |
|
13855 |
|
13856 | <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;">
|
13857 |
|
13858 |
|
13859 | <span class="param-type">number</span>
|
13860 |
|
13861 |
|
13862 |
|
13863 |
|
13864 | </td>
|
13865 |
|
13866 |
|
13867 | <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;">
|
13868 |
|
13869 | <optional><br>
|
13870 |
|
13871 |
|
13872 |
|
13873 |
|
13874 |
|
13875 | </td>
|
13876 |
|
13877 |
|
13878 |
|
13879 | <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;">
|
13880 |
|
13881 | parseFloat(zIndex)||CB_GraphicSprites.ZINDEX_DEFAULT||1
|
13882 |
|
13883 | </td>
|
13884 |
|
13885 |
|
13886 | <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 z-index value we want. It must be a number but never zero (0). If no valid number is given, it will use the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or 1 otherwise.</p></td>
|
13887 | </tr>
|
13888 |
|
13889 |
|
13890 | </tbody>
|
13891 | </table>
|
13892 |
|
13893 |
|
13894 |
|
13895 |
|
13896 | <dl class="details">
|
13897 |
|
13898 |
|
13899 |
|
13900 |
|
13901 |
|
13902 |
|
13903 |
|
13904 |
|
13905 |
|
13906 |
|
13907 |
|
13908 |
|
13909 |
|
13910 |
|
13911 |
|
13912 |
|
13913 |
|
13914 |
|
13915 |
|
13916 |
|
13917 |
|
13918 |
|
13919 |
|
13920 |
|
13921 |
|
13922 |
|
13923 |
|
13924 |
|
13925 |
|
13926 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13927 | <dd class="tag-source">
|
13928 | <ul class="dummy">
|
13929 | <li>
|
13930 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
13931 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1474">line 1474</a>
|
13932 | </li>
|
13933 | </ul>
|
13934 | </dd>
|
13935 |
|
13936 |
|
13937 |
|
13938 |
|
13939 |
|
13940 |
|
13941 |
|
13942 | </dl>
|
13943 |
|
13944 |
|
13945 |
|
13946 |
|
13947 |
|
13948 |
|
13949 |
|
13950 |
|
13951 |
|
13952 |
|
13953 |
|
13954 |
|
13955 |
|
13956 | <h5>Returns:</h5>
|
13957 |
|
13958 |
|
13959 | <div class="param-desc">
|
13960 | <p>Returns the z-index ("zIndex") of the given sprite after setting it (it could have been sanitized).</p>
|
13961 | </div>
|
13962 |
|
13963 |
|
13964 |
|
13965 | <dl>
|
13966 | <dt>
|
13967 | Type
|
13968 | </dt>
|
13969 | <dd>
|
13970 |
|
13971 | <span class="param-type">number</span>
|
13972 |
|
13973 |
|
13974 |
|
13975 | </dd>
|
13976 | </dl>
|
13977 |
|
13978 |
|
13979 |
|
13980 |
|
13981 |
|
13982 | </dd>
|
13983 |
|
13984 |
|
13985 |
|
13986 | <hr>
|
13987 | <dt>
|
13988 | <h4 class="name" id="setZIndexSubSprite"><span class="type-signature"></span>setZIndexSubSprite<span class="signature">(sprite [, zIndex])</span><span class="type-signature"> → {number}</span></h4>
|
13989 |
|
13990 |
|
13991 | </dt>
|
13992 | <dd>
|
13993 |
|
13994 |
|
13995 | <div class="description">
|
13996 | <p>Sets the desired z-index ("zIndex") of the given sub-sprite object. Calls the <a href="CB_GraphicSprites.html#updateSubSpritesByZIndex"><code>CB_GraphicSprites#updateSubSpritesByZIndex</code></a> method internally.</p>
|
13997 | </div>
|
13998 |
|
13999 |
|
14000 |
|
14001 |
|
14002 |
|
14003 |
|
14004 |
|
14005 |
|
14006 | <h5>Parameters:</h5>
|
14007 |
|
14008 |
|
14009 | <table class="params table table-striped">
|
14010 | <thead>
|
14011 | <tr>
|
14012 |
|
14013 | <th style="width:12%; min-width:110px;">Name</th>
|
14014 |
|
14015 |
|
14016 | <th style="width:12%; min-width:110px;">Type</th>
|
14017 |
|
14018 |
|
14019 | <th style="width:12%; min-width:110px;">Argument</th>
|
14020 |
|
14021 |
|
14022 |
|
14023 | <th style="width:12%; min-width:110px;">Default</th>
|
14024 |
|
14025 |
|
14026 | <th class="last" style="min-width:310px;">Description</th>
|
14027 | </tr>
|
14028 | </thead>
|
14029 |
|
14030 | <tbody>
|
14031 |
|
14032 |
|
14033 | <tr>
|
14034 |
|
14035 | <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>sprite</code></td>
|
14036 |
|
14037 |
|
14038 | <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;">
|
14039 |
|
14040 |
|
14041 | <span class="param-type"><a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT">CB_GraphicSprites.SUBSPRITE_OBJECT</a></span>
|
14042 |
|
14043 |
|
14044 |
|
14045 |
|
14046 | </td>
|
14047 |
|
14048 |
|
14049 | <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;">
|
14050 |
|
14051 |
|
14052 |
|
14053 |
|
14054 |
|
14055 | </td>
|
14056 |
|
14057 |
|
14058 |
|
14059 | <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;">
|
14060 |
|
14061 | </td>
|
14062 |
|
14063 |
|
14064 | <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 <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object which contains the sub-sprite.</p></td>
|
14065 | </tr>
|
14066 |
|
14067 |
|
14068 |
|
14069 | <tr>
|
14070 |
|
14071 | <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>zIndex</code></td>
|
14072 |
|
14073 |
|
14074 | <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;">
|
14075 |
|
14076 |
|
14077 | <span class="param-type">number</span>
|
14078 |
|
14079 |
|
14080 |
|
14081 |
|
14082 | </td>
|
14083 |
|
14084 |
|
14085 | <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;">
|
14086 |
|
14087 | <optional><br>
|
14088 |
|
14089 |
|
14090 |
|
14091 |
|
14092 |
|
14093 | </td>
|
14094 |
|
14095 |
|
14096 |
|
14097 | <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;">
|
14098 |
|
14099 | parseFloat(zIndex)||CB_GraphicSprites.ZINDEX_DEFAULT||0
|
14100 |
|
14101 | </td>
|
14102 |
|
14103 |
|
14104 | <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 z-index value we want. It must be a number but never zero (0). If no valid number is given, it will use the value of the <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a> property of evaluates to true or 1 otherwise.</p></td>
|
14105 | </tr>
|
14106 |
|
14107 |
|
14108 | </tbody>
|
14109 | </table>
|
14110 |
|
14111 |
|
14112 |
|
14113 |
|
14114 | <dl class="details">
|
14115 |
|
14116 |
|
14117 |
|
14118 |
|
14119 |
|
14120 |
|
14121 |
|
14122 |
|
14123 |
|
14124 |
|
14125 |
|
14126 |
|
14127 |
|
14128 |
|
14129 |
|
14130 |
|
14131 |
|
14132 |
|
14133 |
|
14134 |
|
14135 |
|
14136 |
|
14137 |
|
14138 |
|
14139 |
|
14140 |
|
14141 |
|
14142 |
|
14143 |
|
14144 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
14145 | <dd class="tag-source">
|
14146 | <ul class="dummy">
|
14147 | <li>
|
14148 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
14149 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1508">line 1508</a>
|
14150 | </li>
|
14151 | </ul>
|
14152 | </dd>
|
14153 |
|
14154 |
|
14155 |
|
14156 |
|
14157 |
|
14158 |
|
14159 |
|
14160 | </dl>
|
14161 |
|
14162 |
|
14163 |
|
14164 |
|
14165 |
|
14166 |
|
14167 |
|
14168 |
|
14169 |
|
14170 |
|
14171 |
|
14172 |
|
14173 |
|
14174 | <h5>Returns:</h5>
|
14175 |
|
14176 |
|
14177 | <div class="param-desc">
|
14178 | <p>Returns the z-index ("zIndex") of the given sub-sprite after setting it (it could have been sanitized).</p>
|
14179 | </div>
|
14180 |
|
14181 |
|
14182 |
|
14183 | <dl>
|
14184 | <dt>
|
14185 | Type
|
14186 | </dt>
|
14187 | <dd>
|
14188 |
|
14189 | <span class="param-type">number</span>
|
14190 |
|
14191 |
|
14192 |
|
14193 | </dd>
|
14194 | </dl>
|
14195 |
|
14196 |
|
14197 |
|
14198 |
|
14199 |
|
14200 | </dd>
|
14201 |
|
14202 |
|
14203 |
|
14204 | <hr>
|
14205 | <dt>
|
14206 | <h4 class="name" id="updateSpritesByZIndex"><span class="type-signature"></span>updateSpritesByZIndex<span class="signature">()</span><span class="type-signature"> → {array}</span></h4>
|
14207 |
|
14208 |
|
14209 | </dt>
|
14210 | <dd>
|
14211 |
|
14212 |
|
14213 | <div class="description">
|
14214 | <p>Updates (sorts again) the "spritesByZIndex" property (which is an array with the sprites ordered by z-index, whose data comes from the array in the "sprites" property of the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> object) of the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> object.</p>
|
14215 | </div>
|
14216 |
|
14217 |
|
14218 |
|
14219 |
|
14220 |
|
14221 |
|
14222 |
|
14223 |
|
14224 |
|
14225 |
|
14226 | <dl class="details">
|
14227 |
|
14228 |
|
14229 |
|
14230 |
|
14231 |
|
14232 |
|
14233 |
|
14234 |
|
14235 |
|
14236 |
|
14237 |
|
14238 |
|
14239 |
|
14240 |
|
14241 |
|
14242 |
|
14243 |
|
14244 |
|
14245 |
|
14246 |
|
14247 |
|
14248 |
|
14249 |
|
14250 |
|
14251 |
|
14252 |
|
14253 |
|
14254 |
|
14255 |
|
14256 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
14257 | <dd class="tag-source">
|
14258 | <ul class="dummy">
|
14259 | <li>
|
14260 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
14261 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-565">line 565</a>
|
14262 | </li>
|
14263 | </ul>
|
14264 | </dd>
|
14265 |
|
14266 |
|
14267 |
|
14268 |
|
14269 |
|
14270 |
|
14271 |
|
14272 | </dl>
|
14273 |
|
14274 |
|
14275 |
|
14276 |
|
14277 |
|
14278 |
|
14279 |
|
14280 |
|
14281 |
|
14282 |
|
14283 |
|
14284 |
|
14285 |
|
14286 | <h5>Returns:</h5>
|
14287 |
|
14288 |
|
14289 | <div class="param-desc">
|
14290 | <p>Returns the "spritesByZIndex" array of the <a href="CB_GraphicSprites.html#spritesGroup"><code>CB_GraphicSprites#spritesGroup</code></a> object after updating it. Returns null if the property could not be obtained or updated.</p>
|
14291 | </div>
|
14292 |
|
14293 |
|
14294 |
|
14295 | <dl>
|
14296 | <dt>
|
14297 | Type
|
14298 | </dt>
|
14299 | <dd>
|
14300 |
|
14301 | <span class="param-type">array</span>
|
14302 |
|
14303 |
|
14304 |
|
14305 | </dd>
|
14306 | </dl>
|
14307 |
|
14308 |
|
14309 |
|
14310 |
|
14311 |
|
14312 | </dd>
|
14313 |
|
14314 |
|
14315 |
|
14316 | <hr>
|
14317 | <dt>
|
14318 | <h4 class="name" id="updateSubSpritesByZIndex"><span class="type-signature"></span>updateSubSpritesByZIndex<span class="signature">( [sprite])</span><span class="type-signature"> → {array}</span></h4>
|
14319 |
|
14320 |
|
14321 | </dt>
|
14322 | <dd>
|
14323 |
|
14324 |
|
14325 | <div class="description">
|
14326 | <p>Updates (sorts again) the "subSpritesByZIndex" property (which is an array with the sub-sprites ordered by z-index, whose data comes from the array in the "subSprites" property of the given <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object)) of the desired sprite.</p>
|
14327 | </div>
|
14328 |
|
14329 |
|
14330 |
|
14331 |
|
14332 |
|
14333 |
|
14334 |
|
14335 |
|
14336 | <h5>Parameters:</h5>
|
14337 |
|
14338 |
|
14339 | <table class="params table table-striped">
|
14340 | <thead>
|
14341 | <tr>
|
14342 |
|
14343 | <th style="width:12%; min-width:110px;">Name</th>
|
14344 |
|
14345 |
|
14346 | <th style="width:12%; min-width:110px;">Type</th>
|
14347 |
|
14348 |
|
14349 | <th style="width:12%; min-width:110px;">Argument</th>
|
14350 |
|
14351 |
|
14352 |
|
14353 | <th style="width:12%; min-width:110px;">Default</th>
|
14354 |
|
14355 |
|
14356 | <th class="last" style="min-width:310px;">Description</th>
|
14357 | </tr>
|
14358 | </thead>
|
14359 |
|
14360 | <tbody>
|
14361 |
|
14362 |
|
14363 | <tr>
|
14364 |
|
14365 | <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>sprite</code></td>
|
14366 |
|
14367 |
|
14368 | <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;">
|
14369 |
|
14370 |
|
14371 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
14372 |
|
14373 |
|
14374 |
|
14375 |
|
14376 | </td>
|
14377 |
|
14378 |
|
14379 | <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;">
|
14380 |
|
14381 | <optional><br>
|
14382 |
|
14383 |
|
14384 |
|
14385 |
|
14386 |
|
14387 | </td>
|
14388 |
|
14389 |
|
14390 |
|
14391 | <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;">
|
14392 |
|
14393 | CB_GraphicSprites#getCurrent()
|
14394 |
|
14395 | </td>
|
14396 |
|
14397 |
|
14398 | <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 sprite whose sub-sprites we want to remove. If not provided, it will use the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object which the pointer (set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property) is currently pointing to (using the returning value of the <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> method internally).</p></td>
|
14399 | </tr>
|
14400 |
|
14401 |
|
14402 | </tbody>
|
14403 | </table>
|
14404 |
|
14405 |
|
14406 |
|
14407 |
|
14408 | <dl class="details">
|
14409 |
|
14410 |
|
14411 |
|
14412 |
|
14413 |
|
14414 |
|
14415 |
|
14416 |
|
14417 |
|
14418 |
|
14419 |
|
14420 |
|
14421 |
|
14422 |
|
14423 |
|
14424 |
|
14425 |
|
14426 |
|
14427 |
|
14428 |
|
14429 |
|
14430 |
|
14431 |
|
14432 |
|
14433 |
|
14434 |
|
14435 |
|
14436 |
|
14437 |
|
14438 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
14439 | <dd class="tag-source">
|
14440 | <ul class="dummy">
|
14441 | <li>
|
14442 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
14443 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-822">line 822</a>
|
14444 | </li>
|
14445 | </ul>
|
14446 | </dd>
|
14447 |
|
14448 |
|
14449 |
|
14450 |
|
14451 |
|
14452 |
|
14453 |
|
14454 | </dl>
|
14455 |
|
14456 |
|
14457 |
|
14458 |
|
14459 |
|
14460 |
|
14461 |
|
14462 |
|
14463 |
|
14464 |
|
14465 |
|
14466 |
|
14467 |
|
14468 | <h5>Returns:</h5>
|
14469 |
|
14470 |
|
14471 | <div class="param-desc">
|
14472 | <p>Returns the "subSpritesByZIndex" array after updating it. Returns null if the property could not be obtained or updated.</p>
|
14473 | </div>
|
14474 |
|
14475 |
|
14476 |
|
14477 | <dl>
|
14478 | <dt>
|
14479 | Type
|
14480 | </dt>
|
14481 | <dd>
|
14482 |
|
14483 | <span class="param-type">array</span>
|
14484 |
|
14485 |
|
14486 |
|
14487 | </dd>
|
14488 | </dl>
|
14489 |
|
14490 |
|
14491 |
|
14492 |
|
14493 |
|
14494 | </dd>
|
14495 |
|
14496 |
|
14497 |
|
14498 | <hr>
|
14499 | <dt>
|
14500 | <h4 class="name" id=".clearReferences"><span class="type-signature"><static> </span>clearReferences<span class="signature">(element)</span><span class="type-signature"> → {*}</span></h4>
|
14501 |
|
14502 |
|
14503 | </dt>
|
14504 | <dd>
|
14505 |
|
14506 |
|
14507 | <div class="description">
|
14508 | <p>Clears the "container", the "parent" and the "data.that" properties (sets to null) of the given object and its sub-objects (works recursively, internally).</p>
|
14509 | </div>
|
14510 |
|
14511 |
|
14512 |
|
14513 |
|
14514 |
|
14515 |
|
14516 |
|
14517 |
|
14518 | <h5>Parameters:</h5>
|
14519 |
|
14520 |
|
14521 | <table class="params table table-striped">
|
14522 | <thead>
|
14523 | <tr>
|
14524 |
|
14525 | <th style="width:12%; min-width:110px;">Name</th>
|
14526 |
|
14527 |
|
14528 | <th style="width:12%; min-width:110px;">Type</th>
|
14529 |
|
14530 |
|
14531 |
|
14532 |
|
14533 |
|
14534 | <th class="last" style="min-width:310px;">Description</th>
|
14535 | </tr>
|
14536 | </thead>
|
14537 |
|
14538 | <tbody>
|
14539 |
|
14540 |
|
14541 | <tr>
|
14542 |
|
14543 | <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>element</code></td>
|
14544 |
|
14545 |
|
14546 | <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;">
|
14547 |
|
14548 |
|
14549 | <span class="param-type">*</span>
|
14550 |
|
14551 |
|
14552 |
|
14553 |
|
14554 | </td>
|
14555 |
|
14556 |
|
14557 |
|
14558 |
|
14559 |
|
14560 | <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 whose properties we want to clear. It can be different kinds (<a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a>, <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a>, <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a>, <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a>, <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a>, <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a>, etc.).</p></td>
|
14561 | </tr>
|
14562 |
|
14563 |
|
14564 | </tbody>
|
14565 | </table>
|
14566 |
|
14567 |
|
14568 |
|
14569 |
|
14570 | <dl class="details">
|
14571 |
|
14572 |
|
14573 |
|
14574 |
|
14575 |
|
14576 |
|
14577 |
|
14578 |
|
14579 |
|
14580 |
|
14581 |
|
14582 |
|
14583 |
|
14584 |
|
14585 |
|
14586 |
|
14587 |
|
14588 |
|
14589 |
|
14590 |
|
14591 |
|
14592 |
|
14593 |
|
14594 |
|
14595 |
|
14596 |
|
14597 |
|
14598 |
|
14599 |
|
14600 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
14601 | <dd class="tag-source">
|
14602 | <ul class="dummy">
|
14603 | <li>
|
14604 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
14605 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1844">line 1844</a>
|
14606 | </li>
|
14607 | </ul>
|
14608 | </dd>
|
14609 |
|
14610 |
|
14611 |
|
14612 |
|
14613 |
|
14614 |
|
14615 |
|
14616 | </dl>
|
14617 |
|
14618 |
|
14619 |
|
14620 |
|
14621 |
|
14622 |
|
14623 |
|
14624 |
|
14625 |
|
14626 |
|
14627 |
|
14628 |
|
14629 |
|
14630 | <h5>Returns:</h5>
|
14631 |
|
14632 |
|
14633 | <div class="param-desc">
|
14634 | <p>Returns the same object with the the "container", the "parent", "data.that" and the "data.getThis" properties cleared (set to null), if possible.</p>
|
14635 | </div>
|
14636 |
|
14637 |
|
14638 |
|
14639 | <dl>
|
14640 | <dt>
|
14641 | Type
|
14642 | </dt>
|
14643 | <dd>
|
14644 |
|
14645 | <span class="param-type">*</span>
|
14646 |
|
14647 |
|
14648 |
|
14649 | </dd>
|
14650 | </dl>
|
14651 |
|
14652 |
|
14653 |
|
14654 |
|
14655 |
|
14656 | </dd>
|
14657 |
|
14658 |
|
14659 |
|
14660 | <hr>
|
14661 | <dt>
|
14662 | <h4 class="name" id=".filterProperties"><span class="type-signature"><static> </span>filterProperties<span class="signature">(element [, propertiesToKeepObject])</span><span class="type-signature"> → {*}</span></h4>
|
14663 |
|
14664 |
|
14665 | </dt>
|
14666 | <dd>
|
14667 |
|
14668 |
|
14669 | <div class="description">
|
14670 | <p>Gets a new object with the properties filtered of a given element and its sub-elements, keeping only the ones that are in the given "propertiesToKeepObject" (works recursively, internally).</p>
|
14671 | </div>
|
14672 |
|
14673 |
|
14674 |
|
14675 |
|
14676 |
|
14677 |
|
14678 |
|
14679 |
|
14680 | <h5>Parameters:</h5>
|
14681 |
|
14682 |
|
14683 | <table class="params table table-striped">
|
14684 | <thead>
|
14685 | <tr>
|
14686 |
|
14687 | <th style="width:12%; min-width:110px;">Name</th>
|
14688 |
|
14689 |
|
14690 | <th style="width:12%; min-width:110px;">Type</th>
|
14691 |
|
14692 |
|
14693 | <th style="width:12%; min-width:110px;">Argument</th>
|
14694 |
|
14695 |
|
14696 |
|
14697 | <th style="width:12%; min-width:110px;">Default</th>
|
14698 |
|
14699 |
|
14700 | <th class="last" style="min-width:310px;">Description</th>
|
14701 | </tr>
|
14702 | </thead>
|
14703 |
|
14704 | <tbody>
|
14705 |
|
14706 |
|
14707 | <tr>
|
14708 |
|
14709 | <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>element</code></td>
|
14710 |
|
14711 |
|
14712 | <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;">
|
14713 |
|
14714 |
|
14715 | <span class="param-type">*</span>
|
14716 |
|
14717 |
|
14718 |
|
14719 |
|
14720 | </td>
|
14721 |
|
14722 |
|
14723 | <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;">
|
14724 |
|
14725 |
|
14726 |
|
14727 |
|
14728 |
|
14729 | </td>
|
14730 |
|
14731 |
|
14732 |
|
14733 | <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;">
|
14734 |
|
14735 | </td>
|
14736 |
|
14737 |
|
14738 | <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 whose properties we want to clear. It can be different kinds (<a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a>, <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a>, <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a>, <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a>, <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a>, <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a>, etc.).</p></td>
|
14739 | </tr>
|
14740 |
|
14741 |
|
14742 |
|
14743 | <tr>
|
14744 |
|
14745 | <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>
|
14746 |
|
14747 |
|
14748 | <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;">
|
14749 |
|
14750 |
|
14751 | <span class="param-type"><a href="CB_GraphicSprites.html#.filterProperties_propertiesToKeepObject_TYPE">CB_GraphicSprites.filterProperties_propertiesToKeepObject_TYPE</a></span>
|
14752 |
|
14753 |
|
14754 |
|
14755 |
|
14756 | </td>
|
14757 |
|
14758 |
|
14759 | <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;">
|
14760 |
|
14761 | <optional><br>
|
14762 |
|
14763 |
|
14764 |
|
14765 |
|
14766 |
|
14767 | </td>
|
14768 |
|
14769 |
|
14770 |
|
14771 | <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;">
|
14772 |
|
14773 | CB_GraphicSprites.filterProperties_DEFAULT_PROPERTIES
|
14774 |
|
14775 | </td>
|
14776 |
|
14777 |
|
14778 | <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.</p></td>
|
14779 | </tr>
|
14780 |
|
14781 |
|
14782 | </tbody>
|
14783 | </table>
|
14784 |
|
14785 |
|
14786 |
|
14787 |
|
14788 | <dl class="details">
|
14789 |
|
14790 |
|
14791 |
|
14792 |
|
14793 |
|
14794 |
|
14795 |
|
14796 |
|
14797 |
|
14798 |
|
14799 |
|
14800 |
|
14801 |
|
14802 |
|
14803 |
|
14804 |
|
14805 |
|
14806 |
|
14807 |
|
14808 |
|
14809 |
|
14810 |
|
14811 |
|
14812 |
|
14813 |
|
14814 |
|
14815 |
|
14816 |
|
14817 |
|
14818 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
14819 | <dd class="tag-source">
|
14820 | <ul class="dummy">
|
14821 | <li>
|
14822 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
14823 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1914">line 1914</a>
|
14824 | </li>
|
14825 | </ul>
|
14826 | </dd>
|
14827 |
|
14828 |
|
14829 |
|
14830 |
|
14831 |
|
14832 |
|
14833 |
|
14834 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
14835 | <dd class="tag-todo">
|
14836 | <ul>
|
14837 | <li>Implement a boolean property and when it is true it will not keep the properties whose values are the default ones (for example, if "byReference" property is false it will not be kept as it is its default value). So the output can be reduced this way.</li>
|
14838 | </ul>
|
14839 | </dd>
|
14840 |
|
14841 | </dl>
|
14842 |
|
14843 |
|
14844 |
|
14845 |
|
14846 |
|
14847 |
|
14848 |
|
14849 |
|
14850 |
|
14851 |
|
14852 |
|
14853 |
|
14854 |
|
14855 | <h5>Returns:</h5>
|
14856 |
|
14857 |
|
14858 | <div class="param-desc">
|
14859 | <p>Returns a new object with the properties filtered of a given element and its sub-elements, keeping only the ones that are in the given "propertiesToKeepObject". If no valid "element" is provided, returns null.</p>
|
14860 | </div>
|
14861 |
|
14862 |
|
14863 |
|
14864 | <dl>
|
14865 | <dt>
|
14866 | Type
|
14867 | </dt>
|
14868 | <dd>
|
14869 |
|
14870 | <span class="param-type">*</span>
|
14871 |
|
14872 |
|
14873 |
|
14874 | </dd>
|
14875 | </dl>
|
14876 |
|
14877 |
|
14878 |
|
14879 |
|
14880 |
|
14881 | </dd>
|
14882 |
|
14883 | </dl>
|
14884 |
|
14885 |
|
14886 |
|
14887 | <h3 class="subsection-title">Type Definitions</h3>
|
14888 |
|
14889 | <dl>
|
14890 |
|
14891 | <hr>
|
14892 | <dt class="name" id=".SPRITES_OBJECT">
|
14893 | <h4 id=".SPRITES_OBJECT">SPRITES_OBJECT</h4>
|
14894 |
|
14895 |
|
14896 | </dt>
|
14897 | <dd>
|
14898 |
|
14899 | <div class="description">
|
14900 | <p>An object with the information that belongs to a group of graphic sprites.</p>
|
14901 | </div>
|
14902 |
|
14903 |
|
14904 |
|
14905 | <h5>Type:</h5>
|
14906 | <ul>
|
14907 | <li>
|
14908 |
|
14909 | <span class="param-type">Object</span>
|
14910 |
|
14911 |
|
14912 |
|
14913 | </li>
|
14914 | </ul>
|
14915 |
|
14916 |
|
14917 |
|
14918 | <dl class="details">
|
14919 |
|
14920 |
|
14921 | <h5 class="subsection-title">Properties:</h5>
|
14922 |
|
14923 | <dl>
|
14924 |
|
14925 | <table class="props table table-striped">
|
14926 | <thead>
|
14927 | <tr>
|
14928 |
|
14929 | <th>Name</th>
|
14930 |
|
14931 |
|
14932 | <th>Type</th>
|
14933 |
|
14934 |
|
14935 | <th>Argument</th>
|
14936 |
|
14937 |
|
14938 |
|
14939 | <th>Default</th>
|
14940 |
|
14941 |
|
14942 | <th class="last">Description</th>
|
14943 | </tr>
|
14944 | </thead>
|
14945 |
|
14946 | <tbody>
|
14947 |
|
14948 |
|
14949 | <tr>
|
14950 |
|
14951 | <td class="name"><code>id</code></td>
|
14952 |
|
14953 |
|
14954 | <td class="type">
|
14955 |
|
14956 |
|
14957 | <span class="param-type">string</span>
|
14958 | |
|
14959 |
|
14960 | <span class="param-type">*</span>
|
14961 |
|
14962 |
|
14963 |
|
14964 |
|
14965 | </td>
|
14966 |
|
14967 |
|
14968 | <td class="attributes">
|
14969 |
|
14970 | <optional><br>
|
14971 |
|
14972 |
|
14973 |
|
14974 | </td>
|
14975 |
|
14976 |
|
14977 |
|
14978 | <td class="default">
|
14979 |
|
14980 | 'CB_GraphicSprites_' + CB_GraphicSprites._idUnique++
|
14981 |
|
14982 | </td>
|
14983 |
|
14984 |
|
14985 | <td class="description last"><p>Identifier of the group of graphic sprites (also used as the <code>CB_GraphicSprites.id</code> property for the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</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>
|
14986 | </tr>
|
14987 |
|
14988 |
|
14989 |
|
14990 | <tr>
|
14991 |
|
14992 | <td class="name"><code>src</code></td>
|
14993 |
|
14994 |
|
14995 | <td class="type">
|
14996 |
|
14997 |
|
14998 | <span class="param-type">*</span>
|
14999 |
|
15000 |
|
15001 |
|
15002 |
|
15003 | </td>
|
15004 |
|
15005 |
|
15006 | <td class="attributes">
|
15007 |
|
15008 | <optional><br>
|
15009 |
|
15010 |
|
15011 |
|
15012 | </td>
|
15013 |
|
15014 |
|
15015 |
|
15016 | <td class="default">
|
15017 |
|
15018 | ""
|
15019 |
|
15020 | </td>
|
15021 |
|
15022 |
|
15023 | <td class="description last"><p>Source of origin. Can be a path or identifier of an image, text, bitmap, 3D object, etc. They can be used for any kind of source you may think of, including (but not limited to) one sprites sheet or more, one atlas or more, etc. or even a mix of all of them.</p></td>
|
15024 | </tr>
|
15025 |
|
15026 |
|
15027 |
|
15028 | <tr>
|
15029 |
|
15030 | <td class="name"><code>srcType</code></td>
|
15031 |
|
15032 |
|
15033 | <td class="type">
|
15034 |
|
15035 |
|
15036 | <span class="param-type">string</span>
|
15037 |
|
15038 |
|
15039 |
|
15040 |
|
15041 | </td>
|
15042 |
|
15043 |
|
15044 | <td class="attributes">
|
15045 |
|
15046 | <optional><br>
|
15047 |
|
15048 |
|
15049 |
|
15050 | </td>
|
15051 |
|
15052 |
|
15053 |
|
15054 | <td class="default">
|
15055 |
|
15056 | <a href="CB_GraphicSprites.html#.SRC_TYPES_DEFAULT"><code>CB_GraphicSprites.SRC_TYPES_DEFAULT</code></a>
|
15057 |
|
15058 | </td>
|
15059 |
|
15060 |
|
15061 | <td class="description last"><p>Type of the source of origin. 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>
|
15062 | </tr>
|
15063 |
|
15064 |
|
15065 |
|
15066 | <tr>
|
15067 |
|
15068 | <td class="name"><code>srcLeft</code></td>
|
15069 |
|
15070 |
|
15071 | <td class="type">
|
15072 |
|
15073 |
|
15074 | <span class="param-type">number</span>
|
15075 |
|
15076 |
|
15077 |
|
15078 |
|
15079 | </td>
|
15080 |
|
15081 |
|
15082 | <td class="attributes">
|
15083 |
|
15084 | <optional><br>
|
15085 |
|
15086 |
|
15087 |
|
15088 | </td>
|
15089 |
|
15090 |
|
15091 |
|
15092 | <td class="default">
|
15093 |
|
15094 | <a href="CB_GraphicSprites.html#.LEFT_SOURCE_DEFAULT"><code>CB_GraphicSprites.LEFT_SOURCE_DEFAULT</code></a>
|
15095 |
|
15096 | </td>
|
15097 |
|
15098 |
|
15099 | <td class="description last"><p>Left (horizontal) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.LEFT_SOURCE_DEFAULT"><code>CB_GraphicSprites.LEFT_SOURCE_DEFAULT</code></a>.</p></td>
|
15100 | </tr>
|
15101 |
|
15102 |
|
15103 |
|
15104 | <tr>
|
15105 |
|
15106 | <td class="name"><code>srcTop</code></td>
|
15107 |
|
15108 |
|
15109 | <td class="type">
|
15110 |
|
15111 |
|
15112 | <span class="param-type">number</span>
|
15113 |
|
15114 |
|
15115 |
|
15116 |
|
15117 | </td>
|
15118 |
|
15119 |
|
15120 | <td class="attributes">
|
15121 |
|
15122 | <optional><br>
|
15123 |
|
15124 |
|
15125 |
|
15126 | </td>
|
15127 |
|
15128 |
|
15129 |
|
15130 | <td class="default">
|
15131 |
|
15132 | <a href="CB_GraphicSprites.html#.TOP_SOURCE_DEFAULT"><code>CB_GraphicSprites.TOP_SOURCE_DEFAULT</code></a>
|
15133 |
|
15134 | </td>
|
15135 |
|
15136 |
|
15137 | <td class="description last"><p>Top (vertical) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.TOP_SOURCE_DEFAULT"><code>CB_GraphicSprites.TOP_SOURCE_DEFAULT</code></a>.</p></td>
|
15138 | </tr>
|
15139 |
|
15140 |
|
15141 |
|
15142 | <tr>
|
15143 |
|
15144 | <td class="name"><code>srcWidth</code></td>
|
15145 |
|
15146 |
|
15147 | <td class="type">
|
15148 |
|
15149 |
|
15150 | <span class="param-type">number</span>
|
15151 |
|
15152 |
|
15153 |
|
15154 |
|
15155 | </td>
|
15156 |
|
15157 |
|
15158 | <td class="attributes">
|
15159 |
|
15160 | <optional><br>
|
15161 |
|
15162 |
|
15163 |
|
15164 | </td>
|
15165 |
|
15166 |
|
15167 |
|
15168 | <td class="default">
|
15169 |
|
15170 | <a href="CB_GraphicSprites.html#.WIDTH_SOURCE_DEFAULT"><code>CB_GraphicSprites.WIDTH_SOURCE_DEFAULT</code></a>
|
15171 |
|
15172 | </td>
|
15173 |
|
15174 |
|
15175 | <td class="description last"><p>Width of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.WIDTH_SOURCE_DEFAULT"><code>CB_GraphicSprites.WIDTH_SOURCE_DEFAULT</code></a>.</p></td>
|
15176 | </tr>
|
15177 |
|
15178 |
|
15179 |
|
15180 | <tr>
|
15181 |
|
15182 | <td class="name"><code>srcHeight</code></td>
|
15183 |
|
15184 |
|
15185 | <td class="type">
|
15186 |
|
15187 |
|
15188 | <span class="param-type">number</span>
|
15189 |
|
15190 |
|
15191 |
|
15192 |
|
15193 | </td>
|
15194 |
|
15195 |
|
15196 | <td class="attributes">
|
15197 |
|
15198 | <optional><br>
|
15199 |
|
15200 |
|
15201 |
|
15202 | </td>
|
15203 |
|
15204 |
|
15205 |
|
15206 | <td class="default">
|
15207 |
|
15208 | <a href="CB_GraphicSprites.html#.HEIGHT_SOURCE_DEFAULT"><code>CB_GraphicSprites.HEIGHT_SOURCE_DEFAULT</code></a>
|
15209 |
|
15210 | </td>
|
15211 |
|
15212 |
|
15213 | <td class="description last"><p>Height of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.HEIGHT_SOURCE_DEFAULT"><code>CB_GraphicSprites.HEIGHT_SOURCE_DEFAULT</code></a>.</p></td>
|
15214 | </tr>
|
15215 |
|
15216 |
|
15217 |
|
15218 | <tr>
|
15219 |
|
15220 | <td class="name"><code>left</code></td>
|
15221 |
|
15222 |
|
15223 | <td class="type">
|
15224 |
|
15225 |
|
15226 | <span class="param-type">number</span>
|
15227 |
|
15228 |
|
15229 |
|
15230 |
|
15231 | </td>
|
15232 |
|
15233 |
|
15234 | <td class="attributes">
|
15235 |
|
15236 | <optional><br>
|
15237 |
|
15238 |
|
15239 |
|
15240 | </td>
|
15241 |
|
15242 |
|
15243 |
|
15244 | <td class="default">
|
15245 |
|
15246 | <a href="CB_GraphicSprites.html#.LEFT_DEFAULT"><code>CB_GraphicSprites.LEFT_DEFAULT</code></a>
|
15247 |
|
15248 | </td>
|
15249 |
|
15250 |
|
15251 | <td class="description last"><p>Left (horizontal) position in the destiny. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.LEFT_DEFAULT"><code>CB_GraphicSprites.LEFT_DEFAULT</code></a>.</p></td>
|
15252 | </tr>
|
15253 |
|
15254 |
|
15255 |
|
15256 | <tr>
|
15257 |
|
15258 | <td class="name"><code>top</code></td>
|
15259 |
|
15260 |
|
15261 | <td class="type">
|
15262 |
|
15263 |
|
15264 | <span class="param-type">number</span>
|
15265 |
|
15266 |
|
15267 |
|
15268 |
|
15269 | </td>
|
15270 |
|
15271 |
|
15272 | <td class="attributes">
|
15273 |
|
15274 | <optional><br>
|
15275 |
|
15276 |
|
15277 |
|
15278 | </td>
|
15279 |
|
15280 |
|
15281 |
|
15282 | <td class="default">
|
15283 |
|
15284 | <a href="CB_GraphicSprites.html#.TOP_DEFAULT"><code>CB_GraphicSprites.TOP_DEFAULT</code></a>
|
15285 |
|
15286 | </td>
|
15287 |
|
15288 |
|
15289 | <td class="description last"><p>Top (vertical) position in the destiny. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.TOP_DEFAULT"><code>CB_GraphicSprites.TOP_DEFAULT</code></a>.</p></td>
|
15290 | </tr>
|
15291 |
|
15292 |
|
15293 |
|
15294 | <tr>
|
15295 |
|
15296 | <td class="name"><code>width</code></td>
|
15297 |
|
15298 |
|
15299 | <td class="type">
|
15300 |
|
15301 |
|
15302 | <span class="param-type">number</span>
|
15303 |
|
15304 |
|
15305 |
|
15306 |
|
15307 | </td>
|
15308 |
|
15309 |
|
15310 | <td class="attributes">
|
15311 |
|
15312 | <optional><br>
|
15313 |
|
15314 |
|
15315 |
|
15316 | </td>
|
15317 |
|
15318 |
|
15319 |
|
15320 | <td class="default">
|
15321 |
|
15322 | <a href="CB_GraphicSprites.html#.WIDTH_DEFAULT"><code>CB_GraphicSprites.WIDTH_DEFAULT</code></a>
|
15323 |
|
15324 | </td>
|
15325 |
|
15326 |
|
15327 | <td class="description last"><p>Width of the destiny. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.WIDTH_DEFAULT"><code>CB_GraphicSprites.WIDTH_DEFAULT</code></a>.</p></td>
|
15328 | </tr>
|
15329 |
|
15330 |
|
15331 |
|
15332 | <tr>
|
15333 |
|
15334 | <td class="name"><code>height</code></td>
|
15335 |
|
15336 |
|
15337 | <td class="type">
|
15338 |
|
15339 |
|
15340 | <span class="param-type">number</span>
|
15341 |
|
15342 |
|
15343 |
|
15344 |
|
15345 | </td>
|
15346 |
|
15347 |
|
15348 | <td class="attributes">
|
15349 |
|
15350 | <optional><br>
|
15351 |
|
15352 |
|
15353 |
|
15354 | </td>
|
15355 |
|
15356 |
|
15357 |
|
15358 | <td class="default">
|
15359 |
|
15360 | <a href="CB_GraphicSprites.html#.HEIGHT_DEFAULT"><code>CB_GraphicSprites.HEIGHT_DEFAULT</code></a>
|
15361 |
|
15362 | </td>
|
15363 |
|
15364 |
|
15365 | <td class="description last"><p>Height of the destiny. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.HEIGHT_DEFAULT"><code>CB_GraphicSprites.HEIGHT_DEFAULT</code></a>.</p></td>
|
15366 | </tr>
|
15367 |
|
15368 |
|
15369 |
|
15370 | <tr>
|
15371 |
|
15372 | <td class="name"><code>zIndex</code></td>
|
15373 |
|
15374 |
|
15375 | <td class="type">
|
15376 |
|
15377 |
|
15378 | <span class="param-type">number</span>
|
15379 |
|
15380 |
|
15381 |
|
15382 |
|
15383 | </td>
|
15384 |
|
15385 |
|
15386 | <td class="attributes">
|
15387 |
|
15388 | <optional><br>
|
15389 |
|
15390 |
|
15391 |
|
15392 | </td>
|
15393 |
|
15394 |
|
15395 |
|
15396 | <td class="default">
|
15397 |
|
15398 | <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a>
|
15399 |
|
15400 | </td>
|
15401 |
|
15402 |
|
15403 | <td class="description last"><p>The z-index for the destiny (only numeric values which are not zero (0) are allowed). Also used as the <code>CB_GraphicSprites.zIndex</code> property for the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object. If not provided, as default it will use the value from <a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a>. To change the value of this property, use the <a href="CB_GraphicSprites.html#setZIndex"><code>CB_GraphicSprites#setZIndex</code></a> method (which will call the <a href="CB_GraphicSpritesScene.html#updateGraphicSpritesByZIndex"><code>CB_GraphicSpritesScene#updateGraphicSpritesByZIndex</code></a> method internally if there is a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> parent object).</p></td>
|
15404 | </tr>
|
15405 |
|
15406 |
|
15407 |
|
15408 | <tr>
|
15409 |
|
15410 | <td class="name"><code>disabled</code></td>
|
15411 |
|
15412 |
|
15413 | <td class="type">
|
15414 |
|
15415 |
|
15416 | <span class="param-type">boolean</span>
|
15417 |
|
15418 |
|
15419 |
|
15420 |
|
15421 | </td>
|
15422 |
|
15423 |
|
15424 | <td class="attributes">
|
15425 |
|
15426 | <optional><br>
|
15427 |
|
15428 |
|
15429 |
|
15430 | </td>
|
15431 |
|
15432 |
|
15433 |
|
15434 | <td class="default">
|
15435 |
|
15436 | false
|
15437 |
|
15438 | </td>
|
15439 |
|
15440 |
|
15441 | <td class="description last"><p>Tells whether this sprites group (and the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object itself) is disabled or not. If not provided, as default it will be false (which means it is enabled).</p></td>
|
15442 | </tr>
|
15443 |
|
15444 |
|
15445 |
|
15446 | <tr>
|
15447 |
|
15448 | <td class="name"><code>data</code></td>
|
15449 |
|
15450 |
|
15451 | <td class="type">
|
15452 |
|
15453 |
|
15454 | <span class="param-type">object</span>
|
15455 |
|
15456 |
|
15457 |
|
15458 |
|
15459 | </td>
|
15460 |
|
15461 |
|
15462 | <td class="attributes">
|
15463 |
|
15464 | <optional><br>
|
15465 |
|
15466 |
|
15467 |
|
15468 | </td>
|
15469 |
|
15470 |
|
15471 |
|
15472 | <td class="default">
|
15473 |
|
15474 | { 'that' : CB_GraphicSprites.SPRITES_OBJECT, 'getThis' = function() { return this.that; } }
|
15475 |
|
15476 | </td>
|
15477 |
|
15478 |
|
15479 | <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 <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> 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.</p></td>
|
15480 | </tr>
|
15481 |
|
15482 |
|
15483 |
|
15484 | <tr>
|
15485 |
|
15486 | <td class="name"><code>sprites</code></td>
|
15487 |
|
15488 |
|
15489 | <td class="type">
|
15490 |
|
15491 |
|
15492 | <span class="param-type">array</span>
|
15493 |
|
15494 |
|
15495 |
|
15496 |
|
15497 | </td>
|
15498 |
|
15499 |
|
15500 | <td class="attributes">
|
15501 |
|
15502 | <optional><br>
|
15503 |
|
15504 |
|
15505 |
|
15506 | </td>
|
15507 |
|
15508 |
|
15509 |
|
15510 | <td class="default">
|
15511 |
|
15512 | []
|
15513 |
|
15514 | </td>
|
15515 |
|
15516 |
|
15517 | <td class="description last"><p>Numeric array containing <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects with all the sprites that will be used. Recommended at least to provide one <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object in the first index.</p></td>
|
15518 | </tr>
|
15519 |
|
15520 |
|
15521 |
|
15522 | <tr>
|
15523 |
|
15524 | <td class="name"><code>spritesByZIndex</code></td>
|
15525 |
|
15526 |
|
15527 | <td class="type">
|
15528 |
|
15529 |
|
15530 | <span class="param-type">array</span>
|
15531 |
|
15532 |
|
15533 |
|
15534 |
|
15535 | </td>
|
15536 |
|
15537 |
|
15538 | <td class="attributes">
|
15539 |
|
15540 |
|
15541 |
|
15542 | </td>
|
15543 |
|
15544 |
|
15545 |
|
15546 | <td class="default">
|
15547 |
|
15548 | </td>
|
15549 |
|
15550 |
|
15551 | <td class="description last"><p>Read-only property containing a numeric array of all the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</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 "setZIndex" method (or when calling the <a href="CB_GraphicSprites.html#setZIndexSprite"><code>CB_GraphicSprites#setZIndexSprite</code></a> method) or when inserting/removing sprites through the <a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a>, <a href="CB_GraphicSprites.html#insertSprite"><code>CB_GraphicSprites#insertSprite</code></a>, <a href="CB_GraphicSprites.html#removeSprite"><code>CB_GraphicSprites#removeSprite</code></a> or <a href="CB_GraphicSprites.html#removeSpriteById"><code>CB_GraphicSprites#removeSpriteById</code></a> methods.</p></td>
|
15552 | </tr>
|
15553 |
|
15554 |
|
15555 |
|
15556 | <tr>
|
15557 |
|
15558 | <td class="name"><code>byReference_DEFAULT</code></td>
|
15559 |
|
15560 |
|
15561 | <td class="type">
|
15562 |
|
15563 |
|
15564 | <span class="param-type">boolean</span>
|
15565 |
|
15566 |
|
15567 |
|
15568 |
|
15569 | </td>
|
15570 |
|
15571 |
|
15572 | <td class="attributes">
|
15573 |
|
15574 | <optional><br>
|
15575 |
|
15576 |
|
15577 |
|
15578 | </td>
|
15579 |
|
15580 |
|
15581 |
|
15582 | <td class="default">
|
15583 |
|
15584 | false
|
15585 |
|
15586 | </td>
|
15587 |
|
15588 |
|
15589 | <td class="description last"><p>Default value to use as the "byReference" parameter for the constructor and for the <a href="CB_GraphicSprites.html#insertSprites"><code>CB_GraphicSprites#insertSprites</code></a> method. If a boolean value is not provided, it will be parsed to boolean (resulting undefined to be false).</p></td>
|
15590 | </tr>
|
15591 |
|
15592 |
|
15593 |
|
15594 | <tr>
|
15595 |
|
15596 | <td class="name"><code>parent</code></td>
|
15597 |
|
15598 |
|
15599 | <td class="type">
|
15600 |
|
15601 |
|
15602 | <span class="param-type">*</span>
|
15603 |
|
15604 |
|
15605 |
|
15606 |
|
15607 | </td>
|
15608 |
|
15609 |
|
15610 | <td class="attributes">
|
15611 |
|
15612 | <optional><br>
|
15613 |
|
15614 |
|
15615 |
|
15616 | </td>
|
15617 |
|
15618 |
|
15619 |
|
15620 | <td class="default">
|
15621 |
|
15622 | undefined|<a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a>
|
15623 |
|
15624 | </td>
|
15625 |
|
15626 |
|
15627 | <td class="description last"><p>Property pointing to or containing its parent (also used as the <code>CB_GraphicSprites.parent</code> property for the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object). It could be a <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object.</p></td>
|
15628 | </tr>
|
15629 |
|
15630 |
|
15631 |
|
15632 | <tr>
|
15633 |
|
15634 | <td class="name"><code>container</code></td>
|
15635 |
|
15636 |
|
15637 | <td class="type">
|
15638 |
|
15639 |
|
15640 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
15641 |
|
15642 |
|
15643 |
|
15644 |
|
15645 | </td>
|
15646 |
|
15647 |
|
15648 | <td class="attributes">
|
15649 |
|
15650 |
|
15651 |
|
15652 | </td>
|
15653 |
|
15654 |
|
15655 |
|
15656 | <td class="default">
|
15657 |
|
15658 | </td>
|
15659 |
|
15660 |
|
15661 | <td class="description last"><p>Read-only property pointing to the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object which contains it.</p></td>
|
15662 | </tr>
|
15663 |
|
15664 |
|
15665 |
|
15666 | <tr>
|
15667 |
|
15668 | <td class="name"><code>isSpritesGroup</code></td>
|
15669 |
|
15670 |
|
15671 | <td class="type">
|
15672 |
|
15673 |
|
15674 | <span class="param-type">boolean</span>
|
15675 |
|
15676 |
|
15677 |
|
15678 |
|
15679 | </td>
|
15680 |
|
15681 |
|
15682 | <td class="attributes">
|
15683 |
|
15684 |
|
15685 |
|
15686 | </td>
|
15687 |
|
15688 |
|
15689 |
|
15690 | <td class="default">
|
15691 |
|
15692 | </td>
|
15693 |
|
15694 |
|
15695 | <td class="description last"><p>Read-only property which is always set to true to help identify this type of object.</p></td>
|
15696 | </tr>
|
15697 |
|
15698 |
|
15699 |
|
15700 | <tr>
|
15701 |
|
15702 | <td class="name"><code>type</code></td>
|
15703 |
|
15704 |
|
15705 | <td class="type">
|
15706 |
|
15707 |
|
15708 | <span class="param-type">'spritesGroup'</span>
|
15709 |
|
15710 |
|
15711 |
|
15712 |
|
15713 | </td>
|
15714 |
|
15715 |
|
15716 | <td class="attributes">
|
15717 |
|
15718 |
|
15719 |
|
15720 | </td>
|
15721 |
|
15722 |
|
15723 |
|
15724 | <td class="default">
|
15725 |
|
15726 | </td>
|
15727 |
|
15728 |
|
15729 | <td class="description last"><p>Read-only property indicating the type of object (always "spritesGroup").</p></td>
|
15730 | </tr>
|
15731 |
|
15732 |
|
15733 |
|
15734 | <tr>
|
15735 |
|
15736 | <td class="name"><code>position</code></td>
|
15737 |
|
15738 |
|
15739 | <td class="type">
|
15740 |
|
15741 |
|
15742 | <span class="param-type">integer</span>
|
15743 |
|
15744 |
|
15745 |
|
15746 |
|
15747 | </td>
|
15748 |
|
15749 |
|
15750 | <td class="attributes">
|
15751 |
|
15752 | <optional><br>
|
15753 |
|
15754 |
|
15755 |
|
15756 | </td>
|
15757 |
|
15758 |
|
15759 |
|
15760 | <td class="default">
|
15761 |
|
15762 | </td>
|
15763 |
|
15764 |
|
15765 | <td class="description last"><p>Read-only property indicating the position of this <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object in the array which is set the "items" property inside the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> object which is in the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object parent (if any).</p></td>
|
15766 | </tr>
|
15767 |
|
15768 |
|
15769 |
|
15770 | <tr>
|
15771 |
|
15772 | <td class="name"><code>positionByZIndex</code></td>
|
15773 |
|
15774 |
|
15775 | <td class="type">
|
15776 |
|
15777 |
|
15778 | <span class="param-type">integer</span>
|
15779 |
|
15780 |
|
15781 |
|
15782 |
|
15783 | </td>
|
15784 |
|
15785 |
|
15786 | <td class="attributes">
|
15787 |
|
15788 | <optional><br>
|
15789 |
|
15790 |
|
15791 |
|
15792 | </td>
|
15793 |
|
15794 |
|
15795 |
|
15796 | <td class="default">
|
15797 |
|
15798 | </td>
|
15799 |
|
15800 |
|
15801 | <td class="description last"><p>Read-only property indicating the position of this <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object in the array which is set the "itemsByZIndex" property inside the <a href="CB_GraphicSpritesScene.html#spritesGroups"><code>CB_GraphicSpritesScene#spritesGroups</code></a> object which is in the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> object parent (if any).</p></td>
|
15802 | </tr>
|
15803 |
|
15804 |
|
15805 | </tbody>
|
15806 | </table>
|
15807 | </dl>
|
15808 |
|
15809 |
|
15810 |
|
15811 |
|
15812 |
|
15813 |
|
15814 |
|
15815 |
|
15816 |
|
15817 |
|
15818 |
|
15819 |
|
15820 |
|
15821 |
|
15822 |
|
15823 |
|
15824 |
|
15825 |
|
15826 |
|
15827 |
|
15828 |
|
15829 |
|
15830 |
|
15831 |
|
15832 |
|
15833 |
|
15834 |
|
15835 |
|
15836 |
|
15837 |
|
15838 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
15839 | <dd class="tag-source">
|
15840 | <ul class="dummy">
|
15841 | <li>
|
15842 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
15843 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-152">line 152</a>
|
15844 | </li>
|
15845 | </ul>
|
15846 | </dd>
|
15847 |
|
15848 |
|
15849 |
|
15850 |
|
15851 |
|
15852 |
|
15853 |
|
15854 | </dl>
|
15855 |
|
15856 |
|
15857 |
|
15858 | <h5>Example</h5>
|
15859 |
|
15860 | <pre class="sunlight-highlight-javascript">{
|
15861 | //'my_sprites_1':
|
15862 | id: "my_sprites_1",
|
15863 | src: "path/to/image.gif",
|
15864 | srcType: CB_GraphicSprites.SRC_TYPES.IMAGE,
|
15865 | srcLeft: 10,
|
15866 | srcTop: 20,
|
15867 | srcWidth: 64,
|
15868 | srcHeight: 32,
|
15869 | left: 10,
|
15870 | top: 20,
|
15871 | width: 64,
|
15872 | height: 32,
|
15873 | data: { datum_1: "value_1", datum_2: 2, datum_3: [ "a", "b", "c" ] },
|
15874 | sprites:
|
15875 | [
|
15876 | //'my_sprite_1':
|
15877 | {
|
15878 | id: "my_sprite_1",
|
15879 | subSprites:
|
15880 | [
|
15881 | //'my_subsprite_1':
|
15882 | { id: "my_subsprite_1", srcLeft: 10, srcTop: 20, zIndex: 1 },
|
15883 | //'my_subsprite_2':
|
15884 | { id: "my_subsprite_2", srcLeft: 20, srcTop: 40, zIndex: 2 }
|
15885 | ]
|
15886 | },
|
15887 | //'my_sprite_2':
|
15888 | {
|
15889 | id: "my_sprite_2",
|
15890 | subSprites:
|
15891 | [
|
15892 | //'my_subsprite_3':
|
15893 | { id: "my_subsprite_3", srcLeft: 30, srcTop: 60, zIndex: 1 },
|
15894 | //'my_subsprite_4':
|
15895 | { id: "my_subsprite_4", srcLeft: 40, srcTop: 80, zIndex: 2 }
|
15896 | ]
|
15897 | }
|
15898 | ]
|
15899 | }
</pre>
|
15900 |
|
15901 |
|
15902 |
|
15903 | </dd>
|
15904 |
|
15905 |
|
15906 |
|
15907 | <hr>
|
15908 | <dt class="name" id=".SPRITE_OBJECT">
|
15909 | <h4 id=".SPRITE_OBJECT">SPRITE_OBJECT</h4>
|
15910 |
|
15911 |
|
15912 | </dt>
|
15913 | <dd>
|
15914 |
|
15915 | <div class="description">
|
15916 | <p>An object with the information that belongs to a certain graphic sprite, being able to contain more than one source used by this graphic sprite (inside sub-sprites).</p>
|
15917 | </div>
|
15918 |
|
15919 |
|
15920 |
|
15921 | <h5>Type:</h5>
|
15922 | <ul>
|
15923 | <li>
|
15924 |
|
15925 | <span class="param-type">Object</span>
|
15926 |
|
15927 |
|
15928 |
|
15929 | </li>
|
15930 | </ul>
|
15931 |
|
15932 |
|
15933 |
|
15934 | <dl class="details">
|
15935 |
|
15936 |
|
15937 | <h5 class="subsection-title">Properties:</h5>
|
15938 |
|
15939 | <dl>
|
15940 |
|
15941 | <table class="props table table-striped">
|
15942 | <thead>
|
15943 | <tr>
|
15944 |
|
15945 | <th>Name</th>
|
15946 |
|
15947 |
|
15948 | <th>Type</th>
|
15949 |
|
15950 |
|
15951 | <th>Argument</th>
|
15952 |
|
15953 |
|
15954 |
|
15955 | <th>Default</th>
|
15956 |
|
15957 |
|
15958 | <th class="last">Description</th>
|
15959 | </tr>
|
15960 | </thead>
|
15961 |
|
15962 | <tbody>
|
15963 |
|
15964 |
|
15965 | <tr>
|
15966 |
|
15967 | <td class="name"><code>id</code></td>
|
15968 |
|
15969 |
|
15970 | <td class="type">
|
15971 |
|
15972 |
|
15973 | <span class="param-type">string</span>
|
15974 | |
|
15975 |
|
15976 | <span class="param-type">*</span>
|
15977 |
|
15978 |
|
15979 |
|
15980 |
|
15981 | </td>
|
15982 |
|
15983 |
|
15984 | <td class="attributes">
|
15985 |
|
15986 | <optional><br>
|
15987 |
|
15988 |
|
15989 |
|
15990 | </td>
|
15991 |
|
15992 |
|
15993 |
|
15994 | <td class="default">
|
15995 |
|
15996 | 'CB_GraphicSprites.sprite_' + CB_GraphicSprites._idSpriteUnique++
|
15997 |
|
15998 | </td>
|
15999 |
|
16000 |
|
16001 | <td class="description last"><p>Identifier of the sprite. 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>
|
16002 | </tr>
|
16003 |
|
16004 |
|
16005 |
|
16006 | <tr>
|
16007 |
|
16008 | <td class="name"><code>src</code></td>
|
16009 |
|
16010 |
|
16011 | <td class="type">
|
16012 |
|
16013 |
|
16014 | <span class="param-type">*</span>
|
16015 |
|
16016 |
|
16017 |
|
16018 |
|
16019 | </td>
|
16020 |
|
16021 |
|
16022 | <td class="attributes">
|
16023 |
|
16024 | <optional><br>
|
16025 |
|
16026 |
|
16027 |
|
16028 | </td>
|
16029 |
|
16030 |
|
16031 |
|
16032 | <td class="default">
|
16033 |
|
16034 | this.parent.src|""
|
16035 |
|
16036 | </td>
|
16037 |
|
16038 |
|
16039 | <td class="description last"><p>Source of origin. Can be a path or identifier of an image, text, bitmap, 3D object, etc. They can be used for any kind of source you may think of, including (but not limited to) one sprites sheet or more, one atlas or more, etc. or even a mix of all of them. If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16040 | </tr>
|
16041 |
|
16042 |
|
16043 |
|
16044 | <tr>
|
16045 |
|
16046 | <td class="name"><code>srcType</code></td>
|
16047 |
|
16048 |
|
16049 | <td class="type">
|
16050 |
|
16051 |
|
16052 | <span class="param-type">string</span>
|
16053 |
|
16054 |
|
16055 |
|
16056 |
|
16057 | </td>
|
16058 |
|
16059 |
|
16060 | <td class="attributes">
|
16061 |
|
16062 | <optional><br>
|
16063 |
|
16064 |
|
16065 |
|
16066 | </td>
|
16067 |
|
16068 |
|
16069 |
|
16070 | <td class="default">
|
16071 |
|
16072 | this.parent.srcType|<a href="CB_GraphicSprites.html#.SRC_TYPES_DEFAULT"><code>CB_GraphicSprites.SRC_TYPES_DEFAULT</code></a>
|
16073 |
|
16074 | </td>
|
16075 |
|
16076 |
|
16077 | <td class="description last"><p>Type of the source of origin. If not provided, as default it will use the value from the sprites group that it belongs to. 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>
|
16078 | </tr>
|
16079 |
|
16080 |
|
16081 |
|
16082 | <tr>
|
16083 |
|
16084 | <td class="name"><code>srcLeft</code></td>
|
16085 |
|
16086 |
|
16087 | <td class="type">
|
16088 |
|
16089 |
|
16090 | <span class="param-type">number</span>
|
16091 |
|
16092 |
|
16093 |
|
16094 |
|
16095 | </td>
|
16096 |
|
16097 |
|
16098 | <td class="attributes">
|
16099 |
|
16100 | <optional><br>
|
16101 |
|
16102 |
|
16103 |
|
16104 | </td>
|
16105 |
|
16106 |
|
16107 |
|
16108 | <td class="default">
|
16109 |
|
16110 | this.parent.srcLeft|<a href="CB_GraphicSprites.html#.LEFT_SOURCE_DEFAULT"><code>CB_GraphicSprites.LEFT_SOURCE_DEFAULT</code></a>
|
16111 |
|
16112 | </td>
|
16113 |
|
16114 |
|
16115 | <td class="description last"><p>Left (horizontal) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16116 | </tr>
|
16117 |
|
16118 |
|
16119 |
|
16120 | <tr>
|
16121 |
|
16122 | <td class="name"><code>srcTop</code></td>
|
16123 |
|
16124 |
|
16125 | <td class="type">
|
16126 |
|
16127 |
|
16128 | <span class="param-type">number</span>
|
16129 |
|
16130 |
|
16131 |
|
16132 |
|
16133 | </td>
|
16134 |
|
16135 |
|
16136 | <td class="attributes">
|
16137 |
|
16138 | <optional><br>
|
16139 |
|
16140 |
|
16141 |
|
16142 | </td>
|
16143 |
|
16144 |
|
16145 |
|
16146 | <td class="default">
|
16147 |
|
16148 | this.parent.srcTop|<a href="CB_GraphicSprites.html#.TOP_SOURCE_DEFAULT"><code>CB_GraphicSprites.TOP_SOURCE_DEFAULT</code></a>
|
16149 |
|
16150 | </td>
|
16151 |
|
16152 |
|
16153 | <td class="description last"><p>Top (vertical) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16154 | </tr>
|
16155 |
|
16156 |
|
16157 |
|
16158 | <tr>
|
16159 |
|
16160 | <td class="name"><code>srcWidth</code></td>
|
16161 |
|
16162 |
|
16163 | <td class="type">
|
16164 |
|
16165 |
|
16166 | <span class="param-type">number</span>
|
16167 |
|
16168 |
|
16169 |
|
16170 |
|
16171 | </td>
|
16172 |
|
16173 |
|
16174 | <td class="attributes">
|
16175 |
|
16176 | <optional><br>
|
16177 |
|
16178 |
|
16179 |
|
16180 | </td>
|
16181 |
|
16182 |
|
16183 |
|
16184 | <td class="default">
|
16185 |
|
16186 | this.parent.srcWidth|<a href="CB_GraphicSprites.html#.WIDTH_SOURCE_DEFAULT"><code>CB_GraphicSprites.WIDTH_SOURCE_DEFAULT</code></a>
|
16187 |
|
16188 | </td>
|
16189 |
|
16190 |
|
16191 | <td class="description last"><p>Width of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16192 | </tr>
|
16193 |
|
16194 |
|
16195 |
|
16196 | <tr>
|
16197 |
|
16198 | <td class="name"><code>srcHeight</code></td>
|
16199 |
|
16200 |
|
16201 | <td class="type">
|
16202 |
|
16203 |
|
16204 | <span class="param-type">number</span>
|
16205 |
|
16206 |
|
16207 |
|
16208 |
|
16209 | </td>
|
16210 |
|
16211 |
|
16212 | <td class="attributes">
|
16213 |
|
16214 | <optional><br>
|
16215 |
|
16216 |
|
16217 |
|
16218 | </td>
|
16219 |
|
16220 |
|
16221 |
|
16222 | <td class="default">
|
16223 |
|
16224 | this.parent.srcHeight|<a href="CB_GraphicSprites.html#.HEIGHT_SOURCE_DEFAULT"><code>CB_GraphicSprites.HEIGHT_SOURCE_DEFAULT</code></a>
|
16225 |
|
16226 | </td>
|
16227 |
|
16228 |
|
16229 | <td class="description last"><p>Height of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16230 | </tr>
|
16231 |
|
16232 |
|
16233 |
|
16234 | <tr>
|
16235 |
|
16236 | <td class="name"><code>left</code></td>
|
16237 |
|
16238 |
|
16239 | <td class="type">
|
16240 |
|
16241 |
|
16242 | <span class="param-type">number</span>
|
16243 |
|
16244 |
|
16245 |
|
16246 |
|
16247 | </td>
|
16248 |
|
16249 |
|
16250 | <td class="attributes">
|
16251 |
|
16252 | <optional><br>
|
16253 |
|
16254 |
|
16255 |
|
16256 | </td>
|
16257 |
|
16258 |
|
16259 |
|
16260 | <td class="default">
|
16261 |
|
16262 | <a href="CB_GraphicSprites.html#.LEFT_DEFAULT"><code>CB_GraphicSprites.LEFT_DEFAULT</code></a>
|
16263 |
|
16264 | </td>
|
16265 |
|
16266 |
|
16267 | <td class="description last"><p>Left (horizontal) position in the destiny (inside the sprites group). Unit agnostic (only numeric values are allowed).</p></td>
|
16268 | </tr>
|
16269 |
|
16270 |
|
16271 |
|
16272 | <tr>
|
16273 |
|
16274 | <td class="name"><code>top</code></td>
|
16275 |
|
16276 |
|
16277 | <td class="type">
|
16278 |
|
16279 |
|
16280 | <span class="param-type">number</span>
|
16281 |
|
16282 |
|
16283 |
|
16284 |
|
16285 | </td>
|
16286 |
|
16287 |
|
16288 | <td class="attributes">
|
16289 |
|
16290 | <optional><br>
|
16291 |
|
16292 |
|
16293 |
|
16294 | </td>
|
16295 |
|
16296 |
|
16297 |
|
16298 | <td class="default">
|
16299 |
|
16300 | <a href="CB_GraphicSprites.html#.TOP_DEFAULT"><code>CB_GraphicSprites.TOP_DEFAULT</code></a>
|
16301 |
|
16302 | </td>
|
16303 |
|
16304 |
|
16305 | <td class="description last"><p>Top (vertical) position in the destiny (inside the sprites group). Unit agnostic (only numeric values are allowed).</p></td>
|
16306 | </tr>
|
16307 |
|
16308 |
|
16309 |
|
16310 | <tr>
|
16311 |
|
16312 | <td class="name"><code>width</code></td>
|
16313 |
|
16314 |
|
16315 | <td class="type">
|
16316 |
|
16317 |
|
16318 | <span class="param-type">number</span>
|
16319 |
|
16320 |
|
16321 |
|
16322 |
|
16323 | </td>
|
16324 |
|
16325 |
|
16326 | <td class="attributes">
|
16327 |
|
16328 | <optional><br>
|
16329 |
|
16330 |
|
16331 |
|
16332 | </td>
|
16333 |
|
16334 |
|
16335 |
|
16336 | <td class="default">
|
16337 |
|
16338 | this.parent.width|<a href="CB_GraphicSprites.html#.WIDTH_DEFAULT"><code>CB_GraphicSprites.WIDTH_DEFAULT</code></a>
|
16339 |
|
16340 | </td>
|
16341 |
|
16342 |
|
16343 | <td class="description last"><p>Width of the destiny (inside the sprites group). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16344 | </tr>
|
16345 |
|
16346 |
|
16347 |
|
16348 | <tr>
|
16349 |
|
16350 | <td class="name"><code>height</code></td>
|
16351 |
|
16352 |
|
16353 | <td class="type">
|
16354 |
|
16355 |
|
16356 | <span class="param-type">number</span>
|
16357 |
|
16358 |
|
16359 |
|
16360 |
|
16361 | </td>
|
16362 |
|
16363 |
|
16364 | <td class="attributes">
|
16365 |
|
16366 | <optional><br>
|
16367 |
|
16368 |
|
16369 |
|
16370 | </td>
|
16371 |
|
16372 |
|
16373 |
|
16374 | <td class="default">
|
16375 |
|
16376 | this.parent.height|<a href="CB_GraphicSprites.html#.HEIGHT_DEFAULT"><code>CB_GraphicSprites.HEIGHT_DEFAULT</code></a>
|
16377 |
|
16378 | </td>
|
16379 |
|
16380 |
|
16381 | <td class="description last"><p>Height of the destiny (inside the sprites group). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16382 | </tr>
|
16383 |
|
16384 |
|
16385 |
|
16386 | <tr>
|
16387 |
|
16388 | <td class="name"><code>zIndex</code></td>
|
16389 |
|
16390 |
|
16391 | <td class="type">
|
16392 |
|
16393 |
|
16394 | <span class="param-type">number</span>
|
16395 |
|
16396 |
|
16397 |
|
16398 |
|
16399 | </td>
|
16400 |
|
16401 |
|
16402 | <td class="attributes">
|
16403 |
|
16404 | <optional><br>
|
16405 |
|
16406 |
|
16407 |
|
16408 | </td>
|
16409 |
|
16410 |
|
16411 |
|
16412 | <td class="default">
|
16413 |
|
16414 | this.parent.zIndex|<a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a>
|
16415 |
|
16416 | </td>
|
16417 |
|
16418 |
|
16419 | <td class="description last"><p>The z-index for the destiny (inside the sprites group). Only numeric values which are not zero (0) are allowed. If not provided, as default it will use the value from the sprites group that it belongs to. To change the value of this property, use the "setZIndex" method of the sprite or the <a href="CB_GraphicSprites.html#setZIndexSprite"><code>CB_GraphicSprites#setZIndexSprite</code></a> method (which will call the <code>CB_GraphicSpritesScene#updateSpritesByZIndex</code> method internally).</p></td>
|
16420 | </tr>
|
16421 |
|
16422 |
|
16423 |
|
16424 | <tr>
|
16425 |
|
16426 | <td class="name"><code>disabled</code></td>
|
16427 |
|
16428 |
|
16429 | <td class="type">
|
16430 |
|
16431 |
|
16432 | <span class="param-type">boolean</span>
|
16433 |
|
16434 |
|
16435 |
|
16436 |
|
16437 | </td>
|
16438 |
|
16439 |
|
16440 | <td class="attributes">
|
16441 |
|
16442 | <optional><br>
|
16443 |
|
16444 |
|
16445 |
|
16446 | </td>
|
16447 |
|
16448 |
|
16449 |
|
16450 | <td class="default">
|
16451 |
|
16452 | this.parent.disabled|false
|
16453 |
|
16454 | </td>
|
16455 |
|
16456 |
|
16457 | <td class="description last"><p>Tells whether this sprite is disabled or not. Regardless its value, it will be considered disabled if its sprites group parent is also disabled. If not provided, as default it will use the value from the sprites group that it belongs to.</p></td>
|
16458 | </tr>
|
16459 |
|
16460 |
|
16461 |
|
16462 | <tr>
|
16463 |
|
16464 | <td class="name"><code>data</code></td>
|
16465 |
|
16466 |
|
16467 | <td class="type">
|
16468 |
|
16469 |
|
16470 | <span class="param-type">object</span>
|
16471 |
|
16472 |
|
16473 |
|
16474 |
|
16475 | </td>
|
16476 |
|
16477 |
|
16478 | <td class="attributes">
|
16479 |
|
16480 | <optional><br>
|
16481 |
|
16482 |
|
16483 |
|
16484 | </td>
|
16485 |
|
16486 |
|
16487 |
|
16488 | <td class="default">
|
16489 |
|
16490 | CB_combineJSON(this.parent.data, this.data)||this.parent.data||{ 'that' : CB_GraphicSprites.SPRITES_OBJECT, 'getThis' = function() { return this.that; } }
|
16491 |
|
16492 | </td>
|
16493 |
|
16494 |
|
16495 | <td class="description last"><p>Object with any additional data desired which can be any kind. If not provided, missing properties as default will use the value from the sprites group that it belongs to. It will always have a "that" property pointing to the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> 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.</p></td>
|
16496 | </tr>
|
16497 |
|
16498 |
|
16499 |
|
16500 | <tr>
|
16501 |
|
16502 | <td class="name"><code>subSprites</code></td>
|
16503 |
|
16504 |
|
16505 | <td class="type">
|
16506 |
|
16507 |
|
16508 | <span class="param-type">array</span>
|
16509 |
|
16510 |
|
16511 |
|
16512 |
|
16513 | </td>
|
16514 |
|
16515 |
|
16516 | <td class="attributes">
|
16517 |
|
16518 | <optional><br>
|
16519 |
|
16520 |
|
16521 |
|
16522 | </td>
|
16523 |
|
16524 |
|
16525 |
|
16526 | <td class="default">
|
16527 |
|
16528 | []
|
16529 |
|
16530 | </td>
|
16531 |
|
16532 |
|
16533 | <td class="description last"><p>Numeric array containing <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects with the sub-sprites that this sprite uses.</p></td>
|
16534 | </tr>
|
16535 |
|
16536 |
|
16537 |
|
16538 | <tr>
|
16539 |
|
16540 | <td class="name"><code>subSpritesByZIndex</code></td>
|
16541 |
|
16542 |
|
16543 | <td class="type">
|
16544 |
|
16545 |
|
16546 | <span class="param-type">array</span>
|
16547 |
|
16548 |
|
16549 |
|
16550 |
|
16551 | </td>
|
16552 |
|
16553 |
|
16554 | <td class="attributes">
|
16555 |
|
16556 |
|
16557 |
|
16558 | </td>
|
16559 |
|
16560 |
|
16561 |
|
16562 | <td class="default">
|
16563 |
|
16564 | </td>
|
16565 |
|
16566 |
|
16567 | <td class="description last"><p>Read-only property containing a numeric array of all the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects of the sprite ordered by their z-index ("zIndex" property). It is updated automatically when the z-index of a sub-sprite is set with its "setZIndex" method (or when calling the <a href="CB_GraphicSprites.html#setZIndexSubSprite"><code>CB_GraphicSprites#setZIndexSubSprite</code></a> method) or when inserting/removing sub-sprites through the <a href="CB_GraphicSprites.html#insertSubSprites"><code>CB_GraphicSprites#insertSubSprites</code></a>, <a href="CB_GraphicSprites.html#insertSubSprite"><code>CB_GraphicSprites#insertSubSprite</code></a>, <a href="CB_GraphicSprites.html#removeSubSprite"><code>CB_GraphicSprites#removeSubSprite</code></a> or <a href="CB_GraphicSprites.html#removeSubSpriteById"><code>CB_GraphicSprites#removeSubSpriteById</code></a> methods.</p></td>
|
16568 | </tr>
|
16569 |
|
16570 |
|
16571 |
|
16572 | <tr>
|
16573 |
|
16574 | <td class="name"><code>byReference</code></td>
|
16575 |
|
16576 |
|
16577 | <td class="type">
|
16578 |
|
16579 |
|
16580 | <span class="param-type">boolean</span>
|
16581 |
|
16582 |
|
16583 |
|
16584 |
|
16585 | </td>
|
16586 |
|
16587 |
|
16588 | <td class="attributes">
|
16589 |
|
16590 | <optional><br>
|
16591 |
|
16592 |
|
16593 |
|
16594 | </td>
|
16595 |
|
16596 |
|
16597 |
|
16598 | <td class="default">
|
16599 |
|
16600 | false
|
16601 |
|
16602 | </td>
|
16603 |
|
16604 |
|
16605 | <td class="description last"><p>If set to true, when inserting the sprite, its "subSprites" property will use exactly the object given for that property (without making a copy) and the same sprite itself (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) will be inserted internally directly without making a copy of itself.</p></td>
|
16606 | </tr>
|
16607 |
|
16608 |
|
16609 |
|
16610 | <tr>
|
16611 |
|
16612 | <td class="name"><code>parent</code></td>
|
16613 |
|
16614 |
|
16615 | <td class="type">
|
16616 |
|
16617 |
|
16618 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITES_OBJECT">CB_GraphicSprites.SPRITES_OBJECT</a></span>
|
16619 |
|
16620 |
|
16621 |
|
16622 |
|
16623 | </td>
|
16624 |
|
16625 |
|
16626 | <td class="attributes">
|
16627 |
|
16628 |
|
16629 |
|
16630 | </td>
|
16631 |
|
16632 |
|
16633 |
|
16634 | <td class="default">
|
16635 |
|
16636 | </td>
|
16637 |
|
16638 |
|
16639 | <td class="description last"><p>Read-only property pointing to its parent (<a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object).</p></td>
|
16640 | </tr>
|
16641 |
|
16642 |
|
16643 |
|
16644 | <tr>
|
16645 |
|
16646 | <td class="name"><code>container</code></td>
|
16647 |
|
16648 |
|
16649 | <td class="type">
|
16650 |
|
16651 |
|
16652 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
16653 |
|
16654 |
|
16655 |
|
16656 |
|
16657 | </td>
|
16658 |
|
16659 |
|
16660 | <td class="attributes">
|
16661 |
|
16662 |
|
16663 |
|
16664 | </td>
|
16665 |
|
16666 |
|
16667 |
|
16668 | <td class="default">
|
16669 |
|
16670 | </td>
|
16671 |
|
16672 |
|
16673 | <td class="description last"><p>Read-only property pointing to the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object which contains it.</p></td>
|
16674 | </tr>
|
16675 |
|
16676 |
|
16677 |
|
16678 | <tr>
|
16679 |
|
16680 | <td class="name"><code>isSprite</code></td>
|
16681 |
|
16682 |
|
16683 | <td class="type">
|
16684 |
|
16685 |
|
16686 | <span class="param-type">boolean</span>
|
16687 |
|
16688 |
|
16689 |
|
16690 |
|
16691 | </td>
|
16692 |
|
16693 |
|
16694 | <td class="attributes">
|
16695 |
|
16696 |
|
16697 |
|
16698 | </td>
|
16699 |
|
16700 |
|
16701 |
|
16702 | <td class="default">
|
16703 |
|
16704 | </td>
|
16705 |
|
16706 |
|
16707 | <td class="description last"><p>Read-only property which is always set to true to help identify this type of object.</p></td>
|
16708 | </tr>
|
16709 |
|
16710 |
|
16711 |
|
16712 | <tr>
|
16713 |
|
16714 | <td class="name"><code>type</code></td>
|
16715 |
|
16716 |
|
16717 | <td class="type">
|
16718 |
|
16719 |
|
16720 | <span class="param-type">'sprite'</span>
|
16721 |
|
16722 |
|
16723 |
|
16724 |
|
16725 | </td>
|
16726 |
|
16727 |
|
16728 | <td class="attributes">
|
16729 |
|
16730 |
|
16731 |
|
16732 | </td>
|
16733 |
|
16734 |
|
16735 |
|
16736 | <td class="default">
|
16737 |
|
16738 | </td>
|
16739 |
|
16740 |
|
16741 | <td class="description last"><p>Read-only property indicating the type of object (always "sprite").</p></td>
|
16742 | </tr>
|
16743 |
|
16744 |
|
16745 |
|
16746 | <tr>
|
16747 |
|
16748 | <td class="name"><code>position</code></td>
|
16749 |
|
16750 |
|
16751 | <td class="type">
|
16752 |
|
16753 |
|
16754 | <span class="param-type">integer</span>
|
16755 |
|
16756 |
|
16757 |
|
16758 |
|
16759 | </td>
|
16760 |
|
16761 |
|
16762 | <td class="attributes">
|
16763 |
|
16764 |
|
16765 |
|
16766 | </td>
|
16767 |
|
16768 |
|
16769 |
|
16770 | <td class="default">
|
16771 |
|
16772 | </td>
|
16773 |
|
16774 |
|
16775 | <td class="description last"><p>Read-only property indicating the position of this sprite in the array which is set the "sprites" property of the sprites group parent (<a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object).</p></td>
|
16776 | </tr>
|
16777 |
|
16778 |
|
16779 |
|
16780 | <tr>
|
16781 |
|
16782 | <td class="name"><code>positionByZIndex</code></td>
|
16783 |
|
16784 |
|
16785 | <td class="type">
|
16786 |
|
16787 |
|
16788 | <span class="param-type">integer</span>
|
16789 |
|
16790 |
|
16791 |
|
16792 |
|
16793 | </td>
|
16794 |
|
16795 |
|
16796 | <td class="attributes">
|
16797 |
|
16798 |
|
16799 |
|
16800 | </td>
|
16801 |
|
16802 |
|
16803 |
|
16804 | <td class="default">
|
16805 |
|
16806 | </td>
|
16807 |
|
16808 |
|
16809 | <td class="description last"><p>Read-only property indicating the position of this sprite in the array which is set the "spritesByZIndex" property of the sprites group parent (<a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> object).</p></td>
|
16810 | </tr>
|
16811 |
|
16812 |
|
16813 |
|
16814 | <tr>
|
16815 |
|
16816 | <td class="name"><code>time</code></td>
|
16817 |
|
16818 |
|
16819 | <td class="type">
|
16820 |
|
16821 |
|
16822 | <span class="param-type">integer</span>
|
16823 |
|
16824 |
|
16825 |
|
16826 |
|
16827 | </td>
|
16828 |
|
16829 |
|
16830 | <td class="attributes">
|
16831 |
|
16832 |
|
16833 |
|
16834 | </td>
|
16835 |
|
16836 |
|
16837 |
|
16838 | <td class="default">
|
16839 |
|
16840 | </td>
|
16841 |
|
16842 |
|
16843 | <td class="description last"><p>Property which stores the time in milliseconds when the sprite was started being pointed for the last time (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which was obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally). Note that it could being not pointed anymore. If it has never being pointed before, it will be set to 0.</p></td>
|
16844 | </tr>
|
16845 |
|
16846 |
|
16847 |
|
16848 | <tr>
|
16849 |
|
16850 | <td class="name"><code>setTime</code></td>
|
16851 |
|
16852 |
|
16853 | <td class="type">
|
16854 |
|
16855 |
|
16856 | <span class="param-type">function</span>
|
16857 |
|
16858 |
|
16859 |
|
16860 |
|
16861 | </td>
|
16862 |
|
16863 |
|
16864 | <td class="attributes">
|
16865 |
|
16866 |
|
16867 |
|
16868 | </td>
|
16869 |
|
16870 |
|
16871 |
|
16872 | <td class="default">
|
16873 |
|
16874 | </td>
|
16875 |
|
16876 |
|
16877 | <td class="description last"><p>Read-only property which is a method that updates the "time" property of the sprite (calls <a href="CB_GraphicSprites.html#setTime"><code>CB_GraphicSprites#setTime</code></a> internally and returns its returning value). With only one parameter which belongs to the "time" parameter of the <a href="CB_GraphicSprites.html#setTime"><code>CB_GraphicSprites#setTime</code></a> method.</p></td>
|
16878 | </tr>
|
16879 |
|
16880 |
|
16881 |
|
16882 | <tr>
|
16883 |
|
16884 | <td class="name"><code>getTime</code></td>
|
16885 |
|
16886 |
|
16887 | <td class="type">
|
16888 |
|
16889 |
|
16890 | <span class="param-type">function</span>
|
16891 |
|
16892 |
|
16893 |
|
16894 |
|
16895 | </td>
|
16896 |
|
16897 |
|
16898 | <td class="attributes">
|
16899 |
|
16900 |
|
16901 |
|
16902 | </td>
|
16903 |
|
16904 |
|
16905 |
|
16906 | <td class="default">
|
16907 |
|
16908 | </td>
|
16909 |
|
16910 |
|
16911 | <td class="description last"><p>Read-only property which is a method that returns the "time" property of the sprite (calls <a href="CB_GraphicSprites.html#getTime"><code>CB_GraphicSprites#getTime</code></a> internally and returns its returning value). With only one parameter which belongs to the "returnValueOnFail" parameter of the <a href="CB_GraphicSprites.html#getTime"><code>CB_GraphicSprites#getTime</code></a> method.</p></td>
|
16912 | </tr>
|
16913 |
|
16914 |
|
16915 |
|
16916 | <tr>
|
16917 |
|
16918 | <td class="name"><code>getTimeElapsed</code></td>
|
16919 |
|
16920 |
|
16921 | <td class="type">
|
16922 |
|
16923 |
|
16924 | <span class="param-type">function</span>
|
16925 |
|
16926 |
|
16927 |
|
16928 |
|
16929 | </td>
|
16930 |
|
16931 |
|
16932 | <td class="attributes">
|
16933 |
|
16934 |
|
16935 |
|
16936 | </td>
|
16937 |
|
16938 |
|
16939 |
|
16940 | <td class="default">
|
16941 |
|
16942 | </td>
|
16943 |
|
16944 |
|
16945 | <td class="description last"><p>Read-only property which is a method that returns how many milliseconds elapsed since the sprite was or will be pointed (checking its "time" property), comparing with the time given in milliseconds (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function) or with the current one if none is given (calls <a href="CB_GraphicSprites.html#getTimeElapsed"><code>CB_GraphicSprites#getTimeElapsed</code></a> internally and returns its returning value). With only one parameter which belongs to the "timeToCompare" parameter of the <a href="CB_GraphicSprites.html#getTimeElapsed"><code>CB_GraphicSprites#getTimeElapsed</code></a> method.</p></td>
|
16946 | </tr>
|
16947 |
|
16948 |
|
16949 |
|
16950 | <tr>
|
16951 |
|
16952 | <td class="name"><code>removeAll</code></td>
|
16953 |
|
16954 |
|
16955 | <td class="type">
|
16956 |
|
16957 |
|
16958 | <span class="param-type">function</span>
|
16959 |
|
16960 |
|
16961 |
|
16962 |
|
16963 | </td>
|
16964 |
|
16965 |
|
16966 | <td class="attributes">
|
16967 |
|
16968 |
|
16969 |
|
16970 | </td>
|
16971 |
|
16972 |
|
16973 |
|
16974 | <td class="default">
|
16975 |
|
16976 | </td>
|
16977 |
|
16978 |
|
16979 | <td class="description last"><p>Read-only property which is a method that removes all the internal sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects) from the sprite which are in the "subSprites" property (calls <a href="CB_GraphicSprites.html#removeSubSprites"><code>CB_GraphicSprites#removeSubSprites</code></a> internally and returns its returning value). With no parameters.</p></td>
|
16980 | </tr>
|
16981 |
|
16982 |
|
16983 |
|
16984 | <tr>
|
16985 |
|
16986 | <td class="name"><code>removeSubSprites</code></td>
|
16987 |
|
16988 |
|
16989 | <td class="type">
|
16990 |
|
16991 |
|
16992 | <span class="param-type">function</span>
|
16993 |
|
16994 |
|
16995 |
|
16996 |
|
16997 | </td>
|
16998 |
|
16999 |
|
17000 | <td class="attributes">
|
17001 |
|
17002 |
|
17003 |
|
17004 | </td>
|
17005 |
|
17006 |
|
17007 |
|
17008 | <td class="default">
|
17009 |
|
17010 | </td>
|
17011 |
|
17012 |
|
17013 | <td class="description last"><p>Alias for the "removeAll" method.</p></td>
|
17014 | </tr>
|
17015 |
|
17016 |
|
17017 |
|
17018 | <tr>
|
17019 |
|
17020 | <td class="name"><code>insertSubSprites</code></td>
|
17021 |
|
17022 |
|
17023 | <td class="type">
|
17024 |
|
17025 |
|
17026 | <span class="param-type">function</span>
|
17027 |
|
17028 |
|
17029 |
|
17030 |
|
17031 | </td>
|
17032 |
|
17033 |
|
17034 | <td class="attributes">
|
17035 |
|
17036 |
|
17037 |
|
17038 | </td>
|
17039 |
|
17040 |
|
17041 |
|
17042 | <td class="default">
|
17043 |
|
17044 | </td>
|
17045 |
|
17046 |
|
17047 | <td class="description last"><p>Read-only property which is a method that inserts the given sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects) in the sprite, adding them to the "subSprites" property (calls <a href="CB_GraphicSprites.html#insertSubSprites"><code>CB_GraphicSprites#insertSubSprites</code></a> internally and returns its returning value). With only one parameter which belongs to the "subSprites" parameter of the <a href="CB_GraphicSprites.html#insertSubSprites"><code>CB_GraphicSprites#insertSubSprites</code></a> method.</p></td>
|
17048 | </tr>
|
17049 |
|
17050 |
|
17051 |
|
17052 | <tr>
|
17053 |
|
17054 | <td class="name"><code>remove</code></td>
|
17055 |
|
17056 |
|
17057 | <td class="type">
|
17058 |
|
17059 |
|
17060 | <span class="param-type">function</span>
|
17061 |
|
17062 |
|
17063 |
|
17064 |
|
17065 | </td>
|
17066 |
|
17067 |
|
17068 | <td class="attributes">
|
17069 |
|
17070 |
|
17071 |
|
17072 | </td>
|
17073 |
|
17074 |
|
17075 |
|
17076 | <td class="default">
|
17077 |
|
17078 | </td>
|
17079 |
|
17080 |
|
17081 | <td class="description last"><p>Read-only property which is a method that removes an internal sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) by its index (position in the "subSprites" array) from the sprite, removing it from the "subSprites" property (calls <a href="CB_GraphicSprites.html#removeSubSprite"><code>CB_GraphicSprites#removeSubSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "index" parameter of the <a href="CB_GraphicSprites.html#removeSubSprite"><code>CB_GraphicSprites#removeSubSprite</code></a> method.</p></td>
|
17082 | </tr>
|
17083 |
|
17084 |
|
17085 |
|
17086 | <tr>
|
17087 |
|
17088 | <td class="name"><code>removeById</code></td>
|
17089 |
|
17090 |
|
17091 | <td class="type">
|
17092 |
|
17093 |
|
17094 | <span class="param-type">function</span>
|
17095 |
|
17096 |
|
17097 |
|
17098 |
|
17099 | </td>
|
17100 |
|
17101 |
|
17102 | <td class="attributes">
|
17103 |
|
17104 |
|
17105 |
|
17106 | </td>
|
17107 |
|
17108 |
|
17109 |
|
17110 | <td class="default">
|
17111 |
|
17112 | </td>
|
17113 |
|
17114 |
|
17115 | <td class="description last"><p>Read-only property which is a method that removes an internal sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) by its identifier from the sprite, removing it from the "subSprites" property (calls <a href="CB_GraphicSprites.html#removeSubSpriteById"><code>CB_GraphicSprites#removeSubSpriteById</code></a> internally and returns its returning value). With only one parameter which belongs to the "id" parameter of the <a href="CB_GraphicSprites.html#removeSubSpriteById"><code>CB_GraphicSprites#removeSubSpriteById</code></a> method.</p></td>
|
17116 | </tr>
|
17117 |
|
17118 |
|
17119 |
|
17120 | <tr>
|
17121 |
|
17122 | <td class="name"><code>insert</code></td>
|
17123 |
|
17124 |
|
17125 | <td class="type">
|
17126 |
|
17127 |
|
17128 | <span class="param-type">function</span>
|
17129 |
|
17130 |
|
17131 |
|
17132 |
|
17133 | </td>
|
17134 |
|
17135 |
|
17136 | <td class="attributes">
|
17137 |
|
17138 |
|
17139 |
|
17140 | </td>
|
17141 |
|
17142 |
|
17143 |
|
17144 | <td class="default">
|
17145 |
|
17146 | </td>
|
17147 |
|
17148 |
|
17149 | <td class="description last"><p>Read-only property which is a method that inserts a given sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) in the sprite, adding it to the "subSprites" property (calls <a href="CB_GraphicSprites.html#insertSubSprite"><code>CB_GraphicSprites#insertSubSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "subSprite" parameter of the <a href="CB_GraphicSprites.html#insertSubSprite"><code>CB_GraphicSprites#insertSubSprite</code></a> method.</p></td>
|
17150 | </tr>
|
17151 |
|
17152 |
|
17153 |
|
17154 | <tr>
|
17155 |
|
17156 | <td class="name"><code>getAll</code></td>
|
17157 |
|
17158 |
|
17159 | <td class="type">
|
17160 |
|
17161 |
|
17162 | <span class="param-type">function</span>
|
17163 |
|
17164 |
|
17165 |
|
17166 |
|
17167 | </td>
|
17168 |
|
17169 |
|
17170 | <td class="attributes">
|
17171 |
|
17172 |
|
17173 |
|
17174 | </td>
|
17175 |
|
17176 |
|
17177 |
|
17178 | <td class="default">
|
17179 |
|
17180 | </td>
|
17181 |
|
17182 |
|
17183 | <td class="description last"><p>Read-only property which is a method that returns all the internal sub-sprites (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects) in the sprite, getting them from the "subSprites" property (calls <a href="CB_GraphicSprites.html#getAll"><code>CB_GraphicSprites#getAll</code></a> internally and returns its returning value). With two parameters ("orderedByZIndex" and "returnValueOnFail") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#getAll"><code>CB_GraphicSprites#getAll</code></a> method.</p></td>
|
17184 | </tr>
|
17185 |
|
17186 |
|
17187 |
|
17188 | <tr>
|
17189 |
|
17190 | <td class="name"><code>getSubSprites</code></td>
|
17191 |
|
17192 |
|
17193 | <td class="type">
|
17194 |
|
17195 |
|
17196 | <span class="param-type">function</span>
|
17197 |
|
17198 |
|
17199 |
|
17200 |
|
17201 | </td>
|
17202 |
|
17203 |
|
17204 | <td class="attributes">
|
17205 |
|
17206 |
|
17207 |
|
17208 | </td>
|
17209 |
|
17210 |
|
17211 |
|
17212 | <td class="default">
|
17213 |
|
17214 | </td>
|
17215 |
|
17216 |
|
17217 | <td class="description last"><p>Alias for the "getAll" method.</p></td>
|
17218 | </tr>
|
17219 |
|
17220 |
|
17221 |
|
17222 | <tr>
|
17223 |
|
17224 | <td class="name"><code>get</code></td>
|
17225 |
|
17226 |
|
17227 | <td class="type">
|
17228 |
|
17229 |
|
17230 | <span class="param-type">function</span>
|
17231 |
|
17232 |
|
17233 |
|
17234 |
|
17235 | </td>
|
17236 |
|
17237 |
|
17238 | <td class="attributes">
|
17239 |
|
17240 |
|
17241 |
|
17242 | </td>
|
17243 |
|
17244 |
|
17245 |
|
17246 | <td class="default">
|
17247 |
|
17248 | </td>
|
17249 |
|
17250 |
|
17251 | <td class="description last"><p>Read-only property which is a method that returns a sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) by its index (position in the "subSprites" array) from the sprite, getting it from the "subSprites" property (calls <a href="CB_GraphicSprites.html#getSubSprite"><code>CB_GraphicSprites#getSubSprite</code></a> internally and returns its returning value). With two parameters ("index" and "returnValueOnFail") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#getSubSprite"><code>CB_GraphicSprites#getSubSprite</code></a> method.</p></td>
|
17252 | </tr>
|
17253 |
|
17254 |
|
17255 |
|
17256 | <tr>
|
17257 |
|
17258 | <td class="name"><code>getById</code></td>
|
17259 |
|
17260 |
|
17261 | <td class="type">
|
17262 |
|
17263 |
|
17264 | <span class="param-type">function</span>
|
17265 |
|
17266 |
|
17267 |
|
17268 |
|
17269 | </td>
|
17270 |
|
17271 |
|
17272 | <td class="attributes">
|
17273 |
|
17274 |
|
17275 |
|
17276 | </td>
|
17277 |
|
17278 |
|
17279 |
|
17280 | <td class="default">
|
17281 |
|
17282 | </td>
|
17283 |
|
17284 |
|
17285 | <td class="description last"><p>Read-only property which is a method that returns a sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) by its identifier from the sprite, getting it from the "subSprites" property (calls <a href="CB_GraphicSprites.html#getSubSpriteById"><code>CB_GraphicSprites#getSubSpriteById</code></a> internally and returns its returning value). With two parameters ("id" and "returnValueOnFail") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#getSubSpriteById"><code>CB_GraphicSprites#getSubSpriteById</code></a> method.</p></td>
|
17286 | </tr>
|
17287 |
|
17288 |
|
17289 |
|
17290 | <tr>
|
17291 |
|
17292 | <td class="name"><code>getIndexById</code></td>
|
17293 |
|
17294 |
|
17295 | <td class="type">
|
17296 |
|
17297 |
|
17298 | <span class="param-type">function</span>
|
17299 |
|
17300 |
|
17301 |
|
17302 |
|
17303 | </td>
|
17304 |
|
17305 |
|
17306 | <td class="attributes">
|
17307 |
|
17308 |
|
17309 |
|
17310 | </td>
|
17311 |
|
17312 |
|
17313 |
|
17314 | <td class="default">
|
17315 |
|
17316 | </td>
|
17317 |
|
17318 |
|
17319 | <td class="description last"><p>Read-only property which is a method that returns the index (position in the "subSprites" array) of a sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) by its identifier (calls <a href="CB_GraphicSprites.html#getSubSpriteIndexById"><code>CB_GraphicSprites#getSubSpriteIndexById</code></a> internally and returns its returning value). With only one parameter which belongs to the "id" parameter of the <a href="CB_GraphicSprites.html#getSubSpriteIndexById"><code>CB_GraphicSprites#getSubSpriteIndexById</code></a> method.</p></td>
|
17320 | </tr>
|
17321 |
|
17322 |
|
17323 |
|
17324 | <tr>
|
17325 |
|
17326 | <td class="name"><code>executeFunctionAll</code></td>
|
17327 |
|
17328 |
|
17329 | <td class="type">
|
17330 |
|
17331 |
|
17332 | <span class="param-type">function</span>
|
17333 |
|
17334 |
|
17335 |
|
17336 |
|
17337 | </td>
|
17338 |
|
17339 |
|
17340 | <td class="attributes">
|
17341 |
|
17342 |
|
17343 |
|
17344 | </td>
|
17345 |
|
17346 |
|
17347 |
|
17348 | <td class="default">
|
17349 |
|
17350 | </td>
|
17351 |
|
17352 |
|
17353 | <td class="description last"><p>Read-only property which is a method that executes the desired function for each sub-sprite (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects which are in the "subSprites" property) in the sprite (calls <a href="CB_GraphicSprites.html#executeFunctionAllSubSprites"><code>CB_GraphicSprites#executeFunctionAllSubSprites</code></a> internally and returns its returning value). With five parameters ("functionEach", "orderedByZIndex", "delayBetweenEach", "returnSetTimeoutsArray", "delayBetweenEachAffectsFirst" and "functionFinish") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#executeFunctionAllSubSprites"><code>CB_GraphicSprites#executeFunctionAllSubSprites</code></a> method.</p></td>
|
17354 | </tr>
|
17355 |
|
17356 |
|
17357 |
|
17358 | <tr>
|
17359 |
|
17360 | <td class="name"><code>executeAll</code></td>
|
17361 |
|
17362 |
|
17363 | <td class="type">
|
17364 |
|
17365 |
|
17366 | <span class="param-type">function</span>
|
17367 |
|
17368 |
|
17369 |
|
17370 |
|
17371 | </td>
|
17372 |
|
17373 |
|
17374 | <td class="attributes">
|
17375 |
|
17376 |
|
17377 |
|
17378 | </td>
|
17379 |
|
17380 |
|
17381 |
|
17382 | <td class="default">
|
17383 |
|
17384 | </td>
|
17385 |
|
17386 |
|
17387 | <td class="description last"><p>Alias for the "executeFunctionAll" method.</p></td>
|
17388 | </tr>
|
17389 |
|
17390 |
|
17391 |
|
17392 | <tr>
|
17393 |
|
17394 | <td class="name"><code>forEach</code></td>
|
17395 |
|
17396 |
|
17397 | <td class="type">
|
17398 |
|
17399 |
|
17400 | <span class="param-type">function</span>
|
17401 |
|
17402 |
|
17403 |
|
17404 |
|
17405 | </td>
|
17406 |
|
17407 |
|
17408 | <td class="attributes">
|
17409 |
|
17410 |
|
17411 |
|
17412 | </td>
|
17413 |
|
17414 |
|
17415 |
|
17416 | <td class="default">
|
17417 |
|
17418 | </td>
|
17419 |
|
17420 |
|
17421 | <td class="description last"><p>Alias for the "executeFunctionAll" method.</p></td>
|
17422 | </tr>
|
17423 |
|
17424 |
|
17425 |
|
17426 | <tr>
|
17427 |
|
17428 | <td class="name"><code>getZIndex</code></td>
|
17429 |
|
17430 |
|
17431 | <td class="type">
|
17432 |
|
17433 |
|
17434 | <span class="param-type">function</span>
|
17435 |
|
17436 |
|
17437 |
|
17438 |
|
17439 | </td>
|
17440 |
|
17441 |
|
17442 | <td class="attributes">
|
17443 |
|
17444 |
|
17445 |
|
17446 | </td>
|
17447 |
|
17448 |
|
17449 |
|
17450 | <td class="default">
|
17451 |
|
17452 | </td>
|
17453 |
|
17454 |
|
17455 | <td class="description last"><p>Read-only property which is a method that returns the z-index ("z-index" property) of the sprite (calls <a href="CB_GraphicSprites.html#getZIndexSprite"><code>CB_GraphicSprites#getZIndexSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "returnValueOnFail" parameter of the <a href="CB_GraphicSprites.html#getZIndexSprite"><code>CB_GraphicSprites#getZIndexSprite</code></a> method.</p></td>
|
17456 | </tr>
|
17457 |
|
17458 |
|
17459 |
|
17460 | <tr>
|
17461 |
|
17462 | <td class="name"><code>setZIndex</code></td>
|
17463 |
|
17464 |
|
17465 | <td class="type">
|
17466 |
|
17467 |
|
17468 | <span class="param-type">function</span>
|
17469 |
|
17470 |
|
17471 |
|
17472 |
|
17473 | </td>
|
17474 |
|
17475 |
|
17476 | <td class="attributes">
|
17477 |
|
17478 |
|
17479 |
|
17480 | </td>
|
17481 |
|
17482 |
|
17483 |
|
17484 | <td class="default">
|
17485 |
|
17486 | </td>
|
17487 |
|
17488 |
|
17489 | <td class="description last"><p>Read-only property which is a method to set the z-index ("z-index" property) of the sprite (calls <a href="CB_GraphicSprites.html#setZIndexSprite"><code>CB_GraphicSprites#setZIndexSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "zIndex" parameter of the <a href="CB_GraphicSprites.html#setZIndexSprite"><code>CB_GraphicSprites#setZIndexSprite</code></a> method.</p></td>
|
17490 | </tr>
|
17491 |
|
17492 |
|
17493 |
|
17494 | <tr>
|
17495 |
|
17496 | <td class="name"><code>isDisabled</code></td>
|
17497 |
|
17498 |
|
17499 | <td class="type">
|
17500 |
|
17501 |
|
17502 | <span class="param-type">function</span>
|
17503 |
|
17504 |
|
17505 |
|
17506 |
|
17507 | </td>
|
17508 |
|
17509 |
|
17510 | <td class="attributes">
|
17511 |
|
17512 |
|
17513 |
|
17514 | </td>
|
17515 |
|
17516 |
|
17517 |
|
17518 | <td class="default">
|
17519 |
|
17520 | </td>
|
17521 |
|
17522 |
|
17523 | <td class="description last"><p>Read-only property which is a method that tells whether the sprite is disabled or not (calls <a href="CB_GraphicSprites.html#isDisabledSprite"><code>CB_GraphicSprites#isDisabledSprite</code></a> internally and returns its returning value). With no parameters. A sprite is considered disabled if its sprites group parent is also disabled.</p></td>
|
17524 | </tr>
|
17525 |
|
17526 |
|
17527 |
|
17528 | <tr>
|
17529 |
|
17530 | <td class="name"><code>setDisabled</code></td>
|
17531 |
|
17532 |
|
17533 | <td class="type">
|
17534 |
|
17535 |
|
17536 | <span class="param-type">function</span>
|
17537 |
|
17538 |
|
17539 |
|
17540 |
|
17541 | </td>
|
17542 |
|
17543 |
|
17544 | <td class="attributes">
|
17545 |
|
17546 |
|
17547 |
|
17548 | </td>
|
17549 |
|
17550 |
|
17551 |
|
17552 | <td class="default">
|
17553 |
|
17554 | </td>
|
17555 |
|
17556 |
|
17557 | <td class="description last"><p>Read-only property which is a method to disable or enable the sprite (calls <a href="CB_GraphicSprites.html#setDisabledSprite"><code>CB_GraphicSprites#setDisabledSprite</code></a> internally and returns its returning value). With four parameters ("disabled", "affectSubSprites", "affectParent" and "affectParentChildren") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#setDisabledSprite"><code>CB_GraphicSprites#setDisabledSprite</code></a> method.</p></td>
|
17558 | </tr>
|
17559 |
|
17560 |
|
17561 |
|
17562 | <tr>
|
17563 |
|
17564 | <td class="name"><code>getPointer</code></td>
|
17565 |
|
17566 |
|
17567 | <td class="type">
|
17568 |
|
17569 |
|
17570 | <span class="param-type">function</span>
|
17571 |
|
17572 |
|
17573 |
|
17574 |
|
17575 | </td>
|
17576 |
|
17577 |
|
17578 | <td class="attributes">
|
17579 |
|
17580 |
|
17581 |
|
17582 | </td>
|
17583 |
|
17584 |
|
17585 |
|
17586 | <td class="default">
|
17587 |
|
17588 | </td>
|
17589 |
|
17590 |
|
17591 | <td class="description last"><p>Read-only property which is a method that gets the current position of the pointer. It belongs to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). Internally, it uses the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property. Calls <a href="CB_GraphicSprites.html#getPointer"><code>CB_GraphicSprites#getPointer</code></a> internally and returns its returning value. With no parameters.</p></td>
|
17592 | </tr>
|
17593 |
|
17594 |
|
17595 |
|
17596 | <tr>
|
17597 |
|
17598 | <td class="name"><code>getCurrentPosition</code></td>
|
17599 |
|
17600 |
|
17601 | <td class="type">
|
17602 |
|
17603 |
|
17604 | <span class="param-type">function</span>
|
17605 |
|
17606 |
|
17607 |
|
17608 |
|
17609 | </td>
|
17610 |
|
17611 |
|
17612 | <td class="attributes">
|
17613 |
|
17614 |
|
17615 |
|
17616 | </td>
|
17617 |
|
17618 |
|
17619 |
|
17620 | <td class="default">
|
17621 |
|
17622 | </td>
|
17623 |
|
17624 |
|
17625 | <td class="description last"><p>Alias for the "getPointer" method.</p></td>
|
17626 | </tr>
|
17627 |
|
17628 |
|
17629 |
|
17630 | <tr>
|
17631 |
|
17632 | <td class="name"><code>getPointerPrevious</code></td>
|
17633 |
|
17634 |
|
17635 | <td class="type">
|
17636 |
|
17637 |
|
17638 | <span class="param-type">function</span>
|
17639 |
|
17640 |
|
17641 |
|
17642 |
|
17643 | </td>
|
17644 |
|
17645 |
|
17646 | <td class="attributes">
|
17647 |
|
17648 |
|
17649 |
|
17650 | </td>
|
17651 |
|
17652 |
|
17653 |
|
17654 | <td class="default">
|
17655 |
|
17656 | </td>
|
17657 |
|
17658 |
|
17659 | <td class="description last"><p>Read-only property which is a method that gets the previous position of the pointer. Internally, it uses the <a href="CB_GraphicSprites.html#pointerPrevious"><code>CB_GraphicSprites#pointerPrevious</code></a> property. Calls <a href="CB_GraphicSprites.html#getPointerPrevious"><code>CB_GraphicSprites#getPointerPrevious</code></a> internally and returns its returning value. With no parameters.</p></td>
|
17660 | </tr>
|
17661 |
|
17662 |
|
17663 |
|
17664 | <tr>
|
17665 |
|
17666 | <td class="name"><code>getPreviousPosition</code></td>
|
17667 |
|
17668 |
|
17669 | <td class="type">
|
17670 |
|
17671 |
|
17672 | <span class="param-type">function</span>
|
17673 |
|
17674 |
|
17675 |
|
17676 |
|
17677 | </td>
|
17678 |
|
17679 |
|
17680 | <td class="attributes">
|
17681 |
|
17682 |
|
17683 |
|
17684 | </td>
|
17685 |
|
17686 |
|
17687 |
|
17688 | <td class="default">
|
17689 |
|
17690 | </td>
|
17691 |
|
17692 |
|
17693 | <td class="description last"><p>Alias for the "getPointerPrevious" method.</p></td>
|
17694 | </tr>
|
17695 |
|
17696 |
|
17697 |
|
17698 | <tr>
|
17699 |
|
17700 | <td class="name"><code>setPointer</code></td>
|
17701 |
|
17702 |
|
17703 | <td class="type">
|
17704 |
|
17705 |
|
17706 | <span class="param-type">function</span>
|
17707 |
|
17708 |
|
17709 |
|
17710 |
|
17711 | </td>
|
17712 |
|
17713 |
|
17714 | <td class="attributes">
|
17715 |
|
17716 |
|
17717 |
|
17718 | </td>
|
17719 |
|
17720 |
|
17721 |
|
17722 | <td class="default">
|
17723 |
|
17724 | </td>
|
17725 |
|
17726 |
|
17727 | <td class="description last"><p>Read-only property which is a method that sets the pointer to the desired position (if possible). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite). Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will also reset the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds). Calls <a href="CB_GraphicSprites.html#setPointer"><code>CB_GraphicSprites#setPointer</code></a> internally and returns the sprite (a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) which is being currently pointed (by the pointer set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property). With two parameters ("position" and "loop") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#setPointer"><code>CB_GraphicSprites#setPointer</code></a> method.</p></td>
|
17728 | </tr>
|
17729 |
|
17730 |
|
17731 |
|
17732 | <tr>
|
17733 |
|
17734 | <td class="name"><code>setCurrentPosition</code></td>
|
17735 |
|
17736 |
|
17737 | <td class="type">
|
17738 |
|
17739 |
|
17740 | <span class="param-type">function</span>
|
17741 |
|
17742 |
|
17743 |
|
17744 |
|
17745 | </td>
|
17746 |
|
17747 |
|
17748 | <td class="attributes">
|
17749 |
|
17750 |
|
17751 |
|
17752 | </td>
|
17753 |
|
17754 |
|
17755 |
|
17756 | <td class="default">
|
17757 |
|
17758 | </td>
|
17759 |
|
17760 |
|
17761 | <td class="description last"><p>Alias for the "setPointer" method.</p></td>
|
17762 | </tr>
|
17763 |
|
17764 |
|
17765 |
|
17766 | <tr>
|
17767 |
|
17768 | <td class="name"><code>getCurrent</code></td>
|
17769 |
|
17770 |
|
17771 | <td class="type">
|
17772 |
|
17773 |
|
17774 | <span class="param-type">function</span>
|
17775 |
|
17776 |
|
17777 |
|
17778 |
|
17779 | </td>
|
17780 |
|
17781 |
|
17782 | <td class="attributes">
|
17783 |
|
17784 |
|
17785 |
|
17786 | </td>
|
17787 |
|
17788 |
|
17789 |
|
17790 | <td class="default">
|
17791 |
|
17792 | </td>
|
17793 |
|
17794 |
|
17795 | <td class="description last"><p>Read-only property which is a method that gets the sprite (a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object) which is being currently pointed (by the pointer set in the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property). Calls <a href="CB_GraphicSprites.html#getCurrent"><code>CB_GraphicSprites#getCurrent</code></a> internally and returns its returning value. With no parameters.</p></td>
|
17796 | </tr>
|
17797 |
|
17798 |
|
17799 |
|
17800 | <tr>
|
17801 |
|
17802 | <td class="name"><code>current</code></td>
|
17803 |
|
17804 |
|
17805 | <td class="type">
|
17806 |
|
17807 |
|
17808 | <span class="param-type">function</span>
|
17809 |
|
17810 |
|
17811 |
|
17812 |
|
17813 | </td>
|
17814 |
|
17815 |
|
17816 | <td class="attributes">
|
17817 |
|
17818 |
|
17819 |
|
17820 | </td>
|
17821 |
|
17822 |
|
17823 |
|
17824 | <td class="default">
|
17825 |
|
17826 | </td>
|
17827 |
|
17828 |
|
17829 | <td class="description last"><p>Alias for the "getCurrent" method.</p></td>
|
17830 | </tr>
|
17831 |
|
17832 |
|
17833 |
|
17834 | <tr>
|
17835 |
|
17836 | <td class="name"><code>now</code></td>
|
17837 |
|
17838 |
|
17839 | <td class="type">
|
17840 |
|
17841 |
|
17842 | <span class="param-type">function</span>
|
17843 |
|
17844 |
|
17845 |
|
17846 |
|
17847 | </td>
|
17848 |
|
17849 |
|
17850 | <td class="attributes">
|
17851 |
|
17852 |
|
17853 |
|
17854 | </td>
|
17855 |
|
17856 |
|
17857 |
|
17858 | <td class="default">
|
17859 |
|
17860 | </td>
|
17861 |
|
17862 |
|
17863 | <td class="description last"><p>Alias for the "getCurrent" method.</p></td>
|
17864 | </tr>
|
17865 |
|
17866 |
|
17867 |
|
17868 | <tr>
|
17869 |
|
17870 | <td class="name"><code>getPrevious</code></td>
|
17871 |
|
17872 |
|
17873 | <td class="type">
|
17874 |
|
17875 |
|
17876 | <span class="param-type">function</span>
|
17877 |
|
17878 |
|
17879 |
|
17880 |
|
17881 | </td>
|
17882 |
|
17883 |
|
17884 | <td class="attributes">
|
17885 |
|
17886 |
|
17887 |
|
17888 | </td>
|
17889 |
|
17890 |
|
17891 |
|
17892 | <td class="default">
|
17893 |
|
17894 | </td>
|
17895 |
|
17896 |
|
17897 | <td class="description last"><p>Read-only property which is a method that gets the sprite which was previously pointed if any or returns null otherwise. It does not modify the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property. Calls <a href="CB_GraphicSprites.html#getPrevious"><code>CB_GraphicSprites#getPrevious</code></a> internally and returns its returning value. With no parameters.</p></td>
|
17898 | </tr>
|
17899 |
|
17900 |
|
17901 |
|
17902 | <tr>
|
17903 |
|
17904 | <td class="name"><code>setPrevious</code></td>
|
17905 |
|
17906 |
|
17907 | <td class="type">
|
17908 |
|
17909 |
|
17910 | <span class="param-type">function</span>
|
17911 |
|
17912 |
|
17913 |
|
17914 |
|
17915 | </td>
|
17916 |
|
17917 |
|
17918 | <td class="attributes">
|
17919 |
|
17920 |
|
17921 |
|
17922 | </td>
|
17923 |
|
17924 |
|
17925 |
|
17926 | <td class="default">
|
17927 |
|
17928 | </td>
|
17929 |
|
17930 |
|
17931 | <td class="description last"><p>Read-only property which is a method that makes the pointer to go back to the previous position (if possible) and returns the sprite located there (if any). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite) and it will be returned if found. Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will update also the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds). Calls <a href="CB_GraphicSprites.html#setPrevious"><code>CB_GraphicSprites#setPrevious</code></a> internally and returns its returning value. With only one parameter which belongs to the "loop" parameter of the <a href="CB_GraphicSprites.html#setPrevious"><code>CB_GraphicSprites#setPrevious</code></a> method.</p></td>
|
17932 | </tr>
|
17933 |
|
17934 |
|
17935 |
|
17936 | <tr>
|
17937 |
|
17938 | <td class="name"><code>previous</code></td>
|
17939 |
|
17940 |
|
17941 | <td class="type">
|
17942 |
|
17943 |
|
17944 | <span class="param-type">function</span>
|
17945 |
|
17946 |
|
17947 |
|
17948 |
|
17949 | </td>
|
17950 |
|
17951 |
|
17952 | <td class="attributes">
|
17953 |
|
17954 |
|
17955 |
|
17956 | </td>
|
17957 |
|
17958 |
|
17959 |
|
17960 | <td class="default">
|
17961 |
|
17962 | </td>
|
17963 |
|
17964 |
|
17965 | <td class="description last"><p>Alias for the "setPrevious" method.</p></td>
|
17966 | </tr>
|
17967 |
|
17968 |
|
17969 |
|
17970 | <tr>
|
17971 |
|
17972 | <td class="name"><code>setNext</code></td>
|
17973 |
|
17974 |
|
17975 | <td class="type">
|
17976 |
|
17977 |
|
17978 | <span class="param-type">function</span>
|
17979 |
|
17980 |
|
17981 |
|
17982 |
|
17983 | </td>
|
17984 |
|
17985 |
|
17986 | <td class="attributes">
|
17987 |
|
17988 |
|
17989 |
|
17990 | </td>
|
17991 |
|
17992 |
|
17993 |
|
17994 | <td class="default">
|
17995 |
|
17996 | </td>
|
17997 |
|
17998 |
|
17999 | <td class="description last"><p>Read-only property which is a method that makes the pointer to advance to the next position (if possible) and returns the sprite located there (if any). The position should belong to an index of the <code>CB_GraphicSprites#spritesGroup.sprites</code> array where a <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object is placed (containing a sprite) and it will be returned if found. Internally, it modifies the <a href="CB_GraphicSprites.html#pointer"><code>CB_GraphicSprites#pointer</code></a> property (if possible). If the position was updated, it will also update the <a href="CB_GraphicSprites.html#time"><code>CB_GraphicSprites#time</code></a> property (setting the current time in milliseconds). Calls <a href="CB_GraphicSprites.html#setNext"><code>CB_GraphicSprites#setNext</code></a> internally and returns its returning value. With only one parameter which belongs to the "loop" parameter of the <a href="CB_GraphicSprites.html#setNext"><code>CB_GraphicSprites#setNext</code></a> method.</p></td>
|
18000 | </tr>
|
18001 |
|
18002 |
|
18003 |
|
18004 | <tr>
|
18005 |
|
18006 | <td class="name"><code>next</code></td>
|
18007 |
|
18008 |
|
18009 | <td class="type">
|
18010 |
|
18011 |
|
18012 | <span class="param-type">function</span>
|
18013 |
|
18014 |
|
18015 |
|
18016 |
|
18017 | </td>
|
18018 |
|
18019 |
|
18020 | <td class="attributes">
|
18021 |
|
18022 |
|
18023 |
|
18024 | </td>
|
18025 |
|
18026 |
|
18027 |
|
18028 | <td class="default">
|
18029 |
|
18030 | </td>
|
18031 |
|
18032 |
|
18033 | <td class="description last"><p>Alias for the "setNext" method.</p></td>
|
18034 | </tr>
|
18035 |
|
18036 |
|
18037 |
|
18038 | <tr>
|
18039 |
|
18040 | <td class="name"><code>setPropertyCascade</code></td>
|
18041 |
|
18042 |
|
18043 | <td class="type">
|
18044 |
|
18045 |
|
18046 | <span class="param-type">function</span>
|
18047 |
|
18048 |
|
18049 |
|
18050 |
|
18051 | </td>
|
18052 |
|
18053 |
|
18054 | <td class="attributes">
|
18055 |
|
18056 |
|
18057 |
|
18058 | </td>
|
18059 |
|
18060 |
|
18061 |
|
18062 | <td class="default">
|
18063 |
|
18064 | </td>
|
18065 |
|
18066 |
|
18067 | <td class="description last"><p>Read-only property which is a method that sets the desired value of a given property name to the sprite itself and all of its sub-sprites (if any). Calls <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> internally and returns its returning value. With two parameters ("propertyName" and "value") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#setPropertyCascade"><code>CB_GraphicSprites#setPropertyCascade</code></a> method.</p></td>
|
18068 | </tr>
|
18069 |
|
18070 |
|
18071 | </tbody>
|
18072 | </table>
|
18073 | </dl>
|
18074 |
|
18075 |
|
18076 |
|
18077 |
|
18078 |
|
18079 |
|
18080 |
|
18081 |
|
18082 |
|
18083 |
|
18084 |
|
18085 |
|
18086 |
|
18087 |
|
18088 |
|
18089 |
|
18090 |
|
18091 |
|
18092 |
|
18093 |
|
18094 |
|
18095 |
|
18096 |
|
18097 |
|
18098 |
|
18099 |
|
18100 |
|
18101 |
|
18102 |
|
18103 |
|
18104 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
18105 | <dd class="tag-source">
|
18106 | <ul class="dummy">
|
18107 | <li>
|
18108 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
18109 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-61">line 61</a>
|
18110 | </li>
|
18111 | </ul>
|
18112 | </dd>
|
18113 |
|
18114 |
|
18115 |
|
18116 |
|
18117 |
|
18118 |
|
18119 |
|
18120 | </dl>
|
18121 |
|
18122 |
|
18123 |
|
18124 | <h5>Example</h5>
|
18125 |
|
18126 | <pre class="sunlight-highlight-javascript">{
|
18127 | //'my_sprite_1':
|
18128 | id: "my_sprite_1",
|
18129 | src: "path/to/image.gif",
|
18130 | srcType: CB_GraphicSprites.SRC_TYPES.IMAGE,
|
18131 | srcLeft: 10,
|
18132 | srcTop: 20,
|
18133 | srcWidth: 64,
|
18134 | srcHeight: 32,
|
18135 | left: 10,
|
18136 | top: 20,
|
18137 | width: 64,
|
18138 | height: 32,
|
18139 | disabled: false,
|
18140 | data: { datum_1 : "value_1", datum_2 : 2, datum_3: [ "a", "b", "c" ] },
|
18141 | subSprites:
|
18142 | [
|
18143 | //'my_subsprite_1':
|
18144 | { id: "my_subsprite_1", srcLeft: 10, srcTop: 20, zIndex: 1 },
|
18145 | //'my_subsprite_2':
|
18146 | { id: "my_subsprite_2", srcLeft: 20, srcTop: 40, zIndex: 2 }
|
18147 | ]
|
18148 | }
</pre>
|
18149 |
|
18150 |
|
18151 |
|
18152 | </dd>
|
18153 |
|
18154 |
|
18155 |
|
18156 | <hr>
|
18157 | <dt class="name" id=".SUBSPRITE_OBJECT">
|
18158 | <h4 id=".SUBSPRITE_OBJECT">SUBSPRITE_OBJECT</h4>
|
18159 |
|
18160 |
|
18161 | </dt>
|
18162 | <dd>
|
18163 |
|
18164 | <div class="description">
|
18165 | <p>An object with the information that belongs to a sub-sprite (data which belongs to a certain source) used by a graphic sprite.</p>
|
18166 | </div>
|
18167 |
|
18168 |
|
18169 |
|
18170 | <h5>Type:</h5>
|
18171 | <ul>
|
18172 | <li>
|
18173 |
|
18174 | <span class="param-type">Object</span>
|
18175 |
|
18176 |
|
18177 |
|
18178 | </li>
|
18179 | </ul>
|
18180 |
|
18181 |
|
18182 |
|
18183 | <dl class="details">
|
18184 |
|
18185 |
|
18186 | <h5 class="subsection-title">Properties:</h5>
|
18187 |
|
18188 | <dl>
|
18189 |
|
18190 | <table class="props table table-striped">
|
18191 | <thead>
|
18192 | <tr>
|
18193 |
|
18194 | <th>Name</th>
|
18195 |
|
18196 |
|
18197 | <th>Type</th>
|
18198 |
|
18199 |
|
18200 | <th>Argument</th>
|
18201 |
|
18202 |
|
18203 |
|
18204 | <th>Default</th>
|
18205 |
|
18206 |
|
18207 | <th class="last">Description</th>
|
18208 | </tr>
|
18209 | </thead>
|
18210 |
|
18211 | <tbody>
|
18212 |
|
18213 |
|
18214 | <tr>
|
18215 |
|
18216 | <td class="name"><code>id</code></td>
|
18217 |
|
18218 |
|
18219 | <td class="type">
|
18220 |
|
18221 |
|
18222 | <span class="param-type">string</span>
|
18223 | |
|
18224 |
|
18225 | <span class="param-type">*</span>
|
18226 |
|
18227 |
|
18228 |
|
18229 |
|
18230 | </td>
|
18231 |
|
18232 |
|
18233 | <td class="attributes">
|
18234 |
|
18235 | <optional><br>
|
18236 |
|
18237 |
|
18238 |
|
18239 | </td>
|
18240 |
|
18241 |
|
18242 |
|
18243 | <td class="default">
|
18244 |
|
18245 | 'CB_GraphicSprites.subSprite_' + CB_GraphicSprites._idSubSpriteUnique++
|
18246 |
|
18247 | </td>
|
18248 |
|
18249 |
|
18250 | <td class="description last"><p>Identifier of the sub-sprite. It should be unique. It must be a value which evaluates to true. By default, it is generated automatically (with an internal counter).</p></td>
|
18251 | </tr>
|
18252 |
|
18253 |
|
18254 |
|
18255 | <tr>
|
18256 |
|
18257 | <td class="name"><code>src</code></td>
|
18258 |
|
18259 |
|
18260 | <td class="type">
|
18261 |
|
18262 |
|
18263 | <span class="param-type">*</span>
|
18264 |
|
18265 |
|
18266 |
|
18267 |
|
18268 | </td>
|
18269 |
|
18270 |
|
18271 | <td class="attributes">
|
18272 |
|
18273 | <optional><br>
|
18274 |
|
18275 |
|
18276 |
|
18277 | </td>
|
18278 |
|
18279 |
|
18280 |
|
18281 | <td class="default">
|
18282 |
|
18283 | this.parent.src|""
|
18284 |
|
18285 | </td>
|
18286 |
|
18287 |
|
18288 | <td class="description last"><p>Source of origin. Can be a path or identifier of an image, text, bitmap, 3D object, etc. They can be used for any kind of source you may think of, including (but not limited to) one sprites sheet or more, one atlas or more, etc. or even a mix of all of them. If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18289 | </tr>
|
18290 |
|
18291 |
|
18292 |
|
18293 | <tr>
|
18294 |
|
18295 | <td class="name"><code>srcType</code></td>
|
18296 |
|
18297 |
|
18298 | <td class="type">
|
18299 |
|
18300 |
|
18301 | <span class="param-type">string</span>
|
18302 |
|
18303 |
|
18304 |
|
18305 |
|
18306 | </td>
|
18307 |
|
18308 |
|
18309 | <td class="attributes">
|
18310 |
|
18311 | <optional><br>
|
18312 |
|
18313 |
|
18314 |
|
18315 | </td>
|
18316 |
|
18317 |
|
18318 |
|
18319 | <td class="default">
|
18320 |
|
18321 | this.parent.srcType|<a href="CB_GraphicSprites.html#.SRC_TYPES_DEFAULT"><code>CB_GraphicSprites.SRC_TYPES_DEFAULT</code></a>
|
18322 |
|
18323 | </td>
|
18324 |
|
18325 |
|
18326 | <td class="description last"><p>Type of the source of origin. If not provided, as default it will use the value from the sprite that it belongs to. 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>
|
18327 | </tr>
|
18328 |
|
18329 |
|
18330 |
|
18331 | <tr>
|
18332 |
|
18333 | <td class="name"><code>srcLeft</code></td>
|
18334 |
|
18335 |
|
18336 | <td class="type">
|
18337 |
|
18338 |
|
18339 | <span class="param-type">number</span>
|
18340 |
|
18341 |
|
18342 |
|
18343 |
|
18344 | </td>
|
18345 |
|
18346 |
|
18347 | <td class="attributes">
|
18348 |
|
18349 | <optional><br>
|
18350 |
|
18351 |
|
18352 |
|
18353 | </td>
|
18354 |
|
18355 |
|
18356 |
|
18357 | <td class="default">
|
18358 |
|
18359 | this.parent.srcLeft|<a href="CB_GraphicSprites.html#.LEFT_SOURCE_DEFAULT"><code>CB_GraphicSprites.LEFT_SOURCE_DEFAULT</code></a>
|
18360 |
|
18361 | </td>
|
18362 |
|
18363 |
|
18364 | <td class="description last"><p>Left (horizontal) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18365 | </tr>
|
18366 |
|
18367 |
|
18368 |
|
18369 | <tr>
|
18370 |
|
18371 | <td class="name"><code>srcTop</code></td>
|
18372 |
|
18373 |
|
18374 | <td class="type">
|
18375 |
|
18376 |
|
18377 | <span class="param-type">number</span>
|
18378 |
|
18379 |
|
18380 |
|
18381 |
|
18382 | </td>
|
18383 |
|
18384 |
|
18385 | <td class="attributes">
|
18386 |
|
18387 | <optional><br>
|
18388 |
|
18389 |
|
18390 |
|
18391 | </td>
|
18392 |
|
18393 |
|
18394 |
|
18395 | <td class="default">
|
18396 |
|
18397 | this.parent.srcTop|<a href="CB_GraphicSprites.html#.TOP_SOURCE_DEFAULT"><code>CB_GraphicSprites.TOP_SOURCE_DEFAULT</code></a>
|
18398 |
|
18399 | </td>
|
18400 |
|
18401 |
|
18402 | <td class="description last"><p>Top (vertical) position in the original source (having in mind its real width and height). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18403 | </tr>
|
18404 |
|
18405 |
|
18406 |
|
18407 | <tr>
|
18408 |
|
18409 | <td class="name"><code>srcWidth</code></td>
|
18410 |
|
18411 |
|
18412 | <td class="type">
|
18413 |
|
18414 |
|
18415 | <span class="param-type">number</span>
|
18416 |
|
18417 |
|
18418 |
|
18419 |
|
18420 | </td>
|
18421 |
|
18422 |
|
18423 | <td class="attributes">
|
18424 |
|
18425 | <optional><br>
|
18426 |
|
18427 |
|
18428 |
|
18429 | </td>
|
18430 |
|
18431 |
|
18432 |
|
18433 | <td class="default">
|
18434 |
|
18435 | this.parent.srcWidth|<a href="CB_GraphicSprites.html#.WIDTH_SOURCE_DEFAULT"><code>CB_GraphicSprites.WIDTH_SOURCE_DEFAULT</code></a>
|
18436 |
|
18437 | </td>
|
18438 |
|
18439 |
|
18440 | <td class="description last"><p>Width of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18441 | </tr>
|
18442 |
|
18443 |
|
18444 |
|
18445 | <tr>
|
18446 |
|
18447 | <td class="name"><code>srcHeight</code></td>
|
18448 |
|
18449 |
|
18450 | <td class="type">
|
18451 |
|
18452 |
|
18453 | <span class="param-type">number</span>
|
18454 |
|
18455 |
|
18456 |
|
18457 |
|
18458 | </td>
|
18459 |
|
18460 |
|
18461 | <td class="attributes">
|
18462 |
|
18463 | <optional><br>
|
18464 |
|
18465 |
|
18466 |
|
18467 | </td>
|
18468 |
|
18469 |
|
18470 |
|
18471 | <td class="default">
|
18472 |
|
18473 | this.parent.srcHeight|<a href="CB_GraphicSprites.html#.HEIGHT_SOURCE_DEFAULT"><code>CB_GraphicSprites.HEIGHT_SOURCE_DEFAULT</code></a>
|
18474 |
|
18475 | </td>
|
18476 |
|
18477 |
|
18478 | <td class="description last"><p>Height of the original source. Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18479 | </tr>
|
18480 |
|
18481 |
|
18482 |
|
18483 | <tr>
|
18484 |
|
18485 | <td class="name"><code>left</code></td>
|
18486 |
|
18487 |
|
18488 | <td class="type">
|
18489 |
|
18490 |
|
18491 | <span class="param-type">number</span>
|
18492 |
|
18493 |
|
18494 |
|
18495 |
|
18496 | </td>
|
18497 |
|
18498 |
|
18499 | <td class="attributes">
|
18500 |
|
18501 | <optional><br>
|
18502 |
|
18503 |
|
18504 |
|
18505 | </td>
|
18506 |
|
18507 |
|
18508 |
|
18509 | <td class="default">
|
18510 |
|
18511 | <a href="CB_GraphicSprites.html#.LEFT_DEFAULT"><code>CB_GraphicSprites.LEFT_DEFAULT</code></a>
|
18512 |
|
18513 | </td>
|
18514 |
|
18515 |
|
18516 | <td class="description last"><p>Left (horizontal) position in the destiny (inside the sprite). Unit agnostic (only numeric values are allowed).</p></td>
|
18517 | </tr>
|
18518 |
|
18519 |
|
18520 |
|
18521 | <tr>
|
18522 |
|
18523 | <td class="name"><code>top</code></td>
|
18524 |
|
18525 |
|
18526 | <td class="type">
|
18527 |
|
18528 |
|
18529 | <span class="param-type">number</span>
|
18530 |
|
18531 |
|
18532 |
|
18533 |
|
18534 | </td>
|
18535 |
|
18536 |
|
18537 | <td class="attributes">
|
18538 |
|
18539 | <optional><br>
|
18540 |
|
18541 |
|
18542 |
|
18543 | </td>
|
18544 |
|
18545 |
|
18546 |
|
18547 | <td class="default">
|
18548 |
|
18549 | <a href="CB_GraphicSprites.html#.TOP_DEFAULT"><code>CB_GraphicSprites.TOP_DEFAULT</code></a>
|
18550 |
|
18551 | </td>
|
18552 |
|
18553 |
|
18554 | <td class="description last"><p>Top (vertical) position in the destiny (inside the sprite). Unit agnostic (only numeric values are allowed).</p></td>
|
18555 | </tr>
|
18556 |
|
18557 |
|
18558 |
|
18559 | <tr>
|
18560 |
|
18561 | <td class="name"><code>width</code></td>
|
18562 |
|
18563 |
|
18564 | <td class="type">
|
18565 |
|
18566 |
|
18567 | <span class="param-type">number</span>
|
18568 |
|
18569 |
|
18570 |
|
18571 |
|
18572 | </td>
|
18573 |
|
18574 |
|
18575 | <td class="attributes">
|
18576 |
|
18577 | <optional><br>
|
18578 |
|
18579 |
|
18580 |
|
18581 | </td>
|
18582 |
|
18583 |
|
18584 |
|
18585 | <td class="default">
|
18586 |
|
18587 | this.parent.width|<a href="CB_GraphicSprites.html#.WIDTH_DEFAULT"><code>CB_GraphicSprites.WIDTH_DEFAULT</code></a>
|
18588 |
|
18589 | </td>
|
18590 |
|
18591 |
|
18592 | <td class="description last"><p>Width of the destiny (inside the sprite). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18593 | </tr>
|
18594 |
|
18595 |
|
18596 |
|
18597 | <tr>
|
18598 |
|
18599 | <td class="name"><code>height</code></td>
|
18600 |
|
18601 |
|
18602 | <td class="type">
|
18603 |
|
18604 |
|
18605 | <span class="param-type">number</span>
|
18606 |
|
18607 |
|
18608 |
|
18609 |
|
18610 | </td>
|
18611 |
|
18612 |
|
18613 | <td class="attributes">
|
18614 |
|
18615 | <optional><br>
|
18616 |
|
18617 |
|
18618 |
|
18619 | </td>
|
18620 |
|
18621 |
|
18622 |
|
18623 | <td class="default">
|
18624 |
|
18625 | this.parent.height|<a href="CB_GraphicSprites.html#.HEIGHT_DEFAULT"><code>CB_GraphicSprites.HEIGHT_DEFAULT</code></a>
|
18626 |
|
18627 | </td>
|
18628 |
|
18629 |
|
18630 | <td class="description last"><p>Height of the destiny (inside the sprite). Unit agnostic (only numeric values are allowed). If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18631 | </tr>
|
18632 |
|
18633 |
|
18634 |
|
18635 | <tr>
|
18636 |
|
18637 | <td class="name"><code>zIndex</code></td>
|
18638 |
|
18639 |
|
18640 | <td class="type">
|
18641 |
|
18642 |
|
18643 | <span class="param-type">number</span>
|
18644 |
|
18645 |
|
18646 |
|
18647 |
|
18648 | </td>
|
18649 |
|
18650 |
|
18651 | <td class="attributes">
|
18652 |
|
18653 | <optional><br>
|
18654 |
|
18655 |
|
18656 |
|
18657 | </td>
|
18658 |
|
18659 |
|
18660 |
|
18661 | <td class="default">
|
18662 |
|
18663 | this.parent.zIndex|<a href="CB_GraphicSprites.html#.ZINDEX_DEFAULT"><code>CB_GraphicSprites.ZINDEX_DEFAULT</code></a>
|
18664 |
|
18665 | </td>
|
18666 |
|
18667 |
|
18668 | <td class="description last"><p>The z-index for the destiny (inside the sprite). Only numeric values which are not zero (0) are allowed. If not provided, as default it will use the value from the sprite that it belongs to. To change the value of this property, use the "setZIndex" method of the sub-sprite or the <a href="CB_GraphicSprites.html#setZIndexSubSprite"><code>CB_GraphicSprites#setZIndexSubSprite</code></a> method (which will call the <code>CB_GraphicSpritesScene#updateSubSpritesByZIndex</code> method internally).</p></td>
|
18669 | </tr>
|
18670 |
|
18671 |
|
18672 |
|
18673 | <tr>
|
18674 |
|
18675 | <td class="name"><code>disabled</code></td>
|
18676 |
|
18677 |
|
18678 | <td class="type">
|
18679 |
|
18680 |
|
18681 | <span class="param-type">boolean</span>
|
18682 |
|
18683 |
|
18684 |
|
18685 |
|
18686 | </td>
|
18687 |
|
18688 |
|
18689 | <td class="attributes">
|
18690 |
|
18691 | <optional><br>
|
18692 |
|
18693 |
|
18694 |
|
18695 | </td>
|
18696 |
|
18697 |
|
18698 |
|
18699 | <td class="default">
|
18700 |
|
18701 | this.parent.disabled|false
|
18702 |
|
18703 | </td>
|
18704 |
|
18705 |
|
18706 | <td class="description last"><p>Tells whether this sub-sprite is disabled or not. Regardless its value, it will be considered disabled if its sprite parent is also disabled. If not provided, as default it will use the value from the sprite that it belongs to.</p></td>
|
18707 | </tr>
|
18708 |
|
18709 |
|
18710 |
|
18711 | <tr>
|
18712 |
|
18713 | <td class="name"><code>data</code></td>
|
18714 |
|
18715 |
|
18716 | <td class="type">
|
18717 |
|
18718 |
|
18719 | <span class="param-type">object</span>
|
18720 |
|
18721 |
|
18722 |
|
18723 |
|
18724 | </td>
|
18725 |
|
18726 |
|
18727 | <td class="attributes">
|
18728 |
|
18729 | <optional><br>
|
18730 |
|
18731 |
|
18732 |
|
18733 | </td>
|
18734 |
|
18735 |
|
18736 |
|
18737 | <td class="default">
|
18738 |
|
18739 | CB_combineJSON(this.parent.data, this.data)||this.parent.data||{ 'that' : CB_GraphicSprites.SPRITES_OBJECT, 'getThis' = function() { return this.that; } }
|
18740 |
|
18741 | </td>
|
18742 |
|
18743 |
|
18744 | <td class="description last"><p>Object with any additional data desired which can be any kind. If not provided, missing properties as default will use the value from the sprite that it belongs to. It will always have a "that" property pointing to the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> 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.</p></td>
|
18745 | </tr>
|
18746 |
|
18747 |
|
18748 |
|
18749 | <tr>
|
18750 |
|
18751 | <td class="name"><code>byReference</code></td>
|
18752 |
|
18753 |
|
18754 | <td class="type">
|
18755 |
|
18756 |
|
18757 | <span class="param-type">boolean</span>
|
18758 |
|
18759 |
|
18760 |
|
18761 |
|
18762 | </td>
|
18763 |
|
18764 |
|
18765 | <td class="attributes">
|
18766 |
|
18767 | <optional><br>
|
18768 |
|
18769 |
|
18770 |
|
18771 | </td>
|
18772 |
|
18773 |
|
18774 |
|
18775 | <td class="default">
|
18776 |
|
18777 | false
|
18778 |
|
18779 | </td>
|
18780 |
|
18781 |
|
18782 | <td class="description last"><p>If set to true, when inserting the sub-sprite, the same sub-sprite itself (<a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> object) will be inserted internally directly without making a copy of itself.</p></td>
|
18783 | </tr>
|
18784 |
|
18785 |
|
18786 |
|
18787 | <tr>
|
18788 |
|
18789 | <td class="name"><code>parent</code></td>
|
18790 |
|
18791 |
|
18792 | <td class="type">
|
18793 |
|
18794 |
|
18795 | <span class="param-type"><a href="CB_GraphicSprites.html#.SPRITE_OBJECT">CB_GraphicSprites.SPRITE_OBJECT</a></span>
|
18796 |
|
18797 |
|
18798 |
|
18799 |
|
18800 | </td>
|
18801 |
|
18802 |
|
18803 | <td class="attributes">
|
18804 |
|
18805 |
|
18806 |
|
18807 | </td>
|
18808 |
|
18809 |
|
18810 |
|
18811 | <td class="default">
|
18812 |
|
18813 | </td>
|
18814 |
|
18815 |
|
18816 | <td class="description last"><p>Read-only property pointing to its parent (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
18817 | </tr>
|
18818 |
|
18819 |
|
18820 |
|
18821 | <tr>
|
18822 |
|
18823 | <td class="name"><code>container</code></td>
|
18824 |
|
18825 |
|
18826 | <td class="type">
|
18827 |
|
18828 |
|
18829 | <span class="param-type"><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></span>
|
18830 |
|
18831 |
|
18832 |
|
18833 |
|
18834 | </td>
|
18835 |
|
18836 |
|
18837 | <td class="attributes">
|
18838 |
|
18839 |
|
18840 |
|
18841 | </td>
|
18842 |
|
18843 |
|
18844 |
|
18845 | <td class="default">
|
18846 |
|
18847 | </td>
|
18848 |
|
18849 |
|
18850 | <td class="description last"><p>Read-only property pointing to the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> object which contains it.</p></td>
|
18851 | </tr>
|
18852 |
|
18853 |
|
18854 |
|
18855 | <tr>
|
18856 |
|
18857 | <td class="name"><code>isSubSprite</code></td>
|
18858 |
|
18859 |
|
18860 | <td class="type">
|
18861 |
|
18862 |
|
18863 | <span class="param-type">boolean</span>
|
18864 |
|
18865 |
|
18866 |
|
18867 |
|
18868 | </td>
|
18869 |
|
18870 |
|
18871 | <td class="attributes">
|
18872 |
|
18873 |
|
18874 |
|
18875 | </td>
|
18876 |
|
18877 |
|
18878 |
|
18879 | <td class="default">
|
18880 |
|
18881 | </td>
|
18882 |
|
18883 |
|
18884 | <td class="description last"><p>Read-only property which is always set to true to help identify this type of object.</p></td>
|
18885 | </tr>
|
18886 |
|
18887 |
|
18888 |
|
18889 | <tr>
|
18890 |
|
18891 | <td class="name"><code>type</code></td>
|
18892 |
|
18893 |
|
18894 | <td class="type">
|
18895 |
|
18896 |
|
18897 | <span class="param-type">'subSprite'</span>
|
18898 |
|
18899 |
|
18900 |
|
18901 |
|
18902 | </td>
|
18903 |
|
18904 |
|
18905 | <td class="attributes">
|
18906 |
|
18907 |
|
18908 |
|
18909 | </td>
|
18910 |
|
18911 |
|
18912 |
|
18913 | <td class="default">
|
18914 |
|
18915 | </td>
|
18916 |
|
18917 |
|
18918 | <td class="description last"><p>Read-only property indicating the type of object (always "subSprite").</p></td>
|
18919 | </tr>
|
18920 |
|
18921 |
|
18922 |
|
18923 | <tr>
|
18924 |
|
18925 | <td class="name"><code>position</code></td>
|
18926 |
|
18927 |
|
18928 | <td class="type">
|
18929 |
|
18930 |
|
18931 | <span class="param-type">integer</span>
|
18932 |
|
18933 |
|
18934 |
|
18935 |
|
18936 | </td>
|
18937 |
|
18938 |
|
18939 | <td class="attributes">
|
18940 |
|
18941 |
|
18942 |
|
18943 | </td>
|
18944 |
|
18945 |
|
18946 |
|
18947 | <td class="default">
|
18948 |
|
18949 | </td>
|
18950 |
|
18951 |
|
18952 | <td class="description last"><p>Read-only property indicating the position of this sub-sprite in the array which is set the "subSprites" property of the sprite parent (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
18953 | </tr>
|
18954 |
|
18955 |
|
18956 |
|
18957 | <tr>
|
18958 |
|
18959 | <td class="name"><code>positionByZIndex</code></td>
|
18960 |
|
18961 |
|
18962 | <td class="type">
|
18963 |
|
18964 |
|
18965 | <span class="param-type">integer</span>
|
18966 |
|
18967 |
|
18968 |
|
18969 |
|
18970 | </td>
|
18971 |
|
18972 |
|
18973 | <td class="attributes">
|
18974 |
|
18975 |
|
18976 |
|
18977 | </td>
|
18978 |
|
18979 |
|
18980 |
|
18981 | <td class="default">
|
18982 |
|
18983 | </td>
|
18984 |
|
18985 |
|
18986 | <td class="description last"><p>Read-only property indicating the position of this sub-sprite in the array which is set the "subSpritesByZIndex" property of the sprite parent (<a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> object).</p></td>
|
18987 | </tr>
|
18988 |
|
18989 |
|
18990 |
|
18991 | <tr>
|
18992 |
|
18993 | <td class="name"><code>time</code></td>
|
18994 |
|
18995 |
|
18996 | <td class="type">
|
18997 |
|
18998 |
|
18999 | <span class="param-type">integer</span>
|
19000 |
|
19001 |
|
19002 |
|
19003 |
|
19004 | </td>
|
19005 |
|
19006 |
|
19007 | <td class="attributes">
|
19008 |
|
19009 |
|
19010 |
|
19011 | </td>
|
19012 |
|
19013 |
|
19014 |
|
19015 | <td class="default">
|
19016 |
|
19017 | </td>
|
19018 |
|
19019 |
|
19020 | <td class="description last"><p>Property which stores the time in milliseconds when its parent sprite was started being pointed for the last time (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which was obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function internally). Note that the parent could being not pointed anymore. If it has never being pointed before, it will be set to 0. It normally has the same value as the "time" property of its parent object but they can be modified independently.</p></td>
|
19021 | </tr>
|
19022 |
|
19023 |
|
19024 |
|
19025 | <tr>
|
19026 |
|
19027 | <td class="name"><code>setTime</code></td>
|
19028 |
|
19029 |
|
19030 | <td class="type">
|
19031 |
|
19032 |
|
19033 | <span class="param-type">function</span>
|
19034 |
|
19035 |
|
19036 |
|
19037 |
|
19038 | </td>
|
19039 |
|
19040 |
|
19041 | <td class="attributes">
|
19042 |
|
19043 |
|
19044 |
|
19045 | </td>
|
19046 |
|
19047 |
|
19048 |
|
19049 | <td class="default">
|
19050 |
|
19051 | </td>
|
19052 |
|
19053 |
|
19054 | <td class="description last"><p>Read-only property which is a method that updates the "time" property of the sub-sprite (calls <a href="CB_GraphicSprites.html#setTime"><code>CB_GraphicSprites#setTime</code></a> internally and returns its returning value). With only one parameter which belongs to the "time" parameter of the <a href="CB_GraphicSprites.html#setTime"><code>CB_GraphicSprites#setTime</code></a> method.</p></td>
|
19055 | </tr>
|
19056 |
|
19057 |
|
19058 |
|
19059 | <tr>
|
19060 |
|
19061 | <td class="name"><code>getTime</code></td>
|
19062 |
|
19063 |
|
19064 | <td class="type">
|
19065 |
|
19066 |
|
19067 | <span class="param-type">function</span>
|
19068 |
|
19069 |
|
19070 |
|
19071 |
|
19072 | </td>
|
19073 |
|
19074 |
|
19075 | <td class="attributes">
|
19076 |
|
19077 |
|
19078 |
|
19079 | </td>
|
19080 |
|
19081 |
|
19082 |
|
19083 | <td class="default">
|
19084 |
|
19085 | </td>
|
19086 |
|
19087 |
|
19088 | <td class="description last"><p>Read-only property which is a method that returns the "time" property of the sub-sprite (calls <a href="CB_GraphicSprites.html#getTime"><code>CB_GraphicSprites#getTime</code></a> internally and returns its returning value). With only one parameter which belongs to the "returnValueOnFail" parameter of the <a href="CB_GraphicSprites.html#getTime"><code>CB_GraphicSprites#getTime</code></a> method. If the "time" property of the sub-sprite is not found, it will use the "time" property from its sprite parent.</p></td>
|
19089 | </tr>
|
19090 |
|
19091 |
|
19092 |
|
19093 | <tr>
|
19094 |
|
19095 | <td class="name"><code>getTimeElapsed</code></td>
|
19096 |
|
19097 |
|
19098 | <td class="type">
|
19099 |
|
19100 |
|
19101 | <span class="param-type">function</span>
|
19102 |
|
19103 |
|
19104 |
|
19105 |
|
19106 | </td>
|
19107 |
|
19108 |
|
19109 | <td class="attributes">
|
19110 |
|
19111 |
|
19112 |
|
19113 | </td>
|
19114 |
|
19115 |
|
19116 |
|
19117 | <td class="default">
|
19118 |
|
19119 | </td>
|
19120 |
|
19121 |
|
19122 | <td class="description last"><p>Read-only property which is a method that returns how many milliseconds elapsed since the sprite was or will be pointed (checking its "time" property), comparing with the time given in milliseconds (time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a> which can be obtained calling the <a href="CB_Device.html#.getTiming"><code>CB_Device.getTiming</code></a> function) or with the current one if none is given (calls <a href="CB_GraphicSprites.html#getTimeElapsed"><code>CB_GraphicSprites#getTimeElapsed</code></a> internally and returns its returning value). With only one parameter which belongs to the "timeToCompare" parameter of the <a href="CB_GraphicSprites.html#getTimeElapsed"><code>CB_GraphicSprites#getTimeElapsed</code></a> method. If the "time" property of the sub-sprite is not found, it will use the "time" property from its sprite parent.</p></td>
|
19123 | </tr>
|
19124 |
|
19125 |
|
19126 |
|
19127 | <tr>
|
19128 |
|
19129 | <td class="name"><code>getZIndex</code></td>
|
19130 |
|
19131 |
|
19132 | <td class="type">
|
19133 |
|
19134 |
|
19135 | <span class="param-type">function</span>
|
19136 |
|
19137 |
|
19138 |
|
19139 |
|
19140 | </td>
|
19141 |
|
19142 |
|
19143 | <td class="attributes">
|
19144 |
|
19145 |
|
19146 |
|
19147 | </td>
|
19148 |
|
19149 |
|
19150 |
|
19151 | <td class="default">
|
19152 |
|
19153 | </td>
|
19154 |
|
19155 |
|
19156 | <td class="description last"><p>Read-only property which is a method that returns the z-index ("z-index" property) of the sub-sprite (calls <a href="CB_GraphicSprites.html#getZIndexSubSprite"><code>CB_GraphicSprites#getZIndexSubSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "returnValueOnFail" parameter of the <a href="CB_GraphicSprites.html#getZIndexSubSprite"><code>CB_GraphicSprites#getZIndexSubSprite</code></a> method.</p></td>
|
19157 | </tr>
|
19158 |
|
19159 |
|
19160 |
|
19161 | <tr>
|
19162 |
|
19163 | <td class="name"><code>setZIndex</code></td>
|
19164 |
|
19165 |
|
19166 | <td class="type">
|
19167 |
|
19168 |
|
19169 | <span class="param-type">function</span>
|
19170 |
|
19171 |
|
19172 |
|
19173 |
|
19174 | </td>
|
19175 |
|
19176 |
|
19177 | <td class="attributes">
|
19178 |
|
19179 |
|
19180 |
|
19181 | </td>
|
19182 |
|
19183 |
|
19184 |
|
19185 | <td class="default">
|
19186 |
|
19187 | </td>
|
19188 |
|
19189 |
|
19190 | <td class="description last"><p>Read-only property which is a method to set the z-index ("z-index" property) of the sub-sprite (calls <a href="CB_GraphicSprites.html#setZIndexSubSprite"><code>CB_GraphicSprites#setZIndexSubSprite</code></a> internally and returns its returning value). With only one parameter which belongs to the "zIndex" parameter of the <a href="CB_GraphicSprites.html#setZIndexSubSprite"><code>CB_GraphicSprites#setZIndexSubSprite</code></a> method.</p></td>
|
19191 | </tr>
|
19192 |
|
19193 |
|
19194 |
|
19195 | <tr>
|
19196 |
|
19197 | <td class="name"><code>isDisabled</code></td>
|
19198 |
|
19199 |
|
19200 | <td class="type">
|
19201 |
|
19202 |
|
19203 | <span class="param-type">function</span>
|
19204 |
|
19205 |
|
19206 |
|
19207 |
|
19208 | </td>
|
19209 |
|
19210 |
|
19211 | <td class="attributes">
|
19212 |
|
19213 |
|
19214 |
|
19215 | </td>
|
19216 |
|
19217 |
|
19218 |
|
19219 | <td class="default">
|
19220 |
|
19221 | </td>
|
19222 |
|
19223 |
|
19224 | <td class="description last"><p>Read-only property which is a method that tells whether the sub-sprite is disabled or not (calls <a href="CB_GraphicSprites.html#isDisabledSubSprite"><code>CB_GraphicSprites#isDisabledSubSprite</code></a> internally and returns its returning value). With no parameters. A sub-sprite is considered disabled if its sprite parent is disabled (a sprite is considered disabled if its sprites group parent is also disabled).</p></td>
|
19225 | </tr>
|
19226 |
|
19227 |
|
19228 |
|
19229 | <tr>
|
19230 |
|
19231 | <td class="name"><code>setDisabled</code></td>
|
19232 |
|
19233 |
|
19234 | <td class="type">
|
19235 |
|
19236 |
|
19237 | <span class="param-type">function</span>
|
19238 |
|
19239 |
|
19240 |
|
19241 |
|
19242 | </td>
|
19243 |
|
19244 |
|
19245 | <td class="attributes">
|
19246 |
|
19247 |
|
19248 |
|
19249 | </td>
|
19250 |
|
19251 |
|
19252 |
|
19253 | <td class="default">
|
19254 |
|
19255 | </td>
|
19256 |
|
19257 |
|
19258 | <td class="description last"><p>Read-only property which is a method to disable or enable the sub-sprite (calls <a href="CB_GraphicSprites.html#setDisabledSubSprite"><code>CB_GraphicSprites#setDisabledSubSprite</code></a> internally and returns its returning value). With three parameters ("disabled", "affectParents" and "affectParentsChildren") which belong to the parameters with the same name of the <a href="CB_GraphicSprites.html#setDisabledSubSprite"><code>CB_GraphicSprites#setDisabledSubSprite</code></a> method.</p></td>
|
19259 | </tr>
|
19260 |
|
19261 |
|
19262 | </tbody>
|
19263 | </table>
|
19264 | </dl>
|
19265 |
|
19266 |
|
19267 |
|
19268 |
|
19269 |
|
19270 |
|
19271 |
|
19272 |
|
19273 |
|
19274 |
|
19275 |
|
19276 |
|
19277 |
|
19278 |
|
19279 |
|
19280 |
|
19281 |
|
19282 |
|
19283 |
|
19284 |
|
19285 |
|
19286 |
|
19287 |
|
19288 |
|
19289 |
|
19290 |
|
19291 |
|
19292 |
|
19293 |
|
19294 |
|
19295 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
19296 | <dd class="tag-source">
|
19297 | <ul class="dummy">
|
19298 | <li>
|
19299 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
19300 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-8">line 8</a>
|
19301 | </li>
|
19302 | </ul>
|
19303 | </dd>
|
19304 |
|
19305 |
|
19306 |
|
19307 |
|
19308 |
|
19309 |
|
19310 |
|
19311 | </dl>
|
19312 |
|
19313 |
|
19314 |
|
19315 | <h5>Example</h5>
|
19316 |
|
19317 | <pre class="sunlight-highlight-javascript">{
|
19318 | id: "my_subsprite_1",
|
19319 | src: "path/to/image.gif",
|
19320 | srcType: CB_GraphicSprites.SRC_TYPES.IMAGE,
|
19321 | srcLeft: 10,
|
19322 | srcTop: 20,
|
19323 | srcWidth: 64,
|
19324 | srcHeight: 32,
|
19325 | left: 10,
|
19326 | top: 20,
|
19327 | width: 64,
|
19328 | height: 32,
|
19329 | zIndex: 1,
|
19330 | disabled: false,
|
19331 | data: { datum_1: "value_1", datum_2: 2, datum_3: [ "a", "b", "c" ] }
|
19332 | }
</pre>
|
19333 |
|
19334 |
|
19335 |
|
19336 | </dd>
|
19337 |
|
19338 |
|
19339 |
|
19340 | <hr>
|
19341 | <dt class="name" id=".filterProperties_propertiesToKeepObject_TYPE">
|
19342 | <h4 id=".filterProperties_propertiesToKeepObject_TYPE">filterProperties_propertiesToKeepObject_TYPE</h4>
|
19343 |
|
19344 |
|
19345 | </dt>
|
19346 | <dd>
|
19347 |
|
19348 | <div class="description">
|
19349 | <p>Object used to know what properties keep when calling the <a href="CB_GraphicSprites.html#.filterProperties"><code>CB_GraphicSprites.filterProperties</code></a> function (type used for its "propertiesToKeepObject" parameter). Its properties must have the name that matches the value returned by the "type" property of each element, being their value an array of strings with the name of the properties we want to keep. The property names which start with a "<em>" symbol will not considered inherited from the element's parent and will always be copied. The other properties (which do not start with the "</em>" symbol) will only be copied when the element contains a value which is different from the same property of its parent.</p>
|
19350 | </div>
|
19351 |
|
19352 |
|
19353 |
|
19354 | <h5>Type:</h5>
|
19355 | <ul>
|
19356 | <li>
|
19357 |
|
19358 | <span class="param-type">Object</span>
|
19359 |
|
19360 |
|
19361 |
|
19362 | </li>
|
19363 | </ul>
|
19364 |
|
19365 |
|
19366 |
|
19367 | <dl class="details">
|
19368 |
|
19369 |
|
19370 | <h5 class="subsection-title">Properties:</h5>
|
19371 |
|
19372 | <dl>
|
19373 |
|
19374 | <table class="props table table-striped">
|
19375 | <thead>
|
19376 | <tr>
|
19377 |
|
19378 | <th>Name</th>
|
19379 |
|
19380 |
|
19381 | <th>Type</th>
|
19382 |
|
19383 |
|
19384 | <th>Argument</th>
|
19385 |
|
19386 |
|
19387 |
|
19388 |
|
19389 | <th class="last">Description</th>
|
19390 | </tr>
|
19391 | </thead>
|
19392 |
|
19393 | <tbody>
|
19394 |
|
19395 |
|
19396 | <tr>
|
19397 |
|
19398 | <td class="name"><code>spritesScene</code></td>
|
19399 |
|
19400 |
|
19401 | <td class="type">
|
19402 |
|
19403 |
|
19404 | <span class="param-type">array</span>
|
19405 |
|
19406 |
|
19407 |
|
19408 |
|
19409 | </td>
|
19410 |
|
19411 |
|
19412 | <td class="attributes">
|
19413 |
|
19414 | <optional><br>
|
19415 |
|
19416 |
|
19417 |
|
19418 | </td>
|
19419 |
|
19420 |
|
19421 |
|
19422 |
|
19423 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19424 | </tr>
|
19425 |
|
19426 |
|
19427 |
|
19428 | <tr>
|
19429 |
|
19430 | <td class="name"><code>spritesGroups</code></td>
|
19431 |
|
19432 |
|
19433 | <td class="type">
|
19434 |
|
19435 |
|
19436 | <span class="param-type">array</span>
|
19437 |
|
19438 |
|
19439 |
|
19440 |
|
19441 | </td>
|
19442 |
|
19443 |
|
19444 | <td class="attributes">
|
19445 |
|
19446 | <optional><br>
|
19447 |
|
19448 |
|
19449 |
|
19450 | </td>
|
19451 |
|
19452 |
|
19453 |
|
19454 |
|
19455 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSpritesScene.html#.SPRITES_GROUPS_OBJECT"><code>CB_GraphicSpritesScene.SPRITES_GROUPS_OBJECT</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19456 | </tr>
|
19457 |
|
19458 |
|
19459 |
|
19460 | <tr>
|
19461 |
|
19462 | <td class="name"><code>sprites</code></td>
|
19463 |
|
19464 |
|
19465 | <td class="type">
|
19466 |
|
19467 |
|
19468 | <span class="param-type">array</span>
|
19469 |
|
19470 |
|
19471 |
|
19472 |
|
19473 | </td>
|
19474 |
|
19475 |
|
19476 | <td class="attributes">
|
19477 |
|
19478 | <optional><br>
|
19479 |
|
19480 |
|
19481 |
|
19482 | </td>
|
19483 |
|
19484 |
|
19485 |
|
19486 |
|
19487 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19488 | </tr>
|
19489 |
|
19490 |
|
19491 |
|
19492 | <tr>
|
19493 |
|
19494 | <td class="name"><code>spritesGroup</code></td>
|
19495 |
|
19496 |
|
19497 | <td class="type">
|
19498 |
|
19499 |
|
19500 | <span class="param-type">array</span>
|
19501 |
|
19502 |
|
19503 |
|
19504 |
|
19505 | </td>
|
19506 |
|
19507 |
|
19508 | <td class="attributes">
|
19509 |
|
19510 | <optional><br>
|
19511 |
|
19512 |
|
19513 |
|
19514 | </td>
|
19515 |
|
19516 |
|
19517 |
|
19518 |
|
19519 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSprites.html#.SPRITES_OBJECT"><code>CB_GraphicSprites.SPRITES_OBJECT</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19520 | </tr>
|
19521 |
|
19522 |
|
19523 |
|
19524 | <tr>
|
19525 |
|
19526 | <td class="name"><code>sprite</code></td>
|
19527 |
|
19528 |
|
19529 | <td class="type">
|
19530 |
|
19531 |
|
19532 | <span class="param-type">array</span>
|
19533 |
|
19534 |
|
19535 |
|
19536 |
|
19537 | </td>
|
19538 |
|
19539 |
|
19540 | <td class="attributes">
|
19541 |
|
19542 | <optional><br>
|
19543 |
|
19544 |
|
19545 |
|
19546 | </td>
|
19547 |
|
19548 |
|
19549 |
|
19550 |
|
19551 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSprites.html#.SPRITE_OBJECT"><code>CB_GraphicSprites.SPRITE_OBJECT</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19552 | </tr>
|
19553 |
|
19554 |
|
19555 |
|
19556 | <tr>
|
19557 |
|
19558 | <td class="name"><code>subSprite</code></td>
|
19559 |
|
19560 |
|
19561 | <td class="type">
|
19562 |
|
19563 |
|
19564 | <span class="param-type">array</span>
|
19565 |
|
19566 |
|
19567 |
|
19568 |
|
19569 | </td>
|
19570 |
|
19571 |
|
19572 | <td class="attributes">
|
19573 |
|
19574 | <optional><br>
|
19575 |
|
19576 |
|
19577 |
|
19578 | </td>
|
19579 |
|
19580 |
|
19581 |
|
19582 |
|
19583 | <td class="description last"><p>Array of strings with the name of the properties to keep for the <a href="CB_GraphicSprites.html#.SUBSPRITE_OBJECT"><code>CB_GraphicSprites.SUBSPRITE_OBJECT</code></a> objects. If no provided, no properties will be kept for this kind of element.</p></td>
|
19584 | </tr>
|
19585 |
|
19586 |
|
19587 | </tbody>
|
19588 | </table>
|
19589 | </dl>
|
19590 |
|
19591 |
|
19592 |
|
19593 |
|
19594 |
|
19595 |
|
19596 |
|
19597 |
|
19598 |
|
19599 |
|
19600 |
|
19601 |
|
19602 |
|
19603 |
|
19604 |
|
19605 |
|
19606 |
|
19607 |
|
19608 |
|
19609 |
|
19610 |
|
19611 |
|
19612 |
|
19613 |
|
19614 |
|
19615 |
|
19616 |
|
19617 |
|
19618 |
|
19619 |
|
19620 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
19621 | <dd class="tag-source">
|
19622 | <ul class="dummy">
|
19623 | <li>
|
19624 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
|
19625 | <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1869">line 1869</a>
|
19626 | </li>
|
19627 | </ul>
|
19628 | </dd>
|
19629 |
|
19630 |
|
19631 |
|
19632 |
|
19633 |
|
19634 |
|
19635 |
|
19636 | </dl>
|
19637 |
|
19638 |
|
19639 |
|
19640 | </dd>
|
19641 |
|
19642 | </dl>
|
19643 |
|
19644 |
|
19645 |
|
19646 | </article>
|
19647 |
|
19648 | </section>
|
19649 |
|
19650 |
|
19651 |
|
19652 |
|
19653 | </div>
|
19654 | </div>
|
19655 |
|
19656 | <div class="clearfix"></div>
|
19657 |
|
19658 |
|
19659 | <div class="col-md-3">
|
19660 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md" style="display:none; visibility:hidden;"></div>
|
19661 | </div>
|
19662 |
|
19663 |
|
19664 | </div>
|
19665 | </div>
|
19666 |
|
19667 |
|
19668 | <div class="modal fade" id="searchResults">
|
19669 | <div class="modal-dialog">
|
19670 | <div class="modal-content">
|
19671 | <div class="modal-header">
|
19672 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
19673 | <h4 class="modal-title">Search results</h4>
|
19674 | </div>
|
19675 | <div class="modal-body"></div>
|
19676 | <div class="modal-footer">
|
19677 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
19678 | </div>
|
19679 | </div>
|
19680 | </div>
|
19681 | </div>
|
19682 |
|
19683 |
|
19684 | <footer>
|
19685 |
|
19686 |
|
19687 | <span class="copyright">
|
19688 | <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>
|
19689 | </span>
|
19690 |
|
19691 | <span class="jsdoc-message">
|
19692 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
|
19693 |
|
19694 | on Wed Mar 22nd 2023
|
19695 |
|
19696 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
19697 | </span>
|
19698 | </footer>
|
19699 |
|
19700 | <script src="scripts/docstrap.lib.js"></script>
|
19701 | <script src="scripts/toc.js"></script>
|
19702 |
|
19703 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
19704 |
|
19705 |
|
19706 | <script>
|
19707 | $( function () {
|
19708 | $( "[id*='$']" ).each( function () {
|
19709 | var $this = $( this );
|
19710 |
|
19711 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
19712 | } );
|
19713 |
|
19714 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
19715 | var $this = $( this );
|
19716 |
|
19717 | var example = $this.find( "code" );
|
19718 | exampleText = example.html();
|
19719 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
19720 | if ( lang && lang[1] ) {
|
19721 | exampleText = exampleText.replace( lang[0], "" );
|
19722 | example.html( exampleText );
|
19723 | lang = lang[1];
|
19724 | } else {
|
19725 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
19726 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
19727 | }
|
19728 |
|
19729 | if ( lang ) {
|
19730 |
|
19731 | $this
|
19732 | .addClass( "sunlight-highlight-" + lang )
|
19733 | .addClass( "linenums" )
|
19734 | .html( example.html() );
|
19735 |
|
19736 | }
|
19737 | } );
|
19738 |
|
19739 | Sunlight.highlightAll( {
|
19740 | lineNumbers : true,
|
19741 | showMenu : true,
|
19742 | enableDoclinks : true
|
19743 | } );
|
19744 |
|
19745 | $.catchAnchorLinks( {
|
19746 | navbarOffset: 10
|
19747 | } );
|
19748 | $( "#toc" ).toc( {
|
19749 | anchorName : function ( i, heading, prefix ) {
|
19750 | return $( heading ).attr( "id" ) || ( prefix + i );
|
19751 | },
|
19752 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
19753 | showAndHide : false,
|
19754 | smoothScrolling: true
|
19755 | } );
|
19756 |
|
19757 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
19758 | $( '.dropdown-toggle' ).dropdown();
|
19759 |
|
19760 | $( "table" ).each( function () {
|
19761 | var $this = $( this );
|
19762 | $this.addClass('table');
|
19763 | } );
|
19764 |
|
19765 | } );
|
19766 | </script>
|
19767 |
|
19768 |
|
19769 |
|
19770 |
|
19771 |
|
19772 |
|
19773 |
|
19774 |
|
19775 |
|
19776 |
|
19777 | <script type="text/javascript">
|
19778 | $(document).ready(function() {
|
19779 | SearcherDisplay.init();
|
19780 | });
|
19781 | </script>
|
19782 |
|
19783 |
|
19784 | </body>
|
19785 | </html> |
\ | No newline at end of file |