pixi-reels

SymbolZIndexContext

pixi-reels


pixi-reels / index / SymbolZIndexContext

Interface: SymbolZIndexContext

Defined in: config/types.ts:700

Everything a SymbolZIndexResolver is asked about. Built by the reel once per symbol per z-index refresh.

Properties#

PropertyTypeDescriptionDefined in
arrayIndexnumberIndex in the reel’s strip array - what the default formula uses.config/types.ts:707
atRestbooleantrue while the reel is fully at rest, i.e. unmask symbols are lifted into the viewport’s shared unmaskedContainer, where a z-index orders them against every other lifted symbol in the set. false from the first frame of motion to the landing.config/types.ts:721
defaultZIndexnumberWhat the engine would have used without a resolver: symbolData.zIndex * 100 + cellStackingIndex. Return it for ids the resolver does not care about.config/types.ts:727
reelCountnumber-config/types.ts:705
reelIndexnumber-config/types.ts:704
symbolDataSymbolDataResolved static metadata for this id (weight / zIndex / unmask / size).config/types.ts:703
symbolIdstring-config/types.ts:701
visibleCellnumber | null0-based visible cell, or null for a buffer slot. A big symbol reports the cell its anchor sits in.config/types.ts:712
visibleCellsnumberVisible cells on THIS reel (varies per reel on a pyramid / MultiWays set).config/types.ts:714