Package net.minestom.server.network.packet.server.play

Record Class PlayerChatMessagePacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.play.PlayerChatMessagePacket
All Implemented Interfaces:
ComponentHolder<ServerPacket>, NetworkBuffer.Writer, ComponentHoldingServerPacket, SendablePacket, ServerPacket
public record PlayerChatMessagePacket(UUID sender, int index, byte @Nullable [] signature, @NotNull SignedMessageBody.Packed messageBody, @Nullable net.kyori.adventure.text.Component unsignedContent, FilterMask filterMask, int msgTypeId, net.kyori.adventure.text.Component msgTypeName, @Nullable net.kyori.adventure.text.Component msgTypeTarget) extends Record implements ComponentHoldingServerPacket
Represents an outgoing chat message packet.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerChatMessagePacket(UUID sender, int index, byte @Nullable [] signature, @NotNull SignedMessageBody.Packed messageBody, @Nullable net.kyori.adventure.text.Component unsignedContent, FilterMask filterMask, int msgTypeId, net.kyori.adventure.text.Component msgTypeName, @Nullable net.kyori.adventure.text.Component msgTypeTarget)
    Creates an instance of a PlayerChatMessagePacket record class.
    PlayerChatMessagePacket(@NotNull NetworkBuffer reader)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Collection<net.kyori.adventure.text.Component>
    components()
    Gets the components held by this object.
    @NotNull ServerPacket
    copyWithOperator(@NotNull UnaryOperator<net.kyori.adventure.text.Component> operator)
    Returns a copy of this object.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    FilterMask
    filterMask()
    Returns the value of the filterMask record component.
    int
    getId(@NotNull ConnectionState state)
    Gets the id of this packet.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index()
    Returns the value of the index record component.
    @NotNull SignedMessageBody.Packed
    messageBody()
    Returns the value of the messageBody record component.
    int
    msgTypeId()
    Returns the value of the msgTypeId record component.
    net.kyori.adventure.text.Component
    msgTypeName()
    Returns the value of the msgTypeName record component.
    @Nullable net.kyori.adventure.text.Component
    msgTypeTarget()
    Returns the value of the msgTypeTarget record component.
    UUID
    sender()
    Returns the value of the sender record component.
    byte @Nullable []
    signature()
    Returns the value of the signature record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable net.kyori.adventure.text.Component
    unsignedContent()
    Returns the value of the unsignedContent record component.
    void
    write(@NotNull NetworkBuffer writer)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.minestom.server.adventure.ComponentHolder

    visitComponents

  • Constructor Details

    • PlayerChatMessagePacket

      public PlayerChatMessagePacket(@NotNull @NotNull NetworkBuffer reader)

    • PlayerChatMessagePacket

      public PlayerChatMessagePacket(UUID sender, int index, byte @Nullable [] signature, @NotNull SignedMessageBody.Packed messageBody, @Nullable @Nullable net.kyori.adventure.text.Component unsignedContent, FilterMask filterMask, int msgTypeId, net.kyori.adventure.text.Component msgTypeName, @Nullable @Nullable net.kyori.adventure.text.Component msgTypeTarget)
      Creates an instance of a PlayerChatMessagePacket record class.
      Parameters:
      sender - the value for the sender record component
      index - the value for the index record component
      signature - the value for the signature record component
      messageBody - the value for the messageBody record component
      unsignedContent - the value for the unsignedContent record component
      filterMask - the value for the filterMask record component
      msgTypeId - the value for the msgTypeId record component
      msgTypeName - the value for the msgTypeName record component
      msgTypeTarget - the value for the msgTypeTarget record component

  • Method Details

    • write

      public void write(@NotNull @NotNull NetworkBuffer writer)
      Specified by:
      write in interface NetworkBuffer.Writer

    • getId

      public int getId(@NotNull @NotNull ConnectionState state)
      Description copied from interface: ServerPacket
      Gets the id of this packet.

      Written in the final buffer header so it needs to match the client id.

      Specified by:
      getId in interface ServerPacket
      Returns:
      the id of this packet

    • components

      @NotNull public @NotNull Collection<net.kyori.adventure.text.Component> components()
      Description copied from interface: ComponentHolder
      Gets the components held by this object.
      Specified by:
      components in interface ComponentHolder<ServerPacket>
      Returns:
      the components

    • copyWithOperator

      @NotNull public @NotNull ServerPacket copyWithOperator(@NotNull @NotNull UnaryOperator<net.kyori.adventure.text.Component> operator)
      Description copied from interface: ComponentHolder
      Returns a copy of this object. For each component this object holds, the operator is applied to the copy before returning.
      Specified by:
      copyWithOperator in interface ComponentHolder<ServerPacket>
      Parameters:
      operator - the operator
      Returns:
      the copy

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

    • sender

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

    • index

      public int index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • signature

      public byte @Nullable [] signature()
      Returns the value of the signature record component.
      Returns:
      the value of the signature record component

    • messageBody

      public @NotNull SignedMessageBody.Packed messageBody()
      Returns the value of the messageBody record component.
      Returns:
      the value of the messageBody record component

    • unsignedContent

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

    • filterMask

      public FilterMask filterMask()
      Returns the value of the filterMask record component.
      Returns:
      the value of the filterMask record component

    • msgTypeId

      public int msgTypeId()
      Returns the value of the msgTypeId record component.
      Returns:
      the value of the msgTypeId record component

    • msgTypeName

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

    • msgTypeTarget

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