Package net.minestom.server.utils

Class PacketSendingUtils

java.lang.Object

net.minestom.server.utils.PacketSendingUtils

public final class PacketSendingUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
PacketSendingUtils()

Method Summary

Modifier and Type	Method	Description
static void	broadcastPlayPacket(@NotNull ServerPacket packet)
static void	sendGroupedPacket(@NotNull Collection<Player> players, @NotNull ServerPacket packet)	Same as sendGroupedPacket(Collection, ServerPacket, Predicate) but without any predicate.
static void	sendGroupedPacket(@NotNull Collection<Player> players, @NotNull ServerPacket packet, @NotNull Predicate<Player> predicate)	Sends a ServerPacket to multiple players.
static void	sendPacket(@NotNull Audience audience, @NotNull ServerPacket packet)	Sends a packet to an audience.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PacketSendingUtils

public PacketSendingUtils()

Method Details

sendPacket

public static void sendPacket(@NotNull
 @NotNull Audience audience,
 @NotNull
 @NotNull ServerPacket packet)

Sends a packet to an audience. This method performs the following steps in the following order:

1. If audience is a Player, send the packet to them.
2. Otherwise, if audience is a PacketGroupingAudience, call sendGroupedPacket(Collection, ServerPacket) on the players that the grouping audience contains.
3. Otherwise, if audience is a ForwardingAudience.Single, call this method on the single audience inside the forwarding audience.
4. Otherwise, if audience is a ForwardingAudience, call this method for each audience member of the forwarding audience.
5. Otherwise, do nothing.

Parameters:

audience - the audience

packet - the packet

sendGroupedPacket

public static void sendGroupedPacket(@NotNull
 @NotNull Collection<Player> players,
 @NotNull
 @NotNull ServerPacket packet,
 @NotNull
 @NotNull Predicate<Player> predicate)

Sends a ServerPacket to multiple players.

Can drastically improve performance since the packet will not have to be processed as much.

Parameters:

players - the players to send the packet to

packet - the packet to send to the players

predicate - predicate to ignore specific players

sendGroupedPacket

public static void sendGroupedPacket(@NotNull
 @NotNull Collection<Player> players,
 @NotNull
 @NotNull ServerPacket packet)

Same as sendGroupedPacket(Collection, ServerPacket, Predicate) but without any predicate.

See Also:

• sendGroupedPacket(Collection, ServerPacket, Predicate)

broadcastPlayPacket

public static void broadcastPlayPacket(@NotNull
 @NotNull ServerPacket packet)