Code style changes

Author: Rollczi

buildSrc/src/main/kotlin/Versions.kt

@@ -10,6 +10,7 @@ object Versions {
 
     const val ETERNALCODE_COMMONS = "1.1.3"
     const val MULTIFICATION = "1.1.4"
+    const val PACKETS_EVENTS = "2.7.0"
 
     const val ADVENTURE_PLATFORM_BUKKIT = "4.3.4"
     const val ADVENTURE_API = "4.17.0"

eternalcombat-plugin/build.gradle.kts

@@ -54,7 +54,7 @@ dependencies {
     // Multification
     implementation("com.eternalcode:multification-bukkit:${Versions.MULTIFICATION}")
     implementation("com.eternalcode:multification-okaeri:${Versions.MULTIFICATION}")
-    implementation("com.github.retrooper:packetevents-spigot:2.7.0")
+    implementation("com.github.retrooper:packetevents-spigot:${Versions.PACKETS_EVENTS}")
     implementation("io.papermc:paperlib:${Versions.PAPERLIB}")
 }
 

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/BorderActivePointsIndex.java

@@ -1,5 +1,6 @@
 package com.eternalcode.combat.border;
 
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
@@ -36,7 +37,7 @@ private static Set<BorderPoint> calculateRemovedPoints(Set<BorderPoint> points,
                 removed.add(oldPoint);
             }
         }
-        return removed;
+        return Collections.unmodifiableSet(removed);
     }
 
     Set<BorderPoint> getPoints(String world, UUID player) {

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/BorderServiceImpl.java

@@ -39,7 +39,7 @@ public void updateBorder(Player player, Location location) {
         String world = player.getWorld().getName();
 
         if (result.isEmpty()) {
-            if (this.activeBorderIndex.hasPoints(world, player.getUniqueId())) {
+            if (!this.activeBorderIndex.hasPoints(world, player.getUniqueId())) {
                 return;
             }
 
@@ -56,10 +56,10 @@ public void updateBorder(Player player, Location location) {
                 points = event.getPoints();
             }
 
-            Set<BorderPoint> toRemove = this.activeBorderIndex.putPoints(world, player.getUniqueId(), points);
+            Set<BorderPoint> removed = this.activeBorderIndex.putPoints(world, player.getUniqueId(), points);
 
-            if (!toRemove.isEmpty()) {
-                eventCaller.publishEvent(new BorderHideAsyncEvent(player, toRemove));
+            if (!removed.isEmpty()) {
+                eventCaller.publishEvent(new BorderHideAsyncEvent(player, removed));
             }
         });
     }
@@ -68,10 +68,11 @@ public void updateBorder(Player player, Location location) {
     public void clearBorder(Player player) {
         World world = player.getWorld();
         UUID uniqueId = player.getUniqueId();
+        
         scheduler.async(() -> {
-            Set<BorderPoint> borderPoints = this.activeBorderIndex.removePoints(world.getName(), uniqueId);
-            if (!borderPoints.isEmpty()) {
-                eventCaller.publishEvent(new BorderHideAsyncEvent(player, borderPoints));
+            Set<BorderPoint> removed = this.activeBorderIndex.removePoints(world.getName(), uniqueId);
+            if (!removed.isEmpty()) {
+                eventCaller.publishEvent(new BorderHideAsyncEvent(player, removed));
             }
         });
     }
@@ -113,6 +114,7 @@ private List<BorderPoint> resolveBorderPoints(BorderTrigger trigger, Location pl
 
         List<BorderPoint> points = new ArrayList<>();
 
+        // this code is ugly but is fast
         if (borderMin.y() >= realMinY) {
             for (int currentX = realMinX; currentX <= realMaxX - 1; currentX++) {
                 for (int currentZ = realMinZ; currentZ <= realMaxZ - 1; currentZ++) {

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/BorderTriggerIndex.java

@@ -29,9 +29,9 @@ private BorderTriggerIndex(Server server, Scheduler scheduler, RegionProvider pr
         this.settings = settings;
     }
 
-    private void update() {
+    private void updateWorlds() {
         for (World world : server.getWorlds()) {
-            updateWorld(world.getName(), provider.getRegions(world));
+            this.updateWorld(world.getName(), provider.getRegions(world));
         }
     }
 
@@ -56,7 +56,7 @@ private void updateWorld(String world, Collection<Region> regions) {
 
     static BorderTriggerIndex started(Server server, Scheduler scheduler, RegionProvider provider, BorderSettings settings) {
         BorderTriggerIndex index = new BorderTriggerIndex(server, scheduler, provider, settings);
-        scheduler.timerSync(() -> index.update(), Duration.ZERO, settings.indexRefreshDelay());
+        scheduler.timerSync(() -> index.updateWorlds(), Duration.ZERO, settings.indexRefreshDelay());
         return index;
     }
 

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/BorderTriggerIndexBucket.java

@@ -8,13 +8,27 @@
 
 class BorderTriggerIndexBucket {
 
+    /**
+     * Represents "00000000 00000000 00000000 00000000 11111111 11111111 11111111 11111111" bit mask.
+     * This allows removing left bits when used with AND bit operator.
+     * */
+    private static final long LEFT_INT_MASK = 0xFFFFFFFFL;
+
+    /**
+     * Allows packing the coordination on one axis from 256 into 1
+     * Why? - We divide the world into fragments of size 256x256
+     * Why it is 8? Because when you shift bits, then the value will be smaller / bigger in scale 2^n
+     * E.g `2^4 = 16` (standard minecraft chunk size) in our case, it is `2^8 = 256`
+     */
+    private static final int CHUNK_SHIFT = 8;
+
     private final Map<Long, Set<BorderTrigger>> index = new HashMap<>();
 
     private BorderTriggerIndexBucket() {
     }
 
     Set<BorderTrigger> getTriggers(int x, int z) {
-        long position = packChunk(x >> 8, z >> 8);
+        long position = packChunk(x >> CHUNK_SHIFT, z >> CHUNK_SHIFT);
         return this.index.getOrDefault(position, Set.of());
     }
 
@@ -30,10 +44,10 @@ private BorderTriggerIndexBucket with(Collection<BorderTrigger> triggers) {
     }
 
     private void withTrigger(BorderTrigger trigger) {
-        int minX = trigger.min().x() >> 8;
-        int minZ = trigger.min().z() >> 8;
-        int maxX = trigger.max().x() >> 8;
-        int maxZ = trigger.max().z() >> 8;
+        int minX = trigger.min().x() >> CHUNK_SHIFT;
+        int minZ = trigger.min().z() >> CHUNK_SHIFT;
+        int maxX = trigger.max().x() >> CHUNK_SHIFT;
+        int maxZ = trigger.max().z() >> CHUNK_SHIFT;
 
         int startX = Math.min(minX, maxX);
         int startZ = Math.min(minZ, maxZ);
@@ -49,8 +63,22 @@ private void withTrigger(BorderTrigger trigger) {
         }
     }
 
+    /**
+     * Packs two ints into long value.
+     * <p>
+     * For example for values:
+     * <ul>
+     *   <li>X - 00000000 00000000 00000000 00000001 </li>
+     *   <li>Z - 00000000 00000000 00000000 00000111 </li>
+     * </ul>
+     * This method will return:<br>
+     * 00000000 00000000 00000000 00000111 00000000 00000000 00000000 00000001
+     * </p>
+     * @param bigChunkX right int to pack
+     * @param bigChunkZ left int to pack
+     */
     private static long packChunk(int bigChunkX, int bigChunkZ) {
-        return (long) bigChunkX & 0xFFFFFFFFL | ((long) bigChunkZ & 0xFFFFFFFFL) << 32;
+        return (long) bigChunkX & LEFT_INT_MASK | ((long) bigChunkZ & LEFT_INT_MASK) << Integer.SIZE;
     }
 
 }

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/LazyBorderResult.java

@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
+
 class LazyBorderResult implements BorderResult {
 
     private final List<Lazy<List<BorderPoint>>> borderPoints = new ArrayList<>();

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/event/BorderHideAsyncEvent.java

@@ -2,7 +2,6 @@
 
 import com.eternalcode.combat.border.BorderPoint;
 import java.util.Set;
-import java.util.UUID;
 import org.bukkit.entity.Player;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
@@ -22,11 +21,11 @@ public BorderHideAsyncEvent(Player player, Set<BorderPoint> points) {
     }
 
     public Player getPlayer() {
-        return player;
+        return this.player;
     }
 
     public Set<BorderPoint> getPoints() {
-        return points;
+        return this.points;
     }
 
     @NotNull

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/particle/BorderBlockController.java

@@ -42,6 +42,7 @@ public class BorderBlockController implements Listener {
 
     private final BorderService borderService;
     private final Server server;
+    
     private final Set<UUID> playersToUpdate = ConcurrentHashMap.newKeySet();
     private final Map<UUID, Object> lockedPlayers = new ConcurrentHashMap<>();
     private final Cache<ChunkLocation, ChunkSnapshot> chunkCache = CacheBuilder.newBuilder()
@@ -57,7 +58,7 @@ public BorderBlockController(BorderService borderService, Scheduler scheduler, S
     @EventHandler
     void onBorderShowAsyncEvent(BorderShowAsyncEvent event) {
         Player player = event.getPlayer();
-        Set<BorderPoint> borderPoints = processChunks(player, event.getPoints());
+        Set<BorderPoint> borderPoints = this.processChunks(player, event.getPoints());
 
         event.setPoints(borderPoints);
         this.playBlocks(player, borderPoints);
@@ -85,7 +86,7 @@ private void updatePlayers() {
                 continue;
             }
 
-            updatePlayer(uuid, player);
+            this.updatePlayer(uuid, player);
         }
     }
 
@@ -99,14 +100,14 @@ private void updatePlayer(UUID uuid, Player player) {
                 return;
             }
 
-            playBlocks(player, border);
+            this.playBlocks(player, border);
         }
     }
 
     record ChunkLocation(int x, int z) {}
 
     public void playBlocks(Player player, Collection<BorderPoint> blocks) {
-        Map<Vector3i, Set<BorderPoint>> chunksToUpdate = splitToChunks(blocks);
+        Map<Vector3i, Set<BorderPoint>> chunksToUpdate = this.splitToChunks(blocks);
 
         for (Map.Entry<Vector3i, Set<BorderPoint>> entry : chunksToUpdate.entrySet()) {
             Vector3i chunk = entry.getKey();

eternalcombat-plugin/src/main/java/com/eternalcode/combat/border/particle/BorderParticleController.java

@@ -46,7 +46,7 @@ void onBorderShowAsyncEvent(BorderShowAsyncEvent event) {
         this.playersToUpdate.add(event.getPlayer().getUniqueId());
 
         for (BorderPoint point : event.getPoints()) {
-            playParticle(event.getPlayer(), point);
+            this.playParticle(event.getPlayer(), point);
         }
     }
 
@@ -69,7 +69,7 @@ private void updatePlayers() {
             }
 
             for (BorderPoint point : border) {
-                playParticle(player, point);
+                this.playParticle(player, point);
             }
         }
     }