Package util

Record Class GameMap

java.lang.Object
java.lang.Record
util.GameMap
public record GameMap(MazeGenerator.TileType[][] types, double[][] elevations) extends Record
Represents a map to be used by a game of PacMann. A map is a rectangular 2D array of tiles (whose types are specified by `types`), each with an elevation (given by `elevations`).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final double[][]
    elevations
    The field for the elevations record component.
    private final MazeGenerator.TileType[][]
    types
    The field for the types record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GameMap(MazeGenerator.TileType[][] types, double[][] elevations)
    Creates an instance of a GameMap record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double[][]
    elevations()
    Returns the value of the elevations record component.
    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.
    MazeGenerator.TileType[][]
    types()
    Returns the value of the types record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • types

      private final MazeGenerator.TileType[][] types
      The field for the types record component.

    • elevations

      private final double[][] elevations
      The field for the elevations record component.

  • Constructor Details

    • GameMap

      public GameMap(MazeGenerator.TileType[][] types, double[][] elevations)
      Creates an instance of a GameMap record class.
      Parameters:
      types - the value for the types record component
      elevations - the value for the elevations 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.

    • types

      public MazeGenerator.TileType[][] types()
      Returns the value of the types record component.
      Returns:
      the value of the types record component

    • elevations

      public double[][] elevations()
      Returns the value of the elevations record component.
      Returns:
      the value of the elevations record component