data/com.gonodono.hexgrid.data/HexOrientation

HexOrientation

enum HexOrientation : Enum<HexOrientation>

Possible options for the orientation of the cell hexagons.

Entries

Indicates that a major axis should be horizontal; "flat top" orientation.

Indicates that a major axis should be vertical; "pointy top" orientation.

Properties

val entries: EnumEntries<HexOrientation>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val HexOrientation.isHorizontal: Boolean

Convenience for concisely checking the hex orientation.

val name: String

val ordinal: Int

Functions

fun valueOf(value: String): HexOrientation

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<HexOrientation>

Returns an array containing the constants of this enum type, in the order they're declared.