profectus-docs/assets/api_modules_util_save.md.37bf1279.js

1 line
14 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: util/save","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/util/save.md","lastUpdated":null}'),o={name:"api/modules/util/save.md"},n=t('<h1 id="module-util-save" tabindex="-1">Module: util/save <a class="header-anchor" href="#module-util-save" aria-label="Permalink to &quot;Module: util/save&quot;"></a></h1><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-label="Permalink to &quot;Variables&quot;"></a></h2><h3 id="loadingsave" tabindex="-1">loadingSave <a class="header-anchor" href="#loadingsave" aria-label="Permalink to &quot;loadingSave&quot;"></a></h3><p>• <code>Const</code> <strong>loadingSave</strong>: <code>Ref</code>&lt;<code>boolean</code>&gt;</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L89" target="_blank" rel="noreferrer">profectus/src/util/save.ts:89</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to &quot;Functions&quot;"></a></h2><h3 id="deletelowersaves" tabindex="-1">deleteLowerSaves <a class="header-anchor" href="#deletelowersaves" aria-label="Permalink to &quot;deleteLowerSaves&quot;"></a></h3><p>▸ <strong>deleteLowerSaves</strong>(): <code>void</code></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><code>void</code></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L155" target="_blank" rel="noreferrer">profectus/src/util/save.ts:155</a></p><p>• <strong>deleteLowerSaves</strong>: () =&gt; <code>void</code></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L155" target="_blank" rel="noreferrer">profectus/src/util/save.ts:155</a></p><hr><h3 id="getuniqueid" tabindex="-1">getUniqueID <a class="header-anchor" href="#getuniqueid" aria-label="Permalink to &quot;getUniqueID&quot;"></a></h3><p>▸ <strong>getUniqueID</strong>(): <code>string</code></p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><code>string</code></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L80" target="_blank" rel="noreferrer">profectus/src/util/save.ts:80</a></p><p>• <strong>getUniqueID</strong>: () =&gt; <code>string</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L80" target="_blank" rel="noreferrer">profectus/src/util/save.ts:80</a></p><hr><h3 id="hardreset" tabindex="-1">hardReset <a class="header-anchor" href="#hardreset" aria-label="Permalink to &quot;hardReset&quot;"></a></h3><p>▸ <strong>hardReset</strong>(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L152" target="_blank" rel="noreferrer">profectus/src/util/save.ts:152</a></p><p>• <strong>hardReset</strong>: () =&gt; <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L152" target="_blank" rel="noreferrer">profectus/src/util/save.ts:152</a></p><hr><h3 id="load" tabindex="-1">load <a class="header-anchor" href="#load" aria-label="Permalink to &quot;load&quot;"></a></h3><p>▸ <strong>load</strong>(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L35" target="_blank" rel="noreferrer">profectus/src/util/save.ts:35</a></p><p>• <strong>load</strong>: () =&gt; <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L35" target="_blank" rel="noreferrer">profectus/src/util/save.ts:35</a></p><hr><h3 id="loadsave" tabindex="-1">loadSave <a class="header-anchor" href="#loadsave" aria-label="Permalink to &quot;loadSave&quot;"></a></h3><p>▸ <strong>loadSave</strong>(<code>playerObj</code>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></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>playerObj</code></td><td style="text-align:left;"><a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<a href="./../game/player#player"><code>Player</code></a>&gt;</td></tr></tbody></table><h4 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L91" target="_blank" rel="noreferrer">profectus/src/util/save.ts:91</a></p><p>• <strong>loadSave</strong>: (<code>playerObj</code>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<a href="./../game/player#player"><code>Player</code></a>&gt;) =&gt; <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a>&lt;<code>void</code>&gt;</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L91" target="_blank" rel="noreferrer">profectus/src/util/save.ts:91</a></p><hr><h3 id="newsave" tabindex="-1">newSave <a class="header-anchor" href="#newsave" aria-label="Permalink to &quot;newSave&quot;"></a></h3><p>▸ <strong>newSave</strong>(): <a href="./../game/player#player"><code>Player</code></a></p><h4 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><a href="./../game/player#player"><code>Player</code></a></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L70" target="_blank" rel="noreferrer">profectus/src/util/save.ts:70</a></p><p>• <strong>newSave</strong>: () =&gt; <a href="./../game/player#player"><code>Player</code></a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L70" target="_blank" rel="noreferrer">profectus/src/util/save.ts:70</a></p><hr><h3 id="save" tabindex="-1">save <a class="header-anchor" href="#save" aria-label="Permalink to &quot;save&quot;"></a></h3><p>▸ <strong>save</strong>(<code>playerData?</code>): <code>string</code></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;"></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>playerData?</code></td><td style="text-align:left;"><a href="./../game/player#player"><code>Player</code></a></td></tr></tbody></table><h4 id="returns-6" tabindex="-1">Returns <a class="header-anchor" href="#returns-6" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><code>string</code></p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L29" target="_blank" rel="noreferrer">profectus/src/util/save.ts:29</a></p><p>• <strong>save</strong>: (<code>playerData?</code>: <a href="./../game/player#player"><code>Player</code></a>) =&gt; <code>string</code></p><h4 id="defined-in-14" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-14" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L29" target="_blank" rel="noreferrer">profectus/src/util/save.ts:29</a></p><hr><h3 id="setupinitialstore" tabindex="-1">setupInitialStore <a class="header-anchor" href="#setupinitialstore" aria-label="Permalink to &quot;setupInitialStore&quot;"></a></h3><p>▸ <strong>setupInitialStore</strong>(<code>player?</code>): <a href="./../game/player#player"><code>Player</code></a></p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to &quot;Parameters&quot;"></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="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<a href="./../game/player#player"><code>Player</code></a>&gt;</td></tr></tbody></table><h4 id="returns-7" tabindex="-1">Returns <a class="header-anchor" href="#returns-7" aria-label="Permalink to &quot;Returns&quot;"></a></h4><p><a href="./../game/player#player"><code>Player</code></a></p><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L9" target="_blank" rel="noreferrer">profectus/src/util/save.ts:9</a></p><p>• <strong>setupInitialStore</strong>: (<code>player</code>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<a href="./../game/player#player"><code>Player</code></a>&gt;) =&gt; <a href="./../game/player#player"><code>Player</code></a></p><h4 id="defined-in-16" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-16" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/save.ts#L9" target="_blank" rel="noreferrer">profectus/src/util/save.ts:9</a></p>',92),i=[n];function l(s,d,c,h,f,u){return r(),a("div",null,i)}const g=e(o,[["render",l]]);export{b as __pageData,g as default};