Reference · Mazes, arrows and mixed boards
turnForfunction
Whether to turn a maze box (as made) for an orientation. portrait turns a wide maze upright and landscape lays a tall one down;
a maze that is as wide as it is tall (within a tenth) is never turned by either. auto has no container to look at here, so it leaves
the maze as made: see autoTurn.
Import it
import { turnFor } from "@johnmorrisdotca/meikyuu";Definition
function turnFor(orientation: MeikyuuOrientation, box: Box): TurnParameters
| Name | Type | Description |
|---|---|---|
orientation | "portrait" | "landscape" | "auto" | Portrait, landscape or automatic native orientation. |
box | Box | The viewport dimensions and logical board bounds, or board bounds specified by the signature. |
Returns
Turn
Whether to turn a maze box (as made) for an orientation. portrait turns a wide maze upright and landscape lays a tall one down; a maze that is as wide as it is tall (within a tenth) is never turned by either. auto has no container to look at here, so it leaves the maze as made: see autoTurn.
Examples
import type { MazeRecipe } from "@johnmorrisdotca/meikyuu";
import { buildMaze, turnFor } from "@johnmorrisdotca/meikyuu";
const recipe: MazeRecipe = {shape:"square",w:5,h:5,algorithm:"backtracker",mode:"to-goal",seed:42};
const maze = buildMaze(recipe);
const grid = maze.grid;
const box = {width:390,height:844,area:grid.box};
console.log(turnFor("portrait",grid.box));0What it prints (run when this page was built)