KHexagon/io.github.offlinebrain.khexagon.coordinates/HexCoordinates/get

get

operator fun get(direction: Int): HexCoordinates(source)

Retrieves the neighboring HexCoordinates in the specified direction.

Return

The neighboring HexCoordinates in the specified direction.

Parameters

direction

An integer representing the direction. Should be in the range 0, 5. For the mapping of integer values to directions, refer to Coordinates.Flat and Coordinates.Pointy.

Throws

if the provided direction integer is not in the range 0, 5.