1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
import{_ as e,c as d,o as r,a}from"./app.ab34650d.js";const b=JSON.parse('{"title":"Interface: BaseBoard","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Hierarchy","slug":"hierarchy"},{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"[Component]","slug":"component"},{"level":3,"title":"[DefaultValue]","slug":"defaultvalue"},{"level":3,"title":"[Deleted]","slug":"deleted"},{"level":3,"title":"[GatherProps]","slug":"gatherprops"},{"level":3,"title":"[PersistentState]","slug":"persistentstate"},{"level":3,"title":"[RefSymbol]","slug":"refsymbol"},{"level":3,"title":"[StackTrace]","slug":"stacktrace"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"links","slug":"links"},{"level":3,"title":"nodes","slug":"nodes"},{"level":3,"title":"selectedAction","slug":"selectedaction"},{"level":3,"title":"selectedNode","slug":"selectednode"},{"level":3,"title":"type","slug":"type"},{"level":3,"title":"value","slug":"value"}],"relativePath":"api/interfaces/features/boards/board.BaseBoard.md","lastUpdated":null}'),o={name:"api/interfaces/features/boards/board.BaseBoard.md"},t=a('<h1 id="interface-baseboard" tabindex="-1">Interface: BaseBoard <a class="header-anchor" href="#interface-baseboard" aria-hidden="true">#</a></h1><p><a href="./../../../modules/features/boards/board.html">features/boards/board</a>.BaseBoard</p><p>A Ref that has been augmented with properties to allow it to be saved and loaded within the player save data object.</p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-hidden="true">#</a></h2><ul><li><p><a href="./../../../modules/game/persistence.html#persistent"><code>Persistent</code></a><<a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a>></p><p>\u21B3 <strong><code>BaseBoard</code></strong></p></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-hidden="true">#</a></h3><p>\u2022 <strong>[Component]</strong>: <code>DefineComponent</code><<code>__VLS_TypePropsToRuntimeProps</code><{ <code>[PersistentState]</code>: <code>Ref</code><<a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a>> ; <code>classes?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>Record</code><<code>string</code>, <code>boolean</code>>> ; <code>height?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>string</code>> ; <code>links</code>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]> ; <code>nodes</code>: <code>Ref</code><<a href="./board.BoardNode"><code>BoardNode</code></a>[]> ; <code>selectedAction</code>: <code>Ref</code><<code>null</code> | <a href="./../../../modules/features/boards/board.html#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>> ; <code>selectedNode</code>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNode"><code>BoardNode</code></a>> ; <code>style?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>> ; <code>types</code>: <code>Record</code><<code>string</code>, <a href="./../../../modules/features/boards/board.html#genericnodetype"><code>GenericNodeType</code></a>> ; <code>visibility</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>> ; <code>width?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>string</code>> }>, {}, <code>unknown</code>, {}, {}, <code>ComponentOptionsMixin</code>, <code>ComponentOptionsMixin</code>, <code>Record</code><<code>string</code>, <code>any</code>>, <code>string</code>, <code>PublicProps</code>, <code>Readonly</code><<code>ExtractPropTypes</code><<code>__VLS_TypePropsToRuntimeProps</code><{ <code>[PersistentState]</code>: <code>Ref</code><<a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a>> ; <code>classes?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>Record</code><<code>string</code>, <code>boolean</code>>> ; <code>height?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>string</code>> ; <code>links</code>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]> ; <code>nodes</code>: <code>Ref</code><<a href="./board.BoardNode"><code>BoardNode</code></a>[]> ; <code>selectedAction</code>: <code>Ref</code><<code>null</code> | <a href="./../../../modules/features/boards/board.html#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>> ; <code>selectedNode</code>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNode"><code>BoardNode</code></a>> ; <code>style?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>> ; <code>types</code>: <code>Record</code><<code>string</code>, <a href="./../../../modules/features/boards/board.html#genericnodetype"><code>GenericNodeType</code></a>> ; <code>visibility</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>> ; <code>width?</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a><<code>string</code>> }>>>, {}></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L176" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:176</a></p><hr><h3 id="defaultvalue" tabindex="-1">[DefaultValue] <a class="header-anchor" href="#defaultvalue" aria-hidden="true">#</a></h3><p>\u2022 <strong>[DefaultValue]</strong>: <a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a></p><p>The value the ref should be set to in a fresh save, or when updating an old save to the current version.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-hidden="true">#</a></h4><p>Persistent.__@DefaultValue@25207</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/persistence.ts#L52" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:52</a></p><hr><h3 id="deleted" tabindex="-1">[Deleted] <a class="header-anchor" href="#deleted" aria-hidden="true">#</a></h3><p>\u2022 <strong>[Deleted]</strong>: <code>boolean</code></p><p>This is a flag that can be set once the option func is evaluated, to mark that a persistent ref should <em>not</em> be saved to the player save data object.</p><p><strong><code>See</code></strong></p><p>deletePersistent for marking a persistent ref as deleted.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-hidden="true">#</a></h4><p>Persistent.__@Deleted@25209</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/persistence.ts#L59" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:59</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-hidden="true">#</a></h3><p>\u2022 <strong>[GatherProps]</strong>: () => <code>Record</code><<code>string</code>, <code>unknown</code>></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</a></h4><p>\u25B8 (): <code>Record</code><<code>string</code>, <code>unknown</code>></p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h5><p><code>Record</code><<code>string</code>, <code>unknown</code>></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L177" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:177</a></p><hr><h3 id="persistentstate" tabindex="-1">[PersistentState] <a class="header-anchor" href="#persistentstate" aria-hidden="true">#</a></h3><p>\u2022 <strong>[PersistentState]</strong>: <code>Ref</code><<a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a>></p><p>A flag that this is a persistent property. Typically a circular reference.</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-hidden="true">#</a></h4><p>Persistent.__@PersistentState@25206</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/persistence.ts#L50" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:50</a></p><hr><h3 id="refsymbol" tabindex="-1">[RefSymbol] <a class="header-anchor" href="#refsymbol" aria-hidden="true">#</a></h3><p>\u2022 <strong>[RefSymbol]</strong>: <code>true</code></p><p>Type differentiator only. We need this to be in public d.ts but don't want it to show up in IDE autocomplete, so we use a private Symbol instead.</p><h4 id="inherited-from-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-hidden="true">#</a></h4><p>Persistent.__@RefSymbol@17474</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p>node_modules/@vue/runtime-core/node_modules/@vue/reactivity/dist/reactivity.d.ts:198</p><hr><h3 id="stacktrace" tabindex="-1">[StackTrace] <a class="header-anchor" href="#stacktrace" aria-hidden="true">#</a></h3><p>\u2022 <strong>[StackTrace]</strong>: <code>string</code></p><p>The stack trace of where the persistent ref was created. This is used for debugging purposes when a persistent ref is created but not placed in its layer object.</p><h4 id="inherited-from-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-hidden="true">#</a></h4><p>Persistent.__@StackTrace@25208</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/persistence.ts#L54" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:54</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-hidden="true">#</a></h3><p>\u2022 <strong>id</strong>: <code>string</code></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L170" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:170</a></p><hr><h3 id="links" tabindex="-1">links <a class="header-anchor" href="#links" aria-hidden="true">#</a></h3><p>\u2022 <strong>links</strong>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNodeLink"><code>BoardNodeLink</code></a>[]></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L171" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:171</a></p><hr><h3 id="nodes" tabindex="-1">nodes <a class="header-anchor" href="#nodes" aria-hidden="true">#</a></h3><p>\u2022 <strong>nodes</strong>: <code>Ref</code><<a href="./board.BoardNode"><code>BoardNode</code></a>[]></p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L172" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:172</a></p><hr><h3 id="selectedaction" tabindex="-1">selectedAction <a class="header-anchor" href="#selectedaction" aria-hidden="true">#</a></h3><p>\u2022 <strong>selectedAction</strong>: <code>Ref</code><<code>null</code> | <a href="./../../../modules/features/boards/board.html#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L174" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:174</a></p><hr><h3 id="selectednode" tabindex="-1">selectedNode <a class="header-anchor" href="#selectednode" aria-hidden="true">#</a></h3><p>\u2022 <strong>selectedNode</strong>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNode"><code>BoardNode</code></a>></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L173" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:173</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-hidden="true">#</a></h3><p>\u2022 <strong>type</strong>: typeof <a href="./../../../modules/features/boards/board.html#boardtype"><code>BoardType</code></a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L175" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:175</a></p><hr><h3 id="value" tabindex="-1">value <a class="header-anchor" href="#value" aria-hidden="true">#</a></h3><p>\u2022 <strong>value</strong>: <a href="./../../../modules/features/boards/board.html#boarddata"><code>BoardData</code></a></p><h4 id="inherited-from-5" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-5" aria-hidden="true">#</a></h4><p>Persistent.value</p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" aria-hidden="true">#</a></h4><p>node_modules/@vue/runtime-core/node_modules/@vue/reactivity/dist/reactivity.d.ts:192</p>',98),s=[t];function c(n,i,h,l,f,u){return r(),d("div",null,s)}var g=e(o,[["render",c]]);export{b as __pageData,g as default};
|