Class GridHex

constructor

• new GridHex(coordinates, grid): GridHex

• Construct a GridHex instance by providing a hex coordinate.

  Parameters

  • coordinates: HexagonalGridCoordinates

    The coordinates of the hex to construct
  • grid: HexagonalGrid

    The hexagonal grid instance to which this hex belongs

  Returns GridHex

grid

cube

offset

center

• get center(): Point

• Return a reference to the pixel point in the center of this hexagon.

  Returns Point

topLeft

• get topLeft(): Point

• Return a reference to the pixel point of the top-left corner of this hexagon.

  Returns Point

getNeighbors

• getNeighbors(): GridHex[]

• Return the array of hexagons which are neighbors of this one. This result is un-bounded by the confines of the game canvas and may include hexes which are off-canvas.

  Returns GridHex[]

shiftCube

• shiftCube(dq, dr, ds): GridHex

• Get a neighboring hex by shifting along cube coordinates

  Parameters

  • dq: number

    A number of hexes to shift along the q axis
  • dr: number

    A number of hexes to shift along the r axis
  • ds: number

    A number of hexes to shift along the s axis

  Returns GridHex

  The shifted hex

equals

• equals(other): boolean

• Return whether this GridHex equals the same position as some other GridHex instance.

  Parameters

  • other: GridHex

    Some other GridHex

  Returns boolean

  Are the positions equal?