Record Class MessageSendEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.message.MessageSendEvent
All Implemented Interfaces:
Event
public record MessageSendEvent(boolean cancelled, ModuleName moduleName, FEntity sender, FPlayer receiver, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata<?> eventMetadata) extends Record implements Event

  • Constructor Details

    • MessageSendEvent

      public MessageSendEvent(ModuleName moduleName, FPlayer receiver, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata<?> eventMetadata)

    • MessageSendEvent

      public MessageSendEvent(ModuleName moduleName, FPlayer sender, net.kyori.adventure.text.Component message)

    • MessageSendEvent

      public MessageSendEvent(boolean cancelled, ModuleName moduleName, FEntity sender, FPlayer receiver, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component submessage, EventMetadata<?> eventMetadata)
      Creates an instance of a MessageSendEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      moduleName - the value for the moduleName record component
      sender - the value for the sender record component
      receiver - the value for the receiver record component
      message - the value for the message record component
      submessage - the value for the submessage record component
      eventMetadata - the value for the eventMetadata record component

  • Method Details

    • withCancelled

      public MessageSendEvent withCancelled(boolean cancelled)
      Specified by:
      withCancelled in interface Event
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withModuleName

      public MessageSendEvent withModuleName(ModuleName moduleName)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withSender

      public MessageSendEvent withSender(FEntity sender)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withReceiver

      public MessageSendEvent withReceiver(FPlayer receiver)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withMessage

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

    • withSubmessage

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

    • withEventMetadata

      public MessageSendEvent withEventMetadata(EventMetadata<?> eventMetadata)
      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

    • moduleName

      public ModuleName moduleName()
      Returns the value of the moduleName record component.
      Returns:
      the value of the moduleName record component

    • sender

      public FEntity sender()
      Returns the value of the sender record component.
      Returns:
      the value of the sender record component

    • receiver

      public FPlayer receiver()
      Returns the value of the receiver record component.
      Returns:
      the value of the receiver record component

    • message

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

    • submessage

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

    • eventMetadata

      public EventMetadata<?> eventMetadata()
      Returns the value of the eventMetadata record component.
      Returns:
      the value of the eventMetadata record component