1 line
7.3 KiB
JavaScript
1 line
7.3 KiB
JavaScript
import{_ as a,c as r,a0 as t,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: BaseLayer","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/layers/interfaces/BaseLayer.md","filePath":"api/game/layers/interfaces/BaseLayer.md","lastUpdated":null}'),n={name:"api/game/layers/interfaces/BaseLayer.md"};function s(i,e,d,c,l,h){return o(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../">Profectus</a> / <a href="./../">game/layers</a> / BaseLayer</p><h1 id="interface-baselayer" tabindex="-1">Interface: BaseLayer <a class="header-anchor" href="#interface-baselayer" aria-label="Permalink to "Interface: BaseLayer""></a></h1><p>The properties that are added onto a processed <a href="./LayerOptions">LayerOptions</a> to create a <a href="./Layer">Layer</a></p><h2 id="extended-by" tabindex="-1">Extended by <a class="header-anchor" href="#extended-by" aria-label="Permalink to "Extended by""></a></h2><ul><li><a href="./Layer"><code>Layer</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="emit" tabindex="-1">emit() <a class="header-anchor" href="#emit" aria-label="Permalink to "emit()""></a></h3><blockquote><p><strong>emit</strong>: <<code>K</code>>(...<code>args</code>) => <code>void</code></p></blockquote><p>A function to emit a <a href="./LayerEvents">LayerEvents</a> event to this layer.</p><h4 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type Parameters""></a></h4><p>• <strong>K</strong> <em>extends</em> keyof <a href="./LayerEvents"><code>LayerEvents</code></a></p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="args" tabindex="-1">args <a class="header-anchor" href="#args" aria-label="Permalink to "args""></a></h5><p>...[<code>K</code>, <code>...Parameters<LayerEvents[K]>[]</code>]</p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></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/game/layers.tsx#L159" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:159</a></p><hr><h3 id="emitter" tabindex="-1">emitter <a class="header-anchor" href="#emitter" aria-label="Permalink to "emitter""></a></h3><blockquote><p><strong>emitter</strong>: <code>Emitter</code><<a href="./LayerEvents"><code>LayerEvents</code></a>></p></blockquote><p>An emitter for sending <a href="./LayerEvents">LayerEvents</a> events for this layer.</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/game/layers.tsx#L155" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:155</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><blockquote><p><strong>id</strong>: <code>string</code></p></blockquote><p>The ID of the layer. Populated from the <a href="./../functions/createLayer">createLayer</a> parameters. Used for saving and tracking open tabs.</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/game/layers.tsx#L151" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:151</a></p><hr><h3 id="minimized" tabindex="-1">minimized <a class="header-anchor" href="#minimized" aria-label="Permalink to "minimized""></a></h3><blockquote><p><strong>minimized</strong>: <a href="./../../persistence/type-aliases/Persistent"><code>Persistent</code></a><<code>boolean</code>></p></blockquote><p>A persistent ref tracking if the tab is minimized or not.</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/game/layers.tsx#L153" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:153</a></p><hr><h3 id="nodes" tabindex="-1">nodes <a class="header-anchor" href="#nodes" aria-label="Permalink to "nodes""></a></h3><blockquote><p><strong>nodes</strong>: <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>undefined</code> | <a href="./FeatureNode"><code>FeatureNode</code></a>>, <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>undefined</code> | <a href="./FeatureNode"><code>FeatureNode</code></a>>></p></blockquote><p>A map of <a href="./FeatureNode">FeatureNode</a>s present in this layer's Context component.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/layers.tsx#L161" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:161</a></p><hr><h3 id="on" tabindex="-1">on() <a class="header-anchor" href="#on" aria-label="Permalink to "on()""></a></h3><blockquote><p><strong>on</strong>: (...<code>args</code>) => <code>Unsubscribe</code></p></blockquote><p>A function to register an event listener on <a href="./BaseLayer#emitter">emitter</a>.</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><h5 id="args-1" tabindex="-1">args <a class="header-anchor" href="#args-1" aria-label="Permalink to "args""></a></h5><p>...[keyof <a href="./LayerEvents"><code>LayerEvents</code></a>, (<code>diff</code>) => <code>void</code> | (<code>diff</code>) => <code>void</code> | (<code>diff</code>) => <code>void</code>]</p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><code>Unsubscribe</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/layers.tsx#L157" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:157</a></p>',53)]))}const m=a(n,[["render",s]]);export{p as __pageData,m as default};
|