1 line
6 KiB
JavaScript
1 line
6 KiB
JavaScript
import{_ as e,c as a,o as t,a as d}from"./app.ab34650d.js";const g=JSON.parse('{"title":"Module: game/player","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"LayerData","slug":"layerdata"},{"level":3,"title":"Player","slug":"player"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"default","slug":"default"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"stringifySave","slug":"stringifysave"}],"relativePath":"api/modules/game/player.md","lastUpdated":null}'),r={name:"api/modules/game/player.md"},o=d('<h1 id="module-game-player" tabindex="-1">Module: game/player <a class="header-anchor" href="#module-game-player" aria-hidden="true">#</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../interfaces/game/player.PlayerData">PlayerData</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="layerdata" tabindex="-1">LayerData <a class="header-anchor" href="#layerdata" aria-hidden="true">#</a></h3><p>\u01AC <strong>LayerData</strong><<code>T</code>>: { [<code>P</code> in keyof <code>T</code>]?: <code>T</code>[<code>P</code>] extends infer U[] ? <code>Record</code><<code>string</code>, <a href="./player.html#layerdata"><code>LayerData</code></a><<code>U</code>>> : <code>T</code>[<code>P</code>] extends <code>Record</code><<code>string</code>, <code>never</code>> ? <code>never</code> : <code>T</code>[<code>P</code>] extends <code>Ref</code><infer S> ? <code>S</code> : <code>T</code>[<code>P</code>] extends <code>object</code> ? <a href="./player.html#layerdata"><code>LayerData</code></a><<code>T</code>[<code>P</code>]> : <code>T</code>[<code>P</code>] }</p><p>A layer's save data. Automatically unwraps refs.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/player.ts#L43" target="_blank" rel="noopener noreferrer">profectus/src/game/player.ts:43</a></p><hr><h3 id="player" tabindex="-1">Player <a class="header-anchor" href="#player" aria-hidden="true">#</a></h3><p>\u01AC <strong>Player</strong>: <a href="./../util/proxies.html#proxiedwithstate"><code>ProxiedWithState</code></a><<a href="../../interfaces/game/player.PlayerData"><code>PlayerData</code></a>></p><p>The proxied player that is used to track NaN values.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/player.ts#L40" target="_blank" rel="noopener noreferrer">profectus/src/game/player.ts:40</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="default" tabindex="-1">default <a class="header-anchor" href="#default" aria-hidden="true">#</a></h3><p>\u2022 <strong>default</strong>: { <code>autosave</code>: <code>boolean</code> ; <code>devSpeed</code>: <code>null</code> | <code>number</code> ; <code>id</code>: <code>string</code> ; <code>keepGoing</code>: <code>boolean</code> ; <code>layers</code>: { [x: string]: {} & { [ProxyState]: LayerData<unknown>; [ProxyPath]: string[]; }; } & { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <code>Record</code><<code>string</code>, <a href="./player.html#layerdata"><code>LayerData</code></a><<code>unknown</code>>> } ; <code>modID</code>: <code>string</code> ; <code>modVersion</code>: <code>string</code> ; <code>name</code>: <code>string</code> ; <code>offlineProd</code>: <code>boolean</code> ; <code>offlineTime</code>: <code>null</code> | <code>number</code> ; <code>tabs</code>: <code>string</code>[] & { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <code>string</code>[] } ; <code>time</code>: <code>number</code> ; <code>timePlayed</code>: <code>number</code> } & { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <a href="../../interfaces/game/player.PlayerData"><code>PlayerData</code></a> }</p><p>The player save data object.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/player.ts#L154" target="_blank" rel="noopener noreferrer">profectus/src/game/player.ts:154</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="stringifysave" tabindex="-1">stringifySave <a class="header-anchor" href="#stringifysave" aria-hidden="true">#</a></h3><p>\u25B8 <strong>stringifySave</strong>(<code>player</code>): <code>string</code></p><p>Convert a player save data object into a JSON string. Unwraps refs.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>player</code></td><td style="text-align:left;"><a href="../../interfaces/game/player.PlayerData"><code>PlayerData</code></a></td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><code>string</code></p>',31),c=[o];function n(l,i,s,h,p,f){return t(),a("div",null,c)}var u=e(r,[["render",n]]);export{g as __pageData,u as default};
|