Class CubeCoordinate

constructor

• new CubeCoordinate(x, y, z): CubeCoordinate

• Parameters

  • x: number
  • y: number
  • z: number

  Returns CubeCoordinate

Readonly x

Readonly y

Readonly z

Static Readonly Directions

Static Readonly Down

Static Readonly LeftDown

Static Readonly LeftUp

Static Readonly RightDown

Static Readonly RightUp

Static Readonly Up

Static Readonly Zero

length

• get length(): number

• Returns number

add

• add(other): CubeCoordinate

• Parameters

  • other: HexDirection | CubeCoordinate

  Returns CubeCoordinate

approximatelyEqual

• approximatelyEqual(other, epsilon?): boolean

• Parameters

  • other: CubeCoordinate
  • epsilon: number = 0.001

  Returns boolean

distance

• distance(other): number

• Parameters

  • other: CubeCoordinate

  Returns number

multiply

• multiply(s): CubeCoordinate

• Parameters

  • s: number

  Returns CubeCoordinate

rounded

• rounded(): CubeCoordinate

• Returns CubeCoordinate

subtract

• subtract(other): CubeCoordinate

• Parameters

  • other: HexDirection | CubeCoordinate

  Returns CubeCoordinate

toAxial

• toAxial(): AxialCoordinate

• Returns AxialCoordinate

toString

• toString(): string

• Returns string

Static add

• add(a, b): CubeCoordinate

• Parameters

  • a: CubeCoordinate
  • b: HexDirection | CubeCoordinate

  Returns CubeCoordinate

Static approximatelyEqual

• approximatelyEqual(a, b, epsilon?): boolean

• Parameters

  • a: CubeCoordinate
  • b: CubeCoordinate
  • epsilon: number = 0.001

  Returns boolean

Static distance

• distance(a, b): number

• Parameters

  • a: CubeCoordinate
  • b: CubeCoordinate

  Returns number

Static multiply

• multiply(a, s): CubeCoordinate

• Parameters

  • a: CubeCoordinate
  • s: number

  Returns CubeCoordinate

Static subtract

• subtract(a, b): CubeCoordinate

• Parameters

  • a: CubeCoordinate
  • b: HexDirection | CubeCoordinate

  Returns CubeCoordinate