FrameBuilder

Class: FrameBuilder

Defined in: frame/FrameBuilder.ts:43

Builds symbol frames using a middleware pipeline.

Built-in middleware handles random fill and target placement. Users can inject custom middleware for features like multiplier encoding or triple-prevention.

Constructors#

Constructor#

new FrameBuilder(_randomProvider: RandomSymbolProvider): FrameBuilder;

Defined in: frame/FrameBuilder.ts:47

Parameters#

Parameter	Type
`_randomProvider`	`RandomSymbolProvider`

Returns#

FrameBuilder

Accessors#

middleware#

Get Signature#

get middleware(): readonly FrameMiddleware[];

Defined in: frame/FrameBuilder.ts:136

Returns

readonly FrameMiddleware[]

Methods#

build()#

build(
   reelIndex: number, 
   visibleCells: number, 
   bufferStart: number, 
   bufferEnd: number, 
   target?: ColumnTarget, 
   isSpinning?: boolean
): string[];

Defined in: frame/FrameBuilder.ts:66

Build a frame for a single reel.

Parameters#

Parameter	Type	Default value
`reelIndex`	`number`	`undefined`
`visibleCells`	`number`	`undefined`
`bufferStart`	`number`	`undefined`
`bufferEnd`	`number`	`undefined`
`target?`	`ColumnTarget`	`undefined`
`isSpinning?`	`boolean`	`false`

Returns#

string[]

buildAll()#

buildAll(
   reelCount: number, 
   visibleCells: number, 
   bufferStart: number, 
   bufferEnd: number, 
   targets?: ColumnTarget[], 
   isSpinning?: boolean
): string[][];

Defined in: frame/FrameBuilder.ts:105

Build frames for all reels.

Parameters#

Parameter	Type	Default value
`reelCount`	`number`	`undefined`
`visibleCells`	`number`	`undefined`
`bufferStart`	`number`	`undefined`
`bufferEnd`	`number`	`undefined`
`targets?`	`ColumnTarget`[]	`undefined`
`isSpinning?`	`boolean`	`false`

Returns#

string[][]

remove()#

remove(name: string): this;

Defined in: frame/FrameBuilder.ts:60

Remove a middleware by name.

Parameters#

Parameter	Type
`name`	`string`

Returns#

this

use()#

use(middleware: FrameMiddleware): this;

Defined in: frame/FrameBuilder.ts:53

Add a middleware to the pipeline.

Parameters#

Parameter	Type
`middleware`	`FrameMiddleware`

Returns#

this