PR pixi-reels

Abstract Class: ReelPhase\<TConfig\>

pixi-reels


pixi-reels / index / ReelPhase

Abstract Class: ReelPhase<TConfig>

Defined in: spin/phases/ReelPhase.ts:15

Abstract base for reel spin phases.

Each phase represents one stage of the spin lifecycle: START → SPIN → ANTICIPATION → STOP.

Phases are entered and exited by SpinController, and can be skipped if marked as skippable and the user triggers skip/slam-stop.

Type Parameters

Type ParameterDefault typeDescription
TConfigvoidPhase-specific configuration type.

Constructors

Constructor

new ReelPhase<TConfig>(reel: Reel, speed: SpeedProfile): ReelPhase<TConfig>;

Defined in: spin/phases/ReelPhase.ts:24

Parameters

ParameterType
reelReel
speedSpeedProfile

Returns

ReelPhase<TConfig>

Properties

PropertyModifierTypeDefault valueDefined in
_isActiveprotectedbooleanfalsespin/phases/ReelPhase.ts:22
_reelprotectedReelundefinedspin/phases/ReelPhase.ts:19
_resolveprotected(() => void) | nullnullspin/phases/ReelPhase.ts:21
_speedprotectedSpeedProfileundefinedspin/phases/ReelPhase.ts:20
nameabstractstringundefinedspin/phases/ReelPhase.ts:16
skippableabstractbooleanundefinedspin/phases/ReelPhase.ts:17

Accessors

isActive

Get Signature

get isActive(): boolean;

Defined in: spin/phases/ReelPhase.ts:33

Returns

boolean


reel

Get Signature

get reel(): Reel;

Defined in: spin/phases/ReelPhase.ts:29

Returns

Reel

Methods

_complete()

protected _complete(): void;

Defined in: spin/phases/ReelPhase.ts:76

Call when the phase naturally completes.

Returns

void


forceComplete()

forceComplete(): void;

Defined in: spin/phases/ReelPhase.ts:60

Force-complete the phase regardless of skippable flag.

Returns

void


onEnter()

abstract protected onEnter(config: TConfig): void;

Defined in: spin/phases/ReelPhase.ts:70

Subclass: set up the phase (start tweens, set speed, etc).

Parameters

ParameterType
configTConfig

Returns

void


onSkip()

abstract protected onSkip(): void;

Defined in: spin/phases/ReelPhase.ts:73

Subclass: clean up when skipped or force-completed.

Returns

void


run()

run(config: TConfig): Promise<void>;

Defined in: spin/phases/ReelPhase.ts:38

Enter the phase. Returns a promise that resolves when the phase is complete.

Parameters

ParameterType
configTConfig

Returns

Promise<void>


skip()

skip(): void;

Defined in: spin/phases/ReelPhase.ts:53

Skip the phase immediately (if skippable).

Returns

void


update()

abstract update(deltaMs: number): void;

Defined in: spin/phases/ReelPhase.ts:67

Called each frame while the phase is active.

Parameters

ParameterType
deltaMsnumber

Returns

void