Reference · Mazes, arrows and mixed boards
isFreefunction
Whether an arrow can be tapped now and slide off: it is on the board, not locked, and nothing is in front of it.
Import it
import { isFree } from "@johnmorrisdotca/meikyuu";
Definition
function isFree(game: ArrowGame, id: number): boolean
Parameters
| Name | Type | Description |
|---|---|---|
game | ArrowGame | The current immutable native game state. |
id | number | The zero-based arrow index. |
Returns
boolean
Whether an arrow can be tapped now and slide off: it is on the board, not locked, and nothing is in front of it.
Examples
import type { ArrowRecipe } from "@johnmorrisdotca/meikyuu";
import { hintArrow, isFree, makeArrows, newArrowGame } from "@johnmorrisdotca/meikyuu";
const arrowRecipe: ArrowRecipe = {shape:"square",w:5,h:5,longest:3,seed:42};
const arrows = makeArrows(arrowRecipe);
const arrowGame = newArrowGame(arrows);
const arrowId = hintArrow(arrowGame)!;
console.log(isFree(arrowGame,arrowId));trueWhat it prints (run when this page was built)