FrameContext
pixi-reels
pixi-reels / index / FrameContext
Interface: FrameContext
Defined in: frame/FrameBuilder.ts:4
Context passed through the middleware pipeline.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|
bufferAbove | readonly | number | Buffer symbols above visible area. | frame/FrameBuilder.ts:10 |
bufferBelow | readonly | number | Buffer symbols below visible area. | frame/FrameBuilder.ts:12 |
isSpinning | readonly | boolean | Whether the reel is currently spinning. | frame/FrameBuilder.ts:18 |
metadata | public | Record<string, unknown> | Arbitrary metadata middleware can use to communicate. | frame/FrameBuilder.ts:20 |
reelIndex | readonly | number | Reel column index. | frame/FrameBuilder.ts:6 |
symbols | public | string[] | The symbol array being built (buffer + visible + buffer). Mutable by middleware. | frame/FrameBuilder.ts:14 |
targetSymbols? | readonly | string[] | Target symbols from setResult() (visible rows only), if available. | frame/FrameBuilder.ts:16 |
visibleRows | readonly | number | Total visible rows. | frame/FrameBuilder.ts:8 |