pixi-reels

SymbolPool

pixi-reels


pixi-reels / index / SymbolPool

Interface: SymbolPool

Defined in: frame/SymbolPool.ts:10

What the engine is allowed to draw when it needs a random symbol.

Every cell the game does not name explicitly (the strip streaming past during a spin, and the buffer cells parked either side of the visible window) is filled from a weighted draw. A pool narrows that draw: it layers weight overrides on top of the registered builder.weights(...) table and hard-excludes ids that must never show up.

Properties#

PropertyTypeDescriptionDefined in
exclude?readonly string[]Symbol ids that must never be drawn in this pool.frame/SymbolPool.ts:18
weights?Readonly<Record<string, number>>Weight overrides by symbol id, layered over the registered weights. A weight of 0 removes the symbol from this pool as surely as listing it in exclude does.frame/SymbolPool.ts:16