(WIP) Split vehicle-damage.

* Initial update to 1.21.3.

Compiles, launches, nothing tested yet.

* Boat tag includes chest boat tag.

* Avoid Material.values call.

* Split ride checks to separate event handler.

Bypass the interact entirely and let EntityMount handle it, since we can't discriminate usage in interact.

gradle/libs.versions.toml

@@ -27,8 +27,8 @@ junit-jupiter-api.module = "org.junit.jupiter:junit-jupiter-api"
 junit-jupiter-params.module = "org.junit.jupiter:junit-jupiter-params"
 junit-jupiter-engine.module = "org.junit.jupiter:junit-jupiter-engine"
 
-spigot = "org.spigotmc:spigot-api:1.21-R0.1-SNAPSHOT"
-paperApi = "io.papermc.paper:paper-api:1.21-R0.1-SNAPSHOT"
+spigot = "org.spigotmc:spigot-api:1.21.3-R0.1-SNAPSHOT"
+paperApi = "io.papermc.paper:paper-api:1.21.3-R0.1-SNAPSHOT"
 paperLib = "io.papermc:paperlib:1.0.8"
 
 dummypermscompat = "com.sk89q:dummypermscompat:1.10"

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/BukkitWorldGuardPlatform.java

@@ -171,9 +171,10 @@ public class BukkitWorldGuardPlatform implements WorldGuardPlatform {
         return WorldGuardPlugin.inst().getDataFolder().toPath();
     }
 
+    @SuppressWarnings("removal")
     @Override
     public void stackPlayerInventory(LocalPlayer localPlayer) {
-        boolean ignoreMax = localPlayer.hasPermission("worldguard.stack.illegitimate");
+        boolean ignoreMax = false; // localPlayer.hasPermission("worldguard.stack.illegitimate");
 
         Player player = ((BukkitPlayer) localPlayer).getPlayer();
 
@@ -191,7 +192,7 @@ public class BukkitWorldGuardPlatform implements WorldGuardPlatform {
                 continue;
             }
 
-            int max = ignoreMax ? 64 : item.getMaxStackSize();
+            int max = /*ignoreMax ? 64 :*/ item.getMaxStackSize();
 
             if (item.getAmount() < max) {
                 int needed = max - item.getAmount(); // Number of needed items until max

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/cause/Cause.java

@@ -32,8 +32,10 @@ import org.bukkit.block.Block;
 import org.bukkit.entity.AnimalTamer;
 import org.bukkit.entity.AreaEffectCloud;
 import org.bukkit.entity.Creature;
+import org.bukkit.entity.Creeper;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.EntityType;
+import org.bukkit.entity.FallingBlock;
 import org.bukkit.entity.Firework;
 import org.bukkit.entity.LightningStrike;
 import org.bukkit.entity.Player;
@@ -326,15 +328,21 @@ public final class Cause {
                             addAll(player.getPlayer()); // player object if online, else null
                         }
                     }
-                } else if (o instanceof Creature && ((Creature) o).getTarget() != null) {
+                } else if (o instanceof Creeper c) {
                     indirect = true;
-                    addAll(((Creature) o).getTarget());
+                    addAll(c.getTarget(), c.getIgniter());
+                } else if (o instanceof Creature c) {
+                    indirect = true;
+                    addAll(c.getTarget());
                 } else if (o instanceof BlockProjectileSource) {
                     addAll(((BlockProjectileSource) o).getBlock());
                 } else if (o instanceof LightningStrike && PaperLib.isPaper() &&
                         ((LightningStrike) o).getCausingEntity() != null) {
                     indirect = true;
                     addAll(((LightningStrike) o).getCausingEntity());
+                } else if (o instanceof FallingBlock f && PaperLib.isPaper() && f.getOrigin() != null) {
+                    indirect = true;
+                    addAll(f.getOrigin().getBlock());
                 }
 
                 // Add manually tracked parent causes

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/listener/EventAbstractionListener.java

@@ -158,6 +158,7 @@ import org.bukkit.util.Vector;
 import javax.annotation.Nullable;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 public class EventAbstractionListener extends AbstractListener {
@@ -347,7 +348,10 @@ public class EventAbstractionListener extends AbstractListener {
         } else if (toType == Material.AIR) {
             // Track the source so later we can create a proper chain of causes
             if (entity instanceof FallingBlock) {
-                Cause.trackParentCause(entity, block);
+                if (!PaperLib.isPaper()) {
+                    // On paper we use FallingBlock#getOrigin to get the origin location, on spigot we store it.
+                    Cause.trackParentCause(entity, block);
+                }
 
                 // Switch around the event
                 Events.fireToCancel(event, new SpawnEntityEvent(event, create(block), entity));
@@ -799,7 +803,9 @@ public class EventAbstractionListener extends AbstractListener {
     public void onPlayerFish(PlayerFishEvent event) {
         if (event.getState() == PlayerFishEvent.State.FISHING) {
             if (Events.fireAndTestCancel(new UseItemEvent(event, create(event.getPlayer(), event.getHook()),
-                    event.getPlayer().getWorld(), event.getPlayer().getInventory().getItemInMainHand()))) {
+                    event.getPlayer().getWorld(),
+                    // guaranteed to be non-null in FISHING state
+                    event.getPlayer().getInventory().getItem(Objects.requireNonNull(event.getHand()))))) {
                 event.setCancelled(true);
             }
         } else if (event.getState() == PlayerFishEvent.State.CAUGHT_FISH) {
@@ -813,7 +819,7 @@ public class EventAbstractionListener extends AbstractListener {
                 Events.fireToCancel(event, new DestroyEntityEvent(event, create(event.getPlayer(), event.getHook()), caught));
             } else if (Entities.isConsideredBuildingIfUsed(caught)) {
                 Events.fireToCancel(event, new UseEntityEvent(event, create(event.getPlayer(), event.getHook()), caught));
-            } else if (Entities.isNonHostile(caught) || caught instanceof Player) {
+            } else if (!Entities.isHostile(caught) || caught instanceof Player) {
                 Events.fireToCancel(event, new DamageEntityEvent(event, create(event.getPlayer(), event.getHook()), caught));
             }
         }
@@ -864,12 +870,7 @@ public class EventAbstractionListener extends AbstractListener {
         if (matchingItem != null && hasInteractBypass(world, matchingItem)) {
             useEntityEvent.setAllowed(true);
         }
-        if (!Events.fireToCancel(event, useEntityEvent)) {
-            // so this is a hack but CreeperIgniteEvent doesn't actually tell us who, so we need to do it here
-            if (item.getType() == Material.FLINT_AND_STEEL && entity.getType() == EntityType.CREEPER) {
-                Cause.trackParentCause(entity, player);
-            }
-        }
+        Events.fireToCancel(event, useEntityEvent);
     }
 
     @EventHandler(ignoreCancelled = true)
@@ -1198,7 +1199,7 @@ public class EventAbstractionListener extends AbstractListener {
 
         // Handle created boats
         if (item != null && Materials.isBoat(item.getType())) {
-            Events.fireToCancel(event, new SpawnEntityEvent(event, cause, placed.getLocation().add(0.5, 0, 0.5), EntityType.BOAT));
+            Events.fireToCancel(event, new SpawnEntityEvent(event, cause, placed.getLocation().add(0.5, 0, 0.5), Materials.getRelatedEntity(item.getType())));
             return;
         }
 

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/listener/RegionProtectionListener.java

@@ -61,6 +61,7 @@ import org.bukkit.entity.Tameable;
 import org.bukkit.event.Event;
 import org.bukkit.event.Event.Result;
 import org.bukkit.event.EventHandler;
+import org.bukkit.event.entity.EntityMountEvent;
 import org.bukkit.event.inventory.InventoryOpenEvent;
 import org.bukkit.event.player.PlayerTakeLecternBookEvent;
 import org.bukkit.event.vehicle.VehicleExitEvent;
@@ -413,13 +414,13 @@ public class RegionProtectionListener extends AbstractListener {
         /* Paintings, item frames, etc. */
         } else if (Entities.isConsideredBuildingIfUsed(entity)
                 // weird case since sneak+interact is chest access and not ride
-                || type == EntityType.CHEST_BOAT && event.getOriginalEvent() instanceof InventoryOpenEvent) {
+                || event.getOriginalEvent() instanceof InventoryOpenEvent) {
             if ((type == EntityType.ITEM_FRAME || type == EntityType.GLOW_ITEM_FRAME)
                     && event.getCause().getFirstPlayer() != null
                     && ((ItemFrame) entity).getItem().getType() != Material.AIR) {
                 canUse = query.testBuild(BukkitAdapter.adapt(target), associable, combine(event, Flags.ITEM_FRAME_ROTATE));
                 what = "change that";
-            } else if (Entities.isMinecart(type) || type == EntityType.CHEST_BOAT) {
+            } else if (event.getOriginalEvent() instanceof InventoryOpenEvent) {
                 canUse = query.testBuild(BukkitAdapter.adapt(target), associable, combine(event, Flags.CHEST_ACCESS));
                 what = "open that";
             } else {
@@ -428,9 +429,10 @@ public class RegionProtectionListener extends AbstractListener {
             }
         /* Ridden on use */
         } else if (Entities.isRiddenOnUse(entity)) {
-            canUse = query.testBuild(BukkitAdapter.adapt(target), associable, combine(event, Flags.RIDE, Flags.INTERACT));
+            // this is bypassed here as it's handled by the entity mount listener below
+            // bukkit actually gives three events in this case - in order: PlayerInteractAtEntity, VehicleEnter, EntityMount
+            canUse = true;
             what = "ride that";
-
         /* Everything else */
         } else {
             canUse = query.testBuild(BukkitAdapter.adapt(target), associable, combine(event, Flags.INTERACT));
@@ -466,11 +468,12 @@ public class RegionProtectionListener extends AbstractListener {
         }
 
         /* Hostile / ambient mob override */
-        if (Entities.isHostile(event.getEntity()) || Entities.isAmbient(event.getEntity())
-                || Entities.isVehicle(event.getEntity().getType())) {
+        if (Entities.isHostile(event.getEntity()) || Entities.isAmbient(event.getEntity())) {
             canDamage = event.getRelevantFlags().isEmpty() || query.queryState(target, associable, combine(event)) != State.DENY;
             what = "hit that";
-
+        } else if (Entities.isVehicle(event.getEntity().getType())) {
+            canDamage = query.testBuild(target, associable, combine(event, Flags.DAMAGE_VEHICLE));
+            what = "change that";
         /* Paintings, item frames, etc. */
         } else if (Entities.isConsideredBuildingIfUsed(event.getEntity())) {
             canDamage = query.testBuild(target, associable, combine(event));
@@ -519,6 +522,27 @@ public class RegionProtectionListener extends AbstractListener {
         }
     }
 
+    @EventHandler
+    public void onEntityMount(EntityMountEvent event) {
+        Entity vehicle = event.getMount();
+        if (!isRegionSupportEnabled(vehicle.getWorld())) return; // Region support disabled
+        if (!(event.getEntity() instanceof Player player)) {
+            return;
+        }
+        Cause cause = Cause.create(player);
+        if (isWhitelisted(cause, vehicle.getWorld(), false)) {
+            return;
+        }
+        RegionQuery query = WorldGuard.getInstance().getPlatform().getRegionContainer().createQuery();
+        Location location = vehicle.getLocation();
+        LocalPlayer localPlayer = WorldGuardPlugin.inst().wrapPlayer(player);
+        if (!query.testBuild(BukkitAdapter.adapt(location), localPlayer, Flags.RIDE, Flags.INTERACT)) {
+            event.setCancelled(true);
+            DelegateEvent dummy = new UseEntityEvent(event, cause, vehicle);
+            tellErrorMessage(dummy, cause, vehicle.getLocation(), "ride that");
+        }
+    }
+
     @EventHandler(ignoreCancelled = true)
     public void onVehicleExit(VehicleExitEvent event) {
         Entity vehicle = event.getVehicle();

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/util/Entities.java

@@ -122,8 +122,11 @@ public final class Entities {
      * @return true if the type is a Boat type
      */
     public static boolean isBoat(EntityType type) {
-        return switch(type) {
-            case BOAT, CHEST_BOAT -> true;
+        return switch (type) {
+            case OAK_BOAT, DARK_OAK_BOAT, SPRUCE_BOAT, ACACIA_BOAT, CHERRY_BOAT, JUNGLE_BOAT, MANGROVE_BOAT,
+                 BIRCH_BOAT, PALE_OAK_BOAT, BAMBOO_RAFT, OAK_CHEST_BOAT, DARK_OAK_CHEST_BOAT, SPRUCE_CHEST_BOAT,
+                 ACACIA_CHEST_BOAT, CHERRY_CHEST_BOAT, JUNGLE_CHEST_BOAT, MANGROVE_CHEST_BOAT, BIRCH_CHEST_BOAT,
+                 PALE_OAK_CHEST_BOAT, BAMBOO_CHEST_RAFT -> true;
             default -> false;
         };
     }

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/util/Materials.java

@@ -23,6 +23,7 @@ import com.google.common.collect.BiMap;
 import com.google.common.collect.HashBiMap;
 import com.sk89q.worldguard.protection.flags.Flags;
 import org.bukkit.Material;
+import org.bukkit.Registry;
 import org.bukkit.Tag;
 import org.bukkit.entity.EntityType;
 import org.bukkit.potion.PotionEffect;
@@ -69,7 +70,6 @@ public final class Materials {
         ENTITY_ITEMS.put(EntityType.TNT, Material.TNT);
         ENTITY_ITEMS.put(EntityType.FIREWORK_ROCKET, Material.FIREWORK_ROCKET);
         ENTITY_ITEMS.put(EntityType.COMMAND_BLOCK_MINECART, Material.COMMAND_BLOCK_MINECART);
-        ENTITY_ITEMS.put(EntityType.BOAT, Material.OAK_BOAT);
         ENTITY_ITEMS.put(EntityType.MINECART, Material.MINECART);
         ENTITY_ITEMS.put(EntityType.CHEST_MINECART, Material.CHEST_MINECART);
         ENTITY_ITEMS.put(EntityType.FURNACE_MINECART, Material.FURNACE_MINECART);
@@ -80,6 +80,15 @@ public final class Materials {
         ENTITY_ITEMS.put(EntityType.ARMOR_STAND, Material.ARMOR_STAND);
         ENTITY_ITEMS.put(EntityType.END_CRYSTAL, Material.END_CRYSTAL);
 
+        for (String wood : new String[]{"OAK", "SPRUCE", "BIRCH", "JUNGLE", "ACACIA", "DARK_OAK", "MANGROVE", "CHERRY", "PALE_OAK"}) {
+            String regular = wood + "_BOAT";
+            String chest = wood + "_CHEST_BOAT";
+            ENTITY_ITEMS.put(EntityType.valueOf(regular), Material.getMaterial(regular));
+            ENTITY_ITEMS.put(EntityType.valueOf(chest), Material.getMaterial(chest));
+        }
+        ENTITY_ITEMS.put(EntityType.BAMBOO_RAFT, Material.BAMBOO_RAFT);
+        ENTITY_ITEMS.put(EntityType.BAMBOO_CHEST_RAFT, Material.BAMBOO_CHEST_RAFT);
+
         // preset some tags to a default value, override some of them:
         putMaterialTag(Tag.DOORS, MODIFIED_ON_RIGHT);
         putMaterialTag(Tag.TRAPDOORS, MODIFIED_ON_RIGHT);
@@ -877,6 +886,7 @@ public final class Materials {
 
         putMaterialTag(Tag.SHULKER_BOXES, MODIFIED_ON_RIGHT);
         putMaterialTag(Tag.ITEMS_BOATS, 0);
+        putMaterialTag(Tag.ITEMS_CHEST_BOATS, 0);
         putMaterialTag(Tag.BANNERS, 0);
         putMaterialTag(Tag.SLABS, 0);
         putMaterialTag(Tag.PLANKS, 0);
@@ -925,8 +935,7 @@ public final class Materials {
         });
 
         // Check for missing items/blocks
-        for (Material material : Material.values()) {
-            if (material.isLegacy()) continue;
+        Registry.MATERIAL.stream().forEach(material -> {
             // Add spawn eggs
             if (isSpawnEgg(material)) {
                 MATERIAL_FLAGS.put(material, 0);
@@ -937,7 +946,7 @@ public final class Materials {
             if (!MATERIAL_FLAGS.containsKey(material)) {
                 logger.fine("Missing material definition for " + (material.isBlock() ? "block " : "item ") + material.name());
             }
-        }
+        });
 
 //        DAMAGE_EFFECTS.add(PotionEffectType.SPEED);
         DAMAGE_EFFECTS.add(PotionEffectType.SLOWNESS);

worldguard-core/src/main/java/com/sk89q/worldguard/commands/GeneralCommands.java

@@ -229,6 +229,7 @@ public class GeneralCommands {
         }
     }
     
+    @SuppressWarnings("removal")
     @Command(aliases = {"stack", ";"}, usage = "", desc = "Stack items", max = 0)
     @CommandPermissions({"worldguard.stack"})
     public void stack(CommandContext args, Actor sender) throws CommandException {

worldguard-core/src/main/java/com/sk89q/worldguard/internal/platform/WorldGuardPlatform.java

@@ -145,6 +145,7 @@ public interface WorldGuardPlatform {
      *
      * @param localPlayer The player
      */
+    @Deprecated(forRemoval = true)
     void stackPlayerInventory(LocalPlayer localPlayer);
 
     /**

worldguard-core/src/main/java/com/sk89q/worldguard/protection/flags/Flags.java

@@ -66,6 +66,7 @@ public final class Flags {
     public static final StateFlag CHEST_ACCESS = register(new StateFlag("chest-access", false));
     public static final StateFlag PLACE_VEHICLE = register(new StateFlag("vehicle-place", false));
     public static final StateFlag DESTROY_VEHICLE = register(new StateFlag("vehicle-destroy", false));
+    public static final StateFlag DAMAGE_VEHICLE = register(new StateFlag("vehicle-damage", false));
     public static final StateFlag LIGHTER = register(new StateFlag("lighter", false));
     public static final StateFlag RIDE = register(new StateFlag("ride", false));
     public static final StateFlag POTION_SPLASH = register(new StateFlag("potion-splash", false));