1 line
3.6 KiB
JavaScript
1 line
3.6 KiB
JavaScript
import{_ as t,c as r,a0 as a,o as s}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: Reset","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/reset/interfaces/Reset.md","filePath":"api/features/reset/interfaces/Reset.md","lastUpdated":null}'),o={name:"api/features/reset/interfaces/Reset.md"};function n(i,e,c,l,h,d){return s(),r("div",null,e[0]||(e[0]=[a('<p><a href="./../../../">Profectus</a> / <a href="./../">features/reset</a> / Reset</p><h1 id="interface-reset" tabindex="-1">Interface: Reset <a class="header-anchor" href="#interface-reset" aria-label="Permalink to "Interface: Reset""></a></h1><p>An object that represents a reset mechanic, which resets progress back to its initial state.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="onreset" tabindex="-1">onReset? <a class="header-anchor" href="#onreset" aria-label="Permalink to "onReset?""></a></h3><blockquote><p><code>optional</code> <strong>onReset</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the reset is performed.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/reset.ts#L35" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:35</a></p><hr><h3 id="reset" tabindex="-1">reset <a class="header-anchor" href="#reset" aria-label="Permalink to "reset""></a></h3><blockquote><p><strong>reset</strong>: <code>VoidFunction</code></p></blockquote><p>Trigger the reset.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/reset.ts#L37" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:37</a></p><hr><h3 id="thingstoreset" tabindex="-1">thingsToReset <a class="header-anchor" href="#thingstoreset" aria-label="Permalink to "thingsToReset""></a></h3><blockquote><p><strong>thingsToReset</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>unknown</code>[]></p></blockquote><p>List of things to reset. Can include objects which will be recursed over for persistent values.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/reset.ts#L33" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:33</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><blockquote><p><strong>type</strong>: <em>typeof</em> <a href="./../variables/ResetType"><code>ResetType</code></a></p></blockquote><p>A symbol that helps identify features of the same type.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/reset.ts#L39" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:39</a></p>',27)]))}const u=t(o,[["render",n]]);export{p as __pageData,u as default};
|