FrameContext
pixi-reels / index / FrameContext
Interface: FrameContext
Defined in: frame/FrameBuilder.ts:5
Context passed through the middleware pipeline.
Properties#
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
bufferEnd | readonly | number | Buffer symbols below visible area. | frame/FrameBuilder.ts:13 |
bufferStart | readonly | number | Buffer symbols above visible area. | frame/FrameBuilder.ts:11 |
isSpinning | readonly | boolean | Whether the reel is currently spinning. | frame/FrameBuilder.ts:23 |
metadata | public | Record<string, unknown> | Arbitrary metadata middleware can use to communicate. | frame/FrameBuilder.ts:25 |
reelIndex | readonly | number | Reel column index. | frame/FrameBuilder.ts:7 |
symbols | public | string[] | The symbol array being built (buffer + visible + buffer). Mutable by middleware. | frame/FrameBuilder.ts:15 |
target? | readonly | ColumnTarget | This reel’s target column from setResult() / initialFrame(), if available. Read it with getTargetSlot(target, cell) (cell 0 is the first visible cell; negative cells are buffer-above). | frame/FrameBuilder.ts:21 |
visibleCells | readonly | number | Total visible cells. | frame/FrameBuilder.ts:9 |