StartPhase

Class: StartPhase

Defined in: spin/phases/StartPhase.ts:43

Accelerates the reel from rest to full spin speed.

Optionally performs a brief step-back (reel reverses a tiny amount) before accelerating upward, giving the classic slot machine “pull” feel.

Steps, in order: delay (the stagger, cut by a quicken), launch (re-mask lifted symbols), pull (only on a profile that bounces), accelerate, announce (notifySpinStart). Under the tween model the pull and the acceleration are tweens of reel.speed; under the drive model they name a targetSpeed and wait, letting the drive’s bounds shape the ramp.

Extends#

ReelPhase<StartPhaseConfig>

Constructors#

Constructor#

new StartPhase(
   reel: Reel, 
   speed: SpeedProfile, 
   options?: StartPhaseOptions
): StartPhase;

Defined in: spin/phases/StartPhase.ts:50

Parameters#

Parameter	Type
`reel`	`Reel`
`speed`	`SpeedProfile`
`options`	`StartPhaseOptions`

Returns#

StartPhase

Overrides#

ReelPhase.constructor

Properties#

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
`_config`	`protected`	`StartPhaseConfig` \| `null`	`null`	The config `run()` was given, for `ctx.config`.	-	`ReelPhase`.`_config`	spin/phases/ReelPhase.ts:132
`_isActive`	`protected`	`boolean`	`false`	-	-	`ReelPhase`.`_isActive`	spin/phases/ReelPhase.ts:130
`_options`	`readonly`	`StartPhaseOptions`	`undefined`	-	-	-	spin/phases/StartPhase.ts:48
`_reel`	`protected`	`Reel`	`undefined`	-	-	`ReelPhase`.`_reel`	spin/phases/ReelPhase.ts:127
`_resolve`	`protected`	(() => `void`) \| `null`	`null`	-	-	`ReelPhase`.`_resolve`	spin/phases/ReelPhase.ts:129
`_speed`	`protected`	`SpeedProfile`	`undefined`	-	-	`ReelPhase`.`_speed`	spin/phases/ReelPhase.ts:128
`name`	`readonly`	`"start"`	`'start'`	-	`ReelPhase`.`name`	-	spin/phases/StartPhase.ts:44
`quickenable`	`readonly`	`true`	`true`	Whether a `'quicken'` press may reach `onSkip(ctx)`. A phase that declares it branches on `ctx.mode` there and completes itself when the natural end is reached. One that does not is left alone by a quicken (its `cut` steps are still skipped), so a phase written for slams only keeps working. The built-ins declare it.	`ReelPhase`.`quickenable`	-	spin/phases/StartPhase.ts:46
`skippable`	`readonly`	`true`	`true`	-	`ReelPhase`.`skippable`	-	spin/phases/StartPhase.ts:45

Accessors#

isActive#

Get Signature#

get isActive(): boolean;

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

Returns

boolean

Inherited from#

ReelPhase.isActive

quickened#

Get Signature#

get quickened(): boolean;

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

true once a 'quicken' press has reached this phase.

Returns

boolean

Inherited from#

ReelPhase.quickened

reel#

Get Signature#

get reel(): Reel;

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

Returns

Reel

Inherited from#

ReelPhase.reel

speed#

Get Signature#

get speed(): TProfile;

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

The profile this phase runs on. A 'quicken' press that names one swaps it.

Returns

TProfile

Inherited from#

ReelPhase.speed

Methods#

_complete()#

protected _complete(): void;

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

Call when the phase naturally completes.

Returns#

void

Inherited from#

ReelPhase._complete

bounce()#

bounce(options?: BounceOptions): ReelBounce;

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

Overshoot the reel in its direction of travel and settle it back, the classic landing bounce. Call it after land: the overshoot is measured from wherever the reel container rests right now.

Moving the container after a landing is not a plain tween. land() has just lifted every at-rest unmask symbol into a layer that does NOT inherit the reel’s offset, so for as long as the bounce runs the base carries those views along on every frame, and the settle lands them on the exact resting position rather than the tween’s last epsilon. That bookkeeping is why the bounce is a helper and not two lines of GSAP, and why a different bounce shape goes through options.animation rather than a raw tween of the container.

Defaults come from the phase’s profile; pass BounceOptions to bounce differently (a pressed reel that lands on a shorter bounce, say). A non-positive distance returns an already-settled bounce, so the caller’s done handling is the same either way.

Parameters#

Parameter	Type
`options`	`BounceOptions`

Returns#

ReelBounce

Inherited from#

ReelPhase.bounce

defaultBounce()#

static defaultBounce(ctx: BounceContext): Animation;

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

The built-in bounce: out by distance, back to base, half the time each.

Parameters#

Parameter	Type
`ctx`	`BounceContext`

Returns#

Animation

Inherited from#

ReelPhase.defaultBounce

defaultSteps()#

defaultSteps(): PhaseStep<StartStepContext>[];

Defined in: spin/phases/StartPhase.ts:56

The built-in list. A subclass overrides this to change the flow; a game edits it through options.steps.

Returns#

PhaseStep<StartStepContext>[]

forceComplete()#

forceComplete(ctx?: SkipContext<SpeedProfile>): void;

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

Slam this phase regardless of skippable: cancel the step in flight, onSkip(ctx), complete. What the controller’s slam path calls; ctx.mode is 'slam' there.

Parameters#

Parameter	Type
`ctx`	`SkipContext`<`SpeedProfile`>

Returns#

void

Inherited from#

ReelPhase.forceComplete

land()#

land(cells?: readonly number[]): void;

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

Bring the reel to rest on the frame it is showing and announce the landing: the drive halts, the strip snaps to the cell grid, symbols are told the spin is over and then that they landed (which lifts unmask symbols above the mask and plays the landing animation), and the reel’s landing event fires, bridged to the set’s spin:reelLanding.

Place the frame first (this.reel.placeStrip(frame)), or let the spin-out carry it in as StopPhase does; this call does not choose the symbols. It is the whole of what StopPhase does between its spin-out and its bounce, and the only way a phase lands a reel.

Parameters#

Parameter	Type	Description
`cells?`	readonly `number`[]	Visible cells (0-indexed) whose symbols receive `onReelLanded()`. Omit for a strip landing, where every visible symbol landed; pass the cells that moved when only some did.

Returns#

void

Inherited from#

ReelPhase.land

onEnter()#

protected onEnter(config: StartPhaseConfig): void;

Defined in: spin/phases/StartPhase.ts:103

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

Parameters#

Parameter	Type
`config`	`StartPhaseConfig`

Returns#

void

Overrides#

ReelPhase.onEnter

onSkip()#

protected onSkip(ctx?: SkipContext): void;

Defined in: spin/phases/StartPhase.ts:118

Both modes end the same way: at full spin speed, with the spin announced. The pose IS the natural end, so a 'quicken' completes here as well.

Parameters#

Parameter	Type
`ctx`	`SkipContext`

Returns#

void

Overrides#

ReelPhase.onSkip

run()#

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

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

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

Parameters#

Parameter	Type
`config`	`StartPhaseConfig`

Returns#

Promise<void>

Inherited from#

ReelPhase.run

runSteps()#

protected runSteps(steps: readonly PhaseStep<StepContext<any, any>>[]): void;

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

Run steps in order and complete the phase after the last one. Each step’s result is waited on (a tween or timeline, a promise, a cancellable such as bounce’s, or nothing). A slam cancels the step in flight; a quicken skips the steps marked cut, in flight or upcoming. Call tickSteps from update() so ctx.until() can watch the reel.

Parameters#

Parameter	Type
`steps`	readonly `PhaseStep`<`StepContext`<`any`, `any`>>[]

Returns#

void

Inherited from#

ReelPhase.runSteps

skip()#

skip(ctx?: SkipContext<SpeedProfile>): void;

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

A skip press reached this phase.

'slam' (the default): if the phase is skippable, the step in flight is cancelled, onSkip(ctx) runs and the phase completes at once; the controller then places the reel.

'quicken': the phase is asked to reach its natural end sooner without changing what it looks like. A profile named on the press replaces speed first. Then, if the phase is quickenable, onSkip(ctx) runs; then every cut step is skipped, the one in flight included. A phase that is neither quickenable nor running steps is left to run its course, and still lands. skippable is not consulted, since nothing is forced.

Parameters#

Parameter	Type
`ctx`	`SkipContext`<`SpeedProfile`>

Returns#

void

Inherited from#

ReelPhase.skip

tickSteps()#

protected tickSteps(): void;

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

Feed ctx.until() from the phase’s update(): every pending predicate is checked and the steps waiting on a true one resume.

Returns#

void

Inherited from#

ReelPhase.tickSteps

update()#

update(_deltaMs: number): void;

Defined in: spin/phases/StartPhase.ts:110

Called each frame while the phase is active.

Parameters#

Parameter	Type
`_deltaMs`	`number`

Returns#

void

Overrides#

ReelPhase.update