Context

Introduction

The context (or game context) provides access to the underlying state. It also provides many utility functions that ease game implementation. The context is typically accessed via the ctx parameter in hooks.

type Context = GameContext<GameModesType, SymbolsType, UserStateType>

export function onHandleGameFlow(ctx: Context) {
  const reels = ctx.services.board.getRandomReelset()
  ctx.services.board.drawBoardWithRandomStops(reels)
  //                           type safe! ⤵
  const scatter = ctx.config.symbols.get("S")!
  const [count] = ctx.services.board.countSymbolsOnBoard(scatter)
}

Properties

config

You can access the complete game configuration through the context. Keep in mind that you shouldn't do any modifications to your game config inside your game implementation.

const config = ctx.config

Further reading

services

Services are cohesive function groups that encapsulate and manage specific parts of the game state. You will use them often when implementing your game.

• Game Service
• Data Service
• Board Service
• Wallet Service
• RNG Service

state

The core game state exposes some underlying state and information about the current simulation.

Further reading