profectus-docs/assets/api_modules_game_player.md.b64f6191.js

2 lines
4.3 KiB
JavaScript
Raw Normal View History

import{_ as e,c as a,o as t,a as r}from"./app.e5a3543f.js";const u='{"title":"Module: game/player","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"Player","slug":"player"},{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"default","slug":"default"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"stringifySave","slug":"stringifysave"}],"relativePath":"api/modules/game/player.md"}',d={},o=r('<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="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>&lt;<a href="../../interfaces/game/player.PlayerData"><code>PlayerData</code></a>&gt;</p><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/2e3f1de/src/game/player.ts#L23" target="_blank" rel="noopener noreferrer">profectus/src/game/player.ts:23</a></p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" 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]: { [x: string]: unknown; } &amp; { [ProxyState]: Record&lt;string, unknown&gt;; [ProxyPath]: string[]; }; } &amp; { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <code>Record</code>&lt;<code>string</code>, <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;&gt; } ; <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>[] &amp; { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <code>string</code>[] } ; <code>time</code>: <code>number</code> ; <code>timePlayed</code>: <code>number</code> } &amp; { <code>[ProxyPath]</code>: <code>string</code>[] ; <code>[ProxyState]</code>: <a href="../../interfaces/game/player.PlayerData"><code>PlayerData</code></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><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><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden=