pixi-reels

HoldAndWinBoardEvents\<TData = `unknown`\>

pixi-reels

pixi-reels / index / HoldAndWinBoardEvents

Type Alias: HoldAndWinBoardEvents<TData = unknown>

type HoldAndWinBoardEvents<TData = unknown> = {
  board:full: [{
     coins: HwCoin<TData>[];
  }];
  cell:landed: [{
     cell: HwCell;
     coin: HwCoin<TData> | null;
  }];
  cells:activated: [{
     capacity: number;
     cells: HwCell[];
  }];
  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;
     mode: SkipMode;
     payload?: unknown;
     speed?: string;
  }];
  respin:end: [{
     hits: HwCoin<TData>[];
     respinsLeft: number;
     round: number;
  }];
  respin:start: [{
     respinsLeft: number;
     round: number;
     spinning: HwCell[];
  }];
  respins:changed: [{
     reason: HwRespinReason;
     value: number;
  }];
  speed:changed: [{
     name: string;
     previous: string;
  }];
};

Defined in: board/HwTypes.ts:42

Type Parameters#

Type ParameterDefault type
TDataunknown

Properties#

PropertyTypeDescriptionDefined in
board:full[{ coins: HwCoin<TData>[]; }]-board/HwTypes.ts:52
cell:landed[{ cell: HwCell; coin: HwCoin<TData> | null; }]Fires per cell, in landing (stagger) order. coin is null on a miss.board/HwTypes.ts:46
cells:activated[{ capacity: number; cells: HwCell[]; }]Fired by activate() - dormant cells joined the board. capacity is the new total of active cells, the number isFull is measured against.board/HwTypes.ts:72
coin:locked[{ capacity: number; coin: HwCoin<TData>; locked: number; }]-board/HwTypes.ts:47
coin:released[{ coin: HwCoin<TData>; remaining: number; }]Fired by release() - the collect / fly-away moment.board/HwTypes.ts:49
feature:end[{ coins: HwCoin<TData>[]; full: boolean; rounds: number; }]-board/HwTypes.ts:67
feature:enter[{ respins: number; seed: HwCoin<TData>[]; }]-board/HwTypes.ts:43
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:66
feature:skip[{ inFlight: number; mode: SkipMode; payload?: unknown; speed?: string; }]Fired by skip(). After a 'slam' the game layer cuts its own flights / collect short; after a 'quicken' the cells are landing through their stop and there is nothing to cut. speed and payload are the press’s own options, passed through as given; keys the press did not set are absent.board/HwTypes.ts:60
respin:end[{ hits: HwCoin<TData>[]; respinsLeft: number; round: number; }]-board/HwTypes.ts:51
respin:start[{ respinsLeft: number; round: number; spinning: HwCell[]; }]-board/HwTypes.ts:44
respins:changed[{ reason: HwRespinReason; value: number; }]-board/HwTypes.ts:50
speed:changed[{ name: string; previous: string; }]Fired by setSpeed() - every cell’s active speed profile changed. Cells already in flight finish on the profile they started with; the next wave (or a skip()) is where the new one shows.board/HwTypes.ts:78