RiverCoordinate

class RiverCoordinate(position: Vector2, bottomRightOrLeft: RiverGenerator.RiverCoordinate.BottomRightOrLeft)

Describes a Vertex on our hexagonal grid via a neighboring hex and clock direction, normalized such that always the north-most hex and one of the two clock directions 5 / 7 o'clock are used.

Constructors

RiverCoordinate

fun RiverCoordinate(position: Vector2, bottomRightOrLeft: RiverGenerator.RiverCoordinate.BottomRightOrLeft)

Types

BottomRightOrLeft

enum BottomRightOrLeft : Enum<RiverGenerator.RiverCoordinate.BottomRightOrLeft>

Functions

equals

open operator fun equals(other: Any?): Boolean

getAdjacentPositions

fun getAdjacentPositions(tileMap: TileMap): Sequence<RiverGenerator.RiverCoordinate>

Lists the three neighboring vertices which have their anchor hex on the map (yes some positions on the map's outer border will be included, some not)

getAdjacentTiles

fun getAdjacentTiles(tileMap: TileMap): Sequence<TileInfo>

Lists the three neighboring hexes to this vertex which are on the map

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Properties

bottomRightOrLeft

val bottomRightOrLeft: RiverGenerator.RiverCoordinate.BottomRightOrLeft

position

val position: Vector2

Sources

jvm source