WinPresenter

pixi-reels

pixi-reels / index / WinPresenter

Class: WinPresenter

Defined in: wins/WinPresenter.ts:88

Highlights winning cells on a reel set. One job: animate the symbols.

The presenter doesn’t draw lines, outlines, or any per-win visual. it emits win:start / win:group / win:symbol / win:end events so your code can hook anything it wants (polylines, Spine line rigs, popup numbers, sound cues) by subscribing and using reelSet.getCellBounds(reel, cell) to place graphics.

Two knobs cover the common presentation modes:

• stagger: 0 → all cells in a win pulse together
• stagger: 60 → cells start one after another. a left-to-right sweep if you pass cells in reel order

const presenter = new WinPresenter(reelSet, { stagger: 80 });

reelSet.events.on('spin:complete', async () => {
  const wins = await server.wins(result);  // your wins, your shape
  await presenter.show(wins);
});
reelSet.events.on('spin:start', () => presenter.abort());

Cascades: drive presenter.show([{ cells: winners }]) from runCascade’s onWinnersVanish hook. cluster pops and payline hits are the same shape to the presenter.

Implements#

• Disposable

Constructors#

Constructor#

new WinPresenter(reelSet: ReelSet, options?: WinPresenterOptions): WinPresenter;

Defined in: wins/WinPresenter.ts:95

Parameters#

Returns#

WinPresenter

Accessors#

isActive#

Get Signature#

get isActive(): boolean;

Defined in: wins/WinPresenter.ts:100

Returns

boolean

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: wins/WinPresenter.ts:104

Returns

boolean

Implementation of#

Disposable.isDestroyed

Methods#

abort()#

abort(): void;

Defined in: wins/WinPresenter.ts:149

Abort any in-flight show().

Returns#

void

destroy()#

destroy(): void;

Defined in: wins/WinPresenter.ts:153

Returns#

void

Implementation of#

Disposable.destroy

show()#

show(wins: readonly Win[]): Promise<void>;

Defined in: wins/WinPresenter.ts:114

Present the given wins. Cancels any in-flight sequence first. Resolves when all cycles complete or when abort() is called.

Empty input resolves immediately without firing any events.

Parameters#

Returns#

Promise<void>