Implemented LivingKnockBackEvent event and hook #4503
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| * Minecraft Forge | ||
| * Copyright (c) 2017. | ||
| * | ||
| * 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.living; | ||
|
|
||
| import net.minecraft.entity.Entity; | ||
| import net.minecraft.entity.EntityLivingBase; | ||
| import net.minecraft.entity.monster.EntityMob; | ||
| import net.minecraft.entity.player.EntityPlayer; | ||
| import net.minecraft.util.DamageSource; | ||
| import net.minecraftforge.common.ForgeHooks; | ||
| import net.minecraftforge.common.MinecraftForge; | ||
| import net.minecraftforge.fml.common.eventhandler.Cancelable; | ||
|
|
||
| /** | ||
| * LivingKnockBackEvent is fired when a living entity is about to be knocked back. <br> | ||
| * This event is fired whenever an Entity is knocked back in | ||
| * {@link EntityLivingBase#attackEntityFrom(DamageSource, float)}, | ||
| * {@link EntityLivingBase#blockWithShield(EntityLivingBase)}, | ||
| * {@link EntityMob#attackEntityAsMob(Entity)} and | ||
| * {@link EntityPlayer#attackTargetEntityWithCurrentItem(Entity)} <br> | ||
| * <br> | ||
| * This event is fired via {@link ForgeHooks#onLivingKnockBack(EntityLivingBase, Entity, float, double, double)}.<br> | ||
| * <br> | ||
| * {@link #attacker} contains the Entity that caused the knock back. <br> | ||
| * {@link #strength} contains the strength of the knock back. <br> | ||
| * {@link #ratioX} contains the x ratio of the knock back. <br> | ||
| * {@link #ratioZ} contains the z ratio of the knock back. <br> | ||
| * <br> | ||
| * This event is {@link Cancelable}.<br> | ||
| * If this event is canceled, the entity is not knocked back.<br> | ||
| * <br> | ||
| * This event does not have a result. {@link HasResult}<br> | ||
| *<br> | ||
| * This event is fired on the {@link MinecraftForge#EVENT_BUS}. | ||
| **/ | ||
| @Cancelable | ||
| public class LivingKnockBackEvent extends LivingEvent | ||
| { | ||
| protected Entity attacker; | ||
| protected float strength; | ||
| protected double ratioX, ratioZ; | ||
|
There was a problem hiding this comment. protected final Entity attacker;
protected float strength;
protected double ratioX, ratioZ;
protected final float originalStrength;
protected final double originalRatioX, originalRatioZ;
public LivingKnockBackEvent(EntityLivingBase target, Entity attacker, float strength, double ratioX, double ratioZ)
{
super(target);
this.attacker = attacker;
this.originalStrength = strength;
this.originalRatioX = ratioX;
this.originalRatioZ = ratioZ;
this.strength = strength;
this.ratioX = ratioX;
this.ratioZ = ratioZ;
}In case of multiple mods modifying the same event. There was a problem hiding this comment. This is a good suggestion from liach, please add the "original" values as final values, so mods using the events can have more information about modifications to the values. |
||
| protected final Entity originalAttacker; | ||
| protected final float originalStrength; | ||
| protected final double originalRatioX, originalRatioZ; | ||
|
|
||
| public LivingKnockBackEvent(EntityLivingBase target, Entity attacker, float strength, double ratioX, double ratioZ) | ||
| { | ||
| super(target); | ||
| this.attacker = this.originalAttacker = attacker; | ||
| this.strength = this.originalStrength = strength; | ||
| this.ratioX = this.originalRatioX = ratioX; | ||
| this.ratioZ = this.originalRatioZ = ratioZ; | ||
| } | ||
|
|
||
| public Entity getAttacker() {return this.attacker;} | ||
|
|
||
| public float getStrength() {return this.strength;} | ||
|
|
||
| public double getRatioX() {return this.ratioX;} | ||
|
|
||
| public double getRatioZ() {return this.ratioZ;} | ||
|
|
||
| public Entity getOriginalAttacker() {return this.originalAttacker;} | ||
|
|
||
| public float getOriginalStrength() {return this.originalStrength;} | ||
|
|
||
| public double getOriginalRatioX() {return this.originalRatioX;} | ||
|
|
||
| public double getOriginalRatioZ() {return this.originalRatioZ;} | ||
|
|
||
| public void setAttacker(Entity attacker) {this.attacker = attacker;} | ||
|
|
||
| public void setStrength(float strength) {this.strength = strength;} | ||
|
|
||
| public void setRatioX(double ratioX) {this.ratioX = ratioX;} | ||
|
|
||
| public void setRatioZ(double ratioZ) {this.ratioZ = ratioZ;} | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package net.minecraftforge.debug; | ||
|
|
||
| import net.minecraft.entity.passive.EntityCow; | ||
| import net.minecraft.entity.passive.EntitySheep; | ||
| import net.minecraftforge.event.entity.living.LivingKnockBackEvent; | ||
| import net.minecraftforge.fml.common.Mod; | ||
| import net.minecraftforge.fml.common.eventhandler.SubscribeEvent; | ||
|
|
||
| @Mod(modid = "kbhtest", name = "Knock Back Hook Test", version = "1.0") | ||
| @Mod.EventBusSubscriber | ||
| public class KnockBackHookTest | ||
| { | ||
| private static final boolean ENABLED = false; | ||
|
|
||
| @SubscribeEvent | ||
| public static void onKnockBack(LivingKnockBackEvent event) | ||
| { | ||
| if(ENABLED) | ||
| { | ||
| if(event.getEntityLiving() instanceof EntitySheep) | ||
| { | ||
| event.setStrength(0.2F); | ||
| } | ||
| else if(event.getEntityLiving() instanceof EntityCow) | ||
| { | ||
| event.setCanceled(true); | ||
| } | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file needs a license header.