worldstate-emitter 1.0.4 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/README.md +6 -6
  2. package/SECURITY.md +17 -0
  3. package/handlers/Twitter.js +2 -2
  4. package/handlers/Worldstate.js +16 -163
  5. package/handlers/events/arrayLike.js +20 -0
  6. package/handlers/events/checkOverrides.js +19 -0
  7. package/handlers/events/cycleLike.js +1 -1
  8. package/handlers/events/eKeyOverrides.js +28 -0
  9. package/handlers/events/kuva.js +31 -0
  10. package/handlers/events/objectLike.js +1 -1
  11. package/handlers/events/parse.js +72 -0
  12. package/package.json +63 -20
  13. package/resources/tweeters.json +3 -3
  14. package/utilities/WSCache.js +5 -1
  15. package/.codeclimate.yml +0 -13
  16. package/.eslintrc.json +0 -33
  17. package/.github/.stale.yml +0 -13
  18. package/.github/CODEOWNERS +0 -1
  19. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -27
  20. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -20
  21. package/.github/PULL_REQUEST_TEMPLATE.md +0 -17
  22. package/.github/update_docs.sh +0 -22
  23. package/.snyk +0 -8
  24. package/docs/RSS.html +0 -424
  25. package/docs/TwitterCache.html +0 -900
  26. package/docs/WSCache.html +0 -734
  27. package/docs/Worldstate.html +0 -1294
  28. package/docs/classes.list.html +0 -344
  29. package/docs/fonts/glyphicons-halflings-regular.eot +0 -0
  30. package/docs/fonts/glyphicons-halflings-regular.svg +0 -288
  31. package/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
  32. package/docs/fonts/glyphicons-halflings-regular.woff +0 -0
  33. package/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
  34. package/docs/global.html +0 -1882
  35. package/docs/handlers_RSS.js.html +0 -321
  36. package/docs/handlers_Twitter.js.html +0 -431
  37. package/docs/handlers_Worldstate.js.html +0 -559
  38. package/docs/img/glyphicons-halflings-white.png +0 -0
  39. package/docs/img/glyphicons-halflings.png +0 -0
  40. package/docs/index.html +0 -402
  41. package/docs/quicksearch.html +0 -31
  42. package/docs/scripts/docstrap.lib.js +0 -11
  43. package/docs/scripts/fulltext-search-ui.js +0 -89
  44. package/docs/scripts/fulltext-search.js +0 -36
  45. package/docs/scripts/lunr.min.js +0 -6
  46. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  47. package/docs/scripts/prettify/jquery.min.js +0 -6
  48. package/docs/scripts/prettify/lang-css.js +0 -21
  49. package/docs/scripts/prettify/prettify.js +0 -496
  50. package/docs/scripts/sunlight.js +0 -1157
  51. package/docs/scripts/toc.js +0 -203
  52. package/docs/styles/darkstrap.css +0 -960
  53. package/docs/styles/prettify-tomorrow.css +0 -132
  54. package/docs/styles/site.cerulean.css +0 -7008
  55. package/docs/styles/site.cosmo.css +0 -7061
  56. package/docs/styles/site.cyborg.css +0 -7048
  57. package/docs/styles/site.darkly.css +0 -7171
  58. package/docs/styles/site.darkstrap.css +0 -5638
  59. package/docs/styles/site.dibs-bootstrap.css +0 -5899
  60. package/docs/styles/site.flatly.css +0 -7147
  61. package/docs/styles/site.journal.css +0 -6973
  62. package/docs/styles/site.lumen.css +0 -7298
  63. package/docs/styles/site.paper.css +0 -7623
  64. package/docs/styles/site.readable.css +0 -6997
  65. package/docs/styles/site.sandstone.css +0 -7035
  66. package/docs/styles/site.simplex.css +0 -7023
  67. package/docs/styles/site.slate.css +0 -7343
  68. package/docs/styles/site.spacelab.css +0 -7055
  69. package/docs/styles/site.superhero.css +0 -7131
  70. package/docs/styles/site.united.css +0 -6895
  71. package/docs/styles/site.yeti.css +0 -7195
  72. package/docs/styles/sunlight.dark.css +0 -345
  73. package/docs/styles/sunlight.default.css +0 -344
  74. package/docs/utilities_WSCache.js.html +0 -322
  75. package/docs/utilities_index.js.html +0 -338
  76. package/jsdoc-config.json +0 -35
package/docs/global.html DELETED
@@ -1,1882 +0,0 @@
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>Worldstate Emitter Global</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.dark.css">
13
-
14
- <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
-
16
- </head>
17
-
18
- <body>
19
-
20
- <div class="navbar navbar-default navbar-fixed-top navbar-inverse">
21
- <div class="container">
22
- <div class="navbar-header">
23
- <a class="navbar-brand" href="index.html">Worldstate Emitter</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="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
35
- <ul class="dropdown-menu inline">
36
- <li><a href="RSS.html">RSS</a></li><li><a href="TwitterCache.html">TwitterCache</a></li><li><a href="Worldstate.html">Worldstate</a></li><li><a href="WSCache.html">WSCache</a></li>
37
- </ul>
38
- </li>
39
-
40
- <li class="dropdown">
41
- <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
42
- <ul class="dropdown-menu inline">
43
- <li><a href="global.html#arrayLike">arrayLike</a></li><li><a href="global.html#between">between</a></li><li><a href="global.html#checkOverrides">checkOverrides</a></li><li><a href="global.html#fromNow">fromNow</a></li><li><a href="global.html#groupBy">groupBy</a></li><li><a href="global.html#initCycleStart">initCycleStart</a></li><li><a href="global.html#kuvaProcessing">kuvaProcessing</a></li><li><a href="global.html#lastUpdated">lastUpdated</a></li><li><a href="global.html#parseNew">parseNew</a></li>
44
- </ul>
45
- </li>
46
-
47
- </ul>
48
-
49
- <div class="col-sm-3 col-md-3">
50
- <form class="navbar-form" role="search">
51
- <div class="input-group">
52
- <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
53
- <div class="input-group-btn">
54
- <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
55
- </div>
56
- </div>
57
- </form>
58
- </div>
59
-
60
- </div>
61
-
62
- </div>
63
- </div>
64
-
65
-
66
- <div class="container" id="toc-content">
67
- <div class="row">
68
-
69
-
70
- <div class="col-md-8">
71
-
72
- <div id="main">
73
-
74
-
75
- <h1 class="page-title">Global</h1>
76
- <section>
77
-
78
- <header>
79
-
80
- <h2>
81
-
82
- </h2>
83
-
84
-
85
- </header>
86
-
87
-
88
- <article>
89
- <div class="container-overview">
90
-
91
-
92
-
93
-
94
- <dl class="details">
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
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
- </dl>
131
-
132
-
133
-
134
-
135
- </div>
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
- <h3 class="subsection-title">Members</h3>
149
-
150
- <dl>
151
-
152
- <hr>
153
- <dt class="name" id="lastUpdated">
154
- <h4 id="lastUpdated"><span class="type-signature">&lt;constant> </span>lastUpdated<span class="type-signature"> :Object</span></h4>
155
-
156
-
157
- </dt>
158
- <dd>
159
-
160
- <div class="description">
161
- Map of last updated dates/times
162
- </div>
163
-
164
-
165
-
166
- <h5>Type:</h5>
167
- <ul>
168
- <li>
169
-
170
- <span class="param-type">Object</span>
171
-
172
-
173
-
174
- </li>
175
- </ul>
176
-
177
-
178
-
179
- <dl class="details">
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
210
- <dd class="tag-source">
211
- <ul class="dummy">
212
- <li>
213
- <a href="utilities_index.js.html">utilities/index.js</a>,
214
- <a href="utilities_index.js.html#sunlight-1-line-66">line 66</a>
215
- </li>
216
- </ul>
217
- </dd>
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
- </dl>
226
-
227
-
228
-
229
- </dd>
230
-
231
- </dl>
232
-
233
-
234
-
235
- <h3 class="subsection-title">Methods</h3>
236
-
237
- <dl>
238
-
239
- <hr>
240
- <dt>
241
- <h4 class="name" id="arrayLike"><span class="type-signature"></span>arrayLike(deps, packets)</h4>
242
-
243
-
244
- </dt>
245
- <dd>
246
-
247
-
248
- <div class="description">
249
- arrayLike are all just arrays of objectLike
250
- </div>
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
- <h5>Parameters:</h5>
260
-
261
-
262
- <table class="params table table-striped">
263
- <thead>
264
- <tr>
265
-
266
- <th>Name</th>
267
-
268
-
269
- <th>Type</th>
270
-
271
-
272
-
273
-
274
-
275
- <th class="last">Description</th>
276
- </tr>
277
- </thead>
278
-
279
- <tbody>
280
-
281
-
282
- <tr>
283
-
284
- <td class="name"><code>deps</code></td>
285
-
286
-
287
- <td class="type">
288
-
289
-
290
- <span class="param-type">Object</span>
291
-
292
-
293
-
294
-
295
- </td>
296
-
297
-
298
-
299
-
300
-
301
- <td class="description last">dependencies for processing</td>
302
- </tr>
303
-
304
-
305
-
306
- <tr>
307
-
308
- <td class="name"><code>packets</code></td>
309
-
310
-
311
- <td class="type">
312
-
313
-
314
- <span class="param-type">Array.&lt;Object></span>
315
-
316
-
317
-
318
-
319
- </td>
320
-
321
-
322
-
323
-
324
-
325
- <td class="description last">packets to emit</td>
326
- </tr>
327
-
328
-
329
- </tbody>
330
- </table>
331
-
332
-
333
-
334
-
335
- <dl class="details">
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
366
- <dd class="tag-source">
367
- <ul class="dummy">
368
- <li>
369
- <a href="handlers_Worldstate.js.html">handlers/Worldstate.js</a>,
370
- <a href="handlers_Worldstate.js.html#sunlight-1-line-96">line 96</a>
371
- </li>
372
- </ul>
373
- </dd>
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- </dl>
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
- <h5>Returns:</h5>
396
-
397
-
398
- <div class="param-desc">
399
- object(s) to emit from arrayLike processing
400
- </div>
401
-
402
-
403
-
404
- <dl>
405
- <dt>
406
- Type
407
- </dt>
408
- <dd>
409
-
410
- <span class="param-type">Object</span>
411
- |
412
-
413
- <span class="param-type">Array.&lt;Object></span>
414
-
415
-
416
-
417
- </dd>
418
- </dl>
419
-
420
-
421
-
422
-
423
-
424
- </dd>
425
-
426
-
427
-
428
- <hr>
429
- <dt>
430
- <h4 class="name" id="between"><span class="type-signature"></span>between(a, b, c)</h4>
431
-
432
-
433
- </dt>
434
- <dd>
435
-
436
-
437
- <div class="description">
438
- Validate that b is between a and c
439
- </div>
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
- <h5>Parameters:</h5>
449
-
450
-
451
- <table class="params table table-striped">
452
- <thead>
453
- <tr>
454
-
455
- <th>Name</th>
456
-
457
-
458
- <th>Type</th>
459
-
460
-
461
-
462
-
463
-
464
- <th class="last">Description</th>
465
- </tr>
466
- </thead>
467
-
468
- <tbody>
469
-
470
-
471
- <tr>
472
-
473
- <td class="name"><code>a</code></td>
474
-
475
-
476
- <td class="type">
477
-
478
-
479
- <span class="param-type">Date</span>
480
-
481
-
482
-
483
-
484
- </td>
485
-
486
-
487
-
488
-
489
-
490
- <td class="description last">The first Date, should be the last time things were updated</td>
491
- </tr>
492
-
493
-
494
-
495
- <tr>
496
-
497
- <td class="name"><code>b</code></td>
498
-
499
-
500
- <td class="type">
501
-
502
-
503
- <span class="param-type">Date</span>
504
-
505
-
506
-
507
-
508
- </td>
509
-
510
-
511
-
512
-
513
-
514
- <td class="description last">The second Date, should be the activation time of an event</td>
515
- </tr>
516
-
517
-
518
-
519
- <tr>
520
-
521
- <td class="name"><code>c</code></td>
522
-
523
-
524
- <td class="type">
525
-
526
-
527
- <span class="param-type">Date</span>
528
-
529
-
530
-
531
-
532
- </td>
533
-
534
-
535
-
536
-
537
-
538
- <td class="description last">The third Date, should be the start time of this update cycle</td>
539
- </tr>
540
-
541
-
542
- </tbody>
543
- </table>
544
-
545
-
546
-
547
-
548
- <dl class="details">
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
-
576
-
577
-
578
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
579
- <dd class="tag-source">
580
- <ul class="dummy">
581
- <li>
582
- <a href="utilities_index.js.html">utilities/index.js</a>,
583
- <a href="utilities_index.js.html#sunlight-1-line-50">line 50</a>
584
- </li>
585
- </ul>
586
- </dd>
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
- </dl>
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
- <h5>Returns:</h5>
609
-
610
-
611
- <div class="param-desc">
612
- if the event date is between the server start time and the last update time
613
- </div>
614
-
615
-
616
-
617
- <dl>
618
- <dt>
619
- Type
620
- </dt>
621
- <dd>
622
-
623
- <span class="param-type">boolean</span>
624
-
625
-
626
-
627
- </dd>
628
- </dl>
629
-
630
-
631
-
632
-
633
-
634
- </dd>
635
-
636
-
637
-
638
- <hr>
639
- <dt>
640
- <h4 class="name" id="checkOverrides"><span class="type-signature"></span>checkOverrides(key, data)</h4>
641
-
642
-
643
- </dt>
644
- <dd>
645
-
646
-
647
- <div class="description">
648
- Find overrides for the provided key
649
- </div>
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
- <h5>Parameters:</h5>
659
-
660
-
661
- <table class="params table table-striped">
662
- <thead>
663
- <tr>
664
-
665
- <th>Name</th>
666
-
667
-
668
- <th>Type</th>
669
-
670
-
671
-
672
-
673
-
674
- <th class="last">Description</th>
675
- </tr>
676
- </thead>
677
-
678
- <tbody>
679
-
680
-
681
- <tr>
682
-
683
- <td class="name"><code>key</code></td>
684
-
685
-
686
- <td class="type">
687
-
688
-
689
- <span class="param-type">string</span>
690
-
691
-
692
-
693
-
694
- </td>
695
-
696
-
697
-
698
-
699
-
700
- <td class="description last">worldsate field to find overrides</td>
701
- </tr>
702
-
703
-
704
-
705
- <tr>
706
-
707
- <td class="name"><code>data</code></td>
708
-
709
-
710
- <td class="type">
711
-
712
-
713
- <span class="param-type">Object</span>
714
-
715
-
716
-
717
-
718
- </td>
719
-
720
-
721
-
722
-
723
-
724
- <td class="description last">data corresponding to the key from provided worldstate</td>
725
- </tr>
726
-
727
-
728
- </tbody>
729
- </table>
730
-
731
-
732
-
733
-
734
- <dl class="details">
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
-
747
-
748
-
749
-
750
-
751
-
752
-
753
-
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
765
- <dd class="tag-source">
766
- <ul class="dummy">
767
- <li>
768
- <a href="handlers_Worldstate.js.html">handlers/Worldstate.js</a>,
769
- <a href="handlers_Worldstate.js.html#sunlight-1-line-52">line 52</a>
770
- </li>
771
- </ul>
772
- </dd>
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
- </dl>
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
- <h5>Returns:</h5>
795
-
796
-
797
- <div class="param-desc">
798
- overrided key
799
- </div>
800
-
801
-
802
-
803
- <dl>
804
- <dt>
805
- Type
806
- </dt>
807
- <dd>
808
-
809
- <span class="param-type">string</span>
810
-
811
-
812
-
813
- </dd>
814
- </dl>
815
-
816
-
817
-
818
-
819
-
820
- </dd>
821
-
822
-
823
-
824
- <hr>
825
- <dt>
826
- <h4 class="name" id="fromNow"><span class="type-signature"></span>fromNow(d [, now])</h4>
827
-
828
-
829
- </dt>
830
- <dd>
831
-
832
-
833
- <div class="description">
834
- Returns the number of milliseconds between now and a given date
835
- </div>
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
- <h5>Parameters:</h5>
845
-
846
-
847
- <table class="params table table-striped">
848
- <thead>
849
- <tr>
850
-
851
- <th>Name</th>
852
-
853
-
854
- <th>Type</th>
855
-
856
-
857
- <th>Argument</th>
858
-
859
-
860
-
861
-
862
- <th class="last">Description</th>
863
- </tr>
864
- </thead>
865
-
866
- <tbody>
867
-
868
-
869
- <tr>
870
-
871
- <td class="name"><code>d</code></td>
872
-
873
-
874
- <td class="type">
875
-
876
-
877
- <span class="param-type">string</span>
878
-
879
-
880
-
881
-
882
- </td>
883
-
884
-
885
- <td class="attributes">
886
-
887
-
888
-
889
-
890
-
891
- </td>
892
-
893
-
894
-
895
-
896
- <td class="description last">The date from which the current time will be subtracted</td>
897
- </tr>
898
-
899
-
900
-
901
- <tr>
902
-
903
- <td class="name"><code>now</code></td>
904
-
905
-
906
- <td class="type">
907
-
908
-
909
- <span class="param-type">function</span>
910
-
911
-
912
-
913
-
914
- </td>
915
-
916
-
917
- <td class="attributes">
918
-
919
- &lt;optional><br>
920
-
921
-
922
-
923
-
924
-
925
- </td>
926
-
927
-
928
-
929
-
930
- <td class="description last">A function that returns the current UNIX time in milliseconds</td>
931
- </tr>
932
-
933
-
934
- </tbody>
935
- </table>
936
-
937
-
938
-
939
-
940
- <dl class="details">
941
-
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
971
- <dd class="tag-source">
972
- <ul class="dummy">
973
- <li>
974
- <a href="utilities_index.js.html">utilities/index.js</a>,
975
- <a href="utilities_index.js.html#sunlight-1-line-58">line 58</a>
976
- </li>
977
- </ul>
978
- </dd>
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
- </dl>
987
-
988
-
989
-
990
-
991
-
992
-
993
-
994
-
995
-
996
-
997
-
998
-
999
-
1000
- <h5>Returns:</h5>
1001
-
1002
-
1003
-
1004
-
1005
- <dl>
1006
- <dt>
1007
- Type
1008
- </dt>
1009
- <dd>
1010
-
1011
- <span class="param-type">number</span>
1012
-
1013
-
1014
-
1015
- </dd>
1016
- </dl>
1017
-
1018
-
1019
-
1020
-
1021
-
1022
- </dd>
1023
-
1024
-
1025
-
1026
- <hr>
1027
- <dt>
1028
- <h4 class="name" id="groupBy"><span class="type-signature"></span>groupBy(array, field)</h4>
1029
-
1030
-
1031
- </dt>
1032
- <dd>
1033
-
1034
-
1035
- <div class="description">
1036
- Group an array by a field value
1037
- </div>
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
- <h5>Parameters:</h5>
1047
-
1048
-
1049
- <table class="params table table-striped">
1050
- <thead>
1051
- <tr>
1052
-
1053
- <th>Name</th>
1054
-
1055
-
1056
- <th>Type</th>
1057
-
1058
-
1059
-
1060
-
1061
-
1062
- <th class="last">Description</th>
1063
- </tr>
1064
- </thead>
1065
-
1066
- <tbody>
1067
-
1068
-
1069
- <tr>
1070
-
1071
- <td class="name"><code>array</code></td>
1072
-
1073
-
1074
- <td class="type">
1075
-
1076
-
1077
- <span class="param-type">Array.&lt;Object></span>
1078
-
1079
-
1080
-
1081
-
1082
- </td>
1083
-
1084
-
1085
-
1086
-
1087
-
1088
- <td class="description last">array of objects to broup</td>
1089
- </tr>
1090
-
1091
-
1092
-
1093
- <tr>
1094
-
1095
- <td class="name"><code>field</code></td>
1096
-
1097
-
1098
- <td class="type">
1099
-
1100
-
1101
- <span class="param-type">string</span>
1102
-
1103
-
1104
-
1105
-
1106
- </td>
1107
-
1108
-
1109
-
1110
-
1111
-
1112
- <td class="description last">field to group by</td>
1113
- </tr>
1114
-
1115
-
1116
- </tbody>
1117
- </table>
1118
-
1119
-
1120
-
1121
-
1122
- <dl class="details">
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
-
1141
-
1142
-
1143
-
1144
-
1145
-
1146
-
1147
-
1148
-
1149
-
1150
-
1151
-
1152
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1153
- <dd class="tag-source">
1154
- <ul class="dummy">
1155
- <li>
1156
- <a href="utilities_index.js.html">utilities/index.js</a>,
1157
- <a href="utilities_index.js.html#sunlight-1-line-29">line 29</a>
1158
- </li>
1159
- </ul>
1160
- </dd>
1161
-
1162
-
1163
-
1164
-
1165
-
1166
-
1167
-
1168
- </dl>
1169
-
1170
-
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
-
1181
-
1182
- <h5>Returns:</h5>
1183
-
1184
-
1185
- <div class="param-desc">
1186
- [description]
1187
- </div>
1188
-
1189
-
1190
-
1191
- <dl>
1192
- <dt>
1193
- Type
1194
- </dt>
1195
- <dd>
1196
-
1197
- <span class="param-type">Object</span>
1198
-
1199
-
1200
-
1201
- </dd>
1202
- </dl>
1203
-
1204
-
1205
-
1206
-
1207
-
1208
- </dd>
1209
-
1210
-
1211
-
1212
- <hr>
1213
- <dt>
1214
- <h4 class="name" id="initCycleStart"><span class="type-signature"></span>initCycleStart(deps)</h4>
1215
-
1216
-
1217
- </dt>
1218
- <dd>
1219
-
1220
-
1221
- <div class="description">
1222
- Set up current cycle start if it's not been intiated
1223
- </div>
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
- <h5>Parameters:</h5>
1233
-
1234
-
1235
- <table class="params table table-striped">
1236
- <thead>
1237
- <tr>
1238
-
1239
- <th>Name</th>
1240
-
1241
-
1242
- <th>Type</th>
1243
-
1244
-
1245
-
1246
-
1247
-
1248
- <th class="last">Description</th>
1249
- </tr>
1250
- </thead>
1251
-
1252
- <tbody>
1253
-
1254
-
1255
- <tr>
1256
-
1257
- <td class="name"><code>deps</code></td>
1258
-
1259
-
1260
- <td class="type">
1261
-
1262
-
1263
- <span class="param-type">Object</span>
1264
-
1265
-
1266
-
1267
-
1268
- </td>
1269
-
1270
-
1271
-
1272
-
1273
-
1274
- <td class="description last">dependencies for processing</td>
1275
- </tr>
1276
-
1277
-
1278
- </tbody>
1279
- </table>
1280
-
1281
-
1282
-
1283
-
1284
- <dl class="details">
1285
-
1286
-
1287
-
1288
-
1289
-
1290
-
1291
-
1292
-
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
-
1300
-
1301
-
1302
-
1303
-
1304
-
1305
-
1306
-
1307
-
1308
-
1309
-
1310
-
1311
-
1312
-
1313
-
1314
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1315
- <dd class="tag-source">
1316
- <ul class="dummy">
1317
- <li>
1318
- <a href="handlers_Worldstate.js.html">handlers/Worldstate.js</a>,
1319
- <a href="handlers_Worldstate.js.html#sunlight-1-line-111">line 111</a>
1320
- </li>
1321
- </ul>
1322
- </dd>
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
- </dl>
1331
-
1332
-
1333
-
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
-
1345
-
1346
- </dd>
1347
-
1348
-
1349
-
1350
- <hr>
1351
- <dt>
1352
- <h4 class="name" id="kuvaProcessing"><span class="type-signature"></span>kuvaProcessing(deps, packets)</h4>
1353
-
1354
-
1355
- </dt>
1356
- <dd>
1357
-
1358
-
1359
- <div class="description">
1360
- Process kuva fields
1361
- </div>
1362
-
1363
-
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-
1370
- <h5>Parameters:</h5>
1371
-
1372
-
1373
- <table class="params table table-striped">
1374
- <thead>
1375
- <tr>
1376
-
1377
- <th>Name</th>
1378
-
1379
-
1380
- <th>Type</th>
1381
-
1382
-
1383
-
1384
-
1385
-
1386
- <th class="last">Description</th>
1387
- </tr>
1388
- </thead>
1389
-
1390
- <tbody>
1391
-
1392
-
1393
- <tr>
1394
-
1395
- <td class="name"><code>deps</code></td>
1396
-
1397
-
1398
- <td class="type">
1399
-
1400
-
1401
- <span class="param-type">Object</span>
1402
-
1403
-
1404
-
1405
-
1406
- </td>
1407
-
1408
-
1409
-
1410
-
1411
-
1412
- <td class="description last">dependencies for processing</td>
1413
- </tr>
1414
-
1415
-
1416
-
1417
- <tr>
1418
-
1419
- <td class="name"><code>packets</code></td>
1420
-
1421
-
1422
- <td class="type">
1423
-
1424
-
1425
- <span class="param-type">Array.&lt;Object></span>
1426
-
1427
-
1428
-
1429
-
1430
- </td>
1431
-
1432
-
1433
-
1434
-
1435
-
1436
- <td class="description last">packets to emit</td>
1437
- </tr>
1438
-
1439
-
1440
- </tbody>
1441
- </table>
1442
-
1443
-
1444
-
1445
-
1446
- <dl class="details">
1447
-
1448
-
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
-
1456
-
1457
-
1458
-
1459
-
1460
-
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
-
1476
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1477
- <dd class="tag-source">
1478
- <ul class="dummy">
1479
- <li>
1480
- <a href="handlers_Worldstate.js.html">handlers/Worldstate.js</a>,
1481
- <a href="handlers_Worldstate.js.html#sunlight-1-line-68">line 68</a>
1482
- </li>
1483
- </ul>
1484
- </dd>
1485
-
1486
-
1487
-
1488
-
1489
-
1490
-
1491
-
1492
- </dl>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
-
1505
-
1506
- <h5>Returns:</h5>
1507
-
1508
-
1509
- <div class="param-desc">
1510
- object(s) to emit from kuva stuff
1511
- </div>
1512
-
1513
-
1514
-
1515
- <dl>
1516
- <dt>
1517
- Type
1518
- </dt>
1519
- <dd>
1520
-
1521
- <span class="param-type">Object</span>
1522
- |
1523
-
1524
- <span class="param-type">Array.&lt;Object></span>
1525
-
1526
-
1527
-
1528
- </dd>
1529
- </dl>
1530
-
1531
-
1532
-
1533
-
1534
-
1535
- </dd>
1536
-
1537
-
1538
-
1539
- <hr>
1540
- <dt>
1541
- <h4 class="name" id="parseNew"><span class="type-signature"></span>parseNew(deps)</h4>
1542
-
1543
-
1544
- </dt>
1545
- <dd>
1546
-
1547
-
1548
- <div class="description">
1549
- Parse new events from the provided worldstate
1550
- </div>
1551
-
1552
-
1553
-
1554
-
1555
-
1556
-
1557
-
1558
-
1559
- <h5>Parameters:</h5>
1560
-
1561
-
1562
- <table class="params table table-striped">
1563
- <thead>
1564
- <tr>
1565
-
1566
- <th>Name</th>
1567
-
1568
-
1569
- <th>Type</th>
1570
-
1571
-
1572
-
1573
-
1574
-
1575
- <th class="last">Description</th>
1576
- </tr>
1577
- </thead>
1578
-
1579
- <tbody>
1580
-
1581
-
1582
- <tr>
1583
-
1584
- <td class="name"><code>deps</code></td>
1585
-
1586
-
1587
- <td class="type">
1588
-
1589
-
1590
- <span class="param-type">Object</span>
1591
-
1592
-
1593
-
1594
-
1595
- </td>
1596
-
1597
-
1598
-
1599
-
1600
-
1601
- <td class="description last">dependencies to parse out events</td>
1602
- </tr>
1603
-
1604
-
1605
- </tbody>
1606
- </table>
1607
-
1608
-
1609
-
1610
-
1611
- <dl class="details">
1612
-
1613
-
1614
-
1615
-
1616
-
1617
-
1618
-
1619
-
1620
-
1621
-
1622
-
1623
-
1624
-
1625
-
1626
-
1627
-
1628
-
1629
-
1630
-
1631
-
1632
-
1633
-
1634
-
1635
-
1636
-
1637
-
1638
-
1639
-
1640
-
1641
- <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1642
- <dd class="tag-source">
1643
- <ul class="dummy">
1644
- <li>
1645
- <a href="handlers_Worldstate.js.html">handlers/Worldstate.js</a>,
1646
- <a href="handlers_Worldstate.js.html#sunlight-1-line-122">line 122</a>
1647
- </li>
1648
- </ul>
1649
- </dd>
1650
-
1651
-
1652
-
1653
-
1654
-
1655
-
1656
-
1657
- </dl>
1658
-
1659
-
1660
-
1661
-
1662
-
1663
-
1664
-
1665
-
1666
-
1667
-
1668
-
1669
-
1670
-
1671
- <h5>Returns:</h5>
1672
-
1673
-
1674
- <div class="param-desc">
1675
- packet(s) to emit
1676
- </div>
1677
-
1678
-
1679
-
1680
- <dl>
1681
- <dt>
1682
- Type
1683
- </dt>
1684
- <dd>
1685
-
1686
- <span class="param-type">Packet</span>
1687
- |
1688
-
1689
- <span class="param-type">Array.&lt;Packet></span>
1690
-
1691
-
1692
-
1693
- </dd>
1694
- </dl>
1695
-
1696
-
1697
-
1698
-
1699
-
1700
- </dd>
1701
-
1702
- </dl>
1703
-
1704
-
1705
-
1706
-
1707
-
1708
- </article>
1709
-
1710
- </section>
1711
-
1712
-
1713
-
1714
-
1715
- </div>
1716
- </div>
1717
-
1718
- <div class="clearfix"></div>
1719
-
1720
-
1721
- <div class="col-md-3">
1722
- <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
1723
- </div>
1724
-
1725
-
1726
- </div>
1727
- </div>
1728
-
1729
-
1730
- <div class="modal fade" id="searchResults">
1731
- <div class="modal-dialog">
1732
- <div class="modal-content">
1733
- <div class="modal-header">
1734
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
1735
- <h4 class="modal-title">Search results</h4>
1736
- </div>
1737
- <div class="modal-body"></div>
1738
- <div class="modal-footer">
1739
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
1740
- </div>
1741
- </div><!-- /.modal-content -->
1742
- </div><!-- /.modal-dialog -->
1743
- </div>
1744
-
1745
-
1746
- <footer>
1747
-
1748
-
1749
- <span class="copyright">
1750
- ©2020, WFCD
1751
- </span>
1752
-
1753
- <span class="jsdoc-message">
1754
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a>
1755
-
1756
- on Monday, August 10th 2020, 15:25:12
1757
-
1758
- using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1759
- </span>
1760
- </footer>
1761
-
1762
- <script src="scripts/docstrap.lib.js"></script>
1763
- <script src="scripts/toc.js"></script>
1764
-
1765
- <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
1766
-
1767
-
1768
- <script>
1769
- $( function () {
1770
- $( "[id*='$']" ).each( function () {
1771
- var $this = $( this );
1772
-
1773
- $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
1774
- } );
1775
-
1776
- $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
1777
- var $this = $( this );
1778
-
1779
- var example = $this.find( "code" );
1780
- exampleText = example.html();
1781
- var lang = /{@lang (.*?)}/.exec( exampleText );
1782
- if ( lang && lang[1] ) {
1783
- exampleText = exampleText.replace( lang[0], "" );
1784
- example.html( exampleText );
1785
- lang = lang[1];
1786
- } else {
1787
- var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
1788
- lang = langClassMatch ? langClassMatch[1] : "javascript";
1789
- }
1790
-
1791
- if ( lang ) {
1792
-
1793
- $this
1794
- .addClass( "sunlight-highlight-" + lang )
1795
- .addClass( "linenums" )
1796
- .html( example.html() );
1797
-
1798
- }
1799
- } );
1800
-
1801
- Sunlight.highlightAll( {
1802
- lineNumbers : true,
1803
- showMenu : true,
1804
- enableDoclinks : true
1805
- } );
1806
-
1807
- $.catchAnchorLinks( {
1808
- navbarOffset: 10
1809
- } );
1810
- $( "#toc" ).toc( {
1811
- anchorName : function ( i, heading, prefix ) {
1812
- return $( heading ).attr( "id" ) || ( prefix + i );
1813
- },
1814
- selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
1815
- showAndHide : false,
1816
- smoothScrolling: true
1817
- } );
1818
-
1819
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
1820
- $( '.dropdown-toggle' ).dropdown();
1821
-
1822
- $( "table" ).each( function () {
1823
- var $this = $( this );
1824
- $this.addClass('table');
1825
- } );
1826
-
1827
- } );
1828
- </script>
1829
-
1830
-
1831
-
1832
- <!--Navigation and Symbol Display-->
1833
-
1834
- <script>
1835
- $( function () {
1836
- $( '#main' ).localScroll( {
1837
- offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
1838
- } );
1839
- $( "dt.name" ).each( function () {
1840
- var $this = $( this ).find("h4");
1841
- var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
1842
- var dt = $(this);
1843
- var children = dt.next( "dd" );
1844
-
1845
- dt.prepend( icon ).css( {cursor : "pointer"} );
1846
- dt.addClass( "member-collapsed" ).addClass( "member" );
1847
-
1848
-
1849
- children.hide();
1850
-
1851
- dt.children().on( "click", function () {
1852
- children = dt.next( "dd" );
1853
- children.slideToggle( "fast", function () {
1854
-
1855
- if ( children.is( ":visible" ) ) {
1856
- icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
1857
- dt.addClass( "member-open" ).animate( "member-collapsed" );
1858
- } else {
1859
- icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
1860
- dt.addClass( "member-collapsed" ).removeClass( "member-open" );
1861
- }
1862
- } );
1863
- } );
1864
-
1865
- } );
1866
- } );
1867
- </script>
1868
-
1869
-
1870
- <!--Google Analytics-->
1871
-
1872
-
1873
-
1874
- <script type="text/javascript">
1875
- $(document).ready(function() {
1876
- SearcherDisplay.init();
1877
- });
1878
- </script>
1879
-
1880
-
1881
- </body>
1882
- </html>