HoldAndWinBoardConfig\<TData\>

pixi-reels / index / HoldAndWinBoardConfig

Interface: HoldAndWinBoardConfig<TData>

Defined in: board/HoldAndWinBoard.ts:27

Internal config produced by HoldAndWinBuilder.build.

Type Parameters#

Type Parameter
`TData`

Properties#

Property	Type	Description	Defined in
`anticipateWhen`	\| ((`state`: { `capacity`: `number`; `locked`: `number`; `respinsLeft`: `number`; }) => `boolean`) \| `null`	-	board/HoldAndWinBoard.ts:54
`cellHeight`	`number`	-	board/HoldAndWinBoard.ts:31
`cellWidth`	`number`	-	board/HoldAndWinBoard.ts:30
`cellZIndex`	\| `BoardCellZIndexResolver` \| `null`	Order of the cells’ lifted art. See `HoldAndWinBuilder.cellZIndex`.	board/HoldAndWinBoard.ts:44
`chrome`	\| ((`g`: `Graphics`, `width`: `number`, `height`: `number`) => `void`) \| `null`	-	board/HoldAndWinBoard.ts:57
`cols`	`number`	-	board/HoldAndWinBoard.ts:28
`columnGap`	`number`	-	board/HoldAndWinBoard.ts:32
`configurator`	(`registry`: `SymbolRegistry`) => `void`	-	board/HoldAndWinBoard.ts:45
`direction?`	`Direction`	-	board/HoldAndWinBoard.ts:62
`emptyId`	`string`	-	board/HoldAndWinBoard.ts:34
`inactive`	`HwCell`[]	Cells built dormant; see `HoldAndWinBuilder.inactive`.	board/HoldAndWinBoard.ts:36
`inactiveId`	`string`	Symbol shown on a dormant cell.	board/HoldAndWinBoard.ts:38
`initialSpeed`	`string`	-	board/HoldAndWinBoard.ts:50
`lockAnimation`	`HwLockAnimationRule`<`TData`>	-	board/HoldAndWinBoard.ts:40
`mask`	\| ((`cell`: `HwCell`, `info`: `BoardCellMaskInfo`) => `MaskStrategy`) \| `null`	Per-cell mask factory. See `HoldAndWinBuilder.cellMask`.	board/HoldAndWinBoard.ts:59
`orientation?`	`Orientation`	Travel axis for each cell’s own strip. See `HoldAndWinBuilder.axis`.	board/HoldAndWinBoard.ts:61
`respins`	`number`	-	board/HoldAndWinBoard.ts:39
`rng`	(() => `number`) \| `null`	-	board/HoldAndWinBoard.ts:64
`rowGap`	`number`	-	board/HoldAndWinBoard.ts:33
`rows`	`number`	-	board/HoldAndWinBoard.ts:29
`skipMode`	`SkipMode`	What `skip()` does when the call does not say. See `HoldAndWinBuilder.skipMode`.	board/HoldAndWinBoard.ts:53
`speeds`	`Record`<`string`, `SpeedProfile`>	Named base profiles, registered into every cell. See `HoldAndWinBuilder.speeds`.	board/HoldAndWinBoard.ts:49
`stagger`	(`reel`: `number`, `cell`: `number`, `speed`: `string`) => `number`	-	board/HoldAndWinBoard.ts:51
`symbolData`	\| `Record`<`string`, `Partial`<`SymbolData`>> \| `null`	-	board/HoldAndWinBoard.ts:47
`symbolZIndex`	`SymbolZIndexResolver` \| `null`	Per-symbol z-index resolver for every cell. See `HoldAndWinBuilder.symbolZIndex`.	board/HoldAndWinBoard.ts:42
`ticker`	`Ticker`	-	board/HoldAndWinBoard.ts:63
`weights`	`Record`<`string`, `number`> \| `null`	-	board/HoldAndWinBoard.ts:46