From 31655b3a7d0f849a2c86265406c8e83c8440fba4 Mon Sep 17 00:00:00 2001 From: Ben Staddon Date: Tue, 31 Oct 2017 18:34:48 +0000 Subject: [PATCH] [1.12] Replace ThrowableImpactEvent with a more generic version (#4040) --- .../entity/projectile/EntityArrow.java.patch | 11 ++ .../projectile/EntityFireball.java.patch | 11 ++ .../projectile/EntityLlamaSpit.java.patch | 11 ++ .../projectile/EntityShulkerBullet.java.patch | 11 ++ .../projectile/EntityThrowable.java.patch | 11 +- .../net/minecraftforge/common/ForgeHooks.java | 5 +- .../event/ForgeEventFactory.java | 27 +++++ .../event/entity/ProjectileImpactEvent.java | 107 ++++++++++++++++++ .../event/entity/ThrowableImpactEvent.java | 3 + .../debug/ProjectileImpactEventTest.java | 32 ++++++ 10 files changed, 222 insertions(+), 7 deletions(-) create mode 100644 patches/minecraft/net/minecraft/entity/projectile/EntityArrow.java.patch create mode 100644 patches/minecraft/net/minecraft/entity/projectile/EntityFireball.java.patch create mode 100644 patches/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java.patch create mode 100644 patches/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java.patch create mode 100644 src/main/java/net/minecraftforge/event/entity/ProjectileImpactEvent.java create mode 100644 src/test/java/net/minecraftforge/debug/ProjectileImpactEventTest.java diff --git a/patches/minecraft/net/minecraft/entity/projectile/EntityArrow.java.patch b/patches/minecraft/net/minecraft/entity/projectile/EntityArrow.java.patch new file mode 100644 index 0000000000..726c3d70f7 --- /dev/null +++ b/patches/minecraft/net/minecraft/entity/projectile/EntityArrow.java.patch @@ -0,0 +1,11 @@ +--- ../src-base/minecraft/net/minecraft/entity/projectile/EntityArrow.java ++++ ../src-work/minecraft/net/minecraft/entity/projectile/EntityArrow.java +@@ -262,7 +262,7 @@ + } + } + +- if (raytraceresult != null) ++ if (raytraceresult != null && !net.minecraftforge.event.ForgeEventFactory.onProjectileImpact(this, raytraceresult)) + { + this.func_184549_a(raytraceresult); + } diff --git a/patches/minecraft/net/minecraft/entity/projectile/EntityFireball.java.patch b/patches/minecraft/net/minecraft/entity/projectile/EntityFireball.java.patch new file mode 100644 index 0000000000..d33aa12bf3 --- /dev/null +++ b/patches/minecraft/net/minecraft/entity/projectile/EntityFireball.java.patch @@ -0,0 +1,11 @@ +--- ../src-base/minecraft/net/minecraft/entity/projectile/EntityFireball.java ++++ ../src-work/minecraft/net/minecraft/entity/projectile/EntityFireball.java +@@ -93,7 +93,7 @@ + ++this.field_70234_an; + RayTraceResult raytraceresult = ProjectileHelper.func_188802_a(this, true, this.field_70234_an >= 25, this.field_70235_a); + +- if (raytraceresult != null) ++ if (raytraceresult != null && !net.minecraftforge.event.ForgeEventFactory.onProjectileImpact(this, raytraceresult)) + { + this.func_70227_a(raytraceresult); + } diff --git a/patches/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java.patch b/patches/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java.patch new file mode 100644 index 0000000000..e68d05f26c --- /dev/null +++ b/patches/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java.patch @@ -0,0 +1,11 @@ +--- ../src-base/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java ++++ ../src-work/minecraft/net/minecraft/entity/projectile/EntityLlamaSpit.java +@@ -80,7 +80,7 @@ + raytraceresult = new RayTraceResult(entity); + } + +- if (raytraceresult != null) ++ if (raytraceresult != null && !net.minecraftforge.event.ForgeEventFactory.onProjectileImpact(this, raytraceresult)) + { + this.func_190536_a(raytraceresult); + } diff --git a/patches/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java.patch b/patches/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java.patch new file mode 100644 index 0000000000..3707a37a26 --- /dev/null +++ b/patches/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java.patch @@ -0,0 +1,11 @@ +--- ../src-base/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java ++++ ../src-work/minecraft/net/minecraft/entity/projectile/EntityShulkerBullet.java +@@ -310,7 +310,7 @@ + + RayTraceResult raytraceresult = ProjectileHelper.func_188802_a(this, true, false, this.field_184570_a); + +- if (raytraceresult != null) ++ if (raytraceresult != null && !net.minecraftforge.event.ForgeEventFactory.onProjectileImpact(this, raytraceresult)) + { + this.func_184567_a(raytraceresult); + } diff --git a/patches/minecraft/net/minecraft/entity/projectile/EntityThrowable.java.patch b/patches/minecraft/net/minecraft/entity/projectile/EntityThrowable.java.patch index 6b7ef40030..8d0622599d 100644 --- a/patches/minecraft/net/minecraft/entity/projectile/EntityThrowable.java.patch +++ b/patches/minecraft/net/minecraft/entity/projectile/EntityThrowable.java.patch @@ -1,10 +1,11 @@ --- ../src-base/minecraft/net/minecraft/entity/projectile/EntityThrowable.java +++ ../src-work/minecraft/net/minecraft/entity/projectile/EntityThrowable.java -@@ -246,6 +246,7 @@ - } - else +@@ -244,7 +244,7 @@ + { + this.func_181015_d(raytraceresult.func_178782_a()); + } +- else ++ else if (!net.minecraftforge.event.ForgeEventFactory.onProjectileImpact(this, raytraceresult)) { -+ if(!net.minecraftforge.common.ForgeHooks.onThrowableImpact(this, raytraceresult)) this.func_70184_a(raytraceresult); } - } diff --git a/src/main/java/net/minecraftforge/common/ForgeHooks.java b/src/main/java/net/minecraftforge/common/ForgeHooks.java index 8fd4472d59..1ca656a10d 100644 --- a/src/main/java/net/minecraftforge/common/ForgeHooks.java +++ b/src/main/java/net/minecraftforge/common/ForgeHooks.java @@ -111,7 +111,6 @@ import net.minecraftforge.event.DifficultyChangeEvent; import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.event.ServerChatEvent; import net.minecraftforge.event.entity.EntityTravelToDimensionEvent; -import net.minecraftforge.event.entity.ThrowableImpactEvent; import net.minecraftforge.event.entity.item.ItemTossEvent; import net.minecraftforge.event.entity.living.LivingAttackEvent; import net.minecraftforge.event.entity.living.LivingDeathEvent; @@ -1239,9 +1238,11 @@ public class ForgeHooks public static LootEntry deserializeJsonLootEntry(String type, JsonObject json, int weight, int quality, LootCondition[] conditions){ return null; } public static String getLootEntryType(LootEntry entry){ return null; } //Companion to above function + /** @deprecated use {@link ForgeEventFactory#onProjectileImpact(EntityThrowable, RayTraceResult)} */ + @Deprecated // TODO: remove (1.13) public static boolean onThrowableImpact(EntityThrowable throwable, RayTraceResult ray) { - return MinecraftForge.EVENT_BUS.post(new ThrowableImpactEvent(throwable, ray)); + return ForgeEventFactory.onProjectileImpact(throwable, ray); } public static boolean onCropsGrowPre(World worldIn, BlockPos pos, IBlockState state, boolean def) diff --git a/src/main/java/net/minecraftforge/event/ForgeEventFactory.java b/src/main/java/net/minecraftforge/event/ForgeEventFactory.java index ab8dfa69db..a319a7af90 100644 --- a/src/main/java/net/minecraftforge/event/ForgeEventFactory.java +++ b/src/main/java/net/minecraftforge/event/ForgeEventFactory.java @@ -36,6 +36,9 @@ import net.minecraft.entity.monster.EntityZombie; import net.minecraft.entity.passive.EntityAnimal; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer.SleepResult; +import net.minecraft.entity.projectile.EntityArrow; +import net.minecraft.entity.projectile.EntityFireball; +import net.minecraft.entity.projectile.EntityThrowable; import net.minecraft.init.Blocks; import net.minecraft.item.Item; import net.minecraft.item.ItemStack; @@ -81,6 +84,8 @@ import net.minecraftforge.event.entity.EntityEvent; import net.minecraftforge.event.entity.EntityMountEvent; import net.minecraftforge.event.entity.EntityStruckByLightningEvent; import net.minecraftforge.event.entity.PlaySoundAtEntityEvent; +import net.minecraftforge.event.entity.ProjectileImpactEvent; +import net.minecraftforge.event.entity.ThrowableImpactEvent; import net.minecraftforge.event.entity.item.ItemExpireEvent; import net.minecraftforge.event.entity.living.AnimalTameEvent; import net.minecraftforge.event.entity.living.LivingDestroyBlockEvent; @@ -644,6 +649,28 @@ public class ForgeEventFactory return event.getCharge(); } + public static boolean onProjectileImpact(Entity entity, RayTraceResult ray) + { + return MinecraftForge.EVENT_BUS.post(new ProjectileImpactEvent(entity, ray)); + } + + public static boolean onProjectileImpact(EntityArrow arrow, RayTraceResult ray) + { + return MinecraftForge.EVENT_BUS.post(new ProjectileImpactEvent.Arrow(arrow, ray)); + } + + public static boolean onProjectileImpact(EntityFireball fireball, RayTraceResult ray) + { + return MinecraftForge.EVENT_BUS.post(new ProjectileImpactEvent.Fireball(fireball, ray)); + } + + public static boolean onProjectileImpact(EntityThrowable throwable, RayTraceResult ray) + { + boolean oldEvent = MinecraftForge.EVENT_BUS.post(new ThrowableImpactEvent(throwable, ray)); + boolean newEvent = MinecraftForge.EVENT_BUS.post(new ProjectileImpactEvent.Throwable(throwable, ray)); + return oldEvent || newEvent; // TODO: clean up when old event is removed + } + public static boolean onReplaceBiomeBlocks(IChunkGenerator gen, int x, int z, ChunkPrimer primer, World world) { ChunkGeneratorEvent.ReplaceBiomeBlocks event = new ChunkGeneratorEvent.ReplaceBiomeBlocks(gen, x, z, primer, world); diff --git a/src/main/java/net/minecraftforge/event/entity/ProjectileImpactEvent.java b/src/main/java/net/minecraftforge/event/entity/ProjectileImpactEvent.java new file mode 100644 index 0000000000..5e099ac3de --- /dev/null +++ b/src/main/java/net/minecraftforge/event/entity/ProjectileImpactEvent.java @@ -0,0 +1,107 @@ +/* + * Minecraft Forge + * Copyright (c) 2016. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation version 2.1 + * of the License. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +package net.minecraftforge.event.entity; + +import net.minecraft.entity.Entity; +import net.minecraft.entity.projectile.EntityArrow; +import net.minecraft.entity.projectile.EntityFireball; +import net.minecraft.entity.projectile.EntityThrowable; +import net.minecraft.util.math.RayTraceResult; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; +import net.minecraftforge.fml.common.eventhandler.Cancelable; + +/** + * This event is fired when a projectile entity impacts something. + * This event is fired via {@link ForgeEventFactory#onProjectileImpact(Entity, RayTraceResult)} + * Subclasses of this event exist for more specific types of projectile. + * This event is fired for all vanilla projectiles by Forge, + * custom projectiles should fire this event and check the result in a similar fashion. + * This event is cancelable. When canceled, the impact will not be processed. + * Killing or other handling of the entity after event cancellation is up to the modder. + * This event is fired on the {@link MinecraftForge#EVENT_BUS}. + */ +@Cancelable +public class ProjectileImpactEvent extends EntityEvent +{ + private final RayTraceResult ray; + + public ProjectileImpactEvent(Entity entity, RayTraceResult ray) + { + super(entity); + this.ray = ray; + } + + public RayTraceResult getRayTraceResult() + { + return ray; + } + + @Cancelable + public static class Arrow extends ProjectileImpactEvent + { + private final EntityArrow arrow; + + public Arrow(EntityArrow arrow, RayTraceResult ray) + { + super(arrow, ray); + this.arrow = arrow; + } + + public EntityArrow getArrow() + { + return arrow; + } + } + + @Cancelable + public static class Fireball extends ProjectileImpactEvent + { + private final EntityFireball fireball; + + public Fireball(EntityFireball fireball, RayTraceResult ray) + { + super(fireball, ray); + this.fireball = fireball; + } + + public EntityFireball getFireball() + { + return fireball; + } + } + + @Cancelable + public static class Throwable extends ProjectileImpactEvent + { + private final EntityThrowable throwable; + + public Throwable(EntityThrowable throwable, RayTraceResult ray) + { + super(throwable, ray); + this.throwable = throwable; + } + + public EntityThrowable getThrowable() + { + return throwable; + } + } +} diff --git a/src/main/java/net/minecraftforge/event/entity/ThrowableImpactEvent.java b/src/main/java/net/minecraftforge/event/entity/ThrowableImpactEvent.java index a06ca54b74..ad340a096a 100644 --- a/src/main/java/net/minecraftforge/event/entity/ThrowableImpactEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/ThrowableImpactEvent.java @@ -10,7 +10,10 @@ import net.minecraftforge.fml.common.eventhandler.Cancelable; * This event is cancelable. When canceled, {@link EntityThrowable#onImpact} will not be called. * Killing or other handling of the entity after event cancellation is up to the modder. * This event is fired on the {@link net.minecraftforge.common.MinecraftForge#EVENT_BUS}. + * + * @deprecated use {@link ProjectileImpactEvent.Throwable} */ +@Deprecated // TODO: remove (1.13) @Cancelable public class ThrowableImpactEvent extends EntityEvent { diff --git a/src/test/java/net/minecraftforge/debug/ProjectileImpactEventTest.java b/src/test/java/net/minecraftforge/debug/ProjectileImpactEventTest.java new file mode 100644 index 0000000000..e9cdd76c32 --- /dev/null +++ b/src/test/java/net/minecraftforge/debug/ProjectileImpactEventTest.java @@ -0,0 +1,32 @@ +package net.minecraftforge.debug; + +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.entity.ProjectileImpactEvent; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; +import net.minecraftforge.fml.common.eventhandler.SubscribeEvent; +import org.apache.logging.log4j.Logger; + +@Mod(modid = "projectile_event_test", name = "ProjectileImpactEvent test mod", version = "1.0", acceptableRemoteVersions = "*") +public class ProjectileImpactEventTest +{ + private static final boolean ENABLED = false; + private static Logger logger; + + @Mod.EventHandler + public void preInit(FMLPreInitializationEvent event) + { + logger = event.getModLog(); + + if (ENABLED) + { + MinecraftForge.EVENT_BUS.register(ProjectileImpactEventTest.class); + } + } + + @SubscribeEvent + public static void onProjectileImpact(ProjectileImpactEvent event) + { + logger.info("projectile: {}, impact: {}", event.getEntity().getName(), event.getRayTraceResult()); + } +}