Class Location

Contains a location description that is useful for entities and other items. X, Y, and Z can contain decimal fractions. For integer-based locations useful for blocks, see BlockLocation.

Hierarchy

  • Location

Constructors

constructor

Properties

x y z

Methods

equals isNear

Constructors

constructor

  • Parameters

    • x: number

      X position of the location.

    • y: number

      Y position of the location.

    • z: number

      Z position of the location.

    Returns Location

    Remarks

    Creates a new instance of an abstract location.

Properties

x

x: number

X component of this location.

y

y: number

Y component of this location.

z

z: number

Z component of this location.

Methods

equals

  • Parameters

    • other: Location

      Other location to compare this Location to.

    Returns boolean

    True if the two locations are equal.

    Remarks

    Compares this Location and another Location to one another.

isNear

  • Parameters

    • other: Location

      Other Location to compare this Location to.

    • epsilon: number

      Maximum distance that the Locations can be from each other to be considered nearby.

    Returns boolean

    True if the two Locations are within epsilon distance of each other.

    Remarks

    Determines whether or not two Locations are considered to be near each other.

Settings

Member Visibility

Theme

On This Page