* This will cause client-glitches! * - * @deprecated although this effect may trigger other events on non-living - * entities, it's only supported usage is on living ones. + * @deprecated split into individual effects + * @see #EGG_BREAK + * @see #SNOWBALL_BREAK + * @see #ENTITY_DEATH */ @Deprecated DEATH(3, Entity.class), - // PAIL - SPIGOT-3641 duplicate - // GOLEM_ATTACK(4, IronGolem.class), + /** + * Spawns the egg breaking particles + */ + EGG_BREAK(3, Egg.class), + /** + * Spawns the snowball breaking particles + */ + SNOWBALL_BREAK(3, Snowball.class), + /** + * Plays the entity death sound and animation + *
+ * This will cause client-glitches! + */ + ENTITY_DEATH(3, LivingEntity.class), + /** + * Plays the fang attack animation + */ + FANG_ATTACK(4, EvokerFangs.class), + /** + * Plays the hoglin attack animation + */ + HOGLIN_ATTACK(4, Hoglin.class), + /** + * Plays the iron golem attack animation + */ + IRON_GOLEN_ATTACK(4, IronGolem.class), + /** + * Plays the ravager attack animation + */ + RAVAGER_ATTACK(4, Ravager.class), + /** + * Plays the warden attack animation + */ + WARDEN_ATTACK(4, Warden.class), + /** + * Plays the zoglin attack animation + */ + ZOGLIN_ATTACK(4, Zoglin.class), // 5 - unused /** - * The smoke when taming a wolf fails. + * The smoke when taming an entity fails. */ WOLF_SMOKE(6, Tameable.class), /** - * The hearts when taming a wolf succeeds. + * The hearts when taming an entity succeeds. */ - WOLF_HEARTS(7, Wolf.class), + WOLF_HEARTS(7, Tameable.class), /** * When a wolf shakes (after being wet). + * + * @see EntityEffect#WOLF_SHAKE_STOP */ WOLF_SHAKE(8, Wolf.class), // 9 - unused /** * When an entity eats a LONG_GRASS block. * - * @deprecated although this effect may trigger other events on non-living - * entities, it's only supported usage is on living ones. + * @deprecated split into individual effects + * @see #SHEEP_EAT_GRASS + * @see #TNT_MINECART_IGNITE */ @Deprecated SHEEP_EAT(10, Entity.class), + /** + * Plays the sheep eating grass animation + */ + SHEEP_EAT_GRASS(10, Sheep.class), + /** + * Causes the TNT minecart to ignite, does not play the ignition sound + *
+ * This will cause client-glitches!
+ */
+ TNT_MINECART_IGNITE(10, ExplosiveMinecart.class),
/**
* When an Iron Golem gives a rose.
*/
@@ -213,7 +281,57 @@ public enum EntityEffect {
/**
* Entity breaks item in boot slot
*/
- BREAK_EQUIPMENT_BOOTS(52, LivingEntity.class);
+ BREAK_EQUIPMENT_BOOTS(52, LivingEntity.class),
+ /**
+ * Spawns honey block slide particles at the entity's feet
+ */
+ HONEY_BLOCK_SLIDE_PARTICLES(53, Entity.class),
+ /**
+ * Spawns honey block fall particles at the entity's feet
+ */
+ HONEY_BLOCK_FALL_PARTICLES(54, LivingEntity.class),
+ /**
+ * Entity swaps the items in their hand and offhand
+ */
+ SWAP_HAND_ITEMS(55, LivingEntity.class),
+ /**
+ * Stops a wolf that is currently shaking
+ *
+ * @see EntityEffect#WOLF_SHAKE
+ */
+ WOLF_SHAKE_STOP(56, Wolf.class),
+ // 57 - unused
+ /**
+ * Goat lowers its head for ramming
+ *
+ * @see #GOAT_RAISE_HEAD
+ */
+ GOAT_LOWER_HEAD(58, Goat.class),
+ /**
+ * Goat raises its head
+ *
+ * @see #GOAT_LOWER_HEAD
+ */
+ GOAT_RAISE_HEAD(59, Goat.class),
+ /**
+ * Spawns death smoke particles
+ */
+ SPAWN_DEATH_SMOKE(60, LivingEntity.class),
+ /**
+ * Warden shakes its tendrils
+ */
+ WARDEN_TENDRIL_SHAKE(61, Warden.class),
+ /**
+ * Warden performs sonic attack animation
+ * Does not play the sound or fire the beam
+ */
+ WARDEN_SONIC_ATTACK(62, Warden.class),
+ /**
+ * Plays sniffer digging sound
+ * Sniffer must have a target and be in {@link Sniffer.State#SEARCHING} or
+ * {@link Sniffer.State#DIGGING}
+ */
+ SNIFFER_DIG(63, Sniffer.class);
private final byte data;
private final Class applicable;
@@ -224,7 +342,7 @@ public enum EntityEffect {
}
/**
- * Gets the data value of this EntityEffect
+ * Gets the data value of this EntityEffect, may not be unique.
*
* @return The data value
* @deprecated Magic value
@@ -243,4 +361,28 @@ public enum EntityEffect {
public Class getApplicable() {
return applicable;
}
+
+ /**
+ * Checks if this effect is applicable to the given entity.
+ *
+ * @param entity the entity to check
+ * @return true if applicable
+ */
+ public boolean isApplicableTo(@NotNull Entity entity) {
+ Preconditions.checkArgument(entity != null, "Entity cannot be null");
+
+ return isApplicableTo(entity.getClass());
+ }
+
+ /**
+ * Checks if this effect is applicable to the given entity class.
+ *
+ * @param clazz the entity class to check
+ * @return true if applicable
+ */
+ public boolean isApplicableTo(@NotNull Class clazz) {
+ Preconditions.checkArgument(clazz != null, "Class cannot be null");
+
+ return applicable.isAssignableFrom(clazz);
+ }
}