2 lines
5.3 KiB
JavaScript
2 lines
5.3 KiB
JavaScript
|
import{_ as e,c as o,o as t,N as a}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BaseInfobox","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/infoboxes/infobox.BaseInfobox.md","lastUpdated":null}'),r={name:"api/interfaces/features/infoboxes/infobox.BaseInfobox.md"},n=a('<h1 id="interface-baseinfobox" tabindex="-1">Interface: BaseInfobox <a class="header-anchor" href="#interface-baseinfobox" aria-label="Permalink to "Interface: BaseInfobox""></a></h1><p><a href="./../../../modules/features/infoboxes/infobox">features/infoboxes/infobox</a>.BaseInfobox</p><p>The properties that are added onto a processed <a href="./infobox.InfoboxOptions">InfoboxOptions</a> to create an <a href="./../../../modules/features/infoboxes/infobox#infobox">Infobox</a>.</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/infoboxes/infobox.ts#L58" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:58</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/infoboxes/infobox.ts#L60" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:60</a></p><hr><h3 id="collapsed" tabindex="-1">collapsed <a class="header-anchor" href="#collapsed" aria-label="Permalink to "collapsed""></a></h3><p>• <strong>collapsed</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a><<code>boolean</code>></p><p>Whether or not this infobox is collapsed.</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/infoboxes/infobox.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:54</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong
|