Slot Engine is in Beta - Expect bugs!
Slot EngineSlot Engine

Config

Access the game configuration from the game context


Introduction

The static game configuration object provides access to various game-specific properties as defined in your createSlotGame function.

The game config must not be modified during runtime.

Properties

Only properties that are relevant for game implementation are listed here.

PropertyTypeDescription
anticipationTriggersRecord<string, number>A mapping of spin types to the number of scatter symbols required to trigger anticipation.
maxWinXnumberThe maximum bet multiplier payout. Wins exceeding this number will be capped.
padSymbolsnumberAmount of padding symbol rows above and below the active board.
Used to display partially visible symbols in the frontend at the top and bottom of the board.

Defaults to 1
symbolsMap<string, GameSymbol>See: Game Configuration: Symbols
scatterToFreespinsRecord<string, Record<number, number>>A mapping from spin type to scatter counts to the number of free spins awarded.

Any other properties you might find under ctx.config shouldn't be used as they only serve internal purposes. They might be made inaccessible in a future update.

Use of AI on this page: All texts were initially written by hand and many were later revised by AI for improved flow. All AI generated revisions were carefully reviewed and edited as needed.

On this page