Package net.minecraftforge.network

Record Class PacketDistributor<T>

java.lang.Object

java.lang.Record

net.minecraftforge.network.PacketDistributor<T>

Type Parameters:

T -

public record PacketDistributor<T>(BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor, NetworkDirection<?> direction)
extends Record

Means to distribute packets in various ways

See Also:

• Channel.send(Object, PacketTarget)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PacketDistributor.PacketTarget	A Distributor curried with a specific value instance, for actual dispatch
static final record	PacketDistributor.TargetPoint

Field Summary

Fields

Modifier and Type	Field	Description
static final PacketDistributor<Void>	ALL	Send to everyone noArg()
static final PacketDistributor<ResourceKey<Level>>	DIMENSION	Send to everyone in the dimension specified in the Supplier with(T) DimensionType
private final NetworkDirection<?>	direction	The field for the direction record component.
private final BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>>	functor	The field for the functor record component.
static final PacketDistributor<PacketDistributor.TargetPoint>	NEAR	Send to everyone near the PacketDistributor.TargetPoint specified in the Supplier with(T) TargetPoint
static final PacketDistributor<List<Connection>>	NMLIST	Send to the supplied list of NetworkManager instances in the Supplier with(T) List of NetworkManager
static final PacketDistributor<ServerPlayer>	PLAYER	Send to the player specified in the Supplier with(T) Player
static final PacketDistributor<Void>	SERVER	Send to the server (CLIENT to SERVER) noArg()
static final PacketDistributor<LevelChunk>	TRACKING_CHUNK	Send to all tracking the Chunk in the Supplier with(T) Chunk
static final PacketDistributor<Entity>	TRACKING_ENTITY	Send to all tracking the Entity in the Supplier with(T) Entity
static final PacketDistributor<Entity>	TRACKING_ENTITY_AND_SELF	Send to all tracking the Entity and Player in the Supplier with(T) Entity

Constructor Summary

Constructors

Constructor	Description
PacketDistributor(BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor)
PacketDistributor(BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor, NetworkDirection<?> direction)	Creates an instance of a PacketDistributor record class.

Method Summary

Modifier and Type	Method	Description
private Consumer<Packet<?>>	clientToServer(Void ignored)
NetworkDirection<?>	direction()	Returns the value of the direction record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>>	functor()	Returns the value of the functor record component.
private MinecraftServer	getServer()
final int	hashCode()	Returns a hash code value for this object.
private Consumer<Packet<?>>	networkManagerList(List<Connection> connections)
PacketDistributor.PacketTarget	noArg()	Apply a no argument value to a distributor to generate an instance for sending packets to.
private Consumer<Packet<?>>	playerConsumer(ServerPlayer player)
private Consumer<Packet<?>>	playerListAll(Void ignored)
private Consumer<Packet<?>>	playerListDimConsumer(ResourceKey<Level> dimension)
private Consumer<Packet<?>>	playerListPointConsumer(PacketDistributor.TargetPoint tp)
final String	toString()	Returns a string representation of this record class.
private Consumer<Packet<?>>	trackingChunk(LevelChunk chunk)
private Consumer<Packet<?>>	trackingEntity(Entity entity)
private Consumer<Packet<?>>	trackingEntityAndSelf(Entity entity)
PacketDistributor.PacketTarget	with(T input)	Apply the supplied value to the specific distributor to generate an instance for sending packets to.

Methods inherited from class java.lang.Object

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

Field Details

functor

private final BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor

The field for the functor record component.

direction

private final NetworkDirection<?> direction

The field for the direction record component.

PLAYER

public static final PacketDistributor<ServerPlayer> PLAYER

Send to the player specified in the Supplier
with(T) Player

DIMENSION

public static final PacketDistributor<ResourceKey<Level>> DIMENSION

Send to everyone in the dimension specified in the Supplier
with(T) DimensionType

NEAR

public static final PacketDistributor<PacketDistributor.TargetPoint> NEAR

Send to everyone near the PacketDistributor.TargetPoint specified in the Supplier
with(T) TargetPoint

ALL

public static final PacketDistributor<Void> ALL

Send to everyone
noArg()

SERVER

public static final PacketDistributor<Void> SERVER

Send to the server (CLIENT to SERVER)
noArg()

TRACKING_ENTITY

public static final PacketDistributor<Entity> TRACKING_ENTITY

Send to all tracking the Entity in the Supplier
with(T) Entity

TRACKING_ENTITY_AND_SELF

public static final PacketDistributor<Entity> TRACKING_ENTITY_AND_SELF

Send to all tracking the Entity and Player in the Supplier
with(T) Entity

TRACKING_CHUNK

public static final PacketDistributor<LevelChunk> TRACKING_CHUNK

Send to all tracking the Chunk in the Supplier
with(T) Chunk

NMLIST

public static final PacketDistributor<List<Connection>> NMLIST

Send to the supplied list of NetworkManager instances in the Supplier
with(T) List of NetworkManager

Constructor Details

PacketDistributor

public PacketDistributor(BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor)

PacketDistributor

public PacketDistributor(BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor,
 NetworkDirection<?> direction)

Creates an instance of a PacketDistributor record class.

Parameters:

functor - the value for the functor record component

direction - the value for the direction record component

Method Details

with

public PacketDistributor.PacketTarget with(T input)

Apply the supplied value to the specific distributor to generate an instance for sending packets to.

Parameters:

input - The input to apply

Returns:

A curried instance

noArg

public PacketDistributor.PacketTarget noArg()

Apply a no argument value to a distributor to generate an instance for sending packets to.

Returns:

A curried instance

See Also:

• ALL
• SERVER

playerConsumer

private Consumer<Packet<?>> playerConsumer(ServerPlayer player)

playerListDimConsumer

private Consumer<Packet<?>> playerListDimConsumer(ResourceKey<Level> dimension)

playerListAll

private Consumer<Packet<?>> playerListAll(Void ignored)

clientToServer

private Consumer<Packet<?>> clientToServer(Void ignored)

playerListPointConsumer

private Consumer<Packet<?>> playerListPointConsumer(PacketDistributor.TargetPoint tp)

trackingEntity

private Consumer<Packet<?>> trackingEntity(Entity entity)

trackingEntityAndSelf

private Consumer<Packet<?>> trackingEntityAndSelf(Entity entity)

trackingChunk

private Consumer<Packet<?>> trackingChunk(LevelChunk chunk)

networkManagerList

private Consumer<Packet<?>> networkManagerList(List<Connection> connections)

getServer

private MinecraftServer getServer()

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.

functor

public BiFunction<PacketDistributor<T>,T,Consumer<Packet<?>>> functor()

Returns the value of the functor record component.

Returns:

the value of the functor record component

direction

public NetworkDirection<?> direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component