UNPKG

69.4 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Namespace: CB_Modules</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Modules</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Modules
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class that contains all the modules and the tools to manage them.</p></div>
102
103
104
105<dl class="details">
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
140 <a href="CrossBrowdy.js.html#sunlight-1-line-157">line 157</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151</dl>
152
153
154
155
156 </div>
157
158
159
160
161
162
163
164
165
166
167
168
169 <h3 class="subsection-title">Members</h3>
170
171 <dl>
172
173<hr>
174<dt class="name" id=".modules">
175 <h4 id=".modules"><span class="type-signature">&lt;static> </span>modules<span class="type-signature"> :Object</span></h4>
176
177
178</dt>
179<dd>
180
181 <div class="description">
182 <p>Contains all the modules, one per property.</p>
183 </div>
184
185
186
187 <h5>Type:</h5>
188 <ul>
189 <li>
190
191<span class="param-type">Object</span>
192
193
194
195 </li>
196 </ul>
197
198
199
200<dl class="details">
201
202
203 <h5 class="subsection-title">Properties:</h5>
204
205 <dl>
206
207<table class="props table table-striped">
208 <thead>
209 <tr>
210
211 <th>Name</th>
212
213
214 <th>Type</th>
215
216
217
218
219
220 <th class="last">Description</th>
221 </tr>
222 </thead>
223
224 <tbody>
225
226
227 <tr>
228
229 <td class="name"><code>name_of_the_module</code></td>
230
231
232 <td class="type">
233
234
235<span class="param-type"><a href="CB_Modules.html#.MODULE">CB_Modules.MODULE</a></span>
236
237
238
239
240 </td>
241
242
243
244
245
246 <td class="description last"><p>Object that contains the module data. The property name must be the name of the module.</p></td>
247 </tr>
248
249
250 </tbody>
251</table>
252</dl>
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
284 <dd class="tag-source">
285 <ul class="dummy">
286 <li>
287 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
288 <a href="CrossBrowdy.js.html#sunlight-1-line-242">line 242</a>
289 </li>
290 </ul>
291 </dd>
292
293
294
295
296
297
298
299</dl>
300
301
302
303</dd>
304
305
306
307<hr>
308<dt class="name" id=".STATUSES">
309 <h4 id=".STATUSES"><span class="type-signature">&lt;static, readonly> </span>STATUSES<span class="type-signature"> :integer</span></h4>
310
311
312</dt>
313<dd>
314
315 <div class="description">
316 <p>Enum which defines possible module statuses.</p>
317 </div>
318
319
320
321 <h5>Type:</h5>
322 <ul>
323 <li>
324
325<span class="param-type">integer</span>
326
327
328
329 </li>
330 </ul>
331
332
333
334<dl class="details">
335
336
337 <h5 class="subsection-title">Properties:</h5>
338
339 <dl>
340
341<table class="props table table-striped">
342 <thead>
343 <tr>
344
345 <th>Name</th>
346
347
348 <th>Type</th>
349
350
351
352
353 <th>Default</th>
354
355
356 <th class="last">Description</th>
357 </tr>
358 </thead>
359
360 <tbody>
361
362
363 <tr>
364
365 <td class="name"><code>FAILED</code></td>
366
367
368 <td class="type">
369
370
371<span class="param-type">integer</span>
372
373
374
375
376 </td>
377
378
379
380
381 <td class="default">
382
383 -1
384
385 </td>
386
387
388 <td class="description last"><p>The module has failed to load.</p></td>
389 </tr>
390
391
392
393 <tr>
394
395 <td class="name"><code>UNKNOWN</code></td>
396
397
398 <td class="type">
399
400
401<span class="param-type">integer</span>
402
403
404
405
406 </td>
407
408
409
410
411 <td class="default">
412
413 0
414
415 </td>
416
417
418 <td class="description last"><p>The module has an unkwnown status.</p></td>
419 </tr>
420
421
422
423 <tr>
424
425 <td class="name"><code>UNLOADED</code></td>
426
427
428 <td class="type">
429
430
431<span class="param-type">integer</span>
432
433
434
435
436 </td>
437
438
439
440
441 <td class="default">
442
443 1
444
445 </td>
446
447
448 <td class="description last"><p>The module is not loaded yet. Default status.</p></td>
449 </tr>
450
451
452
453 <tr>
454
455 <td class="name"><code>LOADING</code></td>
456
457
458 <td class="type">
459
460
461<span class="param-type">integer</span>
462
463
464
465
466 </td>
467
468
469
470
471 <td class="default">
472
473 2
474
475 </td>
476
477
478 <td class="description last"><p>The module is being loading.</p></td>
479 </tr>
480
481
482
483 <tr>
484
485 <td class="name"><code>LOADED</code></td>
486
487
488 <td class="type">
489
490
491<span class="param-type">integer</span>
492
493
494
495
496 </td>
497
498
499
500
501 <td class="default">
502
503 3
504
505 </td>
506
507
508 <td class="description last"><p>The module has loaded successfully (coudl be not ready yet).</p></td>
509 </tr>
510
511
512
513 <tr>
514
515 <td class="name"><code>READY</code></td>
516
517
518 <td class="type">
519
520
521<span class="param-type">integer</span>
522
523
524
525
526 </td>
527
528
529
530
531 <td class="default">
532
533 4
534
535 </td>
536
537
538 <td class="description last"><p>The module has loaded successfully and it is ready to be used.</p></td>
539 </tr>
540
541
542 </tbody>
543</table>
544</dl>
545
546
547
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
574
575 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
576 <dd class="tag-source">
577 <ul class="dummy">
578 <li>
579 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
580 <a href="CrossBrowdy.js.html#sunlight-1-line-166">line 166</a>
581 </li>
582 </ul>
583 </dd>
584
585
586
587
588
589
590
591</dl>
592
593
594
595</dd>
596
597 </dl>
598
599
600
601 <h3 class="subsection-title">Methods</h3>
602
603 <dl>
604
605<hr>
606<dt>
607 <h4 class="name" id=".addNeededFiles"><span class="type-signature">&lt;static> </span>addNeededFiles<span class="signature">(moduleName, neededFiles)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
608
609
610</dt>
611<dd>
612
613
614 <div class="description">
615 <p>Attaches files to a module.</p>
616 </div>
617
618
619
620
621
622
623
624
625 <h5>Parameters:</h5>
626
627
628<table class="params table table-striped">
629 <thead>
630 <tr>
631
632 <th style="width:12%; min-width:110px;">Name</th>
633
634
635 <th style="width:12%; min-width:110px;">Type</th>
636
637
638
639
640
641 <th class="last" style="min-width:310px;">Description</th>
642 </tr>
643 </thead>
644
645 <tbody>
646
647
648 <tr>
649
650 <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>moduleName</code></td>
651
652
653 <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;">
654
655
656<span class="param-type">string</span>
657
658
659
660
661 </td>
662
663
664
665
666
667 <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>Name of the module which will contain the new files.</p></td>
668 </tr>
669
670
671
672 <tr>
673
674 <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>neededFiles</code></td>
675
676
677 <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;">
678
679
680<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILES">CB_Modules.NEEDED_FILES</a></span>
681
682
683
684
685 </td>
686
687
688
689
690
691 <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 &quot;neededFiles&quot; parameter for the module.</p></td>
692 </tr>
693
694
695 </tbody>
696</table>
697
698
699
700
701<dl class="details">
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
732 <dd class="tag-source">
733 <ul class="dummy">
734 <li>
735 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
736 <a href="CrossBrowdy.js.html#sunlight-1-line-947">line 947</a>
737 </li>
738 </ul>
739 </dd>
740
741
742
743
744
745
746
747</dl>
748
749
750
751
752
753
754
755
756
757
758
759
760
761 <h5>Returns:</h5>
762
763
764<div class="param-desc">
765 <p>It will return true if succeeded or false otherwise.</p>
766</div>
767
768
769
770<dl>
771 <dt>
772 Type
773 </dt>
774 <dd>
775
776<span class="param-type">boolean</span>
777
778
779
780 </dd>
781</dl>
782
783
784
785
786
787</dd>
788
789
790
791<hr>
792<dt>
793 <h4 class="name" id=".addNeededModule"><span class="type-signature">&lt;static> </span>addNeededModule<span class="signature">(moduleNameParent, moduleName, neededFiles)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
794
795
796</dt>
797<dd>
798
799
800 <div class="description">
801 <p>Attaches one module to another one.</p>
802 </div>
803
804
805
806
807
808
809
810
811 <h5>Parameters:</h5>
812
813
814<table class="params table table-striped">
815 <thead>
816 <tr>
817
818 <th style="width:12%; min-width:110px;">Name</th>
819
820
821 <th style="width:12%; min-width:110px;">Type</th>
822
823
824
825
826
827 <th class="last" style="min-width:310px;">Description</th>
828 </tr>
829 </thead>
830
831 <tbody>
832
833
834 <tr>
835
836 <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>moduleNameParent</code></td>
837
838
839 <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;">
840
841
842<span class="param-type">string</span>
843
844
845
846
847 </td>
848
849
850
851
852
853 <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>Name of the parent module where the new child module will be attached to.</p></td>
854 </tr>
855
856
857
858 <tr>
859
860 <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>moduleName</code></td>
861
862
863 <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;">
864
865
866<span class="param-type">string</span>
867
868
869
870
871 </td>
872
873
874
875
876
877 <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>Name of the new child module which will be attached to the given parent.</p></td>
878 </tr>
879
880
881
882 <tr>
883
884 <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>neededFiles</code></td>
885
886
887 <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;">
888
889
890<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILES">CB_Modules.NEEDED_FILES</a></span>
891
892
893
894
895 </td>
896
897
898
899
900
901 <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 &quot;neededFiles&quot; parameter for the new child module.</p></td>
902 </tr>
903
904
905 </tbody>
906</table>
907
908
909
910
911<dl class="details">
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
942 <dd class="tag-source">
943 <ul class="dummy">
944 <li>
945 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
946 <a href="CrossBrowdy.js.html#sunlight-1-line-933">line 933</a>
947 </li>
948 </ul>
949 </dd>
950
951
952
953
954
955
956
957</dl>
958
959
960
961
962
963
964
965
966
967
968
969
970
971 <h5>Returns:</h5>
972
973
974<div class="param-desc">
975 <p>It will return true if succeeded or false otherwise.</p>
976</div>
977
978
979
980<dl>
981 <dt>
982 Type
983 </dt>
984 <dd>
985
986<span class="param-type">boolean</span>
987
988
989
990 </dd>
991</dl>
992
993
994
995
996
997</dd>
998
999
1000
1001<hr>
1002<dt>
1003 <h4 class="name" id=".editProperty"><span class="type-signature">&lt;static> </span>editProperty<span class="signature">(moduleName, property, value [, type] [, iterateArray])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1004
1005
1006</dt>
1007<dd>
1008
1009
1010 <div class="description">
1011 <p>Modifies a desired property of a given module.</p>
1012 </div>
1013
1014
1015
1016
1017
1018
1019
1020
1021 <h5>Parameters:</h5>
1022
1023
1024<table class="params table table-striped">
1025 <thead>
1026 <tr>
1027
1028 <th style="width:12%; min-width:110px;">Name</th>
1029
1030
1031 <th style="width:12%; min-width:110px;">Type</th>
1032
1033
1034 <th style="width:12%; min-width:110px;">Argument</th>
1035
1036
1037
1038 <th style="width:12%; min-width:110px;">Default</th>
1039
1040
1041 <th class="last" style="min-width:310px;">Description</th>
1042 </tr>
1043 </thead>
1044
1045 <tbody>
1046
1047
1048 <tr>
1049
1050 <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>moduleName</code></td>
1051
1052
1053 <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;">
1054
1055
1056<span class="param-type">string</span>
1057
1058
1059
1060
1061 </td>
1062
1063
1064 <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;">
1065
1066
1067
1068
1069
1070 </td>
1071
1072
1073
1074 <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;">
1075
1076 </td>
1077
1078
1079 <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>Name of the module which contains the property to modify.</p></td>
1080 </tr>
1081
1082
1083
1084 <tr>
1085
1086 <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>property</code></td>
1087
1088
1089 <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;">
1090
1091
1092<span class="param-type">string</span>
1093
1094
1095
1096
1097 </td>
1098
1099
1100 <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;">
1101
1102
1103
1104
1105
1106 </td>
1107
1108
1109
1110 <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;">
1111
1112 </td>
1113
1114
1115 <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>Name of the property to modify.</p></td>
1116 </tr>
1117
1118
1119
1120 <tr>
1121
1122 <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>
1123
1124
1125 <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;">
1126
1127
1128<span class="param-type">*</span>
1129
1130
1131
1132
1133 </td>
1134
1135
1136 <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;">
1137
1138
1139
1140
1141
1142 </td>
1143
1144
1145
1146 <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;">
1147
1148 </td>
1149
1150
1151 <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>Value desired for the property.</p></td>
1152 </tr>
1153
1154
1155
1156 <tr>
1157
1158 <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>type</code></td>
1159
1160
1161 <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;">
1162
1163
1164<span class="param-type">'array'</span>
1165|
1166
1167<span class="param-type">'object'</span>
1168|
1169
1170<span class="param-type">'scalar'</span>
1171
1172
1173
1174
1175 </td>
1176
1177
1178 <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;">
1179
1180 &lt;optional><br>
1181
1182
1183
1184
1185
1186 </td>
1187
1188
1189
1190 <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;">
1191
1192 'scalar'
1193
1194 </td>
1195
1196
1197 <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>Type that the property uses.<br> If it is &quot;array&quot;, the given &quot;value&quot; will be attached at the end of the array (all in a new single index if the &quot;iterateArray&quot; parameter is set to false, or each value in a new index otherwise).<br> If it is &quot;object&quot;, the given &quot;value&quot; and the given &quot;property&quot; to modify will be treated as objects and the members of the &quot;value&quot; will be copied one by one (overwriting previous members in the case they existed).<br> If it is &quot;scalar&quot; or any other, the given &quot;property&quot; value will be replaced with the given &quot;value&quot;.</p></td>
1198 </tr>
1199
1200
1201
1202 <tr>
1203
1204 <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>iterateArray</code></td>
1205
1206
1207 <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;">
1208
1209
1210<span class="param-type">boolean</span>
1211
1212
1213
1214
1215 </td>
1216
1217
1218 <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;">
1219
1220 &lt;optional><br>
1221
1222
1223
1224
1225
1226 </td>
1227
1228
1229
1230 <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;">
1231
1232 false
1233
1234 </td>
1235
1236
1237 <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 is set to true and the given &quot;type&quot; is &quot;array&quot;, the given &quot;value&quot; will be considered an array and will be iterated to copy each of its values to a new index in the destiny. Otherwise, if it is set to false and the given &quot;type&quot; is &quot;array&quot;, the given &quot;value&quot; will be attached at the end of the array in a new single index.</p></td>
1238 </tr>
1239
1240
1241 </tbody>
1242</table>
1243
1244
1245
1246
1247<dl class="details">
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1278 <dd class="tag-source">
1279 <ul class="dummy">
1280 <li>
1281 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
1282 <a href="CrossBrowdy.js.html#sunlight-1-line-872">line 872</a>
1283 </li>
1284 </ul>
1285 </dd>
1286
1287
1288
1289
1290
1291
1292
1293</dl>
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307 <h5>Returns:</h5>
1308
1309
1310<div class="param-desc">
1311 <p>It will return true if succeeded or false otherwise.</p>
1312</div>
1313
1314
1315
1316<dl>
1317 <dt>
1318 Type
1319 </dt>
1320 <dd>
1321
1322<span class="param-type">boolean</span>
1323
1324
1325
1326 </dd>
1327</dl>
1328
1329
1330
1331
1332
1333</dd>
1334
1335
1336
1337<hr>
1338<dt>
1339 <h4 class="name" id=".get"><span class="type-signature">&lt;static> </span>get<span class="signature">(moduleName)</span><span class="type-signature"> &rarr; {<a href="CB_Modules.html#.MODULE">CB_Modules.MODULE</a>|null}</span></h4>
1340
1341
1342</dt>
1343<dd>
1344
1345
1346 <div class="description">
1347 <p>Returns a <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object for module management.</p>
1348 </div>
1349
1350
1351
1352
1353
1354
1355
1356
1357 <h5>Parameters:</h5>
1358
1359
1360<table class="params table table-striped">
1361 <thead>
1362 <tr>
1363
1364 <th style="width:12%; min-width:110px;">Name</th>
1365
1366
1367 <th style="width:12%; min-width:110px;">Type</th>
1368
1369
1370
1371
1372
1373 <th class="last" style="min-width:310px;">Description</th>
1374 </tr>
1375 </thead>
1376
1377 <tbody>
1378
1379
1380 <tr>
1381
1382 <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>moduleName</code></td>
1383
1384
1385 <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;">
1386
1387
1388<span class="param-type">string</span>
1389
1390
1391
1392
1393 </td>
1394
1395
1396
1397
1398
1399 <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>Name of the desired module.</p></td>
1400 </tr>
1401
1402
1403 </tbody>
1404</table>
1405
1406
1407
1408
1409<dl class="details">
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1440 <dd class="tag-source">
1441 <ul class="dummy">
1442 <li>
1443 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
1444 <a href="CrossBrowdy.js.html#sunlight-1-line-828">line 828</a>
1445 </li>
1446 </ul>
1447 </dd>
1448
1449
1450
1451
1452
1453
1454
1455</dl>
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469 <h5>Returns:</h5>
1470
1471
1472<div class="param-desc">
1473 <p>If found, it will return the <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object desired. Otherwise, it will return null.</p>
1474</div>
1475
1476
1477
1478<dl>
1479 <dt>
1480 Type
1481 </dt>
1482 <dd>
1483
1484<span class="param-type"><a href="CB_Modules.html#.MODULE">CB_Modules.MODULE</a></span>
1485|
1486
1487<span class="param-type">null</span>
1488
1489
1490
1491 </dd>
1492</dl>
1493
1494
1495
1496
1497
1498</dd>
1499
1500
1501
1502<hr>
1503<dt>
1504 <h4 class="name" id=".getProperty"><span class="type-signature">&lt;static> </span>getProperty<span class="signature">(moduleName, property)</span><span class="type-signature"> &rarr; {*|null}</span></h4>
1505
1506
1507</dt>
1508<dd>
1509
1510
1511 <div class="description">
1512 <p>Gets the value of a desired module property (or returns null).</p>
1513 </div>
1514
1515
1516
1517
1518
1519
1520
1521
1522 <h5>Parameters:</h5>
1523
1524
1525<table class="params table table-striped">
1526 <thead>
1527 <tr>
1528
1529 <th style="width:12%; min-width:110px;">Name</th>
1530
1531
1532 <th style="width:12%; min-width:110px;">Type</th>
1533
1534
1535
1536
1537
1538 <th class="last" style="min-width:310px;">Description</th>
1539 </tr>
1540 </thead>
1541
1542 <tbody>
1543
1544
1545 <tr>
1546
1547 <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>moduleName</code></td>
1548
1549
1550 <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;">
1551
1552
1553<span class="param-type">string</span>
1554
1555
1556
1557
1558 </td>
1559
1560
1561
1562
1563
1564 <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>Name of the desired module.</p></td>
1565 </tr>
1566
1567
1568
1569 <tr>
1570
1571 <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>property</code></td>
1572
1573
1574 <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;">
1575
1576
1577<span class="param-type">string</span>
1578
1579
1580
1581
1582 </td>
1583
1584
1585
1586
1587
1588 <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>Name of the desired property.</p></td>
1589 </tr>
1590
1591
1592 </tbody>
1593</table>
1594
1595
1596
1597
1598<dl class="details">
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1629 <dd class="tag-source">
1630 <ul class="dummy">
1631 <li>
1632 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
1633 <a href="CrossBrowdy.js.html#sunlight-1-line-846">line 846</a>
1634 </li>
1635 </ul>
1636 </dd>
1637
1638
1639
1640
1641
1642
1643
1644</dl>
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658 <h5>Returns:</h5>
1659
1660
1661<div class="param-desc">
1662 <p>If found, it will return the value of the desired module property. Otherwise, it will return null.</p>
1663</div>
1664
1665
1666
1667<dl>
1668 <dt>
1669 Type
1670 </dt>
1671 <dd>
1672
1673<span class="param-type">*</span>
1674|
1675
1676<span class="param-type">null</span>
1677
1678
1679
1680 </dd>
1681</dl>
1682
1683
1684
1685
1686
1687</dd>
1688
1689
1690
1691<hr>
1692<dt>
1693 <h4 class="name" id=".setStatus"><span class="type-signature">&lt;static> </span>setStatus<span class="signature">(moduleName, status)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1694
1695
1696</dt>
1697<dd>
1698
1699
1700 <div class="description">
1701 <p>Sets a status for a given module.</p>
1702 </div>
1703
1704
1705
1706
1707
1708
1709
1710
1711 <h5>Parameters:</h5>
1712
1713
1714<table class="params table table-striped">
1715 <thead>
1716 <tr>
1717
1718 <th style="width:12%; min-width:110px;">Name</th>
1719
1720
1721 <th style="width:12%; min-width:110px;">Type</th>
1722
1723
1724
1725
1726
1727 <th class="last" style="min-width:310px;">Description</th>
1728 </tr>
1729 </thead>
1730
1731 <tbody>
1732
1733
1734 <tr>
1735
1736 <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>moduleName</code></td>
1737
1738
1739 <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;">
1740
1741
1742<span class="param-type">string</span>
1743
1744
1745
1746
1747 </td>
1748
1749
1750
1751
1752
1753 <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>Name of the module.</p></td>
1754 </tr>
1755
1756
1757
1758 <tr>
1759
1760 <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>status</code></td>
1761
1762
1763 <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;">
1764
1765
1766<span class="param-type">integer</span>
1767
1768
1769
1770
1771 </td>
1772
1773
1774
1775
1776
1777 <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 desired status. Must be a value that exists in the <a href="CB_Modules.html#.STATUSES"><code>CB_Modules.STATUSES</code></a> enum.</p></td>
1778 </tr>
1779
1780
1781 </tbody>
1782</table>
1783
1784
1785
1786
1787<dl class="details">
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1818 <dd class="tag-source">
1819 <ul class="dummy">
1820 <li>
1821 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
1822 <a href="CrossBrowdy.js.html#sunlight-1-line-740">line 740</a>
1823 </li>
1824 </ul>
1825 </dd>
1826
1827
1828
1829
1830
1831
1832
1833</dl>
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847 <h5>Returns:</h5>
1848
1849
1850<div class="param-desc">
1851 <p>It will return true if succeeded or false otherwise.</p>
1852</div>
1853
1854
1855
1856<dl>
1857 <dt>
1858 Type
1859 </dt>
1860 <dd>
1861
1862<span class="param-type">boolean</span>
1863
1864
1865
1866 </dd>
1867</dl>
1868
1869
1870
1871
1872
1873</dd>
1874
1875 </dl>
1876
1877
1878
1879 <h3 class="subsection-title">Type Definitions</h3>
1880
1881 <dl>
1882
1883<hr>
1884<dt>
1885 <h4 class="name" id=".CALLBACK"><span class="type-signature"></span>CALLBACK<span class="signature">(scriptPath)</span><span class="type-signature"></span></h4>
1886
1887
1888</dt>
1889<dd>
1890
1891
1892 <div class="description">
1893 <p>Callback for the different events of a module.</p>
1894 </div>
1895
1896
1897
1898
1899
1900
1901
1902
1903 <h5>Parameters:</h5>
1904
1905
1906<table class="params table table-striped">
1907 <thead>
1908 <tr>
1909
1910 <th style="width:12%; min-width:110px;">Name</th>
1911
1912
1913 <th style="width:12%; min-width:110px;">Type</th>
1914
1915
1916
1917
1918
1919 <th class="last" style="min-width:310px;">Description</th>
1920 </tr>
1921 </thead>
1922
1923 <tbody>
1924
1925
1926 <tr>
1927
1928 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>scriptPath</code></td>
1929
1930
1931 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1932
1933
1934<span class="param-type">string</span>
1935
1936
1937
1938
1939 </td>
1940
1941
1942
1943
1944
1945 <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 for the &quot;scriptPath&quot; parameter used by <a href="global.html#CB_init"><code>CB_init</code></a> when it was called.</p></td>
1946 </tr>
1947
1948
1949 </tbody>
1950</table>
1951
1952
1953
1954
1955<dl class="details">
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1986 <dd class="tag-source">
1987 <ul class="dummy">
1988 <li>
1989 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
1990 <a href="CrossBrowdy.js.html#sunlight-1-line-219">line 219</a>
1991 </li>
1992 </ul>
1993 </dd>
1994
1995
1996
1997
1998
1999
2000
2001</dl>
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017</dd>
2018
2019
2020
2021<hr>
2022<dt class="name" id=".MODULE">
2023 <h4 id=".MODULE">MODULE</h4>
2024
2025
2026</dt>
2027<dd>
2028
2029 <div class="description">
2030 <p>Object that contains a module.</p>
2031 </div>
2032
2033
2034
2035 <h5>Type:</h5>
2036 <ul>
2037 <li>
2038
2039<span class="param-type">Object</span>
2040
2041
2042
2043 </li>
2044 </ul>
2045
2046
2047
2048<dl class="details">
2049
2050
2051 <h5 class="subsection-title">Properties:</h5>
2052
2053 <dl>
2054
2055<table class="props table table-striped">
2056 <thead>
2057 <tr>
2058
2059 <th>Name</th>
2060
2061
2062 <th>Type</th>
2063
2064
2065
2066
2067
2068 <th class="last">Description</th>
2069 </tr>
2070 </thead>
2071
2072 <tbody>
2073
2074
2075 <tr>
2076
2077 <td class="name"><code>name</code></td>
2078
2079
2080 <td class="type">
2081
2082
2083<span class="param-type">string</span>
2084
2085
2086
2087
2088 </td>
2089
2090
2091
2092
2093
2094 <td class="description last"><p>Name of the module.</p></td>
2095 </tr>
2096
2097
2098
2099 <tr>
2100
2101 <td class="name"><code>status</code></td>
2102
2103
2104 <td class="type">
2105
2106
2107<span class="param-type"><a href="CB_Modules.html#.STATUSES">CB_Modules.STATUSES</a></span>
2108
2109
2110
2111
2112 </td>
2113
2114
2115
2116
2117
2118 <td class="description last"><p>Module status.</p></td>
2119 </tr>
2120
2121
2122
2123 <tr>
2124
2125 <td class="name"><code>onCall</code></td>
2126
2127
2128 <td class="type">
2129
2130
2131<span class="param-type"><a href="CB_Modules.html#.CALLBACK">CB_Modules.CALLBACK</a></span>
2132
2133
2134
2135
2136 </td>
2137
2138
2139
2140
2141
2142 <td class="description last"><p>Callback for when the module is called to be loaded. Being &quot;this&quot; the <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object itself.</p></td>
2143 </tr>
2144
2145
2146
2147 <tr>
2148
2149 <td class="name"><code>onLoad</code></td>
2150
2151
2152 <td class="type">
2153
2154
2155<span class="param-type"><a href="CB_Modules.html#.CALLBACK">CB_Modules.CALLBACK</a></span>
2156
2157
2158
2159
2160 </td>
2161
2162
2163
2164
2165
2166 <td class="description last"><p>Callback for when the module loads successfully. Being &quot;this&quot; the <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object itself.</p></td>
2167 </tr>
2168
2169
2170
2171 <tr>
2172
2173 <td class="name"><code>onReady</code></td>
2174
2175
2176 <td class="type">
2177
2178
2179<span class="param-type"><a href="CB_Modules.html#.CALLBACK">CB_Modules.CALLBACK</a></span>
2180
2181
2182
2183
2184 </td>
2185
2186
2187
2188
2189
2190 <td class="description last"><p>Callback for when the module is totally ready. Being &quot;this&quot; the <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object itself.</p></td>
2191 </tr>
2192
2193
2194
2195 <tr>
2196
2197 <td class="name"><code>onFail</code></td>
2198
2199
2200 <td class="type">
2201
2202
2203<span class="param-type"><a href="CB_Modules.html#.CALLBACK">CB_Modules.CALLBACK</a></span>
2204
2205
2206
2207
2208 </td>
2209
2210
2211
2212
2213
2214 <td class="description last"><p>Callback for when the module fails to load. Being &quot;this&quot; the <a href="CB_Modules.html#.MODULE"><code>CB_Modules.MODULE</code></a> object itself. NOT IMPLEMENTED YET.</p></td>
2215 </tr>
2216
2217
2218
2219 <tr>
2220
2221 <td class="name"><code>neededFiles</code></td>
2222
2223
2224 <td class="type">
2225
2226
2227<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILES">CB_Modules.NEEDED_FILES</a></span>
2228
2229
2230
2231
2232 </td>
2233
2234
2235
2236
2237
2238 <td class="description last"><p>Object containing the needed files.</p></td>
2239 </tr>
2240
2241
2242
2243 <tr>
2244
2245 <td class="name"><code>neededModules</code></td>
2246
2247
2248 <td class="type">
2249
2250
2251<span class="param-type">array</span>
2252
2253
2254
2255
2256 </td>
2257
2258
2259
2260
2261
2262 <td class="description last"><p>Array of <a href="CB_Modules.html#.NEEDED_MODULE"><code>CB_Modules.NEEDED_MODULE</code></a> objects, containing the needed modules.</p></td>
2263 </tr>
2264
2265
2266
2267 <tr>
2268
2269 <td class="name"><code>credits</code></td>
2270
2271
2272 <td class="type">
2273
2274
2275<span class="param-type">string</span>
2276
2277
2278
2279
2280 </td>
2281
2282
2283
2284
2285
2286 <td class="description last"><p>Credits of the module.</p></td>
2287 </tr>
2288
2289
2290 </tbody>
2291</table>
2292</dl>
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2324 <dd class="tag-source">
2325 <ul class="dummy">
2326 <li>
2327 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
2328 <a href="CrossBrowdy.js.html#sunlight-1-line-226">line 226</a>
2329 </li>
2330 </ul>
2331 </dd>
2332
2333
2334
2335
2336
2337
2338
2339</dl>
2340
2341
2342
2343</dd>
2344
2345
2346
2347<hr>
2348<dt class="name" id=".NEEDED_FILE">
2349 <h4 id=".NEEDED_FILE">NEEDED_FILE</h4>
2350
2351
2352</dt>
2353<dd>
2354
2355 <div class="description">
2356 <p>Object that contains a needed file for a module.</p>
2357 </div>
2358
2359
2360
2361 <h5>Type:</h5>
2362 <ul>
2363 <li>
2364
2365<span class="param-type">Object</span>
2366
2367
2368
2369 </li>
2370 </ul>
2371
2372
2373
2374<dl class="details">
2375
2376
2377 <h5 class="subsection-title">Properties:</h5>
2378
2379 <dl>
2380
2381<table class="props table table-striped">
2382 <thead>
2383 <tr>
2384
2385 <th>Name</th>
2386
2387
2388 <th>Type</th>
2389
2390
2391 <th>Argument</th>
2392
2393
2394
2395 <th>Default</th>
2396
2397
2398 <th class="last">Description</th>
2399 </tr>
2400 </thead>
2401
2402 <tbody>
2403
2404
2405 <tr>
2406
2407 <td class="name"><code>load</code></td>
2408
2409
2410 <td class="type">
2411
2412
2413<span class="param-type">boolean</span>
2414
2415
2416
2417
2418 </td>
2419
2420
2421 <td class="attributes">
2422
2423 &lt;optional><br>
2424
2425
2426
2427 </td>
2428
2429
2430
2431 <td class="default">
2432
2433 false
2434
2435 </td>
2436
2437
2438 <td class="description last"><p>Defines whether to load the file or not.</p></td>
2439 </tr>
2440
2441
2442
2443 <tr>
2444
2445 <td class="name"><code>mandatory</code></td>
2446
2447
2448 <td class="type">
2449
2450
2451<span class="param-type">boolean</span>
2452
2453
2454
2455
2456 </td>
2457
2458
2459 <td class="attributes">
2460
2461 &lt;optional><br>
2462
2463
2464
2465 </td>
2466
2467
2468
2469 <td class="default">
2470
2471 false
2472
2473 </td>
2474
2475
2476 <td class="description last"><p>Defines whether the file is mandatory. If the file is not mandatory, its module could be declared as loaded successfully before the file is loaded (and maybe never will).</p></td>
2477 </tr>
2478
2479
2480
2481 <tr>
2482
2483 <td class="name"><code>absolutePath</code></td>
2484
2485
2486 <td class="type">
2487
2488
2489<span class="param-type">boolean</span>
2490
2491
2492
2493
2494 </td>
2495
2496
2497 <td class="attributes">
2498
2499 &lt;optional><br>
2500
2501
2502
2503 </td>
2504
2505
2506
2507 <td class="default">
2508
2509 false
2510
2511 </td>
2512
2513
2514 <td class="description last"><p>Defines whether the path of the file is relative to the path of the main script or absolute.</p></td>
2515 </tr>
2516
2517
2518
2519 <tr>
2520
2521 <td class="name"><code>loadChecker</code></td>
2522
2523
2524 <td class="type">
2525
2526
2527<span class="param-type"><a href="CB_Modules.html#.neededFile_LOAD_CHECKER">CB_Modules.neededFile_LOAD_CHECKER</a></span>
2528
2529
2530
2531
2532 </td>
2533
2534
2535 <td class="attributes">
2536
2537 &lt;optional><br>
2538
2539
2540
2541 </td>
2542
2543
2544
2545 <td class="default">
2546
2547 </td>
2548
2549
2550 <td class="description last"><p>Callback that will be called when the file tries to be loaded and should return true if the file needs to be loaded.</p></td>
2551 </tr>
2552
2553
2554
2555 <tr>
2556
2557 <td class="name"><code>id</code></td>
2558
2559
2560 <td class="type">
2561
2562
2563<span class="param-type">string</span>
2564
2565
2566
2567
2568 </td>
2569
2570
2571 <td class="attributes">
2572
2573 &lt;optional><br>
2574
2575
2576
2577 </td>
2578
2579
2580
2581 <td class="default">
2582
2583 </td>
2584
2585
2586 <td class="description last"><p>Desired string to identify the file.</p></td>
2587 </tr>
2588
2589
2590
2591 <tr>
2592
2593 <td class="name"><code>requires</code></td>
2594
2595
2596 <td class="type">
2597
2598
2599<span class="param-type">array</span>
2600
2601
2602
2603
2604 </td>
2605
2606
2607 <td class="attributes">
2608
2609 &lt;optional><br>
2610
2611
2612
2613 </td>
2614
2615
2616
2617 <td class="default">
2618
2619 </td>
2620
2621
2622 <td class="description last"><p>Array of strings with the IDs of the files that must be loaded before loading this file. The file will not be loaded until the required files are loaded first.</p></td>
2623 </tr>
2624
2625
2626 </tbody>
2627</table>
2628</dl>
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2660 <dd class="tag-source">
2661 <ul class="dummy">
2662 <li>
2663 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
2664 <a href="CrossBrowdy.js.html#sunlight-1-line-191">line 191</a>
2665 </li>
2666 </ul>
2667 </dd>
2668
2669
2670
2671
2672
2673
2674
2675</dl>
2676
2677
2678
2679</dd>
2680
2681
2682
2683<hr>
2684<dt class="name" id=".NEEDED_FILES">
2685 <h4 id=".NEEDED_FILES">NEEDED_FILES</h4>
2686
2687
2688</dt>
2689<dd>
2690
2691 <div class="description">
2692 <p>Object that contains the needed files for a module. Each property will represent a needed file.</p>
2693 </div>
2694
2695
2696
2697 <h5>Type:</h5>
2698 <ul>
2699 <li>
2700
2701<span class="param-type">Object</span>
2702
2703
2704
2705 </li>
2706 </ul>
2707
2708
2709
2710<dl class="details">
2711
2712
2713 <h5 class="subsection-title">Properties:</h5>
2714
2715 <dl>
2716
2717<table class="props table table-striped">
2718 <thead>
2719 <tr>
2720
2721 <th>Name</th>
2722
2723
2724 <th>Type</th>
2725
2726
2727
2728
2729
2730 <th class="last">Description</th>
2731 </tr>
2732 </thead>
2733
2734 <tbody>
2735
2736
2737 <tr>
2738
2739 <td class="name"><code>path_to_the_file</code></td>
2740
2741
2742 <td class="type">
2743
2744
2745<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILE">CB_Modules.NEEDED_FILE</a></span>
2746
2747
2748
2749
2750 </td>
2751
2752
2753
2754
2755
2756 <td class="description last"><p>Object that contains a needed file for a module. The property name must be either the path to the file or a variable containing it. Tto use a variable, the name of the property must start with &quot;VALUEOF_&quot; and continue with the name of the variable. In the case that the variable is an object, each property must be separated by a dot (&quot;.&quot;).</p></td>
2757 </tr>
2758
2759
2760 </tbody>
2761</table>
2762</dl>
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2794 <dd class="tag-source">
2795 <ul class="dummy">
2796 <li>
2797 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
2798 <a href="CrossBrowdy.js.html#sunlight-1-line-203">line 203</a>
2799 </li>
2800 </ul>
2801 </dd>
2802
2803
2804
2805
2806
2807
2808
2809</dl>
2810
2811
2812
2813</dd>
2814
2815
2816
2817<hr>
2818<dt class="name" id=".NEEDED_MODULE">
2819 <h4 id=".NEEDED_MODULE">NEEDED_MODULE</h4>
2820
2821
2822</dt>
2823<dd>
2824
2825 <div class="description">
2826 <p>Object that contains a needed module for a parent module.</p>
2827 </div>
2828
2829
2830
2831 <h5>Type:</h5>
2832 <ul>
2833 <li>
2834
2835<span class="param-type">Object</span>
2836
2837
2838
2839 </li>
2840 </ul>
2841
2842
2843
2844<dl class="details">
2845
2846
2847 <h5 class="subsection-title">Properties:</h5>
2848
2849 <dl>
2850
2851<table class="props table table-striped">
2852 <thead>
2853 <tr>
2854
2855 <th>Name</th>
2856
2857
2858 <th>Type</th>
2859
2860
2861
2862
2863
2864 <th class="last">Description</th>
2865 </tr>
2866 </thead>
2867
2868 <tbody>
2869
2870
2871 <tr>
2872
2873 <td class="name"><code>name</code></td>
2874
2875
2876 <td class="type">
2877
2878
2879<span class="param-type">string</span>
2880
2881
2882
2883
2884 </td>
2885
2886
2887
2888
2889
2890 <td class="description last"><p>Name of the module.</p></td>
2891 </tr>
2892
2893
2894
2895 <tr>
2896
2897 <td class="name"><code>neededFiles</code></td>
2898
2899
2900 <td class="type">
2901
2902
2903<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILES">CB_Modules.NEEDED_FILES</a></span>
2904
2905
2906
2907
2908 </td>
2909
2910
2911
2912
2913
2914 <td class="description last"><p>Object containing the needed files.</p></td>
2915 </tr>
2916
2917
2918 </tbody>
2919</table>
2920</dl>
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2952 <dd class="tag-source">
2953 <ul class="dummy">
2954 <li>
2955 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
2956 <a href="CrossBrowdy.js.html#sunlight-1-line-211">line 211</a>
2957 </li>
2958 </ul>
2959 </dd>
2960
2961
2962
2963
2964
2965
2966
2967</dl>
2968
2969
2970
2971</dd>
2972
2973
2974
2975<hr>
2976<dt>
2977 <h4 class="name" id=".neededFile_LOAD_CHECKER"><span class="type-signature"></span>neededFile_LOAD_CHECKER<span class="signature">(filepath, neededFile)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2978
2979
2980</dt>
2981<dd>
2982
2983
2984 <div class="description">
2985 <p>Callback that is called before loading a file and should return true if we want to load the file or false otherwise.</p>
2986 </div>
2987
2988
2989
2990
2991
2992
2993
2994
2995 <h5>Parameters:</h5>
2996
2997
2998<table class="params table table-striped">
2999 <thead>
3000 <tr>
3001
3002 <th style="width:12%; min-width:110px;">Name</th>
3003
3004
3005 <th style="width:12%; min-width:110px;">Type</th>
3006
3007
3008
3009
3010
3011 <th class="last" style="min-width:310px;">Description</th>
3012 </tr>
3013 </thead>
3014
3015 <tbody>
3016
3017
3018 <tr>
3019
3020 <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>filepath</code></td>
3021
3022
3023 <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;">
3024
3025
3026<span class="param-type">string</span>
3027
3028
3029
3030
3031 </td>
3032
3033
3034
3035
3036
3037 <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>Filepath of the needed file (including the filename).</p></td>
3038 </tr>
3039
3040
3041
3042 <tr>
3043
3044 <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>neededFile</code></td>
3045
3046
3047 <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;">
3048
3049
3050<span class="param-type"><a href="CB_Modules.html#.NEEDED_FILE">CB_Modules.NEEDED_FILE</a></span>
3051
3052
3053
3054
3055 </td>
3056
3057
3058
3059
3060
3061 <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 that contains the needed file.</p></td>
3062 </tr>
3063
3064
3065 </tbody>
3066</table>
3067
3068
3069
3070
3071<dl class="details">
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3102 <dd class="tag-source">
3103 <ul class="dummy">
3104 <li>
3105 <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
3106 <a href="CrossBrowdy.js.html#sunlight-1-line-182">line 182</a>
3107 </li>
3108 </ul>
3109 </dd>
3110
3111
3112
3113
3114
3115
3116
3117</dl>
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131 <h5>Returns:</h5>
3132
3133
3134<div class="param-desc">
3135 <ul>
3136<li>Returns true if we want to load the file or false otherwise.</li>
3137</ul>
3138</div>
3139
3140
3141
3142<dl>
3143 <dt>
3144 Type
3145 </dt>
3146 <dd>
3147
3148<span class="param-type">boolean</span>
3149
3150
3151
3152 </dd>
3153</dl>
3154
3155
3156
3157
3158
3159</dd>
3160
3161 </dl>
3162
3163
3164
3165</article>
3166
3167</section>
3168
3169
3170
3171
3172 </div>
3173 </div>
3174
3175 <div class="clearfix"></div>
3176
3177
3178 <div class="col-md-3">
3179 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
3180 </div>
3181
3182
3183</div>
3184</div>
3185
3186
3187 <div class="modal fade" id="searchResults">
3188 <div class="modal-dialog">
3189 <div class="modal-content">
3190 <div class="modal-header">
3191 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
3192 <h4 class="modal-title">Search results</h4>
3193 </div>
3194 <div class="modal-body"></div>
3195 <div class="modal-footer">
3196 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
3197 </div>
3198 </div><!-- /.modal-content -->
3199 </div><!-- /.modal-dialog -->
3200 </div>
3201
3202
3203<footer>
3204
3205
3206 <span class="copyright">
3207 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
3208 </span>
3209
3210<span class="jsdoc-message">
3211 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
3212
3213 on Mon Feb 3rd 2020
3214
3215 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3216</span>
3217</footer>
3218
3219<script src="scripts/docstrap.lib.js"></script>
3220<script src="scripts/toc.js"></script>
3221
3222 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
3223
3224
3225<script>
3226$( function () {
3227 $( "[id*='$']" ).each( function () {
3228 var $this = $( this );
3229
3230 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
3231 } );
3232
3233 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
3234 var $this = $( this );
3235
3236 var example = $this.find( "code" );
3237 exampleText = example.html();
3238 var lang = /{@lang (.*?)}/.exec( exampleText );
3239 if ( lang && lang[1] ) {
3240 exampleText = exampleText.replace( lang[0], "" );
3241 example.html( exampleText );
3242 lang = lang[1];
3243 } else {
3244 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
3245 lang = langClassMatch ? langClassMatch[1] : "javascript";
3246 }
3247
3248 if ( lang ) {
3249
3250 $this
3251 .addClass( "sunlight-highlight-" + lang )
3252 .addClass( "linenums" )
3253 .html( example.html() );
3254
3255 }
3256 } );
3257
3258 Sunlight.highlightAll( {
3259 lineNumbers : true,
3260 showMenu : true,
3261 enableDoclinks : true
3262 } );
3263
3264 $.catchAnchorLinks( {
3265 navbarOffset: 10
3266 } );
3267 $( "#toc" ).toc( {
3268 anchorName : function ( i, heading, prefix ) {
3269 return $( heading ).attr( "id" ) || ( prefix + i );
3270 },
3271 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
3272 showAndHide : false,
3273 smoothScrolling: true
3274 } );
3275
3276 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
3277 $( '.dropdown-toggle' ).dropdown();
3278
3279 $( "table" ).each( function () {
3280 var $this = $( this );
3281 $this.addClass('table');
3282 } );
3283
3284} );
3285</script>
3286
3287
3288
3289<!--Navigation and Symbol Display-->
3290
3291<script>
3292 $( function () {
3293 $( '#main' ).localScroll( {
3294 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
3295 } );
3296 $( "dt.name" ).each( function () {
3297 var $this = $( this ).find("h4");
3298 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
3299 var dt = $(this);
3300 var children = dt.next( "dd" );
3301
3302 dt.prepend( icon ).css( {cursor : "pointer"} );
3303 dt.addClass( "member-collapsed" ).addClass( "member" );
3304
3305
3306 children.hide();
3307
3308 dt.children().on( "click", function () {
3309 children = dt.next( "dd" );
3310 children.slideToggle( "fast", function () {
3311
3312 if ( children.is( ":visible" ) ) {
3313 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
3314 dt.addClass( "member-open" ).animate( "member-collapsed" );
3315 } else {
3316 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
3317 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
3318 }
3319 } );
3320 } );
3321
3322 } );
3323 } );
3324</script>
3325
3326
3327<!--Google Analytics-->
3328
3329
3330
3331 <script type="text/javascript">
3332 $(document).ready(function() {
3333 SearcherDisplay.init();
3334 });
3335 </script>
3336
3337
3338</body>
3339</html>
\No newline at end of file