brick-engine-js 1.0.27 → 1.0.29
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.
- package/dist/docs/reference/enums/TextTheme.html +511 -0
- package/dist/docs/reference/interfaces/modules/Text.html +128 -0
- package/dist/docs/reference/modules/GameText.html +144 -8
- package/dist/game.bundle.js +1 -1
- package/dist/types/core/module/text/GameText.d.ts +36 -1
- package/dist/types/core/types/enums.d.ts +8 -0
- package/dist/types/core/types/modules.d.ts +34 -1
- package/package.json +1 -1
|
@@ -453,6 +453,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
453
453
|
<li><a href="#setrenderermetricsrenderermetrics-renderermetrics-void">2.5. <code>setRendererMetrics(rendererMetrics: RendererMetrics): void</code></a></li>
|
|
454
454
|
<li><a href="#setactivetext-void">2.6. <code>setActiveText(): void</code></a></li>
|
|
455
455
|
<li><a href="#setinactivetext-void">2.7. <code>setInactiveText(): void</code></a></li>
|
|
456
|
+
<li><a href="#setshadowtext-void">2.8. <code>setShadowText(): void</code></a></li>
|
|
457
|
+
<li><a href="#settextthemetheme-texttheme-void">2.9. <code>setTextTheme(theme: TextTheme): void</code></a></li>
|
|
458
|
+
<li><a href="#pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.10. <code>pulsingTextOnHud(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></li>
|
|
459
|
+
<li><a href="#pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.11. <code>pulsingTextOnDisplay(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></li>
|
|
456
460
|
</ul>
|
|
457
461
|
</li>
|
|
458
462
|
<li><a href="#general-usage">3. General Usage</a></li>
|
|
@@ -643,6 +647,130 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
643
647
|
<div class="paragraph">
|
|
644
648
|
<p>Sets the text rendering style to "inactive" (low contrast, background effect).</p>
|
|
645
649
|
</div>
|
|
650
|
+
<hr>
|
|
651
|
+
</div>
|
|
652
|
+
<div class="sect2">
|
|
653
|
+
<h3 id="setshadowtext-void"><a class="link" href="#setshadowtext-void">2.8. <code>setShadowText(): void</code></a></h3>
|
|
654
|
+
<div class="paragraph">
|
|
655
|
+
<p>Sets the text rendering style to "shadow", used for geometric depth and middle steps in visual pulses.</p>
|
|
656
|
+
</div>
|
|
657
|
+
<hr>
|
|
658
|
+
</div>
|
|
659
|
+
<div class="sect2">
|
|
660
|
+
<h3 id="settextthemetheme-texttheme-void"><a class="link" href="#settextthemetheme-texttheme-void">2.9. <code>setTextTheme(theme: <a href="../../enums/TextTheme.html">TextTheme</a>): void</code></a></h3>
|
|
661
|
+
<div class="paragraph">
|
|
662
|
+
<p>Sets the text rendering style based on a strongly typed enumerator selection.</p>
|
|
663
|
+
</div>
|
|
664
|
+
<div class="paragraph">
|
|
665
|
+
<p><strong>Parameters</strong></p>
|
|
666
|
+
</div>
|
|
667
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
668
|
+
<colgroup>
|
|
669
|
+
<col style="width: 20%;">
|
|
670
|
+
<col style="width: 20%;">
|
|
671
|
+
<col style="width: 60%;">
|
|
672
|
+
</colgroup>
|
|
673
|
+
<tbody>
|
|
674
|
+
<tr>
|
|
675
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
676
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
677
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
678
|
+
</tr>
|
|
679
|
+
<tr>
|
|
680
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>theme</code></p></td>
|
|
681
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../../enums/TextTheme.html">TextTheme</a></code></p></td>
|
|
682
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The selected text theme (<code>ACTIVE</code>, <code>INACTIVE</code>, <code>SHADOW</code>).</p></td>
|
|
683
|
+
</tr>
|
|
684
|
+
</tbody>
|
|
685
|
+
</table>
|
|
686
|
+
<hr>
|
|
687
|
+
</div>
|
|
688
|
+
<div class="sect2">
|
|
689
|
+
<h3 id="pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void"><a class="link" href="#pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.10. <code>pulsingTextOnHud(text: string, coordinate: <a href="../../types/Coordinate.html">Coordinate</a>, elapsedTime: number, pulseSpeedMs?: number): void</code></a></h3>
|
|
690
|
+
<div class="paragraph">
|
|
691
|
+
<p>Renders a string within the HUD area that flashes visually synchronized to the engine’s time elapsed.</p>
|
|
692
|
+
</div>
|
|
693
|
+
<div class="paragraph">
|
|
694
|
+
<p><strong>Parameters</strong></p>
|
|
695
|
+
</div>
|
|
696
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
697
|
+
<colgroup>
|
|
698
|
+
<col style="width: 20%;">
|
|
699
|
+
<col style="width: 20%;">
|
|
700
|
+
<col style="width: 60%;">
|
|
701
|
+
</colgroup>
|
|
702
|
+
<tbody>
|
|
703
|
+
<tr>
|
|
704
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
705
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
706
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
707
|
+
</tr>
|
|
708
|
+
<tr>
|
|
709
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
|
|
710
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
|
|
711
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The string content to display.</p></td>
|
|
712
|
+
</tr>
|
|
713
|
+
<tr>
|
|
714
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
|
|
715
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../../types/Coordinate.html">Coordinate</a></code></p></td>
|
|
716
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Normalized position <code>{x, y}</code>.</p></td>
|
|
717
|
+
</tr>
|
|
718
|
+
<tr>
|
|
719
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>elapsedTime</code></p></td>
|
|
720
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
721
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Total elapsed time in milliseconds from <code>time.elapsedTime</code>.</p></td>
|
|
722
|
+
</tr>
|
|
723
|
+
<tr>
|
|
724
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pulseSpeedMs</code></p></td>
|
|
725
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
726
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Optional. The interval duration of a complete phase loop (in ms).</p></td>
|
|
727
|
+
</tr>
|
|
728
|
+
</tbody>
|
|
729
|
+
</table>
|
|
730
|
+
<hr>
|
|
731
|
+
</div>
|
|
732
|
+
<div class="sect2">
|
|
733
|
+
<h3 id="pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void"><a class="link" href="#pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.11. <code>pulsingTextOnDisplay(text: string, coordinate: <a href="../../types/Coordinate.html">Coordinate</a>, elapsedTime: number, pulseSpeedMs?: number): void</code></a></h3>
|
|
734
|
+
<div class="paragraph">
|
|
735
|
+
<p>Renders a flashing string within the main game area synchronized to the engine’s time elapsed.</p>
|
|
736
|
+
</div>
|
|
737
|
+
<div class="paragraph">
|
|
738
|
+
<p><strong>Parameters</strong></p>
|
|
739
|
+
</div>
|
|
740
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
741
|
+
<colgroup>
|
|
742
|
+
<col style="width: 20%;">
|
|
743
|
+
<col style="width: 20%;">
|
|
744
|
+
<col style="width: 60%;">
|
|
745
|
+
</colgroup>
|
|
746
|
+
<tbody>
|
|
747
|
+
<tr>
|
|
748
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
749
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
750
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
751
|
+
</tr>
|
|
752
|
+
<tr>
|
|
753
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
|
|
754
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
|
|
755
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The string content to display.</p></td>
|
|
756
|
+
</tr>
|
|
757
|
+
<tr>
|
|
758
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
|
|
759
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../../types/Coordinate.html">Coordinate</a></code></p></td>
|
|
760
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Normalized position <code>{x, y}</code>.</p></td>
|
|
761
|
+
</tr>
|
|
762
|
+
<tr>
|
|
763
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>elapsedTime</code></p></td>
|
|
764
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
765
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Total elapsed time in milliseconds from <code>time.elapsedTime</code>.</p></td>
|
|
766
|
+
</tr>
|
|
767
|
+
<tr>
|
|
768
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pulseSpeedMs</code></p></td>
|
|
769
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
770
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Optional. The interval duration of a complete phase loop (in ms).</p></td>
|
|
771
|
+
</tr>
|
|
772
|
+
</tbody>
|
|
773
|
+
</table>
|
|
646
774
|
</div>
|
|
647
775
|
</div>
|
|
648
776
|
</div>
|
|
@@ -450,10 +450,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
450
450
|
<li><a href="#settextalignalign-fontalign-verticalalign-fontverticalalign-void">2.2. <code>setTextAlign(align: FontAlign, verticalAlign: FontVerticalAlign): void</code></a></li>
|
|
451
451
|
<li><a href="#setactivetext-void">2.3. <code>setActiveText(): void</code></a></li>
|
|
452
452
|
<li><a href="#setinactivetext-void">2.4. <code>setInactiveText(): void</code></a></li>
|
|
453
|
-
<li><a href="#
|
|
454
|
-
<li><a href="#
|
|
455
|
-
<li><a href="#
|
|
456
|
-
<li><a href="#
|
|
453
|
+
<li><a href="#setshadowtext-void">2.5. <code>setShadowText(): void</code></a></li>
|
|
454
|
+
<li><a href="#settextthemetheme-texttheme-void">2.6. <code>setTextTheme(theme: TextTheme): void</code></a></li>
|
|
455
|
+
<li><a href="#textondisplaytext-string-coordinate-coordinate-void">2.7. <code>textOnDisplay(text: string, coordinate: Coordinate): void</code></a></li>
|
|
456
|
+
<li><a href="#textonhudtext-string-coordinate-coordinate-void">2.8. <code>textOnHud(text: string, coordinate: Coordinate): void</code></a></li>
|
|
457
|
+
<li><a href="#pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.9. <code>pulsingTextOnDisplay(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></li>
|
|
458
|
+
<li><a href="#pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.10. <code>pulsingTextOnHud(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></li>
|
|
459
|
+
<li><a href="#setrenderermetricsmetrics-renderermetrics-void">2.11. <code>setRendererMetrics(metrics: RendererMetrics): void</code></a></li>
|
|
460
|
+
<li><a href="#getdebugdata-recordstring-string-number-boolean">2.12. <code>getDebugData(): Record<string, string | number | boolean></code></a></li>
|
|
457
461
|
</ul>
|
|
458
462
|
</li>
|
|
459
463
|
</ul>
|
|
@@ -563,7 +567,51 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
563
567
|
<hr>
|
|
564
568
|
</div>
|
|
565
569
|
<div class="sect2">
|
|
566
|
-
<h3 id="
|
|
570
|
+
<h3 id="setshadowtext-void"><a class="link" href="#setshadowtext-void">2.5. <code>setShadowText(): void</code></a></h3>
|
|
571
|
+
<div class="paragraph">
|
|
572
|
+
<p>Sets the text fill color to the shadow theme color.</p>
|
|
573
|
+
</div>
|
|
574
|
+
<hr>
|
|
575
|
+
</div>
|
|
576
|
+
<div class="sect2">
|
|
577
|
+
<h3 id="settextthemetheme-texttheme-void"><a class="link" href="#settextthemetheme-texttheme-void">2.6. <code>setTextTheme(theme: TextTheme): void</code></a></h3>
|
|
578
|
+
<div class="paragraph">
|
|
579
|
+
<p>Sets the active fill style matching the requested theme type.</p>
|
|
580
|
+
</div>
|
|
581
|
+
<div class="paragraph">
|
|
582
|
+
<p><strong>Parameters</strong></p>
|
|
583
|
+
</div>
|
|
584
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
585
|
+
<colgroup>
|
|
586
|
+
<col style="width: 20%;">
|
|
587
|
+
<col style="width: 20%;">
|
|
588
|
+
<col style="width: 60%;">
|
|
589
|
+
</colgroup>
|
|
590
|
+
<tbody>
|
|
591
|
+
<tr>
|
|
592
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
593
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
594
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
595
|
+
</tr>
|
|
596
|
+
<tr>
|
|
597
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>theme</code></p></td>
|
|
598
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/TextTheme.html">TextTheme</a></code></p></td>
|
|
599
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The desired enumerator target.</p></td>
|
|
600
|
+
</tr>
|
|
601
|
+
</tbody>
|
|
602
|
+
</table>
|
|
603
|
+
<div class="paragraph">
|
|
604
|
+
<p><strong>Example</strong></p>
|
|
605
|
+
</div>
|
|
606
|
+
<div class="listingblock">
|
|
607
|
+
<div class="content">
|
|
608
|
+
<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">this.modules.text.setTextTheme(TextTheme.SHADOW);</code></pre>
|
|
609
|
+
</div>
|
|
610
|
+
</div>
|
|
611
|
+
<hr>
|
|
612
|
+
</div>
|
|
613
|
+
<div class="sect2">
|
|
614
|
+
<h3 id="textondisplaytext-string-coordinate-coordinate-void"><a class="link" href="#textondisplaytext-string-coordinate-coordinate-void">2.7. <code>textOnDisplay(text: string, coordinate: Coordinate): void</code></a></h3>
|
|
567
615
|
<div class="paragraph">
|
|
568
616
|
<p>Renders text on the main game display area.</p>
|
|
569
617
|
</div>
|
|
@@ -605,7 +653,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
605
653
|
<hr>
|
|
606
654
|
</div>
|
|
607
655
|
<div class="sect2">
|
|
608
|
-
<h3 id="textonhudtext-string-coordinate-coordinate-void"><a class="link" href="#textonhudtext-string-coordinate-coordinate-void">2.
|
|
656
|
+
<h3 id="textonhudtext-string-coordinate-coordinate-void"><a class="link" href="#textonhudtext-string-coordinate-coordinate-void">2.8. <code>textOnHud(text: string, coordinate: Coordinate): void</code></a></h3>
|
|
609
657
|
<div class="paragraph">
|
|
610
658
|
<p>Renders text on the side HUD area.</p>
|
|
611
659
|
</div>
|
|
@@ -639,7 +687,95 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
639
687
|
<hr>
|
|
640
688
|
</div>
|
|
641
689
|
<div class="sect2">
|
|
642
|
-
<h3 id="
|
|
690
|
+
<h3 id="pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void"><a class="link" href="#pulsingtextondisplaytext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.9. <code>pulsingTextOnDisplay(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></h3>
|
|
691
|
+
<div class="paragraph">
|
|
692
|
+
<p>Renders a flashing text on the Main Display iterating across 3 visual themes based on the elapsed time elapsed.</p>
|
|
693
|
+
</div>
|
|
694
|
+
<div class="paragraph">
|
|
695
|
+
<p><strong>Parameters</strong></p>
|
|
696
|
+
</div>
|
|
697
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
698
|
+
<colgroup>
|
|
699
|
+
<col style="width: 20%;">
|
|
700
|
+
<col style="width: 20%;">
|
|
701
|
+
<col style="width: 60%;">
|
|
702
|
+
</colgroup>
|
|
703
|
+
<tbody>
|
|
704
|
+
<tr>
|
|
705
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
706
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
707
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
708
|
+
</tr>
|
|
709
|
+
<tr>
|
|
710
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
|
|
711
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
|
|
712
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The direct formatted string intended for output.</p></td>
|
|
713
|
+
</tr>
|
|
714
|
+
<tr>
|
|
715
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
|
|
716
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/Coordinate.html">Coordinate</a></code></p></td>
|
|
717
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Floating point proportional coordinate anchor points.</p></td>
|
|
718
|
+
</tr>
|
|
719
|
+
<tr>
|
|
720
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>elapsedTime</code></p></td>
|
|
721
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
722
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The total milliseconds progressed since tracking began (e.g. <code>time.elapsedTime</code>).</p></td>
|
|
723
|
+
</tr>
|
|
724
|
+
<tr>
|
|
725
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pulseSpeedMs</code></p></td>
|
|
726
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
727
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of a full visualization cycle in milliseconds (default: 1000).</p></td>
|
|
728
|
+
</tr>
|
|
729
|
+
</tbody>
|
|
730
|
+
</table>
|
|
731
|
+
<hr>
|
|
732
|
+
</div>
|
|
733
|
+
<div class="sect2">
|
|
734
|
+
<h3 id="pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void"><a class="link" href="#pulsingtextonhudtext-string-coordinate-coordinate-elapsedtime-number-pulsespeedms-number-void">2.10. <code>pulsingTextOnHud(text: string, coordinate: Coordinate, elapsedTime: number, pulseSpeedMs?: number): void</code></a></h3>
|
|
735
|
+
<div class="paragraph">
|
|
736
|
+
<p>Renders a flashing text on the side HUD iterating across 3 visual themes based on the elapsed time elapsed.</p>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="paragraph">
|
|
739
|
+
<p><strong>Parameters</strong></p>
|
|
740
|
+
</div>
|
|
741
|
+
<table class="tableblock frame-all grid-all stretch">
|
|
742
|
+
<colgroup>
|
|
743
|
+
<col style="width: 20%;">
|
|
744
|
+
<col style="width: 20%;">
|
|
745
|
+
<col style="width: 60%;">
|
|
746
|
+
</colgroup>
|
|
747
|
+
<tbody>
|
|
748
|
+
<tr>
|
|
749
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
|
|
750
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
|
|
751
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
|
752
|
+
</tr>
|
|
753
|
+
<tr>
|
|
754
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
|
|
755
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
|
|
756
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The distinct formatted numeric or string label segment intended for the UI.</p></td>
|
|
757
|
+
</tr>
|
|
758
|
+
<tr>
|
|
759
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
|
|
760
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/Coordinate.html">Coordinate</a></code></p></td>
|
|
761
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Relative coordinate vectors bounds scaled strictly according to the active HUD dimensions array.</p></td>
|
|
762
|
+
</tr>
|
|
763
|
+
<tr>
|
|
764
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>elapsedTime</code></p></td>
|
|
765
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
766
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The total milliseconds progressed since tracking began (e.g. <code>time.elapsedTime</code>).</p></td>
|
|
767
|
+
</tr>
|
|
768
|
+
<tr>
|
|
769
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pulseSpeedMs</code></p></td>
|
|
770
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
771
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of a full visualization cycle in milliseconds (default: 1000).</p></td>
|
|
772
|
+
</tr>
|
|
773
|
+
</tbody>
|
|
774
|
+
</table>
|
|
775
|
+
<hr>
|
|
776
|
+
</div>
|
|
777
|
+
<div class="sect2">
|
|
778
|
+
<h3 id="setrenderermetricsmetrics-renderermetrics-void"><a class="link" href="#setrenderermetricsmetrics-renderermetrics-void">2.11. <code>setRendererMetrics(metrics: RendererMetrics): void</code></a></h3>
|
|
643
779
|
<div class="paragraph">
|
|
644
780
|
<p>Updates the coordinate conversion reference.</p>
|
|
645
781
|
</div>
|
|
@@ -674,7 +810,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
674
810
|
<hr>
|
|
675
811
|
</div>
|
|
676
812
|
<div class="sect2">
|
|
677
|
-
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.
|
|
813
|
+
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.12. <code>getDebugData(): Record<string, string | number | boolean></code></a></h3>
|
|
678
814
|
<div class="paragraph">
|
|
679
815
|
<p>Returns metadata for the real-time debugger.</p>
|
|
680
816
|
</div>
|