pixi-reels

BoardGridOptions

pixi-reels


pixi-reels / index / BoardGridOptions

Interface: BoardGridOptions

Defined in: board/BoardGrid.ts:28

Properties

PropertyTypeDescriptionDefined in
cellSizenumberCell edge length in pixels.board/BoardGrid.ts:33
chrome?(g: Graphics, size: number) => voidPer-cell background, drawn behind each reel.board/BoardGrid.ts:49
colsnumberGrid dimensions.board/BoardGrid.ts:30
emptyId?stringId a cell shows when blank — also placed in the off-window buffers. Default 'empty'.board/BoardGrid.ts:37
gap?numberGap between cells. Default 4.board/BoardGrid.ts:35
profiles?Record<string, BoardProfile>Named speed profiles, each registered on every cell and selected by name via BoardGrid.setProfile. A value may be a flat profile or a per-cell function (for stagger waves). Defaults to a single 'default' profile, which is the active one until you setProfile otherwise.board/BoardGrid.ts:56
rng?() => numberInjected RNG for the spin strips (deterministic demos / tests).board/BoardGrid.ts:45
rowsnumber-board/BoardGrid.ts:31
symbolData?Record<string, Partial<SymbolData>>Per-symbol engine overrides, exactly like ReelSetBuilder.symbolData.board/BoardGrid.ts:43
symbols(registry: SymbolRegistry) => voidRegister symbol classes, exactly like ReelSetBuilder.symbols. Applied to every cell.board/BoardGrid.ts:39
tickerTickerDrives every cell’s reel — required.board/BoardGrid.ts:47
weights?Record<string, number>Strip weights during the spin.board/BoardGrid.ts:41