HwCoin\<TData = `unknown`\>
pixi-reels / index / HwCoin
Interface: HwCoin<TData = unknown>
Defined in: board/HwTypes.ts:23
A coin somewhere on the board. id selects the registered symbol art;
data is an opaque game-layer payload the board never interprets.
Ownership contract: cell and id belong to the board - treat them as
read-only; the board keys its ledger by cell and mutating them is undefined.
data is yours: mutate its contents freely (a doubler does coin.data.value *= 2), that is the intended way to carry live game state on a locked coin.
Type Parameters#
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties#
| Property | Modifier | Type | Defined in |
|---|---|---|---|
cell | readonly | HwCell | board/HwTypes.ts:24 |
data? | public | TData | board/HwTypes.ts:26 |
id | readonly | string | board/HwTypes.ts:25 |