rename ConsumeEffect -> ItemActionEffect

Author: MrHell228

src/main/java/org/spongepowered/api/data/Keys.java

@@ -61,7 +61,7 @@
 import org.spongepowered.api.data.type.CatType;
 import org.spongepowered.api.data.type.ChestAttachmentType;
 import org.spongepowered.api.data.type.ComparatorMode;
-import org.spongepowered.api.data.type.ConsumeEffect;
+import org.spongepowered.api.data.type.ItemActionEffect;
 import org.spongepowered.api.data.type.DoorHinge;
 import org.spongepowered.api.data.type.DripstoneSegment;
 import org.spongepowered.api.data.type.DyeColor;
@@ -774,9 +774,9 @@ public final class Keys {
     public static final Key<SetValue<Direction>> CONNECTED_DIRECTIONS = Keys.setKey(ResourceKey.sponge("connected_directions"), Direction.class);
 
     /**
-     * The {@link ConsumeEffect}s an {@link ItemStack} will apply when consumed.
+     * The {@link ItemActionEffect}s an {@link ItemStack} will apply when consumed.
      */
-    public static final Key<ListValue<ConsumeEffect>> CONSUME_EFFECTS = Keys.listKey(ResourceKey.sponge("consume_effects"), ConsumeEffect.class);
+    public static final Key<ListValue<ItemActionEffect>> CONSUME_EFFECTS = Keys.listKey(ResourceKey.sponge("consume_effects"), ItemActionEffect.class);
 
     /**
      * The container {@link ItemType} of an {@link ItemStack}.
@@ -929,9 +929,9 @@ public final class Keys {
     public static final Key<Value<Double>> DAMAGE_PER_BLOCK = Keys.key(ResourceKey.sponge("damage_per_block"), Double.class);
 
     /**
-     * The {@link ConsumeEffect}s an {@link ItemStack} will apply on death.
+     * The {@link ItemActionEffect}s an {@link ItemStack} will apply on death.
      */
-    public static final Key<ListValue<ConsumeEffect>> DEATH_PROTECTION_EFFECTS = Keys.listKey(ResourceKey.sponge("death_protection_effects"), ConsumeEffect.class);
+    public static final Key<ListValue<ItemActionEffect>> DEATH_PROTECTION_EFFECTS = Keys.listKey(ResourceKey.sponge("death_protection_effects"), ItemActionEffect.class);
 
     /**
      * The distance at which a {@link BlockState} will decay.

src/main/java/org/spongepowered/api/data/type/ConsumeEffectTypes.java

@@ -40,24 +40,24 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class ConsumeEffectTypes {
 
-    public static final DefaultedRegistryReference<ConsumeEffectType> APPLY_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("apply_effects"));
+    public static final DefaultedRegistryReference<ItemActionEffectType> APPLY_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("apply_effects"));
 
-    public static final DefaultedRegistryReference<ConsumeEffectType> CLEAR_ALL_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("clear_all_effects"));
+    public static final DefaultedRegistryReference<ItemActionEffectType> CLEAR_ALL_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("clear_all_effects"));
 
-    public static final DefaultedRegistryReference<ConsumeEffectType> PLAY_SOUND = ConsumeEffectTypes.key(ResourceKey.minecraft("play_sound"));
+    public static final DefaultedRegistryReference<ItemActionEffectType> PLAY_SOUND = ConsumeEffectTypes.key(ResourceKey.minecraft("play_sound"));
 
-    public static final DefaultedRegistryReference<ConsumeEffectType> REMOVE_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("remove_effects"));
+    public static final DefaultedRegistryReference<ItemActionEffectType> REMOVE_EFFECTS = ConsumeEffectTypes.key(ResourceKey.minecraft("remove_effects"));
 
-    public static final DefaultedRegistryReference<ConsumeEffectType> TELEPORT_RANDOMLY = ConsumeEffectTypes.key(ResourceKey.minecraft("teleport_randomly"));
+    public static final DefaultedRegistryReference<ItemActionEffectType> TELEPORT_RANDOMLY = ConsumeEffectTypes.key(ResourceKey.minecraft("teleport_randomly"));
 
     private ConsumeEffectTypes() {
     }
 
-    public static Registry<ConsumeEffectType> registry() {
-        return Sponge.game().registry(RegistryTypes.CONSUME_EFFECT_TYPE);
+    public static Registry<ItemActionEffectType> registry() {
+        return Sponge.game().registry(RegistryTypes.ITEM_ACTION_EFFECT_TYPE);
     }
 
-    private static DefaultedRegistryReference<ConsumeEffectType> key(final ResourceKey location) {
-        return RegistryKey.of(RegistryTypes.CONSUME_EFFECT_TYPE, location).asDefaultedReference(Sponge::game);
+    private static DefaultedRegistryReference<ItemActionEffectType> key(final ResourceKey location) {
+        return RegistryKey.of(RegistryTypes.ITEM_ACTION_EFFECT_TYPE, location).asDefaultedReference(Sponge::game);
     }
 }

src/main/java/org/spongepowered/api/data/type/ConsumeEffect.java renamed to src/main/java/org/spongepowered/api/data/type/ItemActionEffect.java

@@ -44,55 +44,55 @@
 /**
  * Represents an effect that can be applied on {@link ItemStack} consumption.
  */
-public interface ConsumeEffect {
+public interface ItemActionEffect {
 
     static ApplyEffects applyEffects(final Collection<PotionEffect> effects) {
-        return ConsumeEffect.applyEffects(1.0D, effects);
+        return ItemActionEffect.applyEffects(1.0D, effects);
     }
 
     static ApplyEffects applyEffects(final PotionEffect... effects) {
-        return ConsumeEffect.applyEffects(1.0D, effects);
+        return ItemActionEffect.applyEffects(1.0D, effects);
     }
 
     static ApplyEffects applyEffects(final double chance, final Collection<PotionEffect> effects) {
-        return ConsumeEffect.factory().applyEffects(chance, List.copyOf(effects));
+        return ItemActionEffect.factory().applyEffects(chance, List.copyOf(effects));
     }
 
     static ApplyEffects applyEffects(final double chance, final PotionEffect... effects) {
-        return ConsumeEffect.factory().applyEffects(chance, List.of(effects));
+        return ItemActionEffect.factory().applyEffects(chance, List.of(effects));
     }
 
     static RemoveEffects removeEffects(final Collection<PotionEffectType> effectTypes) {
-        return ConsumeEffect.factory().removeEffects(Set.copyOf(effectTypes));
+        return ItemActionEffect.factory().removeEffects(Set.copyOf(effectTypes));
     }
 
     static RemoveEffects removeEffects(final PotionEffectType... effectTypes) {
-        return ConsumeEffect.factory().removeEffects(Set.of(effectTypes));
+        return ItemActionEffect.factory().removeEffects(Set.of(effectTypes));
     }
 
     @SafeVarargs
     static RemoveEffects removeEffects(final Supplier<PotionEffectType>... effectTypes) {
-        return ConsumeEffect.factory().removeEffects(Arrays.stream(effectTypes).map(Supplier::get).collect(Collectors.toSet()));
+        return ItemActionEffect.factory().removeEffects(Arrays.stream(effectTypes).map(Supplier::get).collect(Collectors.toSet()));
     }
 
     static RemoveEffects removeEffects(final Tag<PotionEffectType> effectTypeTag) {
-        return ConsumeEffect.factory().removeEffects(effectTypeTag);
+        return ItemActionEffect.factory().removeEffects(effectTypeTag);
     }
 
     static ClearEffects clearEffects() {
-        return ConsumeEffect.factory().clearEffects();
+        return ItemActionEffect.factory().clearEffects();
     }
 
     static PlaySound playSound(final SoundType soundType) {
-        return ConsumeEffect.factory().playSound(soundType);
+        return ItemActionEffect.factory().playSound(soundType);
     }
 
     static PlaySound playSound(final Supplier<SoundType> soundType) {
-        return ConsumeEffect.factory().playSound(soundType.get());
+        return ItemActionEffect.factory().playSound(soundType.get());
     }
 
     static TeleportRandomly teleportRandomly(final double distance) {
-        return ConsumeEffect.factory().teleportRandomly(distance);
+        return ItemActionEffect.factory().teleportRandomly(distance);
     }
 
     private static Factory factory() {
@@ -103,7 +103,7 @@ private static Factory factory() {
      * Returns the type of this effect.
      * @return The type of this effect
      */
-    ConsumeEffectType type();
+    ItemActionEffectType type();
 
     /**
      * Tries to apply this effect and returns whether it was successfully applied.
@@ -154,7 +154,7 @@ default boolean apply(final Living entity) {
     /**
      * Applies {@link PotionEffect}s with chance.
      */
-    interface ApplyEffects extends ConsumeEffect {
+    interface ApplyEffects extends ItemActionEffect {
         /**
          * Returns the probability for effects to be applied.
          * @return The probability for effects to be applied
@@ -171,7 +171,7 @@ interface ApplyEffects extends ConsumeEffect {
     /**
      * Removes {@link PotionEffect}s with matching {@link PotionEffectType}s.
      */
-    interface RemoveEffects extends ConsumeEffect {
+    interface RemoveEffects extends ItemActionEffect {
         /**
          * Returns {@link PotionEffectType}s that will be removed.
          * @return {@link PotionEffectType}s that will be removed
@@ -182,13 +182,13 @@ interface RemoveEffects extends ConsumeEffect {
     /**
      * Clears all {@link PotionEffect}s.
      */
-    interface ClearEffects extends ConsumeEffect {
+    interface ClearEffects extends ItemActionEffect {
     }
 
     /**
      * Plays {@link SoundType}.
      */
-    interface PlaySound extends ConsumeEffect {
+    interface PlaySound extends ItemActionEffect {
         /**
          * Returns the consumption {@link SoundType}.
          * @return The consumption {@link SoundType}
@@ -199,7 +199,7 @@ interface PlaySound extends ConsumeEffect {
     /**
      * Teleports randomly within maximum distance.
      */
-    interface TeleportRandomly extends ConsumeEffect {
+    interface TeleportRandomly extends ItemActionEffect {
         /**
          * Returns the maximum distance entity can be teleported.
          * @return The maximum distance entity can be teleported

src/main/java/org/spongepowered/api/data/type/ConsumeEffectType.java renamed to src/main/java/org/spongepowered/api/data/type/ItemActionEffectType.java

@@ -28,8 +28,8 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 /**
- * Represents a possible type of {@link ConsumeEffect}.
+ * Represents a possible type of {@link ItemActionEffect}.
  */
 @CatalogedBy(ConsumeEffectTypes.class)
-public interface ConsumeEffectType extends DefaultedRegistryValue {
+public interface ItemActionEffectType extends DefaultedRegistryValue {
 }

src/main/java/org/spongepowered/api/registry/RegistryTypes.java

@@ -56,7 +56,7 @@
 import org.spongepowered.api.data.type.CatType;
 import org.spongepowered.api.data.type.ChestAttachmentType;
 import org.spongepowered.api.data.type.ComparatorMode;
-import org.spongepowered.api.data.type.ConsumeEffectType;
+import org.spongepowered.api.data.type.ItemActionEffectType;
 import org.spongepowered.api.data.type.DoorHinge;
 import org.spongepowered.api.data.type.DripstoneSegment;
 import org.spongepowered.api.data.type.DyeColor;
@@ -227,7 +227,7 @@ public final class RegistryTypes {
 
     public static final DefaultedRegistryType<ChunkState> CHUNK_STATE = RegistryTypes.minecraftKeyInGame("chunk_status");
 
-    public static final DefaultedRegistryType<ConsumeEffectType> CONSUME_EFFECT_TYPE = RegistryTypes.minecraftKeyInGame("consume_effect_type");
+    public static final DefaultedRegistryType<ItemActionEffectType> ITEM_ACTION_EFFECT_TYPE = RegistryTypes.minecraftKeyInGame("consume_effect_type");
 
     public static final DefaultedRegistryType<ContainerType> CONTAINER_TYPE = RegistryTypes.minecraftKeyInGame("menu");