Record Class PlayerQuitEvent

java.lang.Object
java.lang.Record
fr.fidorial.event.player.PlayerQuitEvent
Record Components:
player - the player who left
All Implemented Interfaces:
Event, PlayerEvent
public record PlayerQuitEvent(Player player) extends Record implements PlayerEvent
Fired when a player leaves the world.

Also fired when a player enters the configuration phase through Player.enterConfigurationPhase().

Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerQuitEvent(Player player)
    Creates an instance of a PlayerQuitEvent 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.
    Player
    player()
    Returns the value of the player record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • PlayerQuitEvent

      public PlayerQuitEvent(Player player)
      Creates an instance of a PlayerQuitEvent record class.
      Parameters:
      player - the value for the player 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.

    • 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