CellPinOptions
pixi-reels / index / CellPinOptions
Interface: CellPinOptions
Defined in: pins/CellPin.ts:84
Options accepted by reelSet.pin().
Calling pin() mid-reshape (from a shape:changed, pin:migrated, or
adjust:start event handler) is allowed and well-defined: the new pin is
placed at the cell you pass, and originRow defaults to the post-reshape
row (i.e. whatever row is now, on the new shape). If you want the pin
to remember a different origin, pass originRow explicitly. The pin
participates in the next migration cycle like any other pin.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
migration? | PinMigration | MultiWays migration policy. Default 'origin'. clamp + restore. Set to 'frozen' for “lock at current row, never restore” semantics. See PinMigration. | pins/CellPin.ts:102 |
originRow? | number | Original row for MultiWays pin migration. Defaults to the row at pin placement. With migration === 'origin' (default), the pin’s row migrates back toward this value when the shape grows enough to fit it; with migration === 'frozen' this gets overwritten on every clamp so the pin doesn’t restore. | pins/CellPin.ts:96 |
payload? | Record<string, unknown> | Arbitrary per-instance data. | pins/CellPin.ts:88 |
turns? | number | "eval" | "permanent" | Defaults to ‘permanent’. | pins/CellPin.ts:86 |