Package net.neoforged.neoforge.network.payload

Record Class AdvancedAddEntityPayload

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.payload.AdvancedAddEntityPayload
Record Components:
entityId - The id of the entity to add.
customPayload - The custom data of the entity to add.
All Implemented Interfaces:
net.minecraft.network.protocol.common.custom.CustomPacketPayload, ClientDispatchPayload
@Internal public record AdvancedAddEntityPayload(int entityId, byte[] customPayload) extends Record implements ClientDispatchPayload
Payload that can be sent from the server to the client to add an entity to the world, with custom data.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    net.minecraft.network.protocol.common.custom.CustomPacketPayload.FallbackProvider<B extends net.minecraft.network.FriendlyByteBuf>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.TypeAndCodec<B extends net.minecraft.network.FriendlyByteBuf,T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final byte[]
    customPayload
    The field for the customPayload record component.
    private final int
    entityId
    The field for the entityId record component.
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,AdvancedAddEntityPayload>
    STREAM_CODEC
     
    static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<AdvancedAddEntityPayload>
    TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdvancedAddEntityPayload(int entityId, byte[] customPayload)
    Creates an instance of a AdvancedAddEntityPayload record class.
    AdvancedAddEntityPayload(net.minecraft.world.entity.Entity e)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    customPayload()
    Returns the value of the customPayload record component.
    int
    entityId()
    Returns the value of the entityId record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<AdvancedAddEntityPayload>
    type()
     
    private static byte[]
    writeCustomData(net.minecraft.world.entity.Entity entity)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    toVanillaClientbound, toVanillaServerbound

  • Field Details

    • entityId

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

    • customPayload

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

    • TYPE

      public static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<AdvancedAddEntityPayload> TYPE

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,AdvancedAddEntityPayload> STREAM_CODEC

  • Constructor Details

    • AdvancedAddEntityPayload

      public AdvancedAddEntityPayload(net.minecraft.world.entity.Entity e)

    • AdvancedAddEntityPayload

      public AdvancedAddEntityPayload(int entityId, byte[] customPayload)
      Creates an instance of a AdvancedAddEntityPayload record class.
      Parameters:
      entityId - the value for the entityId record component
      customPayload - the value for the customPayload record component

  • Method Details

    • writeCustomData

      private static byte[] writeCustomData(net.minecraft.world.entity.Entity entity)

    • type

      public net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<AdvancedAddEntityPayload> type()
      Specified by:
      type in interface net.minecraft.network.protocol.common.custom.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.

    • entityId

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

    • customPayload

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