1 line
8.6 KiB
JavaScript
1 line
8.6 KiB
JavaScript
import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Interface: Player","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/player.Player.md","lastUpdated":null}'),o={name:"api/interfaces/game/player.Player.md"},n=t('<h1 id="interface-player" tabindex="-1">Interface: Player <a class="header-anchor" href="#interface-player" aria-label="Permalink to "Interface: Player""></a></h1><p><a href="./../../modules/game/player">game/player</a>.Player</p><p>The player save data object.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="autosave" tabindex="-1">autosave <a class="header-anchor" href="#autosave" aria-label="Permalink to "autosave""></a></h3><p>• <strong>autosave</strong>: <code>boolean</code></p><p>Whether or not to automatically save every couple of seconds and on tab close.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L17" target="_blank" rel="noreferrer">profectus/src/game/player.ts:17</a></p><hr><h3 id="devspeed" tabindex="-1">devSpeed <a class="header-anchor" href="#devspeed" aria-label="Permalink to "devSpeed""></a></h3><p>• <strong>devSpeed</strong>: <code>null</code> | <code>number</code></p><p>A multiplier for time passing. Set to 0 when the game is paused.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L9" target="_blank" rel="noreferrer">profectus/src/game/player.ts:9</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>The ID of this save.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L7" target="_blank" rel="noreferrer">profectus/src/game/player.ts:7</a></p><hr><h3 id="keepgoing" tabindex="-1">keepGoing <a class="header-anchor" href="#keepgoing" aria-label="Permalink to "keepGoing""></a></h3><p>• <strong>keepGoing</strong>: <code>boolean</code></p><p>Whether or not to continue playing after <a href="./../../modules/data/projEntry#haswon">hasWon</a> is true.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L25" target="_blank" rel="noreferrer">profectus/src/game/player.ts:25</a></p><hr><h3 id="layers" tabindex="-1">layers <a class="header-anchor" href="#layers" aria-label="Permalink to "layers""></a></h3><p>• <strong>layers</strong>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <a href="./../../modules/game/player#layerdata"><code>LayerData</code></a><<code>unknown</code>>></p><p>A dictionary of layer save data.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L31" target="_blank" rel="noreferrer">profectus/src/game/player.ts:31</a></p><hr><h3 id="modid" tabindex="-1">modID <a class="header-anchor" href="#modid" aria-label="Permalink to "modID""></a></h3><p>• <strong>modID</strong>: <code>string</code></p><p>The ID of this project, to make sure saves aren't imported into the wrong project.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L27" target="_blank" rel="noreferrer">profectus/src/game/player.ts:27</a></p><hr><h3 id="modversion" tabindex="-1">modVersion <a class="header-anchor" href="#modversion" aria-label="Permalink to "modVersion""></a></h3><p>• <strong>modVersion</strong>: <code>string</code></p><p>The version of the project this save was created by. Used for upgrading saves for new versions.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L29" target="_blank" rel="noreferrer">profectus/src/game/player.ts:29</a></p><hr><h3 id="name" tabindex="-1">name <a class="header-anchor" href="#name" aria-label="Permalink to "name""></a></h3><p>• <strong>name</strong>: <code>string</code></p><p>The display name of this save.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L11" target="_blank" rel="noreferrer">profectus/src/game/player.ts:11</a></p><hr><h3 id="offlineprod" tabindex="-1">offlineProd <a class="header-anchor" href="#offlineprod" aria-label="Permalink to "offlineProd""></a></h3><p>• <strong>offlineProd</strong>: <code>boolean</code></p><p>Whether or not to apply offline time when loading this save.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L19" target="_blank" rel="noreferrer">profectus/src/game/player.ts:19</a></p><hr><h3 id="offlinetime" tabindex="-1">offlineTime <a class="header-anchor" href="#offlinetime" aria-label="Permalink to "offlineTime""></a></h3><p>• <strong>offlineTime</strong>: <code>null</code> | <code>number</code></p><p>How much offline time has been accumulated and not yet processed.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L21" target="_blank" rel="noreferrer">profectus/src/game/player.ts:21</a></p><hr><h3 id="tabs" tabindex="-1">tabs <a class="header-anchor" href="#tabs" aria-label="Permalink to "tabs""></a></h3><p>• <strong>tabs</strong>: <code>string</code>[]</p><p>The open tabs.</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L13" target="_blank" rel="noreferrer">profectus/src/game/player.ts:13</a></p><hr><h3 id="time" tabindex="-1">time <a class="header-anchor" href="#time" aria-label="Permalink to "time""></a></h3><p>• <strong>time</strong>: <code>number</code></p><p>The current time this save was last opened at, in ms since the unix epoch.</p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L15" target="_blank" rel="noreferrer">profectus/src/game/player.ts:15</a></p><hr><h3 id="timeplayed" tabindex="-1">timePlayed <a class="header-anchor" href="#timeplayed" aria-label="Permalink to "timePlayed""></a></h3><p>• <strong>timePlayed</strong>: <code>number</code></p><p>How long, in ms, this game has been played.</p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/player.ts#L23" target="_blank" rel="noreferrer">profectus/src/game/player.ts:23</a></p>',81),i=[n];function s(d,l,h,c,p,f){return r(),a("div",null,i)}const b=e(o,[["render",s]]);export{m as __pageData,b as default};
|