Package net.minecraftforge.network
Record Class ForgePayload
java.lang.Object
java.lang.Record
net.minecraftforge.network.ForgePayload
- All Implemented Interfaces:
CustomPacketPayload
,CustomQueryAnswerPayload
,CustomQueryPayload
@Internal
public record ForgePayload(ResourceLocation id, @Nullable FriendlyByteBuf data, Consumer<FriendlyByteBuf> encoder)
extends Record
implements CustomPacketPayload, CustomQueryPayload, CustomQueryAnswerPayload
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload
CustomPacketPayload.FallbackProvider<B extends FriendlyByteBuf>, CustomPacketPayload.Type<T extends CustomPacketPayload>, CustomPacketPayload.TypeAndCodec<B extends FriendlyByteBuf,
T extends CustomPacketPayload> -
Field Summary
Modifier and TypeFieldDescriptionprivate final @Nullable FriendlyByteBuf
The field for thedata
record component.private final Consumer
<FriendlyByteBuf> The field for theencoder
record component.private final ResourceLocation
The field for theid
record component. -
Constructor Summary
ConstructorDescriptionForgePayload
(ResourceLocation id, @Nullable FriendlyByteBuf data, Consumer<FriendlyByteBuf> encoder) Creates an instance of aForgePayload
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic ForgePayload
create
(ResourceLocation id, Consumer<FriendlyByteBuf> encoder) static ForgePayload
create
(ResourceLocation id, FriendlyByteBuf data) @Nullable FriendlyByteBuf
data()
Returns the value of thedata
record component.encoder()
Returns the value of theencoder
record component.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.id()
Returns the value of theid
record component.final String
toString()
Returns a string representation of this record class.CustomPacketPayload.Type
<? extends CustomPacketPayload> type()
void
write
(FriendlyByteBuf buf)
-
Field Details
-
id
The field for theid
record component. -
data
The field for thedata
record component. -
encoder
The field for theencoder
record component.
-
-
Constructor Details
-
ForgePayload
public ForgePayload(ResourceLocation id, @Nullable @Nullable FriendlyByteBuf data, Consumer<FriendlyByteBuf> encoder) Creates an instance of aForgePayload
record class.- Parameters:
id
- the value for theid
record componentdata
- the value for thedata
record componentencoder
- the value for theencoder
record component
-
-
Method Details
-
create
-
create
-
write
- Specified by:
write
in interfaceCustomQueryAnswerPayload
- Specified by:
write
in interfaceCustomQueryPayload
-
type
- Specified by:
type
in interfaceCustomPacketPayload
-
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. -
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. -
equals
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. All components in this record class are compared withObjects::equals(Object,Object)
. -
id
Returns the value of theid
record component.- Specified by:
id
in interfaceCustomQueryPayload
- Returns:
- the value of the
id
record component
-
data
Returns the value of thedata
record component.- Returns:
- the value of the
data
record component
-
encoder
Returns the value of theencoder
record component.- Returns:
- the value of the
encoder
record component
-