Dir8

enum Dir8 : Enum<Dir8>

Enum representing the eight cardinal and intercardinal directions.

Provides conversion and rotation utilities to DirYZ, DirRotate, and related types.

Entries

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun opposite(): Dir8

Returns the opposite direction of the current Dir8 value.

Link copied to clipboard
fun rotate(dirRotate: DirRotate): Dir8

Rotates the current direction based on the given DirRotate direction.

Link copied to clipboard
fun toDirYZ(dirRotate: DirRotate): DirYZ

Converts the current Dir8 value to the corresponding DirYZ value based on the given DirRotate direction.

Link copied to clipboard
fun valueOf(value: String): Dir8

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.)

Link copied to clipboard
fun values(): Array<Dir8>

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