profectus-docs/assets/api_game_persistence_functions_deletePersistent.md.BqW7NUXw.lean.js

import{_ as t,c as a,a0 as s,o as r}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Function: deletePersistent()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/persistence/functions/deletePersistent.md","filePath":"api/game/persistence/functions/deletePersistent.md","lastUpdated":null}'),n={name:"api/game/persistence/functions/deletePersistent.md"};function i(o,e,d,c,l,p){return r(),a("div",null,e[0]||(e[0]=[s('<p><a href="./../../../">Profectus</a> / <a href="./../">game/persistence</a> / deletePersistent</p><h1 id="function-deletepersistent" tabindex="-1">Function: deletePersistent() <a class="header-anchor" href="#function-deletepersistent" aria-label="Permalink to &quot;Function: deletePersistent()&quot;">​</a></h1><blockquote><p><strong>deletePersistent</strong>(<code>persistent</code>): <code>void</code></p></blockquote><p>Mark a <a href="./../type-aliases/Persistent">Persistent</a> as deleted, so it won&#39;t be saved and loaded. Since persistent refs must be created during a layer&#39;s options func, features can not create persistent refs after evaluating their own options funcs. As a result, it must create any persistent refs it <em>might</em> need. This function can then be called after the options func is evaluated to mark the persistent ref to not be saved or loaded.</p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h2><h3 id="persistent" tabindex="-1">persistent <a class="header-anchor" href="#persistent" aria-label="Permalink to &quot;persistent&quot;">​</a></h3><p><a href="./../type-aliases/Persistent"><code>Persistent</code></a>&lt;<a href="./../type-aliases/State"><code>State</code></a>&gt;</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h2><p><code>void</code></p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/persistence.ts#L245" target="_blank" rel="noreferrer">profectus/src/game/persistence.ts:245</a></p>',11)]))}const h=t(n,[["render",i]]);export{u as __pageData,h as default};