1.3.2 Release Stable!

* Code cleanup

* Custom NotNull and Nullable annotations added

* Example packages removed, please see https://github.com/retrooper/packetevents-example

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.retrooper</groupId>
     <artifactId>packetevents</artifactId>
-    <version>1.3.1.3</version>
+    <version>1.3.2</version>
     <packaging>jar</packaging>
     <name>packetevents</name>
     <properties>

src/main/java/io/github/retrooper/packetevents/PacketEvents.java

@@ -2,7 +2,7 @@ package io.github.retrooper.packetevents;
 
 import io.github.retrooper.packetevents.enums.ClientVersion;
 import io.github.retrooper.packetevents.enums.ServerVersion;
-import io.github.retrooper.packetevents.event.PacketHandler;
+import io.github.retrooper.packetevents.annotations.PacketHandler;
 import io.github.retrooper.packetevents.event.PacketListener;
 import io.github.retrooper.packetevents.event.impl.PacketLoginEvent;
 import io.github.retrooper.packetevents.event.impl.PlayerInjectEvent;
@@ -17,17 +17,15 @@ import io.github.retrooper.packetevents.utils.NMSUtils;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
-import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerJoinEvent;
-import org.bukkit.event.player.PlayerLoginEvent;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.scheduler.BukkitTask;
 
-import javax.annotation.Nullable;
+import io.github.retrooper.packetevents.annotations.Nullable;
 import java.lang.reflect.InvocationTargetException;
 import java.util.HashMap;
 
-public class PacketEvents implements PacketListener, Listener {
+public final class PacketEvents implements PacketListener{
 
 
     /*
@@ -40,7 +38,7 @@ public class PacketEvents implements PacketListener, Listener {
 
     private static final ServerVersion version = ServerVersion.getVersion();
     private static PacketEvents instance;
-    private static EventManager eventManager = new EventManager();
+    private static final EventManager eventManager = new EventManager();
 
     private static int currentTick;
 
@@ -62,7 +60,6 @@ public class PacketEvents implements PacketListener, Listener {
         if (!hasRegistered) {
             //Register Bukkit and PacketListener
             getEventManager().registerListener(getInstance());
-            Bukkit.getPluginManager().registerEvents(getInstance(), plugin);
 
             //Initialize the TinyProtocolHandler
             TinyProtocolHandler.initTinyProtocol(plugin);
@@ -230,22 +227,6 @@ public class PacketEvents implements PacketListener, Listener {
         final ClientVersion clientVersion = PacketEvents.getClientVersion(e.getPlayer());
     }
 
-    @EventHandler
-    public void onLogin(final PlayerLoginEvent e) {
-        final Plugin[] plugins = Bukkit.getPluginManager().getPlugins();
-        boolean canJoin = true;
-        for (final Plugin pl : plugins) {
-            if (!pl.isEnabled()) {
-                canJoin = false;
-                break;
-            }
-        }
-        if (!canJoin) {
-            e.setResult(PlayerLoginEvent.Result.KICK_OTHER);
-            e.setKickMessage("Please wait for the server to finish loading all plugins");
-        }
-    }
-
     @EventHandler
     public void onJoin(PlayerJoinEvent e) {
         if (hasInjected(e.getPlayer())) {

src/main/java/io/github/retrooper/packetevents/annotations/NotNull.java

@@ -0,0 +1,13 @@
+package io.github.retrooper.packetevents.annotations;
+
+
+import java.lang.annotation.*;
+/**
+ *  Is for sure not null.
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+public @interface NotNull {
+
+
+}

src/main/java/io/github/retrooper/packetevents/annotations/Nullable.java

@@ -0,0 +1,16 @@
+package io.github.retrooper.packetevents.annotations;
+
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ *  Could be null.
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Nullable {
+
+
+}

src/main/java/io/github/retrooper/packetevents/annotations/PacketHandler.java

@@ -1,4 +1,4 @@
-package io.github.retrooper.packetevents.event;
+package io.github.retrooper.packetevents.annotations;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

src/main/java/io/github/retrooper/packetevents/event/impl/PlayerUninjectEvent.java

@@ -3,7 +3,7 @@ package io.github.retrooper.packetevents.event.impl;
 import io.github.retrooper.packetevents.event.PacketEvent;
 import org.bukkit.entity.Player;
 
-public class PlayerUninjectEvent extends PacketEvent {
+public final class PlayerUninjectEvent extends PacketEvent {
     private final Player player;
 
     public PlayerUninjectEvent(final Player player) {

src/main/java/io/github/retrooper/packetevents/event/impl/ServerTickEvent.java

@@ -3,7 +3,7 @@ package io.github.retrooper.packetevents.event.impl;
 import io.github.retrooper.packetevents.PacketEvents;
 import io.github.retrooper.packetevents.event.PacketEvent;
 
-public class ServerTickEvent extends PacketEvent {
+public final class ServerTickEvent extends PacketEvent {
     private final int tick;
     private final double tps;
     public ServerTickEvent(final int tick, final long timestamp) {

src/main/java/io/github/retrooper/packetevents/event/manager/EventManager.java

@@ -1,7 +1,7 @@
 package io.github.retrooper.packetevents.event.manager;
 
 import io.github.retrooper.packetevents.event.PacketEvent;
-import io.github.retrooper.packetevents.event.PacketHandler;
+import io.github.retrooper.packetevents.annotations.PacketHandler;
 import io.github.retrooper.packetevents.event.PacketListener;
 
 import java.lang.reflect.InvocationTargetException;
@@ -10,7 +10,7 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 
-public class EventManager {
+public final class EventManager {
 
     private HashMap<PacketListener, List<Method>> registeredMethods = new HashMap<PacketListener, List<Method>>();
 

src/main/java/io/github/retrooper/packetevents/example/CustomMoveEvent.java

@@ -1,59 +0,0 @@
-package io.github.retrooper.packetevents.example;
-
-import io.github.retrooper.packetevents.event.PacketEvent;
-import org.bukkit.Location;
-import org.bukkit.entity.Player;
-
-/**
- * Example packetevent
- * Make sure to initiate the super timestamp variable,
- * if you want to use the getTimestamp() function
- */
-public class CustomMoveEvent extends PacketEvent {
-    private final Player player;
-    private Location to, from;
-    private boolean cancelled;
-
-    public CustomMoveEvent(final Player player, final Location to, final Location from) {
-        this.player = player;
-        this.to = to;
-        this.from = from;
-        this.cancelled = false;
-        //Timestamp is initialized automatically, so you don't need to initiate it, but you may modify it if you like
-        //this.timestamp = PacketEvents.currentTimeMS();
-    }
-
-    @Override
-    public long getTimestamp() {
-        return super.getTimestamp();
-    }
-
-    public void setCancelled(boolean cancelled) {
-        this.cancelled = cancelled;
-    }
-
-    public boolean isCancelled() {
-        return this.cancelled;
-    }
-
-    public Player getPlayer() {
-        return player;
-    }
-
-    public Location getTo() {
-        return to;
-    }
-
-    public Location getFrom() {
-        return from;
-    }
-
-    public void setTo(final Location loc) {
-        this.to = loc;
-    }
-
-    public void setFrom(final Location loc) {
-        this.from = from;
-    }
-
-}

src/main/java/io/github/retrooper/packetevents/example/MainExample.java

@@ -1,32 +0,0 @@
-package io.github.retrooper.packetevents.example;
-
-import io.github.retrooper.packetevents.PacketEvents;
-import org.bukkit.plugin.java.JavaPlugin;
-
-public class MainExample extends JavaPlugin {
-    @Override
-    public void onEnable() {
-
-        PacketEvents.start(this);
-
-        //If you do not need the server tick event you can just cancel its task like this
-
-        //PacketEvents.getServerTickTask().cancel();
-
-
-        /**
-         * Register TestExample's PacketListener
-         */
-        PacketEvents.getEventManager().registerListener(new RegisteredListener());
-    }
-
-    @Override
-    public void onDisable() {
-        /**
-         * Stops server tick event task if enabled and unregisters packetlisteners
-         */
-        PacketEvents.stop();
-
-    }
-
-}

src/main/java/io/github/retrooper/packetevents/example/RegisteredListener.java

@@ -1,172 +0,0 @@
-package io.github.retrooper.packetevents.example;
-
-import io.github.retrooper.packetevents.PacketEvents;
-import io.github.retrooper.packetevents.enums.*;
-import io.github.retrooper.packetevents.event.PacketEvent;
-import io.github.retrooper.packetevents.event.PacketHandler;
-import io.github.retrooper.packetevents.event.PacketListener;
-import io.github.retrooper.packetevents.event.impl.*;
-import io.github.retrooper.packetevents.packet.Packet;
-import io.github.retrooper.packetevents.packetwrappers.in.abilities.WrappedPacketInAbilities;
-import io.github.retrooper.packetevents.packetwrappers.in.blockdig.WrappedPacketInBlockDig;
-import io.github.retrooper.packetevents.packetwrappers.in.blockplace.WrappedPacketInBlockPlace;
-import io.github.retrooper.packetevents.packetwrappers.in.chat.WrappedPacketInChat;
-import io.github.retrooper.packetevents.packetwrappers.in.entityaction.WrappedPacketInEntityAction;
-import io.github.retrooper.packetevents.packetwrappers.in.flying.WrappedPacketInFlying;
-import io.github.retrooper.packetevents.packetwrappers.in.keepalive.WrappedPacketInKeepAlive;
-import io.github.retrooper.packetevents.packetwrappers.in.useentity.WrappedPacketInUseEntity;
-import io.github.retrooper.packetevents.packetwrappers.login.WrappedPacketLoginHandshake;
-import io.github.retrooper.packetevents.packetwrappers.out.chat.WrappedPacketOutChat;
-import io.github.retrooper.packetevents.packetwrappers.out.entityvelocity.WrappedPacketOutEntityVelocity;
-import io.github.retrooper.packetevents.packetwrappers.out.kickdisconnect.WrappedPacketOutKickDisconnect;
-import io.github.retrooper.packetevents.utils.vector.Vector3i;
-import org.bukkit.Location;
-import org.bukkit.entity.Entity;
-import org.bukkit.entity.Player;
-import org.bukkit.inventory.ItemStack;
-
-/**
- * Implementing PacketListener to listen to packetevents' custom events,
- */
-public class RegisteredListener implements PacketListener {
-    /**
-     * Listen to PacketReceiveEvent
-     *
-     * @param e PacketReceiveEvent
-     */
-    @PacketHandler
-    public void onPacketReceive(PacketReceiveEvent e) {
-        final Player p = e.getPlayer();
-        final long timestamp = e.getTimestamp();
-
-        //The block place name field is not set at compilation time, so we cannot use it in the switch statement
-        //On 1.7->1.8.8 servers it is "PacketPlayInBlockPlace" and on 1.9+ servers it is "PacketPlayInUseItem"
-        if(e.getPacketName().equals(Packet.Client.BLOCK_PLACE)) {
-            final WrappedPacketInBlockPlace blockPlace = new WrappedPacketInBlockPlace(e.getPlayer(), e.getPacket());
-            final Vector3i blockPosition = blockPlace.getBlockPosition();
-            final ItemStack stack = blockPlace.getItemStack();
-           // e.getPlayer().sendMessage("pos: " + blockPosition.toString() + ", type: " + stack.getType());
-        }
-        switch (e.getPacketName()) {
-            case Packet.Client.USE_ENTITY:
-                final WrappedPacketInUseEntity useEntity = new WrappedPacketInUseEntity(e.getPacket());
-                final Entity entity = useEntity.getEntity();
-                final double distanceSquared = entity.getLocation().distanceSquared(p.getLocation());
-                final EntityUseAction useAction = useEntity.getAction();
-                break;
-            case Packet.Client.ABILITIES:
-                final WrappedPacketInAbilities abilities = new WrappedPacketInAbilities(e.getPacket());
-                final boolean isVulnerable = abilities.isVulnerable();
-                final boolean isFlying = abilities.isFlying();
-                final boolean canFly = abilities.canFly();
-                final boolean canInstantlyBuild = abilities.canInstantlyBuild();
-                final float flySpeed = abilities.getFlySpeed();
-                final float walkSpeed = abilities.getWalkSpeed();
-               //  e.getPlayer().sendMessage("walkspeed: " + walkSpeed + ", flyspeed: " + flySpeed + ", canFly: " + canFly);
-                break;
-            case Packet.Client.BLOCK_DIG:
-                //Custom PlayerDigType enum
-                final WrappedPacketInBlockDig blockDig = new WrappedPacketInBlockDig(e.getPacket());
-                final PlayerDigType type = blockDig.getDigType();
-                final Direction direction = blockDig.getDirection();
-                break;
-            case Packet.Client.FLYING:
-                final WrappedPacketInFlying flying = new WrappedPacketInFlying(e.getPacket());
-                final float pitch = flying.getPitch();
-                final float yaw = flying.getYaw();
-                break;
-            case Packet.Client.POSITION:
-                final WrappedPacketInFlying.WrappedPacketInPosition position =
-                        new WrappedPacketInFlying.WrappedPacketInPosition(e.getPacket());
-                final boolean isPos = position.isPosition(); //true
-                break;
-            case Packet.Client.POSITION_LOOK:
-                final WrappedPacketInFlying.WrappedPacketInPosition_Look position_look =
-                        new WrappedPacketInFlying.WrappedPacketInPosition_Look(e.getPacket());
-                final boolean isLook = position_look.isLook(); //true
-                break;
-            case Packet.Client.CHAT:
-                final WrappedPacketInChat chat = new WrappedPacketInChat(e.getPacket());
-                final String message = chat.getMessage();
-                break;
-            case Packet.Client.KEEP_ALIVE:
-                final WrappedPacketInKeepAlive keepAlive = new WrappedPacketInKeepAlive(e.getPacket());
-                final long responseID = keepAlive.getId();
-                break;
-            case Packet.Client.ENTITY_ACTION:
-                final WrappedPacketInEntityAction entityAction = new WrappedPacketInEntityAction(e.getPacket());
-                final PlayerAction action = entityAction.getAction();
-                final int jumpBoost = entityAction.getJumpBoost();
-                break;
-        }
-
-    }
-
-
-    @PacketHandler
-    public void onInject(PlayerInjectEvent event) {
-
-    }
-
-    /**
-     * In this event you can safely register your players, unlike the PlayerInjectEvent.
-     * In the PlayerInjectEvent some fields in the player object might be null.
-     * So use this event!
-     * @param event
-     */
-    @PacketHandler
-    public void onPostInject(PostPlayerInjectEvent event) {
-
-    }
-
-    /**
-     * You can use this event to unregister your players,
-     * This event is called when a player is uninjected
-     * @param event
-     */
-    @PacketHandler
-    public void onUninject(PlayerUninjectEvent event) {
-
-    }
-
-    /**
-     * Another way to listen to packets
-     *
-     * @param e PacketEvent
-     */
-    @PacketHandler
-    public void onPacket(PacketEvent e) {
-        if (e instanceof PacketSendEvent) {
-            final PacketSendEvent p = (PacketSendEvent) e;
-            final Player targetPlayer = p.getPlayer();
-            final Object rawNMSPacket = p.getPacket();
-            final long timestamp = p.getTimestamp();
-            if (p.getPacketName().equals(Packet.Server.ENTITY_VELOCITY)) {
-                final WrappedPacketOutEntityVelocity vel = new WrappedPacketOutEntityVelocity(p.getPacket());
-                final double velocityX = vel.getVelocityX();
-                final double velocityY = vel.getVelocityY();
-                final double velocityZ = vel.getVelocityZ();
-            } else if (p.getPacketName().equals(Packet.Server.CHAT)) {
-                final WrappedPacketOutChat chat = new WrappedPacketOutChat(p.getPacket());
-            }
-        } else if (e instanceof CustomMoveEvent) {
-            final CustomMoveEvent event = (CustomMoveEvent) e;
-            final Player player = event.getPlayer();
-            final Location to = event.getTo();
-            final Location from = event.getFrom();
-        } else if (e instanceof ServerTickEvent) {
-            final ServerTickEvent event = (ServerTickEvent) e;
-            final int currentTick = event.getCurrentTick();
-            final double tps = PacketEvents.getCurrentServerTPS();
-        }
-        else if(e instanceof PacketLoginEvent) {
-            final PacketLoginEvent event = (PacketLoginEvent)e;
-            if(event.getPacketName().equals(Packet.Login.HANDSHAKE)) {
-                final WrappedPacketLoginHandshake handshake = new WrappedPacketLoginHandshake(event.getPacket());
-                final int protocolVersion = handshake.getProtocolVersion();
-                final String hostname = handshake.getHostname();
-                final int port = handshake.getPort();
-            }
-        }
-    }
-}

src/main/java/io/github/retrooper/packetevents/handler/TinyProtocolHandler.java

@@ -9,7 +9,7 @@ import io.github.retrooper.packetevents.utils.NMSUtils;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
 
-public class TinyProtocolHandler {
+public final class TinyProtocolHandler {
     private static final ServerVersion version = PacketEvents.getServerVersion();
 
     private static Object tinyProtocol;

src/main/java/io/github/retrooper/packetevents/handler/TinyProtocolHandler_1_7.java

@@ -10,9 +10,9 @@ import net.minecraft.util.io.netty.channel.Channel;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
 
-import javax.annotation.Nullable;
+import io.github.retrooper.packetevents.annotations.Nullable;
 
-public class TinyProtocolHandler_1_7 {
+public final class TinyProtocolHandler_1_7 {
     private final Plugin plugin;
 
     public TinyProtocolHandler_1_7(final Plugin plugin) {

src/main/java/io/github/retrooper/packetevents/handler/TinyProtocolHandler_1_8.java

@@ -11,9 +11,9 @@ import io.netty.channel.Channel;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
 
-import javax.annotation.Nullable;
+import io.github.retrooper.packetevents.annotations.Nullable;
 
-public class TinyProtocolHandler_1_8 {
+public final class TinyProtocolHandler_1_8 {
     private static final ServerVersion version = PacketEvents.getServerVersion();
     private final Plugin plugin;
 

src/main/java/io/github/retrooper/packetevents/packetwrappers/in/entityaction/WrappedPacketInEntityAction.java

@@ -6,7 +6,7 @@ import io.github.retrooper.packetevents.packetwrappers.api.WrappedPacket;
 import io.github.retrooper.packetevents.utils.NMSUtils;
 import org.bukkit.entity.Entity;
 
-import javax.annotation.Nullable;
+import io.github.retrooper.packetevents.annotations.Nullable;
 import java.lang.reflect.Field;
 
 public final class WrappedPacketInEntityAction extends WrappedPacket {

src/main/java/io/github/retrooper/packetevents/utils/NMSUtils.java

@@ -8,12 +8,12 @@ import org.bukkit.entity.Entity;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 
-import javax.annotation.Nullable;
+import io.github.retrooper.packetevents.annotations.Nullable;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
-public class NMSUtils {
+public final class NMSUtils {
     private static final ServerVersion version = ServerVersion.getVersion();
 
 

src/main/java/io/github/retrooper/packetevents/utils/nms_entityfinder/EntityFinderUtils.java

@@ -1,20 +1,21 @@
 package io.github.retrooper.packetevents.utils.nms_entityfinder;
 
 import io.github.retrooper.packetevents.PacketEvents;
+import io.github.retrooper.packetevents.annotations.Nullable;
 import io.github.retrooper.packetevents.enums.ServerVersion;
 import io.github.retrooper.packetevents.utils.NMSUtils;
 import org.bukkit.Bukkit;
 import org.bukkit.World;
 import org.bukkit.entity.Entity;
 
-import javax.annotation.Nullable;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
-public class EntityFinderUtils {
+public final class EntityFinderUtils {
     @Nullable
     private static ServerVersion version = PacketEvents.getServerVersion();
 
+
     public static Entity getEntityById(final int id) {
         for (final World world : Bukkit.getWorlds()) {
             final Entity entity = getEntityByIdWithWorld(world, id);
@@ -27,6 +28,9 @@ public class EntityFinderUtils {
 
     @Nullable
     public static Entity getEntityByIdWithWorld(final World world, final int id) {
+        if(world == null) {
+            return null;
+        }
         Object craftWorld = craftWorldClass.cast(world);
 
         Object worldServer = null;

src/main/java/io/github/retrooper/packetevents/utils/vector/Vector3d.java

@@ -0,0 +1,16 @@
+package io.github.retrooper.packetevents.utils.vector;
+
+public final class Vector3d {
+    public double x, y, z;
+
+    public Vector3d(final double x, final double y, final double z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+
+    @Override
+    public String toString() {
+        return "X: " + x + ", Y: " + y + ", Z: " + z;
+    }
+}

src/main/java/io/github/retrooper/packetevents/utils/vector/Vector3f.java

@@ -0,0 +1,16 @@
+package io.github.retrooper.packetevents.utils.vector;
+
+public final class Vector3f {
+    public float x, y, z;
+
+    public Vector3f(final float x, final float y, final float z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+
+    @Override
+    public String toString() {
+        return "X: " + x + ", Y: " + y + ", Z: " + z;
+    }
+}

src/main/java/io/github/retrooper/packetevents/utils/vector/Vector3i.java

@@ -1,6 +1,6 @@
 package io.github.retrooper.packetevents.utils.vector;
 
-public class Vector3i {
+public final class Vector3i {
     public int x, y, z;
 
     public Vector3i(final int x, final int y, final int z) {