Interface HexCoord

Flat-top hexagon geometry, addressed the same way a square grid is: x the column, y the row, both integers - which is what lets mwg/roguelike's Level (grid logic) and mwg/render's TileMap (pixel positions) each reuse it without depending on the other. It lives in mwg/core for exactly that reason: neither of those two modules is allowed to depend on the other, and this needs to sit below both.

Internally this converts to and from cube coordinates (x + y + z = 0) for every calculation, because the six neighbour directions are then a fixed, orientation-agnostic list rather than a column-parity-dependent table someone has to get right twice. The offset "odd-q" scheme below - odd columns pushed half a row down - is what makes that cube math round-trip back to integers; nothing about it is rot.js's, which is deliberate (see the roadmap: rot.js's own hex Path topology is doubled-width coordinates built for pointy-top hexagons, and does not match this orientation).

Example

import { hexNeighbors, hexDistance, hexLine, hexRange, hexToPixel, pixelToHex } from '@datamoc/mw_games/core';

const start = { x: 2, y: 2 };
const neighbours = hexNeighbors(start.x, start.y); // the 6 adjacent cells
const cellsAway = hexDistance(start, { x: 4, y: 1 });
const path = hexLine(start, { x: 4, y: 1 }); // every cell the line crosses
const nearby = hexRange(start, 2); // every cell within 2 hexes

const pixel = hexToPixel(start.x, start.y, 32, 28); // tile width/height in pixels
const backToHex = pixelToHex(pixel.x, pixel.y, 32, 28); // round-trips to { x: 2, y: 2 }

interface HexCoord {
x: number;
y: number;
}

Index

Properties

x y

Properties

x

x: number

y

y: number

Interface HexCoord

Example

Index

Properties

Properties

x

y

Settings

On This Page