Record Class GameEvent.FrozenBlocksChanged

java.lang.Object
java.lang.Record
edu.uw.tcss.model.GameEvent.FrozenBlocksChanged
Record Components:
blocks - the frozen blocks state
timestamp - when the event was created (milliseconds since epoch)
All Implemented Interfaces:
GameEvent
Enclosing interface:
GameEvent
public static record GameEvent.FrozenBlocksChanged(GameControls.FrozenBlocks blocks, long timestamp) extends Record implements GameEvent
Event fired when the game's frozen blocks change state. This occurs when the current movable piece freezes into place on the board.

This event provides type-safe access to the complete frozen blocks state. When fired, this event is associated with property name "FrozenBlocksChanged".

Note: Implementing classes may use GameControls.Block.EMPTY or null for empty spaces in the collection. Please refer to implementation-specific documentation for details.

Usage Example: 

game.addPropertyChangeListener(evt -> {
    if (evt.getNewValue() instanceof GameEvent.FrozenBlocksChanged e) {
        redrawFrozenBlocks(e.blocks());
    }
});
Version:
Winter 2025
Author:
Charles Bryan

  • Constructor Details

    • FrozenBlocksChanged

      public FrozenBlocksChanged(GameControls.FrozenBlocks blocks, long timestamp)
      Creates an instance of a FrozenBlocksChanged record class.
      Parameters:
      blocks - the value for the blocks record component
      timestamp - the value for the timestamp 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • blocks

      public GameControls.FrozenBlocks blocks()
      Returns the value of the blocks record component.
      Returns:
      the value of the blocks record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface GameEvent
      Returns:
      the value of the timestamp record component