Class Dispatcher

java.lang.Object
commonnetwork.api.Dispatcher
public class Dispatcher extends Object
Static convenience facade over NetworkHandler. Every method delegates to Network.getNetworkHandler(); use this when you don't want to thread the handler reference through your code.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Dispatcher()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    @Nullable net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket
    getRawClientboundPacket(T packet)
    Generates a ClientboundCustomPayloadPacket wrapping the given packet without sending it.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    @Nullable net.minecraft.network.protocol.common.ServerboundCustomPayloadPacket
    getRawServerboundPacket(T packet)
    Generates a ServerboundCustomPayloadPacket wrapping the given packet without sending it.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    send(T packet, net.minecraft.network.Connection connection)
    Sends the packet to the connection.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToAllClients(T packet, net.minecraft.server.MinecraftServer server)
    Sends the packet to all the client players in the server, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToAllClients(T packet, net.minecraft.server.MinecraftServer server, boolean ignoreCheck)
    Sends the packet to all the client players in the server.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClient(T packet, net.minecraft.server.level.ServerPlayer player)
    Sends the packet to the client player, only if the player has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClient(T packet, net.minecraft.server.level.ServerPlayer player, boolean ignoreCheck)
    Sends the packet to the client player.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClients(T packet, List<net.minecraft.server.level.ServerPlayer> players)
    Sends the packet to the client players, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClients(T packet, List<net.minecraft.server.level.ServerPlayer> players, boolean ignoreCheck)
    Sends the packet to the client players.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsInLevel(T packet, net.minecraft.server.level.ServerLevel level)
    Sends the packet to all the client players in the level, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsInLevel(T packet, net.minecraft.server.level.ServerLevel level, boolean ignoreCheck)
    Sends the packet to all the client players in the level.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsInRange(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, double range)
    Sends the packet to all the client players in range of a position, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsInRange(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, double range, boolean ignoreCheck)
    Sends the packet to all the client players in range of a position.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingChunk(T packet, net.minecraft.world.level.chunk.LevelChunk chunk)
    Sends the packet to all the client players loading a chunk, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingChunk(T packet, net.minecraft.world.level.chunk.LevelChunk chunk, boolean ignoreCheck)
    Sends the packet to all the client players loading a chunk.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos)
    Sends the packet to all the client players loading a position, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, boolean ignoreCheck)
    Sends the packet to all the client players loading a position.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.world.level.ChunkPos pos)
    Sends the packet to all the client players loading a position, only if the players has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.world.level.ChunkPos pos, boolean ignoreCheck)
    Sends the packet to all the client players loading a position.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToServer(T packet)
    Sends the packet to the server, if the server has the packet registered.
    static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    void
    sendToServer(T packet, boolean ignoreCheck)
    Sends the packet to the server.

    Methods inherited from class Object

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

  • Constructor Details

    • Dispatcher

      public Dispatcher()

  • Method Details

    • sendToServer

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToServer(T packet)
      Sends the packet to the server, if the server has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet

    • sendToServer

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToServer(T packet, boolean ignoreCheck)
      Sends the packet to the server. Can ignore the check if the server has the packet registered. Likely use case for this is talking to bukkit/spigot/paper servers.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      ignoreCheck - - ignore the check if the server has the packet registered.

    • send

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void send(T packet, net.minecraft.network.Connection connection)
      Sends the packet to the connection.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      connection - - the connection

    • sendToClient

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClient(T packet, net.minecraft.server.level.ServerPlayer player)
      Sends the packet to the client player, only if the player has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      player - - the player

    • sendToClient

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClient(T packet, net.minecraft.server.level.ServerPlayer player, boolean ignoreCheck)
      Sends the packet to the client player.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      player - - the player
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClients

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClients(T packet, List<net.minecraft.server.level.ServerPlayer> players)
      Sends the packet to the client players, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      players - - the players

    • sendToClients

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClients(T packet, List<net.minecraft.server.level.ServerPlayer> players, boolean ignoreCheck)
      Sends the packet to the client players.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      players - - the players
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToAllClients

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToAllClients(T packet, net.minecraft.server.MinecraftServer server)
      Sends the packet to all the client players in the server, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      server - - the server

    • sendToAllClients

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToAllClients(T packet, net.minecraft.server.MinecraftServer server, boolean ignoreCheck)
      Sends the packet to all the client players in the server.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      server - - the server
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClientsInLevel

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsInLevel(T packet, net.minecraft.server.level.ServerLevel level)
      Sends the packet to all the client players in the level, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level

    • sendToClientsInLevel

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsInLevel(T packet, net.minecraft.server.level.ServerLevel level, boolean ignoreCheck)
      Sends the packet to all the client players in the level.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClientsLoadingChunk

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingChunk(T packet, net.minecraft.world.level.chunk.LevelChunk chunk)
      Sends the packet to all the client players loading a chunk, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      chunk - - the chunk

    • sendToClientsLoadingChunk

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingChunk(T packet, net.minecraft.world.level.chunk.LevelChunk chunk, boolean ignoreCheck)
      Sends the packet to all the client players loading a chunk.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      chunk - - the chunk
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClientsLoadingPos

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.world.level.ChunkPos pos)
      Sends the packet to all the client players loading a position, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the chunkpos

    • sendToClientsLoadingPos

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.world.level.ChunkPos pos, boolean ignoreCheck)
      Sends the packet to all the client players loading a position.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the chunkpos
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClientsLoadingPos

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos)
      Sends the packet to all the client players loading a position, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the blockpos

    • sendToClientsLoadingPos

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsLoadingPos(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, boolean ignoreCheck)
      Sends the packet to all the client players loading a position.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the blockpos
      ignoreCheck - - ignore the check if the client has the packet registered.

    • sendToClientsInRange

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsInRange(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, double range)
      Sends the packet to all the client players in range of a position, only if the players has the packet registered.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the blockpos
      range - - the range

    • sendToClientsInRange

      public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void sendToClientsInRange(T packet, net.minecraft.server.level.ServerLevel level, net.minecraft.core.BlockPos pos, double range, boolean ignoreCheck)
      Sends the packet to all the client players in range of a position.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      level - - the level
      pos - - the blockpos
      range - - the range
      ignoreCheck - - ignore the check if the client has the packet registered.

    • getRawClientboundPacket

      @Nullable public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> @Nullable net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket getRawClientboundPacket(T packet)
      Generates a ClientboundCustomPayloadPacket wrapping the given packet without sending it.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      Returns:
      The packet wrapped into a ClientboundCustomPayloadPacket, or null if the packet is not registered.

    • getRawServerboundPacket

      @Nullable public static <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> @Nullable net.minecraft.network.protocol.common.ServerboundCustomPayloadPacket getRawServerboundPacket(T packet)
      Generates a ServerboundCustomPayloadPacket wrapping the given packet without sending it.
      Type Parameters:
      T - - The packet type
      Parameters:
      packet - - the packet
      Returns:
      The packet wrapped into a ServerboundCustomPayloadPacket, or null if the packet is not registered.