1 line
11 KiB
JavaScript
1 line
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="header-anchor" href="#cells" aria-label="Permalink to "cells""></a></h3><p>• <strong>cells</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>number</code>, <a href="./grid.GridCell"><code>GridCell</code></a>></p><p>A dictionary of cells within this grid.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L264" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:264</a></p><hr><h3 id="getid" tabindex="-1">getID <a class="header-anchor" href="#getid" aria-label="Permalink to "getID""></a></h3><p>• <strong>getID</strong>: (<code>id</code>: <code>string</code> | <code>number</code>, <code>state</code>: <a href="./../../../modules/game/persistence#state"><code>State</code></a>) => <code>string</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>id</code>, <code>state</code>): <code>string</code></p><p>Get the auto-generated ID for identifying a specific cell of this grid that appears in the DOM. Will not persist between refreshes or updates.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></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>id</code></td><td style="text-align:left;"><code>string</code> | <code>number</code></td></tr><tr><td style="text-align:left;"><code>state</code></td><td style="text-align:left;"><a href="./../../../modules/game/persistence#state"><code>State</code></a></td></tr></tbody></table><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><code>string</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L258" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:258</a></p><hr><h3 id="getstate" tabindex="-1">getState <a class="header-anchor" href="#getstate" aria-label="Permalink to "getState""></a></h3><p>• <strong>getState</strong>: (<code>id</code>: <code>string</code> | <code>number</code>) => <a href="./../../../modules/game/persistence#state"><code>State</code></a></p><h4 id="type-declaration-2" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-2" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>id</code>): <a href="./../../../modules/game/persistence#state"><code>State</code></a></p><p>Get the persistent state of the given cell.</p><h5 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></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>id</code></td><td style="text-align:left;"><code>string</code> | <code>number</code></td></tr></tbody></table><h5 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h5><p><a href="./../../../modules/game/persistence#state"><code>State</code></a></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L260" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:260</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L256" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:256</a></p><hr><h3 id="setstate" tabindex="-1">setState <a class="header-anchor" href="#setstate" aria-label="Permalink to "setState""></a></h3><p>• <strong>setState</strong>: (<code>id</code>: <code>string</code> | <code>number</code>, <code>state</code>: <a href="./../../../modules/game/persistence#state"><code>State</code></a>) => <code>void</code></p><h4 id="type-declaration-3" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-3" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>id</code>, <code>state</code>): <code>void</code></p><p>Set the persistent state of the given cell.</p><h5 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></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>id</code></td><td style="text-align:left;"><code>string</code> | <code>number</code></td></tr><tr><td style="text-align:left;"><code>state</code></td><td style="text-align:left;"><a href="./../../../modules/game/persistence#state"><code>State</code></a></td></tr></tbody></table><h5 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L262" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:262</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/grids/grid#gridtype"><code>GridType</code></a></p><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L268" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:268</a></p>',79),i=[d];function s(n,c,l,h,p,f){return a(),t("div",null,i)}const b=e(o,[["render",s]]);export{g as __pageData,b as default};
|