profectus-docs/assets/api_modules_game_layers.md.7ee3d623.js

2 lines
24 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: game/layers","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/game/layers.md","lastUpdated":null}'),o={name:"api/modules/game/layers.md"},d=r('<h1 id="module-game-layers" tabindex="-1">Module: game/layers <a class="header-anchor" href="#module-game-layers" aria-label="Permalink to &quot;Module: game/layers&quot;"></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;"></a></h2><ul><li><a href="../../interfaces/game/layers.BaseLayer">BaseLayer</a></li><li><a href="../../interfaces/game/layers.FeatureNode">FeatureNode</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-label="Permalink to &quot;Type Aliases&quot;"></a></h2><h3 id="genericlayer" tabindex="-1">GenericLayer <a class="header-anchor" href="#genericlayer" aria-label="Permalink to &quot;GenericLayer&quot;"></a></h3><p>Ƭ <strong>GenericLayer</strong>: <a href="./../features/feature#replace"><code>Replace</code></a>&lt;<a href="./layers#layer"><code>Layer</code></a>&lt;<a href="../../interfaces/game/layers.LayerOptions"><code>LayerOptions</code></a>&gt;, { <code>minWidth</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>number</code>&gt; ; <code>minimizable</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>name</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code>&gt; }&gt;</p><p>A type that matches any valid <a href="./layers#layer">Layer</a> object.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/layers.tsx#L184" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:184</a></p><hr><h3 id="layer" tabindex="-1">Layer <a class="header-anchor" href="#layer" aria-label="Permalink to &quot;Layer&quot;"></a></h3><p>Ƭ <strong>Layer</strong>&lt;<code>T</code>&gt;: <a href="./../features/feature#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#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>color</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;color&quot;</code>]&gt; ; <code>display</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>forceHideGoBack</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;forceHideGoBack&quot;</code>]&gt; ; <code>minWidth</code>: <a href="./../util/computed#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#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;minimizable&quot;</code>], <code>true</code>&gt; ; <code>minimizedDisplay</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;minimizedDisplay&quot;</code>]&gt; ; <code>name</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTyp