Files
Mantle/src/main/java/slimeknights/mantle/network/NetworkWrapper.java
T
KnightMiner 8b8f979a4f Clean up network logic
* Renamed BookNetowkr network to MantleNetwork, as I'd like this to be usable for things other than books if needed
* Replace abstract packet with an interface
* Reimplement threadsafe packet
* Simplify registration methods
* Require a network direction on registation, to filter packets into client only/server only
2020-07-24 12:09:56 -05:00

124 lines
4.4 KiB
Java

package slimeknights.mantle.network;
import net.minecraft.entity.Entity;
import net.minecraft.entity.player.ServerPlayerEntity;
import net.minecraft.network.IPacket;
import net.minecraft.network.PacketBuffer;
import net.minecraft.util.ResourceLocation;
import net.minecraft.util.math.BlockPos;
import net.minecraft.world.chunk.Chunk;
import net.minecraft.world.server.ServerWorld;
import net.minecraftforge.common.util.FakePlayer;
import net.minecraftforge.fml.network.NetworkDirection;
import net.minecraftforge.fml.network.NetworkEvent.Context;
import net.minecraftforge.fml.network.NetworkRegistry;
import net.minecraftforge.fml.network.PacketDistributor;
import net.minecraftforge.fml.network.simple.SimpleChannel;
import slimeknights.mantle.network.packet.ISimplePacket;
import javax.annotation.Nullable;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.function.Supplier;
/**
* A small network implementation/wrapper using AbstractPackets instead of IMessages.
* Instantiate in your mod class and register your packets accordingly.
*/
@SuppressWarnings({"unused", "WeakerAccess"})
public class NetworkWrapper {
/** Network instance */
public final SimpleChannel network;
private int id = 0;
private static final String PROTOCOL_VERSION = Integer.toString(1);
/**
* Creates a new network wrapper
* @param channelName Unique packet channel name
*/
public NetworkWrapper(ResourceLocation channelName) {
this.network = NetworkRegistry.ChannelBuilder.named(channelName)
.clientAcceptedVersions(PROTOCOL_VERSION::equals)
.serverAcceptedVersions(PROTOCOL_VERSION::equals)
.networkProtocolVersion(() -> PROTOCOL_VERSION)
.simpleChannel();
}
/**
* Registers a new {@link ISimplePacket}
* @param clazz Packet class
* @param decoder Packet decoder, typically the constructor
* @param <MSG> Packet class type
*/
public <MSG extends ISimplePacket> void registerPacket(Class<MSG> clazz, Function<PacketBuffer, MSG> decoder, @Nullable NetworkDirection direction) {
registerPacket(clazz, ISimplePacket::encode, decoder, ISimplePacket::handle, direction);
}
/**
* Registers a new generic packet
* @param clazz Packet class
* @param encoder Encodes a packet to the buffer
* @param decoder Packet decoder, typically the constructor
* @param consumer Logic to handle a packet
* @param direction Network direction for validation. Pass null for no direction
* @param <MSG> Packet class type
*/
public <MSG> void registerPacket(Class<MSG> clazz, BiConsumer<MSG, PacketBuffer> encoder, Function<PacketBuffer, MSG> decoder, BiConsumer<MSG,Supplier<Context>> consumer, @Nullable NetworkDirection direction) {
this.network.registerMessage(this.id++, clazz, encoder, decoder, consumer, Optional.ofNullable(direction));
}
/* Sending packets */
/**
* Sends a packet to the server
* @param msg Packet to send
*/
public void sendToServer(Object msg) {
this.network.sendToServer(msg);
}
/**
* Sends a packet to the given packet distributor
* @param target Packet target
* @param message Packet to send
*/
public void send(PacketDistributor.PacketTarget target, Object message) {
network.send(target, message);
}
/**
* Sends a vanilla packet to the given entity
* @param player Player receiving the packet
* @param packet Packet
*/
public void sendVanillaPacket(IPacket<?> packet, Entity player) {
if (player instanceof ServerPlayerEntity && ((ServerPlayerEntity) player).connection != null) {
((ServerPlayerEntity) player).connection.sendPacket(packet);
}
}
/**
* Sends a packet to a player
* @param msg Packet
* @param player Player to send
*/
public void sendTo(Object msg, ServerPlayerEntity player) {
if (!(player instanceof FakePlayer)) {
network.sendTo(msg, player.connection.netManager, NetworkDirection.PLAY_TO_CLIENT);
}
}
/**
* Sends a packet to players near a location
* @param msg Packet to send
* @param serverWorld World instance
* @param position Position within range
*/
public void sendToClientsAround(Object msg, ServerWorld serverWorld, BlockPos position) {
Chunk chunk = serverWorld.getChunkAt(position);
network.send(PacketDistributor.TRACKING_CHUNK.with(() -> chunk), msg);
}
}