Record Class Location

java.lang.Object
java.lang.Record
idlab.colonyops.model.Location
Record Components:
x - the column, in [0, Planet.mapWidth())
y - the row, in [0, Planet.mapHeight())
public record Location(int x, int y) extends Record
A tile coordinate on a Planet's grid.

Distance and movement between locations use Chebyshev distance (a unit may move to any of the 8 surrounding tiles in a single step). The planet wraps around on both axes (toroidal topology): moving past one edge places you on the opposite edge, and distance calculations always use the shortest path, accounting for wrap-around.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Location(int x, int y)
    Creates an instance of a Location record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Location

      public Location(int x, int y)
      Creates an instance of a Location record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component