Reference · Mazes, arrows and mixed boards
mazeProgressfunction
How far the line has got, for a progress line: cells drawn, keys, and whether it is solved.
Import it
import { mazeProgress } from "@johnmorrisdotca/meikyuu";Definition
function mazeProgress(game: MazeGame<MazeCore>): { cells: number; keys: number; keysOf: number; solved: boolean; }Parameters
| Name | Type | Description |
|---|---|---|
game | MazeGame<MazeCore> | The current immutable native game state. |
Returns
{ cells: number; keys: number; keysOf: number; solved: boolean; }
How far the line has got, for a progress line: cells drawn, keys, and whether it is solved.
Examples
import type { MazeRecipe } from "@johnmorrisdotca/meikyuu";
import { buildMaze, mazeProgress, newMazeGame } from "@johnmorrisdotca/meikyuu";
const recipe: MazeRecipe = {shape:"square",w:5,h:5,algorithm:"backtracker",mode:"to-goal",seed:42};
const maze = buildMaze(recipe);
const game = newMazeGame(maze);
console.log(mazeProgress(game));{ cells: 0, keys: 0, keysOf: 0, solved: false }What it prints (run when this page was built)