Record Class PlayerJoinEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.player.PlayerJoinEvent
Record Components:
cancelled - whether a listener suppressed the join handling
player - the joining player
All Implemented Interfaces:
Event, PlayerEvent
public record PlayerJoinEvent(boolean cancelled, FPlayer player) extends Record implements PlayerEvent
Fired when a player joins the server.

  • Constructor Details

    • PlayerJoinEvent

      public PlayerJoinEvent(FPlayer player)
      Creates an event that has not been cancelled.
      Parameters:
      player - the joining player

    • PlayerJoinEvent

      public PlayerJoinEvent(boolean cancelled, FPlayer player)
      Creates an instance of a PlayerJoinEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      player - the value for the player record component

  • Method Details

    • withCancelled

      public PlayerJoinEvent withCancelled(boolean cancelled)
      Description copied from interface: Event
      Returns a copy of this event with the cancelled flag set.
      Specified by:
      withCancelled in interface Event
      Parameters:
      cancelled - the new cancelled state
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withPlayer

      public PlayerJoinEvent withPlayer(FPlayer player)
      Description copied from interface: PlayerEvent
      Returns a copy of this event for a different player.
      Specified by:
      withPlayer in interface PlayerEvent
      Parameters:
      player - the new player
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

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

    • cancelled

      public boolean cancelled()
      Returns the value of the cancelled record component.
      Specified by:
      cancelled in interface Event
      Returns:
      the value of the cancelled record component

    • player

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