brick-engine-js 1.0.38 → 1.0.40

package/dist/docs/reference/modules/GameScore.html

@@ -443,75 +443,130 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
-<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
-<li><a href="#api-reference">2. API Reference</a>
+<li><a href="#api-reference">1. API Reference</a>
 <ul class="sectlevel2">
-<li><a href="#score-number">2.1. <code>score: number</code></a></li>
-<li><a href="#level-number">2.2. <code>level: number</code></a></li>
-<li><a href="#multiplier-number">2.3. <code>multiplier: number</code></a></li>
-<li><a href="#highscore-number">2.4. <code>highScore: number</code></a></li>
-<li><a href="#increasescoreamount-number-void">2.5. <code>increaseScore(amount: number): void</code></a></li>
-<li><a href="#resetscore-void">2.6. <code>resetScore(): void</code></a></li>
-<li><a href="#increaselevelamount-number-void">2.7. <code>increaseLevel(amount: number): void</code></a></li>
-<li><a href="#resetlevel-void">2.8. <code>resetLevel(): void</code></a></li>
-<li><a href="#setupgamehighscoreid-string-void">2.9. <code>setupGameHighScore(id: string): void</code></a></li>
-<li><a href="#getformattedscoredigits-number-string">2.10. <code>getFormattedScore(digits: number): string</code></a></li>
-<li><a href="#serialize-string">2.11. <code>serialize(): string</code></a></li>
-<li><a href="#deserializedata-string-void">2.12. <code>deserialize(data: string): void</code></a></li>
-<li><a href="#getdebugdata-recordstring-string-number-boolean">2.13. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></li>
+<li><a href="#life-cycle">1.1. Life Cycle</a>
+<ul class="sectlevel3">
+<li><a href="#setupgamehighscoreid-string-void">1.1.1. <code>setupGameHighScore(id: string): void</code></a></li>
+</ul>
+</li>
+<li><a href="#score-management">1.2. Score Management</a>
+<ul class="sectlevel3">
+<li><a href="#score-number">1.2.1. <code>score: number</code></a></li>
+<li><a href="#increasescoreamount-number-void">1.2.2. <code>increaseScore(amount: number): void</code></a></li>
+<li><a href="#resetscore-void">1.2.3. <code>resetScore(): void</code></a></li>
+<li><a href="#highscore-number">1.2.4. <code>highScore: number</code></a></li>
+</ul>
+</li>
+<li><a href="#level-management">1.3. Level Management</a>
+<ul class="sectlevel3">
+<li><a href="#level-number">1.3.1. <code>level: number</code></a></li>
+<li><a href="#increaselevelamount-number-void">1.3.2. <code>increaseLevel(amount: number): void</code></a></li>
+<li><a href="#resetlevel-void">1.3.3. <code>resetLevel(): void</code></a></li>
+<li><a href="#maxlevel-number">1.3.4. <code>maxLevel: number</code></a></li>
+</ul>
+</li>
+<li><a href="#subscriptions">1.4. Subscriptions</a>
+<ul class="sectlevel3">
+<li><a href="#subscribecallback-score-number-void-void">1.4.1. <code>subscribe(callback: (score: number) &#8658; void): void</code></a></li>
+<li><a href="#unsubscribecallback-score-number-void-void">1.4.2. <code>unsubscribe(callback: (score: number) &#8658; void): void</code></a></li>
+</ul>
+</li>
+<li><a href="#utility-state">1.5. Utility &amp; State</a>
+<ul class="sectlevel3">
+<li><a href="#multiplier-number">1.5.1. <code>multiplier: number</code></a></li>
+<li><a href="#getformattedscoredigits-number-string">1.5.2. <code>getFormattedScore(digits: number): string</code></a></li>
+<li><a href="#serialize-string">1.5.3. <code>serialize(): string</code></a></li>
+<li><a href="#deserializedata-string-void">1.5.4. <code>deserialize(data: string): void</code></a></li>
+<li><a href="#getdebugdata-recordstring-string-number-boolean">1.5.5. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <div id="content">
-<div class="sect1">
-<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
+<div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>The <code>GameScore</code> module acts as the strict authority dedicated to tracking real-time player performance metrics, levels, and point multipliers. It prevents transient session logic from interacting with persistent storage, explicitly taking over saving the global <code>highScore</code> into an isolated <code>LocalStorage</code> namespace directly, ensuring different game engines do not overwrite each other&#8217;s records.</p>
 </div>
+<div class="paragraph">
+<p>It exposes reactivity through an event-based system using <code><a href="../enums/ScoreProperty.html">ScoreProperty</a></code>.</p>
+</div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
+<h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</a></h2>
 <div class="sectionbody">
 <div class="sect2">
-<h3 id="score-number"><a class="link" href="#score-number">2.1. <code>score: number</code></a></h3>
+<h3 id="life-cycle"><a class="link" href="#life-cycle">1.1. Life Cycle</a></h3>
 <div class="paragraph">
-<p>Read-only property returning the current session&#8217;s points.</p>
-</div>
-<hr>
+<p>Methods for initializing the high score context.</p>
 </div>
-<div class="sect2">
-<h3 id="level-number"><a class="link" href="#level-number">2.2. <code>level: number</code></a></h3>
+<div class="sect3">
+<h4 id="setupgamehighscoreid-string-void"><a class="link" href="#setupgamehighscoreid-string-void">1.1.1. <code>setupGameHighScore(id: string): void</code></a></h4>
 <div class="paragraph">
-<p>Read-only property returning the current difficulty level.</p>
+<p>Initializes the module with the specific game ID and loads the corresponding high score.</p>
 </div>
-<hr>
+<div class="paragraph">
+<p><strong>Parameters</strong></p>
 </div>
-<div class="sect2">
-<h3 id="multiplier-number"><a class="link" href="#multiplier-number">2.3. <code>multiplier: number</code></a></h3>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 60%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The unique game UUID identifier used as a persistent prefix for namespace isolation.</p></td>
+</tr>
+</tbody>
+</table>
 <div class="paragraph">
-<p>Read and Write property for the current points multiplier.</p>
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.setupGameHighScore("tetris-v1");</code></pre>
+</div>
 </div>
 <hr>
 </div>
+</div>
 <div class="sect2">
-<h3 id="highscore-number"><a class="link" href="#highscore-number">2.4. <code>highScore: number</code></a></h3>
+<h3 id="score-management"><a class="link" href="#score-management">1.2. Score Management</a></h3>
 <div class="paragraph">
-<p>Read and Write property for the highest overall score achieved.</p>
+<p>Methods for adding and resetting points.</p>
 </div>
+<div class="sect3">
+<h4 id="score-number"><a class="link" href="#score-number">1.2.1. <code>score: number</code></a></h4>
 <div class="paragraph">
-<p><strong>Behavior</strong></p>
+<p>Read-only property returning the current session&#8217;s points.</p>
 </div>
 <div class="paragraph">
-<p>When set, it automatically persists the value directly to <code>LocalStorage</code> under the namespaced key <code>${gameId}::highScore</code>. This ensures that different games do not overwrite each other&#8217;s records.</p>
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">console.log(`Current Score: ${core.score.score}`);</code></pre>
+</div>
 </div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="increasescoreamount-number-void"><a class="link" href="#increasescoreamount-number-void">2.5. <code>increaseScore(amount: number): void</code></a></h3>
+<div class="sect3">
+<h4 id="increasescoreamount-number-void"><a class="link" href="#increasescoreamount-number-void">1.2.2. <code>increaseScore(amount: number): void</code></a></h4>
 <div class="paragraph">
 <p>Adds points to the current session.</p>
 </div>
@@ -524,12 +579,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <col style="width: 20%;">
 <col style="width: 60%;">
 </colgroup>
-<tbody>
+<thead>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
@@ -541,19 +598,80 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <p><strong>Behavior</strong></p>
 </div>
 <div class="paragraph">
-<p>Increases the score by <code>amount * multiplier</code>. Automatically compares the new score against the internal <code>highScore</code> property and updates it if a new record is reached (which in turn persists the new record to <code>LocalStorage</code>).</p>
+<p>Increases the score by <code>amount * multiplier</code>. Automatically compares the new score against the internal <code>highScore</code> property and updates it if a new record is reached (which in turn persists the new record to <code>LocalStorage</code>). Triggers a <code>SCORE</code> notification via the <code><a href="EventEmitter.html">EventEmitter</a></code>.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">// Adds 500 * current multiplier to the score
+core.score.increaseScore(500);</code></pre>
+</div>
 </div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="resetscore-void"><a class="link" href="#resetscore-void">2.6. <code>resetScore(): void</code></a></h3>
+<div class="sect3">
+<h4 id="resetscore-void"><a class="link" href="#resetscore-void">1.2.3. <code>resetScore(): void</code></a></h4>
+<div class="paragraph">
+<p>Resets the session score to zero. Triggers a <code>SCORE</code> notification.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.resetScore();</code></pre>
+</div>
+</div>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="highscore-number"><a class="link" href="#highscore-number">1.2.4. <code>highScore: number</code></a></h4>
+<div class="paragraph">
+<p>Read and Write property for the highest overall score achieved.</p>
+</div>
+<div class="paragraph">
+<p><strong>Behavior</strong></p>
+</div>
+<div class="paragraph">
+<p>When set, it automatically persists the value directly to <code>LocalStorage</code> under the namespaced key <code>${gameId}::highScore</code>. This ensures that different games do not overwrite each other&#8217;s records. Triggers a <code>HIGH_SCORE</code> notification.</p>
+</div>
 <div class="paragraph">
-<p>Resets the session score to zero.</p>
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">console.log(`High Score to beat: ${core.score.highScore}`);</code></pre>
+</div>
 </div>
 <hr>
 </div>
+</div>
 <div class="sect2">
-<h3 id="increaselevelamount-number-void"><a class="link" href="#increaselevelamount-number-void">2.7. <code>increaseLevel(amount: number): void</code></a></h3>
+<h3 id="level-management"><a class="link" href="#level-management">1.3. Level Management</a></h3>
+<div class="paragraph">
+<p>Methods for difficulty scaling.</p>
+</div>
+<div class="sect3">
+<h4 id="level-number"><a class="link" href="#level-number">1.3.1. <code>level: number</code></a></h4>
+<div class="paragraph">
+<p>Read-only property returning the current difficulty level.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">if (core.score.level &gt; 10) {
+  unlockSecretLevel();
+}</code></pre>
+</div>
+</div>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="increaselevelamount-number-void"><a class="link" href="#increaselevelamount-number-void">1.3.2. <code>increaseLevel(amount: number): void</code></a></h4>
 <div class="paragraph">
 <p>Increases the game difficulty level.</p>
 </div>
@@ -566,12 +684,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <col style="width: 20%;">
 <col style="width: 60%;">
 </colgroup>
-<tbody>
+<thead>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
@@ -579,19 +699,62 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </tr>
 </tbody>
 </table>
+<div class="paragraph">
+<p><strong>Behavior</strong></p>
+</div>
+<div class="paragraph">
+<p>Increases the internal level and triggers a <code>LEVEL</code> notification.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.increaseLevel(1);</code></pre>
+</div>
+</div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="resetlevel-void"><a class="link" href="#resetlevel-void">2.8. <code>resetLevel(): void</code></a></h3>
+<div class="sect3">
+<h4 id="resetlevel-void"><a class="link" href="#resetlevel-void">1.3.3. <code>resetLevel(): void</code></a></h4>
+<div class="paragraph">
+<p>Resets the level counter to 1. Triggers a <code>LEVEL</code> notification.</p>
+</div>
 <div class="paragraph">
-<p>Resets the level counter to 1.
-'''</p>
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.resetLevel();</code></pre>
+</div>
+</div>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="maxlevel-number"><a class="link" href="#maxlevel-number">1.3.4. <code>maxLevel: number</code></a></h4>
+<div class="paragraph">
+<p>Read and Write property for the maximum game level cap. Triggers a <code>MAX_LEVEL</code> notification on change.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.maxLevel = 25;</code></pre>
+</div>
+</div>
+<hr>
 </div>
 </div>
 <div class="sect2">
-<h3 id="setupgamehighscoreid-string-void"><a class="link" href="#setupgamehighscoreid-string-void">2.9. <code>setupGameHighScore(id: string): void</code></a></h3>
+<h3 id="subscriptions"><a class="link" href="#subscriptions">1.4. Subscriptions</a></h3>
 <div class="paragraph">
-<p>Initializes the module with the specific game ID and loads the corresponding high score.</p>
+<p>Enables other modules to listen for score-related updates.</p>
+</div>
+<div class="sect3">
+<h4 id="subscribecallback-score-number-void-void"><a class="link" href="#subscribecallback-score-number-void-void">1.4.1. <code>subscribe(callback: (score: number) &#8658; void): void</code></a></h4>
+<div class="paragraph">
+<p>Registers a listener for score changes.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -602,23 +765,93 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <col style="width: 20%;">
 <col style="width: 60%;">
 </colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(score: number) &#8658; void</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute when the score changes.</p></td>
 </tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.subscribe((val) =&gt; hud.refresh(val));</code></pre>
+</div>
+</div>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="unsubscribecallback-score-number-void-void"><a class="link" href="#unsubscribecallback-score-number-void-void">1.4.2. <code>unsubscribe(callback: (score: number) &#8658; void): void</code></a></h4>
+<div class="paragraph">
+<p>Removes an existing score listener.</p>
+</div>
+<div class="paragraph">
+<p><strong>Parameters</strong></p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 60%;">
+</colgroup>
+<thead>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The unique game UUID identifier used as a persistent prefix for namespace isolation.</p></td>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(score: number) &#8658; void</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The function to remove.</p></td>
 </tr>
 </tbody>
 </table>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.unsubscribe(onScoreUpdate);</code></pre>
+</div>
+</div>
 <hr>
 </div>
+</div>
 <div class="sect2">
-<h3 id="getformattedscoredigits-number-string"><a class="link" href="#getformattedscoredigits-number-string">2.10. <code>getFormattedScore(digits: number): string</code></a></h3>
+<h3 id="utility-state"><a class="link" href="#utility-state">1.5. Utility &amp; State</a></h3>
+<div class="paragraph">
+<p>Methods for formatting and serialization.</p>
+</div>
+<div class="sect3">
+<h4 id="multiplier-number"><a class="link" href="#multiplier-number">1.5.1. <code>multiplier: number</code></a></h4>
+<div class="paragraph">
+<p>Read and Write property for the current points multiplier. Triggers a <code>MULTIPLIER</code> notification on change.</p>
+</div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.multiplier = 2.5; // Enable power-up</code></pre>
+</div>
+</div>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="getformattedscoredigits-number-string"><a class="link" href="#getformattedscoredigits-number-string">1.5.2. <code>getFormattedScore(digits: number): string</code></a></h4>
 <div class="paragraph">
 <p>Returns the score as a padded string suitable for HUD display.</p>
 </div>
@@ -631,12 +864,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <col style="width: 20%;">
 <col style="width: 60%;">
 </colgroup>
-<tbody>
+<thead>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>digits</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
@@ -650,33 +885,66 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div class="paragraph">
 <p><code>string</code> - The zero-padded score string.</p>
 </div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">const label = core.score.getFormattedScore(6);</code></pre>
+</div>
+</div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="serialize-string"><a class="link" href="#serialize-string">2.11. <code>serialize(): string</code></a></h3>
+<div class="sect3">
+<h4 id="serialize-string"><a class="link" href="#serialize-string">1.5.3. <code>serialize(): string</code></a></h4>
 <div class="paragraph">
 <p><strong>Behavior</strong></p>
 </div>
 <div class="paragraph">
 <p>Implements <code><a href="../interfaces/Serializable.html">Serializable</a></code>. Packs the current <code>score</code>, <code>level</code>, <code>max_level</code>, <code>multiplier</code>, and <code>highScore</code> into a JSON string to be managed by the active game session.</p>
 </div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">const saveData = core.score.serialize();</code></pre>
+</div>
+</div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="deserializedata-string-void"><a class="link" href="#deserializedata-string-void">2.12. <code>deserialize(data: string): void</code></a></h3>
+<div class="sect3">
+<h4 id="deserializedata-string-void"><a class="link" href="#deserializedata-string-void">1.5.4. <code>deserialize(data: string): void</code></a></h4>
 <div class="paragraph">
 <p><strong>Behavior</strong></p>
 </div>
 <div class="paragraph">
 <p>Implements <code><a href="../interfaces/Serializable.html">Serializable</a></code>. Restores all progress from a saved session string.</p>
 </div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">core.score.deserialize(savedState);</code></pre>
+</div>
+</div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.13. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></h3>
+<div class="sect3">
+<h4 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">1.5.5. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></h4>
 <div class="paragraph">
 <p>Returns metadata for the real-time debugger.</p>
 </div>
+<div class="paragraph">
+<p><strong>Example</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">const debugInfo = core.score.getDebugData();</code></pre>
+</div>
+</div>
+</div>
 </div>
 </div>
 </div>