Record Class PlayerInputEvent

java.lang.Object
java.lang.Record
fr.fidorial.event.player.PlayerInputEvent
All Implemented Interfaces:
Event, PlayerEvent
public record PlayerInputEvent(Player player, PlayerInput previous, PlayerInput input) extends Record implements PlayerEvent
Fired when a player presses or releases a movement key.

Listeners run on the network thread of the player, keep them short.

Since:
0.1.0

  • Constructor Details

    • PlayerInputEvent

      public PlayerInputEvent(Player player, PlayerInput previous, PlayerInput input)
      Creates an event.
      Parameters:
      player - the player
      previous - the keys held before
      input - the keys held now
      Since:
      0.1.0

  • Method Details

    • previous

      public PlayerInput previous()
      Returns the keys held before this change.
      Returns:
      the keys held before this change
      Since:
      0.1.0

    • input

      public PlayerInput input()
      Returns the keys held now.
      Returns:
      the keys held now
      Since:
      0.1.0

    • 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.

    • player

      public Player player()
      Returns the value of the player record component.
      Specified by:
      player in interface PlayerEvent
      Returns:
      the value of the player record component