2 lines
11 KiB
JavaScript
2 lines
11 KiB
JavaScript
|
import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: BaseGrid","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/grids/grid.BaseGrid.md","lastUpdated":null}'),o={name:"api/interfaces/features/grids/grid.BaseGrid.md"},d=r('<h1 id="interface-basegrid" tabindex="-1">Interface: BaseGrid <a class="header-anchor" href="#interface-basegrid" aria-label="Permalink to "Interface: BaseGrid""></a></h1><p><a href="./../../../modules/features/grids/grid">features/grids/grid</a>.BaseGrid</p><p>The properties that are added onto a processed BoardOptions to create a Board.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to "[Component]""></a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L270" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:270</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to "[GatherProps]""></a></h3><p>• <strong>[GatherProps]</strong>: () => <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>unknown</code>></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (): <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>unknown</code>></p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><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>unknown</code>></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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L272" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:272</a></p><hr><h3 id="cellstate" tabindex="-1">cellState <a class="header-anchor" href="#cellstate" aria-label="Permalink to "cellState""></a></h3><p>• <strong>cellState</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</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>number</code>, <a href="./../../../modules/game/persistence#state"><code>State</code></a>>></p><p>The persistent state of this grid, which is a dictionary of cell states.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L266" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:266</a></p><hr><h3 id="cells" tabindex="-1">cells <a class="heade
|