FrameBuilder

Class: FrameBuilder

Defined in: frame/FrameBuilder.ts:38

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:42

Parameters

Parameter	Type
`_randomProvider`	`RandomSymbolProvider`

Returns

FrameBuilder

Accessors

middleware

Get Signature

get middleware(): readonly FrameMiddleware[];

Defined in: frame/FrameBuilder.ts:125

Returns

readonly FrameMiddleware[]

randomProvider

Get Signature

get randomProvider(): RandomSymbolProvider;

Defined in: frame/FrameBuilder.ts:121

Returns

RandomSymbolProvider

Methods

build()

build(
   reelIndex: number, 
   visibleRows: number, 
   bufferAbove: number, 
   bufferBelow: number, 
   targetSymbols?: string[], 
   isSpinning?: boolean): string[];

Defined in: frame/FrameBuilder.ts:62

Build a frame for a single reel.

Parameters

Parameter	Type	Default value
`reelIndex`	`number`	`undefined`
`visibleRows`	`number`	`undefined`
`bufferAbove`	`number`	`undefined`
`bufferBelow`	`number`	`undefined`
`targetSymbols?`	`string`[]	`undefined`
`isSpinning?`	`boolean`	`false`

Returns

string[]

buildAll()

buildAll(
   reelCount: number, 
   visibleRows: number, 
   bufferAbove: number, 
   bufferBelow: number, 
   targetSymbols?: string[][], 
   isSpinning?: boolean): string[][];

Defined in: frame/FrameBuilder.ts:101

Build frames for all reels.

Parameters

Parameter	Type	Default value
`reelCount`	`number`	`undefined`
`visibleRows`	`number`	`undefined`
`bufferAbove`	`number`	`undefined`
`bufferBelow`	`number`	`undefined`
`targetSymbols?`	`string`[][]	`undefined`
`isSpinning?`	`boolean`	`false`

Returns

string[][]

remove()

remove(name: string): this;

Defined in: frame/FrameBuilder.ts:56

Remove a middleware by name.

Parameters

Parameter	Type
`name`	`string`

Returns

this

use()

use(middleware: FrameMiddleware): this;

Defined in: frame/FrameBuilder.ts:49

Add a middleware to the pipeline.

Parameters

Parameter	Type
`middleware`	`FrameMiddleware`

Returns

this