HoldAndWinBoardEvents\<TData\>

pixi-reels / index / HoldAndWinBoardEvents

Type Alias: HoldAndWinBoardEvents<TData>

type HoldAndWinBoardEvents<TData> = {
  board:full: [{
     coins: HwCoin<TData>[];
  }];
  cell:landed: [{
     cell: HwCell;
     coin: HwCoin<TData> | null;
  }];
  coin:locked: [{
     capacity: number;
     coin: HwCoin<TData>;
     locked: number;
  }];
  coin:released: [{
     coin: HwCoin<TData>;
     remaining: number;
  }];
  feature:end: [{
     coins: HwCoin<TData>[];
     full: boolean;
     rounds: number;
  }];
  feature:enter: [{
     respins: number;
     seed: HwCoin<TData>[];
  }];
  feature:reset: [{
     clearedCoins: number;
  }];
  feature:skip: [{
     inFlight: number;
  }];
  respin:end: [{
     hits: HwCoin<TData>[];
     respinsLeft: number;
     round: number;
  }];
  respin:start: [{
     respinsLeft: number;
     round: number;
     spinning: HwCell[];
  }];
  respins:changed: [{
     reason: HwRespinReason;
     value: number;
  }];
};

Defined in: board/HwTypes.ts:41

Type Parameters

Type Parameter	Default type
`TData`	`unknown`

Properties

Property	Type	Description	Defined in
`board:full`	[{ `coins`: `HwCoin`<`TData`>[]; }]	-	board/HwTypes.ts:51
`cell:landed`	[{ `cell`: `HwCell`; `coin`: `HwCoin`<`TData`> \| `null`; }]	Fires per cell, in landing (stagger) order. `coin` is null on a miss.	board/HwTypes.ts:45
`coin:locked`	[{ `capacity`: `number`; `coin`: `HwCoin`<`TData`>; `locked`: `number`; }]	-	board/HwTypes.ts:46
`coin:released`	[{ `coin`: `HwCoin`<`TData`>; `remaining`: `number`; }]	Fired by `release()` — the collect / fly-away moment.	board/HwTypes.ts:48
`feature:end`	[{ `coins`: `HwCoin`<`TData`>[]; `full`: `boolean`; `rounds`: `number`; }]	-	board/HwTypes.ts:60
`feature:enter`	[{ `respins`: `number`; `seed`: `HwCoin`<`TData`>[]; }]	-	board/HwTypes.ts:42
`feature:reset`	[{ `clearedCoins`: `number`; }]	Fired by `reset()` — a hard clear back to idle. Distinct from `coin:released` (which means “collect this coin”); listeners that maintain derived state from events (HUD totals, meters) clear it here without triggering collect.	board/HwTypes.ts:59
`feature:skip`	[{ `inFlight`: `number`; }]	Fired by `skip()` so the game layer can cut its own flights / collect short.	board/HwTypes.ts:53
`respin:end`	[{ `hits`: `HwCoin`<`TData`>[]; `respinsLeft`: `number`; `round`: `number`; }]	-	board/HwTypes.ts:50
`respin:start`	[{ `respinsLeft`: `number`; `round`: `number`; `spinning`: `HwCell`[]; }]	-	board/HwTypes.ts:43
`respins:changed`	[{ `reason`: `HwRespinReason`; `value`: `number`; }]	-	board/HwTypes.ts:49