profectus-docs/assets/api_interfaces_game_layers.BaseLayer.md.a132813d.js

1 line
5 KiB
JavaScript

import{_ as e,c as t,o as a,a as r}from"./app.8e8712eb.js";const g='{"title":"Interface: BaseLayer","description":"","frontmatter":{},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"emitter","slug":"emitter"},{"level":3,"title":"minimized","slug":"minimized"},{"level":3,"title":"on","slug":"on"},{"level":2,"title":"Methods","slug":"methods"},{"level":3,"title":"emit","slug":"emit"}],"relativePath":"api/interfaces/game/layers.BaseLayer.md"}',d={},n=r('<h1 id="interface-baselayer" tabindex="-1">Interface: BaseLayer <a class="header-anchor" href="#interface-baselayer" aria-hidden="true">#</a></h1><p><a href="./../../modules/game/layers.html">game/layers</a>.BaseLayer</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="emitter" tabindex="-1">emitter <a class="header-anchor" href="#emitter" aria-hidden="true">#</a></h3><p>\u2022 <strong>emitter</strong>: <code>Emitter</code>&lt;<a href="./layers.LayerEvents"><code>LayerEvents</code></a>&gt;</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L63" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:63</a></p><hr><h3 id="minimized" tabindex="-1">minimized <a class="header-anchor" href="#minimized" aria-hidden="true">#</a></h3><p>\u2022 <strong>minimized</strong>: <a href="./../../modules/game/persistence.html#persistentref"><code>PersistentRef</code></a>&lt;<code>boolean</code>&gt;</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L62" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:62</a></p><hr><h3 id="on" tabindex="-1">on <a class="header-anchor" href="#on" aria-hidden="true">#</a></h3><p>\u2022 <strong>on</strong>: (...<code>args</code>: [event: keyof LayerEvents, cb: Function | Function | Function]) =&gt; <code>Unsubscribe</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</a></h4><p>\u25B8 (...<code>args</code>): <code>Unsubscribe</code></p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h5><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>...args</code></td><td style="text-align:left;">[event: keyof LayerEvents, cb: Function | Function | Function]</td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h5><p><code>Unsubscribe</code></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L64" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:64</a></p><h2 id="methods" tabindex="-1">Methods <a class="header-anchor" href="#methods" aria-hidden="true">#</a></h2><h3 id="emit" tabindex="-1">emit <a class="header-anchor" href="#emit" aria-hidden="true">#</a></h3><p>\u25B8 <strong>emit</strong>&lt;<code>K</code>&gt;(<code>event</code>, ...<code>args</code>): <code>void</code></p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</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>K</code></td><td style="text-align:left;">extends keyof <a href="./layers.LayerEvents"><code>LayerEvents</code></a></td></tr></tbody></table><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</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>event</code></td><td style="text-align:left;"><code>K</code></td></tr><tr><td style="text-align:left;"><code>...args</code></td><td style="text-align:left;"><code>Parameters</code>&lt;<a href="./layers.LayerEvents"><code>LayerEvents</code></a>[<code>K</code>]&gt;</td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><code>void</code></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L65" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:65</a></p>',34),s=[n];function i(o,h,c,l,f,p){return a(),t("div",null,s)}var y=e(d,[["render",i]]);export{g as __pageData,y as default};