ReelConfig
pixi-reels / index / ReelConfig
Interface: ReelConfig
Defined in: core/Reel.ts:143
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
axis? | ReelAxis | Travel projection for this reel. Defaults to vertical/forward. | core/Reel.ts:169 |
bufferEnd | number | - | core/Reel.ts:149 |
bufferStart | number | - | core/Reel.ts:148 |
cellStacking? | Stacking | - | core/Reel.ts:192 |
curve? | ReelCurveInput | Cylinder curvature for this reel. Omitted or 0 leaves it dead flat and costs nothing. See ReelCurveConfig. | core/Reel.ts:202 |
curveBleed? | number | Cross-axis room, in pixels per side, for art that is wider than its cell. Warp mode only; set by ReelSetBuilder.curveBleed(). | core/Reel.ts:221 |
curveFocus? | number | Reel-local cross coordinate the curve’s perspective converges on. Set by the builder from curveFocus(...); omitted means the reel’s own centre. | core/Reel.ts:207 |
curveRenderer? | Renderer | Renderer to draw the reel’s warp texture with. Present only when the set was built with curveMode('warp') and a renderer(...); its presence is what switches this reel from the per-symbol projection to the whole-reel vertex warp. | core/Reel.ts:214 |
curveTicker? | Ticker | Ticker driving the warp’s per-frame texture refresh. Warp mode only. | core/Reel.ts:216 |
extent? | number | Pixel height of this reel’s box. Used for MultiWays cell-height derivation (extent / visibleCells). Defaults to visibleCells * symbolHeight. | core/Reel.ts:175 |
gsap? | typeof gsap | The gsap instance this reel’s tweens live on. Defaults to the one resolved at lib-load time; ReelSetBuilder.gsap(...) overrides it PER SET, so two sets on one stage can use different instances. | core/Reel.ts:191 |
initialSymbols | string[] | - | core/Reel.ts:161 |
mainOffset? | number | Y offset of this reel relative to the viewport’s top edge. Set by the builder so jagged shapes (pyramids) align according to reelAnchor. Default 0. | core/Reel.ts:167 |
reelCount? | number | Reels in the set. Reported to symbols and z-index resolvers. Default 1. | core/Reel.ts:146 |
reelIndex | number | - | core/Reel.ts:144 |
reelStacking? | Stacking | Render order of reels within the set. Default 'ascending'. the last reel draws in front. | core/Reel.ts:197 |
spinCellSize? | number | SPIN-time uniform cell height. During SPIN every reel uses this same height. AdjustPhase later swaps to per-reel extent / visibleCells. Defaults to symbolHeight. | core/Reel.ts:181 |
symbolGapX | number | - | core/Reel.ts:152 |
symbolGapY | number | - | core/Reel.ts:153 |
symbolHeight | number | - | core/Reel.ts:151 |
symbolsData | Record<string, SymbolData> | - | core/Reel.ts:154 |
symbolWidth | number | - | core/Reel.ts:150 |
symbolZIndex? | SymbolZIndexResolver | Replaces the engine’s symbol z-index formula. See ReelSetBuilder.symbolZIndex. Omitted: symbolData.zIndex * 100 + cellStackingIndex. | core/Reel.ts:160 |
visibleCells | number | - | core/Reel.ts:147 |