Record Class PlayerPreLoginEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.player.PlayerPreLoginEvent
Record Components:
cancelled - whether a listener vetoed the check
player - the connecting player
kickReason - the message shown when the player is refused
allowed - whether the player may join
All Implemented Interfaces:
Event, PlayerEvent
public record PlayerPreLoginEvent(boolean cancelled, FPlayer player, net.kyori.adventure.text.Component kickReason, boolean allowed) extends Record implements PlayerEvent
Fired before a player is let in, while the connection can still be refused.

  • Constructor Details

    • PlayerPreLoginEvent

      public PlayerPreLoginEvent(FPlayer player)
      Creates an event that allows the player in with no kick reason.
      Parameters:
      player - the connecting player

    • PlayerPreLoginEvent

      public PlayerPreLoginEvent(boolean cancelled, FPlayer player, net.kyori.adventure.text.Component kickReason, boolean allowed)
      Creates an instance of a PlayerPreLoginEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      player - the value for the player record component
      kickReason - the value for the kickReason record component
      allowed - the value for the allowed record component

  • Method Details

    • withCancelled

      public PlayerPreLoginEvent 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 PlayerPreLoginEvent 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).

    • withKickReason

      public PlayerPreLoginEvent withKickReason(net.kyori.adventure.text.Component kickReason)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withAllowed

      public PlayerPreLoginEvent withAllowed(boolean allowed)
      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

    • kickReason

      public net.kyori.adventure.text.Component kickReason()
      Returns the value of the kickReason record component.
      Returns:
      the value of the kickReason record component

    • allowed

      public boolean allowed()
      Returns the value of the allowed record component.
      Returns:
      the value of the allowed record component