Record Class MessageReceiveEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.message.MessageReceiveEvent
Record Components:
cancelled - whether a listener suppressed the message
player - the receiving player
component - the message
overlay - whether it is drawn over the hotbar instead of in chat
All Implemented Interfaces:
Event
public record MessageReceiveEvent(boolean cancelled, FPlayer player, net.kyori.adventure.text.Component component, boolean overlay) extends Record implements Event
Fired when the server is about to show a message to a player, including messages FlectonePulse did not send.

  • Constructor Details

    • MessageReceiveEvent

      public MessageReceiveEvent(FPlayer fPlayer, net.kyori.adventure.text.Component component, boolean overlay)
      Creates an event that has not been cancelled.
      Parameters:
      fPlayer - the receiving player
      component - the message
      overlay - whether it is drawn over the hotbar

    • MessageReceiveEvent

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

  • Method Details

    • getTranslatableComponent

      public net.kyori.adventure.text.TranslatableComponent getTranslatableComponent()
      The message as a translatable component, which vanilla messages usually are.
      Returns:
      the translatable component, or null if the message is not translatable

    • withCancelled

      public MessageReceiveEvent 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 MessageReceiveEvent withPlayer(FPlayer player)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withComponent

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

    • withOverlay

      public MessageReceiveEvent withOverlay(boolean overlay)
      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.
      Returns:
      the value of the player record component

    • component

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

    • overlay

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