profectus-docs/assets/api_game_layers_functions_createLayer.md.DV7i6TWU.lean.js

1 line
5.1 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as t,c as o,a0 as a,o as r}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Function: createLayer()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/layers/functions/createLayer.md","filePath":"api/game/layers/functions/createLayer.md","lastUpdated":null}'),c={name:"api/game/layers/functions/createLayer.md"};function d(i,e,s,n,l,p){return r(),o("div",null,e[0]||(e[0]=[a('<p><a href="./../../../">Profectus</a> / <a href="./../">game/layers</a> / createLayer</p><h1 id="function-createlayer" tabindex="-1">Function: createLayer() <a class="header-anchor" href="#function-createlayer" aria-label="Permalink to &quot;Function: createLayer()&quot;"></a></h1><blockquote><p><strong>createLayer</strong>&lt;<code>T</code>&gt;(<code>id</code>, <code>optionsFunc</code>): <code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype" target="_blank" rel="noreferrer"><code>ThisType</code></a>&lt;<a href="./../interfaces/Layer"><code>Layer</code></a> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, keyof <a href="./../interfaces/Layer"><code>Layer</code></a>&gt;&gt;, <code>&quot;display&quot;</code> | <code>&quot;classes&quot;</code> | <code>&quot;style&quot;</code> | <code>&quot;color&quot;</code> | <code>&quot;name&quot;</code> | <code>&quot;minimizable&quot;</code> | <code>&quot;minimizedDisplay&quot;</code> | <code>&quot;forceHideGoBack&quot;</code> | <code>&quot;minWidth&quot;</code>&gt;, keyof <a href="./../interfaces/LayerOptions"><code>LayerOptions</code></a>&gt; &amp; <code>object</code></p></blockquote><p>Lazily creates a layer with the given options.</p><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h2><p>• <strong>T</strong> <em>extends</em> <a href="./../interfaces/LayerOptions"><code>LayerOptions</code></a></p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;"></a></h3><p><code>string</code></p><p>The ID this layer will have. See <a href="./../interfaces/BaseLayer#id">BaseLayer.id</a>.</p><h3 id="optionsfunc" tabindex="-1">optionsFunc <a class="header-anchor" href="#optionsfunc" aria-label="Permalink to &quot;optionsFunc&quot;"></a></h3><p>(<code>layer</code>) =&gt; <code>T</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype" target="_blank" rel="noreferrer"><code>ThisType</code></a>&lt;<a href="./../interfaces/Layer"><code>Layer</code></a> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, keyof <a href="./../interfaces/Layer"><code>Layer</code></a>&gt;&gt;</p><p>Layer options.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype" target="_blank" rel="noreferrer"><code>ThisType</code></a>&lt;<a href="./../interfaces/Layer"><code>Layer</code></a> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, keyof <a href="./../interfaces/Layer"><code>Layer</code></a>&gt;&gt;, <code>&quot;display&quot;</code> | <code>&quot;classes&quot;</code> | <code>&quot;style&quot;</code> | <code>&quot;color&quot;</code> | <code>&quot;name&quot;</code> | <code>&quot;minimizable&quot;</code> | <code>&quot;minimizedDisplay&quot;</code> | <code>&quot;forceHideGoBack&quot;</code> | <code>&quot;minWidth&quot;</code>&gt;, keyof <a href="./../interfaces/LayerOptions"><code>LayerOptions</code></a>&gt; &amp; <code>object</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/layers.tsx#L218" target="_blank" rel="noreferrer">profectus/src/game/layers.tsx:218</a></p>',17)]))}const u=t(c,[["render",d]]);export{h as __pageData,u as default};