Package net.minecraftforge.network

Record Class PayloadChannel.Builder.Flow<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload>

java.lang.Object

java.lang.Record

net.minecraftforge.network.PayloadChannel.Builder.Flow<BUF,BASE>

All Implemented Interfaces:

ChannelBuildable<CustomPacketPayload>, PayloadConnection<BASE>, PayloadFlow<BUF,BASE>, PayloadProtocol<BUF,BASE>, PayloadChannel.Builder.ProtocolFactory<BUF,BASE>, BaseProtocol<PayloadFlow<BUF,BASE>,PayloadProtocol<BUF,BASE>>

Enclosing class:

PayloadChannel.Builder

private static record PayloadChannel.Builder.Flow<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload>(PayloadChannel.Builder.BuilderContext<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload> ctx)
extends Record
implements PayloadChannel.Builder.ProtocolFactory<BUF,BASE>, PayloadFlow<BUF,BASE>

Field Summary

Fields

Modifier and Type	Field	Description
private final PayloadChannel.Builder.BuilderContext<BUF,BASE>	ctx	The field for the ctx record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Flow(PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx)	Creates an instance of a Flow record class.

Method Summary

Modifier and Type	Method	Description
<MSG extends BASE> PayloadChannel.Builder.Flow<BUF,BASE>	add(CustomPacketPayload.Type<MSG> type, StreamCodec<BUF,MSG> codec, BiConsumer<MSG,CustomPayloadEvent.Context> consumer)	Adds a packet to this channel that has it's protocol validated whenever sent or received.
PayloadChannel.Builder.BuilderContext<BUF,BASE>	ctx()	Returns the value of the ctx record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PayloadFlow<BUF,BASE>	flow(@Nullable PacketFlow flow)
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.network.simple.BaseProtocol

bidirectional, bidirectional, clientbound, clientbound, flow, flow, serverbound, serverbound

Methods inherited from interface net.minecraftforge.network.PayloadChannel.Builder.ProtocolFactory

build, protocol, protocol

Methods inherited from interface net.minecraftforge.network.payload.PayloadConnection

any, any, any, any, configuration, configuration, configuration, configuration, login, login, login, login, play, play, play, play, protocol, protocol

Methods inherited from interface net.minecraftforge.network.payload.PayloadFlow

addMain

Field Details

ctx

private final PayloadChannel.Builder.BuilderContext<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload> ctx

The field for the ctx record component.

Constructor Details

Flow

private Flow(PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx)

Creates an instance of a Flow record class.

Parameters:

ctx - the value for the ctx record component

Method Details

add

public <MSG extends BASE>
PayloadChannel.Builder.Flow<BUF,BASE> add(CustomPacketPayload.Type<MSG> type,
 StreamCodec<BUF,MSG> codec,
 BiConsumer<MSG,CustomPayloadEvent.Context> consumer)

Description copied from interface: PayloadFlow

Adds a packet to this channel that has it's protocol validated whenever sent or received.

The handler is called on the network thread, and so should not interact with most game state by default. CustomPayloadEvent.Context.enqueueWork(Runnable) can be used to handle the message on the main server or client thread.

Specified by:

add in interface PayloadFlow<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload>

flow

public PayloadFlow<BUF,BASE> flow(@Nullable
 @Nullable PacketFlow flow)

Specified by:

flow in interface BaseProtocol<BUF extends FriendlyByteBuf,BASE extends 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

ctx

public PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx()

Returns the value of the ctx record component.

Specified by:

ctx in interface PayloadChannel.Builder.ProtocolFactory<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload>

Returns:

the value of the ctx record component