profectus-docs/assets/api_game_persistence_functions_noPersist.md.BNfSgyIM.js

1 line
4.2 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 t,c as a,a0 as r,o as s}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Function: noPersist()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/persistence/functions/noPersist.md","filePath":"api/game/persistence/functions/noPersist.md","lastUpdated":null}'),n={name:"api/game/persistence/functions/noPersist.md"};function o(i,e,c,d,p,l){return s(),a("div",null,e[0]||(e[0]=[r('<p><a href="./../../../">Profectus</a> / <a href="./../">game/persistence</a> / noPersist</p><h1 id="function-nopersist" tabindex="-1">Function: noPersist() <a class="header-anchor" href="#function-nopersist" aria-label="Permalink to &quot;Function: noPersist()&quot;"></a></h1><h2 id="call-signature" tabindex="-1">Call Signature <a class="header-anchor" href="#call-signature" aria-label="Permalink to &quot;Call Signature&quot;"></a></h2><blockquote><p><strong>noPersist</strong>&lt;<code>T</code>, <code>S</code>&gt;(<code>persistent</code>): <code>T</code>[<em>typeof</em> <a href="./../variables/NonPersistent"><code>NonPersistent</code></a>]</p></blockquote><p>Unwraps the non-persistent ref inside of persistent refs, to be passed to other features without duplicating values in the save data object.</p><h3 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h3><p>• <strong>T</strong> <em>extends</em> <a href="./../type-aliases/Persistent"><code>Persistent</code></a>&lt;<code>S</code>&gt;</p><p>• <strong>S</strong> <em>extends</em> <a href="./../type-aliases/State"><code>State</code></a></p><h3 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h3><h4 id="persistent" tabindex="-1">persistent <a class="header-anchor" href="#persistent" aria-label="Permalink to &quot;persistent&quot;"></a></h4><p><code>T</code></p><p>The persistent ref to unwrap, or an object to ignore all persistent refs within</p><h3 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h3><p><code>T</code>[<em>typeof</em> <a href="./../variables/NonPersistent"><code>NonPersistent</code></a>]</p><h3 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h3><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/persistence.ts#L203" target="_blank" rel="noreferrer">profectus/src/game/persistence.ts:203</a></p><h2 id="call-signature-1" tabindex="-1">Call Signature <a class="header-anchor" href="#call-signature-1" aria-label="Permalink to &quot;Call Signature&quot;"></a></h2><blockquote><p><strong>noPersist</strong>&lt;<code>T</code>&gt;(<code>persistent</code>): <code>T</code></p></blockquote><p>Unwraps the non-persistent ref inside of persistent refs, to be passed to other features without duplicating values in the save data object.</p><h3 id="type-parameters-1" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters-1" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h3><p>• <strong>T</strong> <em>extends</em> <code>object</code></p><h3 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;"></a></h3><h4 id="persistent-1" tabindex="-1">persistent <a class="header-anchor" href="#persistent-1" aria-label="Permalink to &quot;persistent&quot;"></a></h4><p><code>T</code></p><p>The persistent ref to unwrap, or an object to ignore all persistent refs within</p><h3 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;"></a></h3><p><code>T</code></p><h3 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></h3><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/persistence.ts#L206" target="_blank" rel="noreferrer">profectus/src/game/persistence.ts:206</a></p>',29)]))}const f=t(n,[["render",o]]);export{u as __pageData,f as default};