Record Class EntitiesAtLocation

java.lang.Object
java.lang.Record
idlab.colonyops.model.EntitiesAtLocation
Record Components:
location - the tile's coordinates
entities - the entities currently occupying that tile (may be empty)
public record EntitiesAtLocation(Location location, List<Entity> entities) extends Record
The entities present at a single tile within a squad member's vision range, as reported in ActionRequest.locationsInView().

  • Constructor Details

    • EntitiesAtLocation

      public EntitiesAtLocation(Location location, List<Entity> entities)
      Creates an instance of a EntitiesAtLocation record class.
      Parameters:
      location - the value for the location record component
      entities - the value for the entities 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 Objects::equals(Object,Object).
      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.

    • location

      public Location location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component

    • entities

      public List<Entity> entities()
      Returns the value of the entities record component.
      Returns:
      the value of the entities record component