ReelGridConfig
pixi-reels / index / ReelGridConfig
Interface: ReelGridConfig
Defined in: config/types.ts:447
Configuration for the reel grid layout.
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
bufferSymbols? | number | Number of buffer symbols above and below the visible area. Default: 1. | config/types.ts:479 |
multiways? | MultiWaysConfig | MultiWays configuration. Set by builder.multiways(...). When present: - setShape(cellsPerReel) becomes callable mid-spin - AdjustPhase is inserted between SPIN and STOP - big-symbol registration throws at build time | config/types.ts:486 |
reelAnchor? | ReelAnchor | How short reels align vertically inside the tallest reel’s height. Default: ‘center’. | config/types.ts:475 |
reelCount | number | Number of reel columns. | config/types.ts:449 |
reelExtents? | number[] | Per-reel pixel-box heights. Length MUST equal reelCount when set. For MultiWays: every entry is the same fixed reel height. For static pyramids: defaults to visibleCellsPerReel[i] * symbolHeight. | config/types.ts:470 |
symbolGap? | { x: number; y: number; } | Gap between symbols. Default: { x: 0, y: 0 }. | config/types.ts:477 |
symbolGap.x | number | - | config/types.ts:477 |
symbolGap.y | number | - | config/types.ts:477 |
symbolHeight | number | Symbol height in pixels. Used as the SPIN-time uniform cell height. | config/types.ts:464 |
symbolWidth | number | Symbol width in pixels. | config/types.ts:462 |
visibleCells | number | Default visible cells when all reels are uniform. Ignored if visibleCellsPerReel is set. | config/types.ts:454 |
visibleCellsPerReel? | number[] | Per-reel cell counts (static shape). Length MUST equal reelCount. Example: [3, 5, 5, 5, 3] for a pyramid layout. Mutually exclusive with the scalar visibleCells field at the builder level. | config/types.ts:460 |