profectus-docs/assets/api_modules_game_layers.md.b7e968b4.js

import{_ as e,c as t,o as a,a as r}from"./app.54d5a277.js";const u='{"title":"Module: game/layers","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"GenericLayer","slug":"genericlayer"},{"level":3,"title":"Layer","slug":"layer"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"layers","slug":"layers"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"addLayer","slug":"addlayer"},{"level":3,"title":"createLayer","slug":"createlayer"},{"level":3,"title":"getLayer","slug":"getlayer"},{"level":3,"title":"reloadLayer","slug":"reloadlayer"},{"level":3,"title":"removeLayer","slug":"removelayer"},{"level":3,"title":"setupLayerModal","slug":"setuplayermodal"}],"relativePath":"api/modules/game/layers.md"}',d={},o=r('<h1 id="module-game-layers" tabindex="-1">Module: game/layers <a class="header-anchor" href="#module-game-layers" aria-hidden="true">#</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../interfaces/game/layers.BaseLayer">BaseLayer</a></li><li><a href="../../interfaces/game/layers.LayerEvents">LayerEvents</a></li><li><a href="../../interfaces/game/layers.LayerOptions">LayerOptions</a></li><li><a href="../../interfaces/game/layers.Position">Position</a></li></ul><h2 id="type-aliases" tabindex="-1">Type aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="genericlayer" tabindex="-1">GenericLayer <a class="header-anchor" href="#genericlayer" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericLayer</strong>: <a href="./../features/feature.html#replace"><code>Replace</code></a>&lt;<a href="./layers.html#layer"><code>Layer</code></a>&lt;<a href="../../interfaces/game/layers.LayerOptions"><code>LayerOptions</code></a>&gt;, { <code>minWidth</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>number</code>&gt; ; <code>minimizable</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>name</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code>&gt; }&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#L83" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:83</a></p><hr><h3 id="layer" tabindex="-1">Layer <a class="header-anchor" href="#layer" aria-hidden="true">#</a></h3><p>\u01AC <strong>Layer</strong>&lt;<code>T</code>&gt;: <a href="./../features/feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../interfaces/game/layers.BaseLayer"><code>BaseLayer</code></a>, { <code>classes</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>color</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;color&quot;</code>]&gt; ; <code>display</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>forceHideGoBack</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;forceHideGoBack&quot;</code>]&gt; ; <code>links</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;links&quot;</code>]&gt; ; <code>minWidth</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;minWidth&quot;</code>], <code>600</code>&gt; ; <code>minimizable</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;minimizable&quot;</code>], <code>true</code>&gt; ; <code>name</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;name&quot;</code>], <code>T</code>[<code>&quot;id&quot;</code>]&gt; ; <code>style</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; }&gt;</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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/game/layers.LayerOptions"><code>LayerOptions</code></a></td></tr></tbody></table><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#L68" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:68</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="layers" tabindex="-1">layers <a class="header-anchor" href="#layers" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>layers</strong>: <code>Record</code>&lt;<code>string</code>, <code>Readonly</code>&lt;<a href="./layers.html#genericlayer"><code>GenericLayer</code></a>&gt; | <code>undefined</code>&gt; = <code>{}</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#L34" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:34</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="addlayer" tabindex="-1">addLayer <a class="header-anchor" href="#addlayer" aria-hidden="true">#</a></h3><p>\u25B8 <strong>addLayer</strong>(<code>layer</code>, <code>player</code>): <code>void</code></p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#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>layer</code></td><td style="text-align:left;"><a href="./layers.html#genericlayer"><code>GenericLayer</code></a></td></tr><tr><td style="text-align:left;"><code>player</code></td><td style="text-align:left;"><code>Object</code></td></tr><tr><td style="text-align:left;"><code>player.layers?</code></td><td style="text-align:left;"><code>Record</code>&lt;<code>string</code>, <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" 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#L115" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:115</a></p><hr><h3 id="createlayer" tabindex="-1">createLayer <a class="header-anchor" href="#createlayer" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createLayer</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./layers.html#layer"><code>Layer</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/game/layers.LayerOptions"><code>LayerOptions</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>optionsFunc</code></td><td style="text-align:left;">() =&gt; <code>T</code></td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><a href="./layers.html#layer"><code>Layer</code></a>&lt;<code>T</code>&gt;</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L92" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:92</a></p><hr><h3 id="getlayer" tabindex="-1">getLayer <a class="header-anchor" href="#getlayer" aria-hidden="true">#</a></h3><p>\u25B8 <strong>getLayer</strong>&lt;<code>T</code>&gt;(<code>layerID</code>): <code>T</code></p><h4 id="type-parameters-2" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-2" 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>T</code></td><td style="text-align:left;">extends <a href="./layers.html#genericlayer"><code>GenericLayer</code></a></td></tr></tbody></table><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" 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>layerID</code></td><td style="text-align:left;"><code>string</code></td></tr></tbody></table><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-hidden="true">#</a></h4><p><code>T</code></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L138" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:138</a></p><hr><h3 id="reloadlayer" tabindex="-1">reloadLayer <a class="header-anchor" href="#reloadlayer" aria-hidden="true">#</a></h3><p>\u25B8 <strong>reloadLayer</strong>(<code>layer</code>): <code>void</code></p><h4 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" 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>layer</code></td><td style="text-align:left;"><a href="./layers.html#genericlayer"><code>GenericLayer</code></a></td></tr></tbody></table><h4 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-hidden="true">#</a></h4><p><code>void</code></p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L149" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:149</a></p><hr><h3 id="removelayer" tabindex="-1">removeLayer <a class="header-anchor" href="#removelayer" aria-hidden="true">#</a></h3><p>\u25B8 <strong>removeLayer</strong>(<code>layer</code>): <code>void</code></p><h4 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" 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>layer</code></td><td style="text-align:left;"><a href="./layers.html#genericlayer"><code>GenericLayer</code></a></td></tr></tbody></table><h4 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-hidden="true">#</a></h4><p><code>void</code></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L142" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:142</a></p><hr><h3 id="setuplayermodal" tabindex="-1">setupLayerModal <a class="header-anchor" href="#setuplayermodal" aria-hidden="true">#</a></h3><p>\u25B8 <strong>setupLayerModal</strong>(<code>layer</code>): <code>Object</code></p><h4 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" 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>layer</code></td><td style="text-align:left;"><a href="./layers.html#genericlayer"><code>GenericLayer</code></a></td></tr></tbody></table><h4 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-hidden="true">#</a></h4><p><code>Object</code></p><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>modal</code></td><td style="text-align:left;"><a href="./../features/feature.html#jsxfunction"><code>JSXFunction</code></a></td></tr><tr><td style="text-align:left;"><code>openModal</code></td><td style="text-align:left;"><code>VoidFunction</code></td></tr></tbody></table><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/game/layers.tsx#L156" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:156</a></p>',79),l=[o];function c(s,i,n,h,y,f){return a(),t("div",null,l)}var g=e(d,[["render",c]]);export{u as __pageData,g as default};