PR pixi-reels

ColumnTarget

pixi-reels


pixi-reels / index / ColumnTarget

Interface: ColumnTarget

Defined in: frame/ColumnTarget.ts:9

Per-reel target shape for ReelSet.setResult and ReelSetBuilder.initialFrame. One object per reel.

Use this for every result grid that crosses a worker, network, or serializer boundary. The shape survives structuredClone, JSON, and postMessage round-trips.

Properties

PropertyTypeDescriptionDefined in
bufferAbove?(string | undefined)[]Buffer-above target symbols. bufferAbove[0] is the slot closest to the visible top row; later indices go further above. Up to bufferSymbols entries are honored. Big-symbol anchors may sit here. Place a multi-cell symbol id (one whose SymbolData.size.h > 1) at any bufferAbove[i] and the coordinator paints OCCUPIED stubs across the rest of the block, including any cells that fall in visible. The block must fit on the strip end-to-end (anchor.row + h <= visibleRows + bufferBelow); the portion above visible is clipped by the reel mask. This is the “tail-visible” partial-landing pattern.frame/ColumnTarget.ts:25
bufferBelow?(string | undefined)[]Buffer-below target symbols. bufferBelow[0] is the slot closest to the visible bottom row; later indices go further below. Up to bufferSymbols entries are honored. Big-symbol stubs may sit here. A block anchored at the last visible row with h > 1 will have its non-anchor cells spill into bufferBelow automatically. You can also place an anchor here, but the block then lies entirely off-screen (legal but invisible).frame/ColumnTarget.ts:36
visiblestring[]Visible-area target symbols, indexed 0 ... visibleRows-1.frame/ColumnTarget.ts:11