Interface: BaseBoard #

features/boards/board.BaseBoard

A Ref that has been augmented with properties to allow it to be saved and loaded within the player save data object.

Hierarchy #

• Persistent<BoardData>

  ↳ BaseBoard

Properties #

[Component] #

• [Component]: DefineComponent<__VLS_TypePropsToRuntimeProps<{ [PersistentState]: Ref<BoardData> ; classes?: ProcessedComputable<Record<string, boolean>> ; height?: ProcessedComputable<string> ; links: Ref<null | BoardNodeLink[]> ; nodes: Ref<BoardNode[]> ; selectedAction: Ref<null | GenericBoardNodeAction> ; selectedNode: Ref<null | BoardNode> ; style?: ProcessedComputable<StyleValue> ; types: Record<string, GenericNodeType> ; visibility: ProcessedComputable<Visibility> ; width?: ProcessedComputable<string> }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, Record<string, any>, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{ [PersistentState]: Ref<BoardData> ; classes?: ProcessedComputable<Record<string, boolean>> ; height?: ProcessedComputable<string> ; links: Ref<null | BoardNodeLink[]> ; nodes: Ref<BoardNode[]> ; selectedAction: Ref<null | GenericBoardNodeAction> ; selectedNode: Ref<null | BoardNode> ; style?: ProcessedComputable<StyleValue> ; types: Record<string, GenericNodeType> ; visibility: ProcessedComputable<Visibility> ; width?: ProcessedComputable<string> }>>>, {}>

Defined in #

profectus/src/features/boards/board.ts:176

[DefaultValue] #

• [DefaultValue]: BoardData

The value the ref should be set to in a fresh save, or when updating an old save to the current version.

Inherited from #

Persistent.__@DefaultValue@25207

Defined in #

profectus/src/game/persistence.ts:52

[Deleted] #

• [Deleted]: boolean

This is a flag that can be set once the option func is evaluated, to mark that a persistent ref should not be saved to the player save data object.

See

deletePersistent for marking a persistent ref as deleted.

Inherited from #

Persistent.__@Deleted@25209

Defined in #

profectus/src/game/persistence.ts:59

[GatherProps] #

• [GatherProps]: () => Record<string, unknown>

Type declaration #

▸ (): Record<string, unknown>

Returns #

Record<string, unknown>

Defined in #

profectus/src/features/boards/board.ts:177

[PersistentState] #

• [PersistentState]: Ref<BoardData>

A flag that this is a persistent property. Typically a circular reference.

Inherited from #

Persistent.__@PersistentState@25206

Defined in #

profectus/src/game/persistence.ts:50

[RefSymbol] #

• [RefSymbol]: true

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.

Inherited from #

Persistent.__@RefSymbol@17474

Defined in #

node_modules/@vue/runtime-core/node_modules/@vue/reactivity/dist/reactivity.d.ts:198

[StackTrace] #

• [StackTrace]: string

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.

Inherited from #

Persistent.__@StackTrace@25208

Defined in #

profectus/src/game/persistence.ts:54

id #

• id: string

Defined in #

profectus/src/features/boards/board.ts:170

links #

• links: Ref<null | BoardNodeLink[]>

Defined in #

profectus/src/features/boards/board.ts:171

nodes #

• nodes: Ref<BoardNode[]>

Defined in #

profectus/src/features/boards/board.ts:172

selectedAction #

• selectedAction: Ref<null | GenericBoardNodeAction>

Defined in #

profectus/src/features/boards/board.ts:174

selectedNode #

• selectedNode: Ref<null | BoardNode>

Defined in #

profectus/src/features/boards/board.ts:173

type #

• type: typeof BoardType

Defined in #

profectus/src/features/boards/board.ts:175

value #

• value: BoardData

Inherited from #

Persistent.value

Defined in #

node_modules/@vue/runtime-core/node_modules/@vue/reactivity/dist/reactivity.d.ts:192