Package net.neoforged.neoforge.network.payload

Record Class AdvancedOpenScreenPayload

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.payload.AdvancedOpenScreenPayload
Record Components:
windowId - The window ID to use for the screen.
menuType - The menu type to open.
name - The name of the screen.
additionalData - The additional data to pass to the screen.
All Implemented Interfaces:
CustomPacketPayload
@Internal public record AdvancedOpenScreenPayload(int windowId, MenuType<?> menuType, Component name, byte[] additionalData) extends Record implements CustomPacketPayload
A custom payload that allows for opening screens with additional data.

  • Field Details

    • windowId

      private final int windowId
      The field for the windowId record component.

    • name

      private final Component name
      The field for the name record component.

    • additionalData

      private final byte[] additionalData
      The field for the additionalData record component.

    • ID

      public static final ResourceLocation ID

  • Constructor Details

    • AdvancedOpenScreenPayload

      public AdvancedOpenScreenPayload(int windowId, MenuType<?> menuType, Component name, Consumer<FriendlyByteBuf> dataWriter)

    • AdvancedOpenScreenPayload

      public AdvancedOpenScreenPayload(FriendlyByteBuf buffer)

    • AdvancedOpenScreenPayload

      public AdvancedOpenScreenPayload(int windowId, MenuType<?> menuType, Component name, byte[] additionalData)
      Creates an instance of a AdvancedOpenScreenPayload record class.
      Parameters:
      windowId - the value for the windowId record component
      menuType - the value for the menuType record component
      name - the value for the name record component
      additionalData - the value for the additionalData record component

  • Method Details

    • write

      public void write(FriendlyByteBuf buffer)
      Specified by:
      write in interface CustomPacketPayload

    • id

      public ResourceLocation id()
      Specified by:
      id in interface CustomPacketPayload

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

    • windowId

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

    • name

      public Component name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • additionalData

      public byte[] additionalData()
      Returns the value of the additionalData record component.
      Returns:
      the value of the additionalData record component