pixi-reels

PinMigration

pixi-reels


pixi-reels / index / PinMigration

Type Alias: PinMigration

type PinMigration = "origin" | "frozen";

Defined in: pins/CellPin.ts:40

How a pin behaves when a MultiWays reshape changes the cell count of its reel. Non-MultiWays slots never reshape, so this value is irrelevant there.

  • 'origin' (default). the pin migrates to min(originCell, newCells - 1) on every reshape. Clamps when the shape is too small; restores to the origin when the shape grows back. Prevents wander. a pin at originCell=3 clamped to cell 2 on a 3-cell shape returns to cell 3 on a later 5-cell shape. The right default for sticky wilds, trailing wilds, and any “this position has meaning” mechanic.

  • 'frozen'. the pin stays at its current cell if the new shape fits, otherwise clamps to the last visible cell AND updates originCell to the clamped position so it never restores. Use when the pin’s cell should be locked to wherever it is now, regardless of future shape changes (e.g. a walking-wild on MultiWays where the wild’s “current cell” IS the source of truth. restoring to a pre-walk cell would undo the walk).