54 lines
4.1 KiB
Markdown
54 lines
4.1 KiB
Markdown
---
|
|
title: CardinalDirection -
|
|
---
|
|
//[KSpigot](../../index.md)/[net.axay.kspigot.utils](../index.md)/[CardinalDirection](index.md)
|
|
|
|
|
|
|
|
# CardinalDirection
|
|
[jvm]
|
|
|
|
This enum class is useful for determining cardinal directions (yaw).
|
|
|
|
enum [CardinalDirection](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[CardinalDirection](index.md)>
|
|
|
|
|
|
## Entries
|
|
|
|
| Name| Summary|
|
|
|---|---|
|
|
| [NORTH](-n-o-r-t-h/index.md)| [jvm] [NORTH](-n-o-r-t-h/index.md)() <br> <br> <br>
|
|
| [EAST](-e-a-s-t/index.md)| [jvm] [EAST](-e-a-s-t/index.md)() <br> <br> <br>
|
|
| [SOUTH](-s-o-u-t-h/index.md)| [jvm] [SOUTH](-s-o-u-t-h/index.md)() <br> <br> <br>
|
|
| [WEST](-w-e-s-t/index.md)| [jvm] [WEST](-w-e-s-t/index.md)() <br> <br> <br>
|
|
|
|
|
|
## Types
|
|
|
|
| Name| Summary|
|
|
|---|---|
|
|
| [Companion](-companion/index.md)| [jvm] <br>Content <br>object [Companion](-companion/index.md) <br><br><br>
|
|
|
|
|
|
## Functions
|
|
|
|
| Name| Summary|
|
|
|---|---|
|
|
| [compareTo](-w-e-s-t/index.md#kotlin/Enum/compareTo/#net.axay.kspigot.utils.CardinalDirection/PointingToDeclaration/)| [jvm] <br>Content <br>operator override fun [compareTo](-w-e-s-t/index.md#kotlin/Enum/compareTo/#net.axay.kspigot.utils.CardinalDirection/PointingToDeclaration/)(other: [CardinalDirection](index.md)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) <br><br><br>
|
|
| [describeConstable](-w-e-s-t/index.md#kotlin/Enum/describeConstable/#/PointingToDeclaration/)| [jvm] <br>Content <br>~~override~~ ~~fun~~ [~~describeConstable~~](-w-e-s-t/index.md#kotlin/Enum/describeConstable/#/PointingToDeclaration/)~~(~~~~)~~~~:~~ [Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html)<[Enum.EnumDesc](https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html)<[CardinalDirection](index.md)>> <br><br><br>
|
|
| [equals](-w-e-s-t/index.md#kotlin/Enum/equals/#kotlin.Any?/PointingToDeclaration/)| [jvm] <br>Content <br>operator override fun [equals](-w-e-s-t/index.md#kotlin/Enum/equals/#kotlin.Any?/PointingToDeclaration/)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) <br><br><br>
|
|
| [finalize](-w-e-s-t/index.md#kotlin/Enum/finalize/#/PointingToDeclaration/)| [jvm] <br>Content <br>override fun [finalize](-w-e-s-t/index.md#kotlin/Enum/finalize/#/PointingToDeclaration/)() <br><br><br>
|
|
| [getDeclaringClass](-w-e-s-t/index.md#kotlin/Enum/getDeclaringClass/#/PointingToDeclaration/)| [jvm] <br>Content <br>override fun [getDeclaringClass](-w-e-s-t/index.md#kotlin/Enum/getDeclaringClass/#/PointingToDeclaration/)(): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)<[CardinalDirection](index.md)> <br><br><br>
|
|
| [hashCode](-w-e-s-t/index.md#kotlin/Enum/hashCode/#/PointingToDeclaration/)| [jvm] <br>Content <br>override fun [hashCode](-w-e-s-t/index.md#kotlin/Enum/hashCode/#/PointingToDeclaration/)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) <br><br><br>
|
|
| [toString](-w-e-s-t/index.md#kotlin/Enum/toString/#/PointingToDeclaration/)| [jvm] <br>Content <br>open override fun [toString](-w-e-s-t/index.md#kotlin/Enum/toString/#/PointingToDeclaration/)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) <br><br><br>
|
|
|
|
|
|
## Properties
|
|
|
|
| Name| Summary|
|
|
|---|---|
|
|
| [facing](index.md#net.axay.kspigot.utils/CardinalDirection/facing/#/PointingToDeclaration/)| [jvm] val [facing](index.md#net.axay.kspigot.utils/CardinalDirection/facing/#/PointingToDeclaration/): BlockFace? <br>
|
|
| [name](index.md#net.axay.kspigot.utils/CardinalDirection/name/#/PointingToDeclaration/)| [jvm] override val [name](index.md#net.axay.kspigot.utils/CardinalDirection/name/#/PointingToDeclaration/): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) <br>
|
|
| [ordinal](index.md#net.axay.kspigot.utils/CardinalDirection/ordinal/#/PointingToDeclaration/)| [jvm] override val [ordinal](index.md#net.axay.kspigot.utils/CardinalDirection/ordinal/#/PointingToDeclaration/): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) <br>
|
|
|