-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathindex.html
2556 lines (1204 loc) · 76.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
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
732
733
734
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
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
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
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset='utf-8'>
<title>@piured/engine 0.0.2 | Documentation</title>
<meta name='description' content='A web-based Pump It Up engine'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
<link href='assets/style.css' rel='stylesheet'>
<link href='assets/github.css' rel='stylesheet'>
<link href='assets/split.css' rel='stylesheet'>
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>@piured/engine</h3>
<div class='mb1'><code>0.0.2</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
spellcheck='false'
autocapitalize='off'
autocorrect='off'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#piured-engine'
class="h5 bold black caps">
piured-engine
</a>
</li>
<li><a
href='#engine'
class=" toggle-sibling">
Engine
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#engineinit'
class='regular pre-open'>
#init
</a></li>
<li><a
href='#engineconfigurestage'
class='regular pre-open'>
#configureStage
</a></li>
<li><a
href='#engineaddplayer'
class='regular pre-open'>
#addPlayer
</a></li>
<li><a
href='#engineaddtodom'
class='regular pre-open'>
#addToDOM
</a></li>
<li><a
href='#engineupdateoffset'
class='regular pre-open'>
#updateOffset
</a></li>
<li><a
href='#enginetuneplaybackspeed'
class='regular pre-open'>
#tunePlayBackSpeed
</a></li>
<li><a
href='#enginekeydown'
class='regular pre-open'>
#keyDown
</a></li>
<li><a
href='#enginekeyup'
class='regular pre-open'>
#keyUp
</a></li>
<li><a
href='#enginetouchdown'
class='regular pre-open'>
#touchDown
</a></li>
<li><a
href='#enginetouchup'
class='regular pre-open'>
#touchUp
</a></li>
<li><a
href='#enginesetcameraposition'
class='regular pre-open'>
#setCameraPosition
</a></li>
<li><a
href='#enginequerystagetype'
class='regular pre-open'>
#queryStageType
</a></li>
<li><a
href='#enginestart'
class='regular pre-open'>
#start
</a></li>
<li><a
href='#enginestartplayback'
class='regular pre-open'>
#startPlayBack
</a></li>
<li><a
href='#enginestop'
class='regular pre-open'>
#stop
</a></li>
<li><a
href='#engineresize'
class='regular pre-open'>
#resize
</a></li>
<li><a
href='#enginelogframe'
class='regular pre-open'>
#logFrame
</a></li>
<li><a
href='#engineonframelog'
class='regular pre-open'>
#onFrameLog
</a></li>
<li><a
href='#engineonstagecleared'
class='regular pre-open'>
#onStageCleared
</a></li>
</ul>
</div>
</li>
<li><a
href='#configuration-files'
class="h5 bold black caps">
Configuration Files
</a>
</li>
<li><a
href='#stageconfig'
class="">
StageConfig
</a>
</li>
<li><a
href='#playerconfig'
class="">
PlayerConfig
</a>
</li>
<li><a
href='#keyinputconfig'
class="">
KeyInputConfig
</a>
</li>
<li><a
href='#touchinputconfig'
class="">
TouchInputConfig
</a>
</li>
<li><a
href='#remoteinput'
class="">
RemoteInput
</a>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
<a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
</div>
</div>
</div>
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h2 id='piured-engine' class='mt0'>
piured-engine
</h2>
</section></div>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='engine'>
Engine
</h3>
</div>
<p>PIURED is a Pump It Up stage simulator that works directly in your browser.
There are already a number of dance simulators for Windows and Linux, most of them being StepMania-based.
Stepmania is a great choice for DDR-style rhythm games, however it lacks to capture the behaviour as well as
the feel & look of a Pump It Up arcade.</p>
<p>In this sense, PIURED's goal is to recreate as accurately as possible the Pump It Up-style experience
whilst keeping the engine cross-platform (web-based), so it can be enjoyed anywhere and anytime.</p>
<p>PIURED is written in its whole in Javascript using <a href="https://threejs.org/">ThreeJS</a>. The code is organized
trying to mimick the structure of any game engine. The source code can be found in <a href="https://github.com/piulin/piured-engine">this repo</a> under the folder <code>js</code>.</p>
<p>This engine features:</p>
<ol>
<li>A Stepmania SSC parser. Stepcharts can be directly read from bare Stepmania files. No need to convert them into another intermediate format. This means that all the songs that are available for Pump-style would work off-the-shelf in PIURED.</li>
<li>A loader that supports both MP3 and OGG audio formats. These are the most common formats used in Stepmania audio files.</li>
<li>Support for changes of BPM, SCROLL, STOPS, DELAYS as well as changes of SPEED (attributes used in Stepmania to create effects).</li>
<li>Pump-single, Pump-double and Pump-Halfdouble styles.</li>
<li>VS. mode, including two or more players playing any combination of Pump-single and Pump-double styles.</li>
<li>Remote input capabilities to create online-like battles.</li>
<li>On-the-fly tuning of the offset parameter.</li>
<li>Variable speed rates.</li>
<li>A number of Noteskins to choose from (sprite-based).</li>
<li>Game performance metrics.</li>
<li>Visual effects close to the original arcade.</li>
<li>A background theme which "FEELS THE BEAT".</li>
</ol>
<p>There are, however, some features available in Stepmania that PIURED does not support:</p>
<ol>
<li>The engine only supports a 4/4 bar.</li>
<li>BGA in any video format is not supported.</li>
<li>Dance pads or Joysticks are not supported as input methods.</li>
<li>Performance metrics may not be deterministic.</li>
<li>Only Pump-single, Pump-double and Pump-halfdouble styles are supported. Any other style may cause
the engine to crash.</li>
</ol>
<p>The <a href="#engine">Engine</a> class is the main abstraction for creating a pump it up stage and playing a chart. It contains all
methods necessary to create a new stage, add an indefinite number of local and remote players, load Stepmania SSC files,
and report players' performance.</p>
<p>This class is intended to be used only as javascript code on the client-side, as it will attempt to draw stuff on the browser.</p>
<div class='pre p1 fill-light mt0'>new Engine()</div>
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Importing the engine via ES6 modules</p>
</p>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">import</span> {<span class="hljs-title class_">PiuredEngine</span>, <span class="hljs-title class_">StageConfig</span>, <span class="hljs-title class_">PlayerConfig</span>, <span class="hljs-title class_">KeyInputConfig</span>} <span class="hljs-keyword">from</span> <span class="hljs-string">'@piured/engine'</span></pre>
<p><p>Full example to configure a working engine.</p>
</p>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">import</span> {<span class="hljs-title class_">PiuredEngine</span>, <span class="hljs-title class_">StageConfig</span>, <span class="hljs-title class_">PlayerConfig</span>, <span class="hljs-title class_">KeyInputConfig</span>} <span class="hljs-keyword">from</span> <span class="hljs-string">'@piured/engine'</span>
<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span> <span class="hljs-title function_">setUpEngine</span> (dom) {
<span class="hljs-keyword">let</span> engine = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Engine</span>()
<span class="hljs-keyword">function</span> <span class="hljs-title function_">stageCleared</span>(<span class="hljs-params">performance</span>) {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(performance);
engine = <span class="hljs-literal">null</span>;
}
<span class="hljs-keyword">function</span> <span class="hljs-title function_">onKeyDown</span>(<span class="hljs-params">event</span>) {
engine.<span class="hljs-title function_">keyDown</span>(event);
}
<span class="hljs-keyword">function</span> <span class="hljs-title function_">onKeyUp</span>(<span class="hljs-params">event</span>) {
engine.<span class="hljs-title function_">keyUp</span>(event);
}
<span class="hljs-keyword">let</span> speed = <span class="hljs-number">4.0</span>;
<span class="hljs-keyword">let</span> playback = <span class="hljs-number">1.0</span>;
<span class="hljs-keyword">let</span> offset = <span class="hljs-number">0.0</span>;
<span class="hljs-keyword">let</span> noteskin = <span class="hljs-string">'NX'</span>;
<span class="hljs-keyword">let</span> touchpadSize = <span class="hljs-number">1.0</span>;
<span class="hljs-keyword">let</span> leftKeyMap = {
<span class="hljs-attr">dl</span>: <span class="hljs-string">'Z'</span>,
<span class="hljs-attr">ul</span>: <span class="hljs-string">'Q'</span>,
<span class="hljs-attr">c</span>: <span class="hljs-string">'S'</span>,
<span class="hljs-attr">ur</span>: <span class="hljs-string">'E'</span>,
<span class="hljs-attr">dr</span>: <span class="hljs-string">'C'</span>
}
<span class="hljs-keyword">let</span> rightKeyMap = {
<span class="hljs-attr">dl</span>: <span class="hljs-string">'V'</span>,
<span class="hljs-attr">ul</span>: <span class="hljs-string">'R'</span>,
<span class="hljs-attr">c</span>: <span class="hljs-string">'G'</span>,
<span class="hljs-attr">ur</span>: <span class="hljs-string">'Y'</span>,
<span class="hljs-attr">dr</span>: <span class="hljs-string">'N'</span>
}
<span class="hljs-keyword">let</span> chartLevel = <span class="hljs-number">0</span>;
<span class="hljs-keyword">let</span> innerWidth = <span class="hljs-number">800</span>
<span class="hljs-keyword">let</span> innerHeight = <span class="hljs-number">800</span>
<span class="hljs-keyword">let</span> pixelRatio = <span class="hljs-variable language_">window</span>.<span class="hljs-property">devicePixelRatio</span>
engine.<span class="hljs-title function_">init</span>(innerWidth, innerHeight, pixelRatio, <span class="hljs-variable language_">window</span>)
<span class="hljs-keyword">let</span> stageConfig = <span class="hljs-keyword">new</span> <span class="hljs-title class_">StageConfig</span>(<span class="hljs-string">'<mp3-url>'</span>,
<span class="hljs-string">'<ssc-url>'</span>,
playback,
offset,
[noteskin],
<span class="hljs-function">() =></span> {
<span class="hljs-keyword">let</span> dateToStart = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>();
<span class="hljs-comment">// delay of 2 secs</span>
dateToStart.<span class="hljs-title function_">setMilliseconds</span>(dateToStart.<span class="hljs-title function_">getMilliseconds</span>() + <span class="hljs-number">2000.0</span>);
engine.<span class="hljs-title function_">startPlayBack</span>(dateToStart, <span class="hljs-function">() =></span> {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>();
});
}
);
<span class="hljs-keyword">await</span> engine.<span class="hljs-title function_">configureStage</span>(stageConfig);
<span class="hljs-keyword">let</span> p1InputConfig;
<span class="hljs-keyword">let</span> accuracyMargin = <span class="hljs-number">0.15</span>;
accuracyMargin = <span class="hljs-number">0.25</span>;
<span class="hljs-variable language_">window</span>.<span class="hljs-property">onkeydown</span> = onKeyDown;
<span class="hljs-variable language_">window</span>.<span class="hljs-property">onkeyup</span> = onKeyUp;
p1InputConfig = <span class="hljs-keyword">new</span> <span class="hljs-title class_">KeyInputConfig</span>(leftKeyMap, rightKeyMap);
<span class="hljs-keyword">let</span> p1Config = <span class="hljs-keyword">new</span> <span class="hljs-title class_">PlayerConfig</span>(p1InputConfig,
noteskin,
chartLevel,
speed,
accuracyMargin);
engine.<span class="hljs-title function_">addPlayer</span>(p1Config);
engine.<span class="hljs-title function_">addToDOM</span>(dom);
<span class="hljs-variable language_">window</span>.<span class="hljs-title function_">addEventListener</span>( <span class="hljs-string">'resize'</span>, engine.<span class="hljs-property">onWindowResize</span>.<span class="hljs-title function_">bind</span>(engine), <span class="hljs-literal">false</span> );
engine.<span class="hljs-property">onStageCleared</span> = stageCleared;
engine.<span class="hljs-title function_">start</span>();
}
<span class="hljs-keyword">await</span> <span class="hljs-title function_">setUpEngine</span>(<span class="hljs-string">'<container>'</span>)</pre>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='engineinit'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>init(width, height, pixelRatio, window)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Configures the renderer and sets the camera into position. Call this method before setting up the stage through <a href="#engineconfigurestage">Engine#configureStage</a>.</p>
<div class='pre p1 fill-light mt0'>init(width: any, height: any, pixelRatio: any, window: any)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>width</span> <code class='quiet'>(any)</code>
width of canvas
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>height</span> <code class='quiet'>(any)</code>
height of canvas
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>pixelRatio</span> <code class='quiet'>(any)</code>
pixel ratio of screen
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>window</span> <code class='quiet'>(any)</code>
window object from browser, to respond to frames requests
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Initializing a new engine.</p>
</p>
<pre class='p1 overflow-auto round fill-light'>engine.<span class="hljs-title function_">init</span>( <span class="hljs-number">1270</span>, <span class="hljs-number">768</span>, <span class="hljs-variable language_">window</span>.<span class="hljs-property">devicePixelRatio</span>, <span class="hljs-variable language_">window</span> )</pre>
</section>
</div>
</div>
<div class='border-bottom' id='engineconfigurestage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>configureStage(stageConfig)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Constructs the stage where one or more players will dance. In a nutshell, the stage sets up the environment needed
to play a specific tune associated with its Stepmania step definition file (i.e., mp3+SSC).
This method must be called before adding new players to the stage through <a href="#engineaddplayer">Engine#addPlayer</a>.</p>
<div class='pre p1 fill-light mt0'>configureStage(stageConfig: <a href="#stageconfig">StageConfig</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>stageConfig</span> <code class='quiet'>(<a href="#stageconfig">StageConfig</a>)</code>
stage configuration
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Configuring a new stage. Details of the <a href="#stageconfig">StageConfig</a> object are omitted.</p>
</p>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">let</span> stageConfig = <span class="hljs-keyword">new</span> <span class="hljs-title class_">StageConfig</span>( ... ) ;
engine.<span class="hljs-title function_">configureStage</span>(stageConfig) ;</pre>
</section>
</div>
</div>
<div class='border-bottom' id='engineaddplayer'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>addPlayer(playerConfig)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Adds a new player to the dance stage. This method must be called after configuring the stage through <a href="#engineconfigurestage">Engine#configureStage</a>.
There is no upper limit for the number of players that can join, but for some number the camera position must be updated to show the whole stage.
Players could play locally by using traditional input methods (e.g., Keyboard, Touch) or remotely (via logging <a href="FrameLog">FrameLog</a>s).</p>
<div class='pre p1 fill-light mt0'>addPlayer(playerConfig: <a href="#playerconfig">PlayerConfig</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>playerConfig</span> <code class='quiet'>(<a href="#playerconfig">PlayerConfig</a>)</code>
player configuration
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>:
player identifier
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Adding a new player to the stage. Details of the <a href="#playerconfig">PlayerConfig</a> object are omitted.</p>
</p>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">let</span> p1Config = <span class="hljs-keyword">new</span> <span class="hljs-title class_">PlayerConfig</span>( ... ) ;
<span class="hljs-keyword">let</span> p1Id = engine.<span class="hljs-title function_">addPlayer</span>(p1Config) ;</pre>
</section>
</div>
</div>
<div class='border-bottom' id='engineaddtodom'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>addToDOM(containerId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Appends the renderer's DOM element to a container with id <code>containerId</code> present in your HTML document.
You need to call this function so that the engine has a canvas to draw on.</p>
<div class='pre p1 fill-light mt0'>addToDOM(containerId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>containerId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
container id in the HTML document
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Granted we have defined in a HTML document the following container <code><div id="container"></div></code>, we add the engine to the DOM</p>
</p>
<pre class='p1 overflow-auto round fill-light'>engine.<span class="hljs-title function_">addToDOM</span>(<span class="hljs-string">'container'</span>) ;</pre>
</section>
</div>
</div>
<div class='border-bottom' id='engineupdateoffset'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>updateOffset(playerId, newOffsetOffset)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Updates the player's stage <code>playerId</code> offset. This function can be used to sync off-beat steps on-the-fly when the
engine is running.</p>
<div class='pre p1 fill-light mt0'>updateOffset(playerId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, newOffsetOffset: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>playerId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
player identifier
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>newOffsetOffset</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
new offset to be applied in seconds.
<code>newOffsetOffset</code>
must be a floating point number
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Updating the offset by 0.01 seconds for player with id <code>p1Id := 0</code>.</p>
</p>
<pre class='p1 overflow-auto round fill-light'>engine.<span class="hljs-title function_">updateOffset</span>(p1Id, <span class="hljs-number">0.01</span>) ;</pre>
</section>
</div>
</div>
<div class='border-bottom' id='enginetuneplaybackspeed'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>tunePlayBackSpeed(playBackSpeed)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Updates the stage's audio playback rate (i.e., increases or decreases the audio & step speed). This function might be called
while the engine is running. This function won't have any effect if there are remote players logged in the engine.</p>
<div class='pre p1 fill-light mt0'>tunePlayBackSpeed(playBackSpeed: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>playBackSpeed</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
new playback speed to be applied in percentage.
<code>playBackSpeed</code>
must be a floating point
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>Speeding up the playback rate to 110% (1.1x)</p>
</p>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-comment">// changes the playback speed to 110%</span>
engine.<span class="hljs-title function_">tunePlayBackSpeed</span>(<span class="hljs-number">1.1</span>) ;
<span class="hljs-comment">// Essentially stops the playback</span>
engine.<span class="hljs-title function_">tunePlayBackSpeed</span>(<span class="hljs-number">0.0</span>) ;</pre>
</section>
</div>
</div>
<div class='border-bottom' id='enginekeydown'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>keyDown(event)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Logs a key down event from the browser into the engine. Keyboard events must be logged if any player is using <a href="#keyinputconfig">KeyInputConfig</a>
(i.e. keyboard) as input method.</p>
<div class='pre p1 fill-light mt0'>keyDown(event: <a href="https://developer.mozilla.org/docs/Web/API/KeyboardEvent">KeyboardEvent</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>event</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/API/KeyboardEvent">KeyboardEvent</a>)</code>
keyboard event
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>: