forked from OpenTaiko/OpTk-Documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
778 lines (750 loc) · 41 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
<!DOCTYPE html>
<head>
<script>
function toggleTheme(use_dark) {
localStorage.setItem("darkmode", use_dark)
initTheme()
}
function initTheme() {
let css = document.getElementById("dark_mode")
if (localStorage.getItem("darkmode") === 'true') {
css.href = "./src/style_dark.css"
}
else {
css.href = ""
}
}
</script>
<title>OpenTaiko Documentation</title>
<link href="./src/style.css" rel="stylesheet">
<link href="./src/style_dark.css" rel="stylesheet" id="dark_mode" onload="initTheme()">
<link rel="icon" type="image/x-icon" href="favicon.ico">
</head>
<body>
<header>
<h1><open>Open</open><taiko>Taiko</taiko> Documentation</h1>
<h2>Written for Version 0.6.0.0</h2>
<b>English (United States)</b>
| <a href="en-uk/index.html">English (United Kingdom)</a>
| <a href="fr/index.html">français</a>
| <a href="ja/index.html">日本語</a>
| <a href="ru/index.html">русский</a>
| <a href="zh/index.html">中文(中国内地)</a>
</header>
<nav>
<button onclick="toggleTheme('false')">Light Mode</button>
<button onclick="toggleTheme('true')">Dark Mode</button>
<h2>Navigation</h2>
<a href="#intro" class="h1">Introduction</a>
<a href="#general" class="h1">General</a>
<a href="#gameplay" class="h1">Gameplay</a>
<a href="#charting" class="h1">Charting</a>
<a href="#note-types" class="h2">Note Types</a>
<a href="#taiko-notes" class="h3">Taiko Notes</a>
<a href="#konga-notes" class="h3">Konga Notes</a>
<a href="#miscellaneous-notes" class="h3">Miscellaneous Notes</a>
<a href="#skinning" class="h1">Skinning & Customization</a>
<a href="#lua-scripting" class="h2">Lua Scripting</a>
<a href="#calling-functions" class="h3">Calling Functions</a>
<a href="#receiving-functions" class="h3">Receiving Functions</a>
<a href="#variables" class="h3">Variables</a>
<a href="#faq" class="h1">Frequently Asked Questions</a>
</nav>
<content>
<h1 id="intro">Introduction</h1>
<p>Welcome to the OpenTaiko documentation page! Everything you see here is a work in progress, as we are still documenting the massive amount of info related to this game.</p>
<h1 id="general">General</h1>
<p>-</p>
<h1 id="gameplay">Gameplay</h1>
<p>-</p>
<h1 id="charting">Charting</h1>
<p>OpenTaiko uses the TJA format for charting songs. They can be opened with any text editor, or with a visual editor such as PeepoDrumKit. Below is a list of note types used.</p>
<h2 id="note-types">Note Types</h2>
<p>There are many notes supported by OpenTaiko. Some are commonly used in every chart, while others appear less often. Some may also be exclusive to other modes, or have different behaviors.</p>
<h3 id="taiko-notes">Taiko Notes</h3>
<p>Listed here are common note types used in Taiko mode.</p>
<table>
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>Empty</td>
<td>
<p>Empty space</p>
<p>Essential in spacing apart notes, as well as assisting in creating complex patterns.</p>
</td>
</tr>
<tr>
<td>1</td>
<td>Don</td>
<td>Red note</td>
</tr>
<tr>
<td>2</td>
<td>Ka</td>
<td>Blue note</td>
</tr>
<tr>
<td>3</td>
<td>Don (Large)</td>
<td>Large red note</td>
</tr>
<tr>
<td>4</td>
<td>Ka (Large)</td>
<td>Large blue note</td>
</tr>
<tr>
<td>5</td>
<td>Start of Drumroll</td>
<td>
<p>Drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
</td>
</tr>
<tr>
<td>6</td>
<td>Start of Drumroll (Large)</td>
<td>
<p>Large drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
</td>
</tr>
<tr>
<td>7</td>
<td>Start of Balloon</td>
<td>
<p>Balloon</p>
<p>Marks the beginning of a balloon. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Similar to the drumroll, but must be hit a certain amount within a time limit to be cleared. Balloon value is specified by the BALLOON tag.</p>
</td>
</tr>
<tr>
<td>8</td>
<td>End of long note</td>
<td>Marks the end of any long note.</td>
</tr>
<tr>
<td>9</td>
<td>Start of Kusudama</td>
<td>
<p>Large balloon</p>
<p>Marks the beginning of a kusudama. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Similar to the drumroll, but must be hit a certain amount within a time limit to be cleared. Kusudama value is specified by the BALLOON tag.</p>
</td>
</tr>
<tr>
<td>A</td>
<td>Don (Large - Both)</td>
<td>
<p>Large red note</p>
<p>Displays connected hands when playing a chart in multiplayer & the note appear aligned together.</p>
</td>
</tr>
<tr>
<td>B</td>
<td>Ka (Large - Both)</td>
<td>
<p>Large blue note</p>
<p>Displays connected hands when playing a chart in multiplayer & the note appear aligned together.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="konga-notes">Konga Notes</h3>
<p>Listed here are common note types used in Konga mode.</p>
<p>Many of them are already used in Taiko mode, but a few are exclusively used in this gamemode.</p>
<table>
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>Empty</td>
<td>
<p>Empty space</p>
<p>Essential in spacing apart notes, as well as assisting in creating complex patterns.</p>
</td>
</tr>
<tr>
<td>1</td>
<td>Right</td>
<td>Right note</td>
</tr>
<tr>
<td>2</td>
<td>Left</td>
<td>Left note</td>
</tr>
<tr>
<td>3</td>
<td>Double</td>
<td>Double note</td>
</tr>
<tr>
<td>4</td>
<td>Clap</td>
<td>Clap note</td>
</tr>
<tr>
<td>5</td>
<td>Start of Right Drumroll</td>
<td>
<p>Right drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
</td>
</tr>
<tr>
<td>6</td>
<td>Start of Double Drumroll</td>
<td>
<p>Double drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
</td>
</tr>
<tr>
<td>7</td>
<td>Start of Balloon</td>
<td>
<p>Balloon</p>
<p>Marks the beginning of a balloon. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Similar to the drumroll, but must be hit a certain amount within a time limit to be cleared. Balloon value is specified by the BALLOON tag.</p>
</td>
</tr>
<tr>
<td>8</td>
<td>End of long note</td>
<td>Marks the end of any long note.</td>
</tr>
<tr>
<td>9</td>
<td>Start of Kusudama</td>
<td>
<p>Large balloon</p>
<p>Marks the beginning of a kusudama. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Similar to the drumroll, but must be hit a certain amount within a time limit to be cleared. Kusudama value is specified by the BALLOON tag.</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Konga Only Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>I</td>
<td>Start of Left Drumroll</td>
<td>
<p>Left drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Becomes a small drumroll in Taiko Mode.</p>
</td>
</tr>
<tr>
<td>H</td>
<td>Start of Clap Drumroll</td>
<td>
<p>Clap drumroll</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Becomes a large drumroll in Taiko Mode.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="miscellaneous-notes">Miscellaneous Notes</h3>
<p>Listed here are miscellaneous notes used in all modes.</p>
<p>These note types are not regularly used in normal charts. You'll typically only find them in gimmick charts.</p>
<table>
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>C</td>
<td>Bomb</td>
<td>
<p>Bomb note</p>
<p>A note that players should actively avoid hitting. Breaks combo and drastically drops gauge if hit.</p>
</td>
</tr>
<tr>
<td>F</td>
<td>Adlib</td>
<td>
<p>Invisible note</p>
<p>Appears invisible by default, and is not required to be hit. If hit, a special hitsound plays.</p>
</td>
</tr>
<tr>
<td>G</td>
<td>Kadon</td>
<td>
<p>Purple note</p>
<p>Requires the player to hit both don & ka. In Konga Mode, this appear as a Double note.</p>
</td>
</tr>
<tr>
<td>D</td>
<td>Start of Fuse Roll</td>
<td>
<p>Bomb balloon</p>
<p>Marks the beginning of a drumroll. Use 0 to increase the length of the drumroll, and 8 to end the drumroll.</p>
<p>Behaves similarly to Balloon, but must be broken in time. If the user fails, it will behave like a Bomb note, breaking combo and damaging their current gauge.</p>
</td>
</tr>
</tbody>
</table>
<h1 id="skinning">Skinning & Customization</h1>
<p>In addition to OpenTaiko's default skins, users are able to create their own skins.</p>
<h2 id="lua-scripting">Lua Scripting</h2>
<p>OpenTaiko's Lua API allows creators to further customize their skin beyond just replacing textures and sounds, allowing for more dynamic visuals without the need to modify the game's source code. While most menus can have Lua scripts, most scripts are only suited for animating backgrounds at this time. The capabilities of the Lua API are still a work in progress, and will expand in the future.</p>
<p>Read-only variables are also provided by OpenTaiko, allowing the creator to change the behavior of their script based on what is happening at that moment.</p>
<p>Some examples of what can be done with Lua include :</p>
<ul>
<li>Being able to read the BPM, gauge percentage, go-go state, and clear status of each active player, and change how visuals are animated using these values.</li>
<li>Checking what language the user is currently using, allowing for localization support for skins.</li>
<li>Changing the visuals of a background depending on their Tower progress or AI battle state.</li>
</ul>
<h3 id="calling-functions">Calling Functions</h3>
<p>Calling Functions are commands that you send to OpenTaiko to execute a function.</p>
<p>Most of these functions are related to drawing and manipulating textures that your script imports, and does not modify the game itself.</p>
<table>
<thead>
<tr>
<th>Function</th>
<th>Input Type(s)</th>
<th>Description</th>
</tr>
</thead>
<thead>
<tr>
<th class="sub" colspan="3">Console Drawing</th>
</tr>
</thead>
<tbody>
<tr>
<td>func:DrawText(x, y, text);</td>
<td>number, number, string</td>
<td>Draws text using the skin's Console Font. (/Graphics/Console_Font.png)</td>
</tr>
<tr>
<td>func:DrawNum(x, y, num);</td>
<td>number, number, number</td>
<td>Draws a number using the skin's Console Font. (/Graphics/Console_Font.png)</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Image Drawing</th>
</tr>
</thead>
<tbody>
<tr>
<td>func:AddGraph(filepath);</td>
<td>string</td>
<td>Load an image file to be used for your script. This is mandatory for drawing functions to work on your image.</td>
</tr>
<tr>
<td>func:DrawGraph(x, y, filepath);</td>
<td>number, number, string</td>
<td>Draw a given image at a position.</td>
</tr>
<tr>
<td>func:DrawGraphCenter(x, y, filepath);</td>
<td>number, number, string</td>
<td>Draw a given image at a position, centered at the given coordinates.</td>
</tr>
<tr>
<td>func:DrawRectGraph(x, y, rect_x, rect_y, rect_width, rect_height, filepath);</td>
<td>number, number, number, number, number, number, string</td>
<td>
<p>Draw a given image at a position.</p>
<p>A rectangle is used to specify what portion of the image you want to draw.</p>
<p>If a rectangle goes outside the bounds of the given image, it will loop back to continue drawing. This method can be used to repeat textures.</p>
</td>
</tr>
<tr>
<td>func:DrawGraphRectCenter(x, y, rect_x, rect_y, rect_width, rect_height, filepath);</td>
<td>number, number, number, number, number, number, string</td>
<td>
<p>Draw a given image at a position, centered at the given coordinates.</p>
<p>A rectangle is used to specify what portion of the image you want to draw.</p>
<p>If a rectangle goes outside the bounds of the given image, it will loop back to continue drawing. This method can be used to repeat textures.</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Image Manipulation</th>
</tr>
</thead>
<tbody>
<tr>
<td>func:SetScale(x_scale, y_scale, filepath)</td>
<td>number, number, string</td>
<td>Set the scale of your image. 1.0 is the default value.</td>
</tr>
<tr>
<td>func:SetRotation(rotation, filepath)</td>
<td>number, string</td>
<td>Set the rotation of your image. Value is typically between 0 and 360.</td>
</tr>
<tr>
<td>func:SetOpacity(opacity, filepath)</td>
<td>number, string</td>
<td>Set the opacity of a given image. Value must be between 0 and 255.</td>
</tr>
<tr>
<td>func:SetColor(r, g, b, filepath)</td>
<td>number, number, number, string</td>
<td>Use a Multiply filter to recolor your image. All values must be between 0.0 and 1.0.</td>
</tr>
<tr>
<td>func:SetBlendMode(mode, filepath)</td>
<td>string, string</td>
<td>
<p>Specify how an image should blend into the background.</p>
<p>Blend modes available are: "Normal", "Add", "Multi" (Multiply), "Sub" (Subtract), "Screen"</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Image Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>func:GetTextureWidth(filepath)</td>
<td>string</td>
<td>Get the width of the loaded texture. Returns -1 if the texture is null.</td>
</tr>
<tr>
<td>func:GetTextureHeight(filepath)</td>
<td>string</td>
<td>Get the height of the loaded texture. Returns -1 if the texture is null.</td>
</tr>
</tbody>
</table>
<h3 id="receiving-functions">Receiving Functions</h3>
<p>Receiving Functions are commands that OpenTaiko sends to your script.</p>
<p>Some of these functions are called every frame, while others are only called when necessary. Some can also be called multiple times, mainly per player.</p>
<table>
<thead>
<tr>
<th>Function</th>
<th>Input Type(s)</th>
<th>Description</th>
</tr>
</thead>
<thead>
<tr>
<th class="sub" colspan="3">General</th>
</tr>
</thead>
<tbody>
<tr>
<td>function init()</td>
<td>-</td>
<td>Called once when the script is first loaded. This is used to initialize data, including images.</td>
</tr>
<tr>
<td>function update()</td>
<td>-</td>
<td>
<p>Called once every frame. Used to calculate & update values. Temporarily stops being called if the game is paused.</p>
<p>This is always called before draw().</p>
</td>
</tr>
<tr>
<td>function draw()</td>
<td>-</td>
<td>Called once every frame. Used to manipulate and draw images.</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">In-Game Only</th>
</tr>
</thead>
<tbody>
<tr>
<td>function clearIn(player)</td>
<td>integer</td>
<td>
<p>Called once when a player has reached the clear range. The player value is the player ID that has entered the clear range.</p>
<p>The player ID starts at 0 and ends at 4.</p>
<p>0 for 1P, 1 for 2P, 2 for 3P, etc.</p>
</td>
</tr>
<tr>
<td>function clearOut(player)</td>
<td>integer</td>
<td>Called once when a player has dropped from the clear range. The player value is the player ID that has dropped from the clear range.</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">In-Game Only (Kusudama)</th>
</tr>
</thead>
<tbody>
<tr>
<td>function kusuIn()</td>
<td>-</td>
<td>Called once when a Kusudama sequence has started.</td>
</tr>
<tr>
<td>function kusuBroke()</td>
<td>-</td>
<td>Called once when a Kusudama was successfully cleared.</td>
</tr>
<tr>
<td>function kusuMiss()</td>
<td>-</td>
<td>Called once when a Kusudama has failed to clear before the sequence has ended.</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">In-Game Only (Ending)</th>
</tr>
</thead>
<tbody>
<tr>
<td>function update(player)</td>
<td>integer</td>
<td>
<p>Called every frame. Used to calculate & update values. Unlike the original function, this is called for each player ID qualified to run this script.</p>
<p>Can run multiple times in a single frame.</p>
</td>
</tr>
<tr>
<td>function draw(player)</td>
<td>integer</td>
<td>
<p>Called every frame. Used to manipulate & draw images. Unlike the original function, this is called for each player ID qualified to run this script.</p>
<p>Can run multiple times in a single frame.</p>
</td>
</tr>
<tr>
<td>function playEndAnime(player)</td>
<td>integer</td>
<td>
<p>Called once when a course is finished. The player value is the player ID qualified to run this script.</p>
<p>Can run multiple times in a single frame.</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Results Only</th>
</tr>
</thead>
<tbody>
<tr>
<td>function skipAnime()</td>
<td>-</td>
<td>Called once when any player skips the Results Screen animation.</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Song Select Only</th>
</tr>
</thead>
<tbody>
<tr>
<td>function playAnime()</td>
<td>-</td>
<td>
<p>Called when a player on the difficulty select screen swaps between Extreme and Extra difficulty.</p>
<p>Animation duration is specified in the Skin Config files.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="variables">Variables</h3>
<p>OpenTaiko gives variables with read-only values to get details about what's happening at that moment.</p>
<p>Some details include information about what state a player is in, while others may provide detail about the gamemode status or certain application parameters.</p>
<p>Because these variables are already reserved, you can not create your own variables with the same names as the ones listed below.</p>
<table>
<thead>
<tr>
<th>Variable Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<thead>
<tr>
<th class="sub" colspan="3">Application Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>fps</td>
<td>integer</td>
<td>
<p>Gets the framerate of the application.</p>
</td>
</tr>
<tr>
<td>deltaTime</td>
<td>decimal</td>
<td>
<p>Gets the amount of time that has passed since the last frame was drawn.</p>
<p>Non-integral, valued in seconds (i.e. 0.0166666...)</p>
</td>
</tr>
<tr>
<td>lang</td>
<td>string</td>
<td>
<p>Gets the current selected language as a short string format.</p>
<p>(i.e. "en", "ja", "fr", etc.)</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Player Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>playerCount</td>
<td>integer</td>
<td>Gets the current number of active players.</td>
</tr>
<tr>
<td>p1IsBlue</td>
<td>boolean</td>
<td>
<p>Gets a bool stating if Player 1 is blue. (via. selecting Right in the title menu)</p>
<p>1P only; Returns false if not blue, or if there are 2 or more players.</p>
</td>
</tr>
<tr>
<td>characterRarities</td>
<td>string[]</td>
<td>
<p>Gets each player's Character rarity.</p>
<p>Possible rarities: "Poor"/"Common"/"Uncommon"/"Rare"/"Epic"/"Legendary"/"Mythical"</p>
</td>
</tr>
<tr>
<td>puchicharaRarities</td>
<td>string[]</td>
<td>
<p>Gets each player's Puchichara rarity.</p>
<p>Possible rarities: "Poor"/"Common"/"Uncommon"/"Rare"/"Epic"/"Legendary"/"Mythical"</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Player Information (In-Game)</th>
</tr>
</thead>
<tbody>
<tr>
<td>bpm</td>
<td>decimal[]</td>
<td>
<p>Gets a list of numbers for each player that tell what BPM their chart is currently on.</p>
<p>Can be different for each player.</p>
</td>
</tr>
<tr>
<td>gauge</td>
<td>decimal[]</td>
<td>Gets a list of numbers between 0-100 for each player that tell where the player is on the soul gauge.</td>
</tr>
<tr>
<td>isClear</td>
<td>boolean[]</td>
<td>Gets a list of booleans for each player that tell if each player is clearing their course.</td>
</tr>
<tr>
<td>gogo</td>
<td>boolean[]</td>
<td>Gets a list of booleans for each player that tell if Go-Go Time is currently active.</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Gameplay Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>timeStamp</td>
<td>decimal</td>
<td>
<p>Gets the amount of time in seconds that have passed since the chart has begun, beginning at the first measure.</p>
<p>Can be negative if the chart hasn't started yet.</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">Tower Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>towerNightNum</td>
<td>decimal</td>
<td>
<p>Gets a number starting at 0 and going up to (but not always ending at) 1, which changes depending on how far the player has progressed through a Tower.</p>
<p>The source code determining towerNightNum's value is: Math.Min(CurrentMeasure / Math.Max(140, MaxFloorCount / 2), 1);</p>
</td>
</tr>
</tbody>
<thead>
<tr>
<th class="sub" colspan="3">AI Battle Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>battleState</td>
<td>integer</td>
<td>
<p>Gets a number related to the current state of the active AI Battle, valued between -9 and 9. Default is 0.</p>
<p>Zero or higher number means the player is winning. Negative number means the AI is winning.</p>
</td>
</tr>
<tr>
<td>battleWin</td>
<td>boolean</td>
<td>
<p>Gets a bool stating if the player is winning (or has won) against the AI in AI Battle.</p>
<p>Can also be used in the Results Screen menu.</p>
</td>
</tr>
</tbody>
</table>
<h1 id="faq">Frequently Asked Questions</h1>
<p>Q: Why?</p>
<p>A: idk</p>
</content>
</body>
</html>