Class GameSimulator

A WASM-friendly wrapper around the core GameSimulator type.

Provides methods to simulate plays, drives, or full games. Mirrors the Rust GameSimulator API, accepting teams, context, and a mutable game reference as parameters.

Index

Constructors

constructor

Methods

free simDrive simGame simPlay

Constructors

constructor

new GameSimulator(): GameSimulator
Creates a new game simulator.

Returns GameSimulator
- Defined in fbsim_core.d.ts:799

Methods

free

free(): void
Returns void
- Defined in fbsim_core.d.ts:795

simDrive

simDrive(
    home: FootballTeam,
    away: FootballTeam,
    context: GameContext,
    game: Game,
    rng: Rng,
): GameContext
Simulates until the current drive is complete.

Mutates the game in place and returns the updated GameContext.

Arguments
- home - The home team
- away - The away team
- context - The current game context
- game - The game log (mutated in place)
- rng - The random number generator
Parameters
- home: FootballTeam
- away: FootballTeam
- context: GameContext
- game: Game
- rng: Rng
Returns GameContext
- Defined in fbsim_core.d.ts:839

simGame

simGame(
    home: FootballTeam,
    away: FootballTeam,
    context: GameContext,
    game: Game,
    rng: Rng,
): GameContext
Simulates the rest of the game.

Mutates the game in place and returns the updated GameContext.

Arguments
- home - The home team
- away - The away team
- context - The current game context
- game - The game log (mutated in place)
- rng - The random number generator
Parameters
- home: FootballTeam
- away: FootballTeam
- context: GameContext
- game: Game
- rng: Rng
Returns GameContext
- Defined in fbsim_core.d.ts:812

simPlay

simPlay(
    home: FootballTeam,
    away: FootballTeam,
    context: GameContext,
    game: Game,
    rng: Rng,
): GameContext
Simulates the next play.

Mutates the game in place and returns the updated GameContext. Call game.getLatestPlay() to inspect the play that was simulated.

Arguments
- home - The home team
- away - The away team
- context - The current game context
- game - The game log (mutated in place)
- rng - The random number generator
Parameters
- home: FootballTeam
- away: FootballTeam
- context: GameContext
- game: Game
- rng: Rng
Returns GameContext
- Defined in fbsim_core.d.ts:826

Class GameSimulator

Index

Constructors

Methods

Constructors

constructor

Returns GameSimulator

Methods

free

Returns void

simDrive

Arguments

Parameters

Returns GameContext

simGame

Arguments

Parameters

Returns GameContext

simPlay

Arguments

Parameters

Returns GameContext

Settings

On This Page