add(api/enums): particle and sound effect enumerations (#1154)

* add(api/enums): particle and sound effect enumerations

- Adds new GregTech API enumerations:
  - `ParticleFX`: Enumerates known EntityFX particles.
  - `SoundResource`: Enumerates known sounds with, id and ResourceLocation.
- Refactors code to use the new enumerations instead of string literals.
- Uses `ParticleFX` and `onRandomDisplayTick` to improve or implement
  new particle effects for these machines:
  - BBF: Adds random flames in front of the firebox.
  - Steam machines: Changes pressure-exhaust particles to white vapour,
    rather than dark smoke.
  - Magic Energy Absorber: Adds random effect, of absorbed magical purple
    particles, by the EnderDragon Egg siphon.
  - Forge Hammer: Adds sparse random sparks, ejected from the main face.

3 files changed, 62 insertions, 73 deletions

diff --git a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler.java b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler.java
index 96b991e767..9eebaaabc4 100644
--- a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler.java
+++ b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler.java
@@ -2,8 +2,10 @@ package gregtech.common.tileentities.boilers;
 
 import gregtech.GT_Mod;
 import gregtech.api.GregTech_API;
+import gregtech.api.enums.ParticleFX;
 import gregtech.api.enums.GT_Values;
 import gregtech.api.enums.Materials;
+import gregtech.api.enums.SoundResource;
 import gregtech.api.interfaces.ITexture;
 import gregtech.api.interfaces.tileentity.IGregTechTileEntity;
 import gregtech.api.metatileentity.implementations.GT_MetaTileEntity_BasicTank;
@@ -11,7 +13,7 @@ import gregtech.api.objects.GT_ItemStack;
 import gregtech.api.util.GT_Log;
 import gregtech.api.util.GT_ModHandler;
 import gregtech.api.util.GT_Utility;
-import gregtech.api.util.WorldSpawnedEventBuilder;
+import gregtech.api.util.WorldSpawnedEventBuilder.ParticleEventBuilder;
 import gregtech.common.GT_Pollution;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.init.Items;
@@ -24,6 +26,7 @@ import net.minecraftforge.fluids.IFluidHandler;
 import static gregtech.api.objects.XSTR.XSTR_INSTANCE;
 
 public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTank {
+    public static final byte SOUND_EVENT_LET_OFF_EXCESS_STEAM = 1;
     public int mTemperature = 20;
     public int mProcessingEnergy = 0;
     public int mLossTimer = 0;
@@ -31,8 +34,6 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
     public boolean mHadNoWater = false;
     private int mExcessWater = 0;
 
-    public static final byte SOUND_EVENT_LET_OFF_EXCESS_STEAM = 1;
-
     public GT_MetaTileEntity_Boiler(int aID, String aName, String aNameRegional, String aDescription, ITexture... aTextures) {
         super(aID, aName, aNameRegional, 0, 4, aDescription, aTextures);
     }
@@ -44,7 +45,7 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
     public GT_MetaTileEntity_Boiler(String aName, int aTier, String aDescription, ITexture[][][] aTextures) {
         super(aName, aTier, 4, aDescription, aTextures);
     }
-    
+
     public GT_MetaTileEntity_Boiler(String aName, int aTier, String[] aDescription, ITexture[][][] aTextures) {
         super(aName, aTier, 4, aDescription, aTextures);
     }
@@ -190,7 +191,8 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
         }
         try {
             aNBT.setTag("mSteam", this.mSteam.writeToNBT(new NBTTagCompound()));
-        } catch (Throwable ignored) {}
+        } catch (Throwable ignored) {
+        }
     }
 
     @Override
@@ -224,8 +226,7 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
     public void onPostTick(IGregTechTileEntity aBaseMetaTileEntity, long aTick) {
         pollute(aTick);
 
-        if (isNotAllowedToWork(aBaseMetaTileEntity, aTick))
-            return;
+        if (isNotAllowedToWork(aBaseMetaTileEntity, aTick)) return;
 
         calculateCooldown();
         pushSteamToInventories(aBaseMetaTileEntity);
@@ -292,27 +293,23 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
         return false;
     }
 
-    protected void onDangerousWaterLack(IGregTechTileEntity tile, long ticks) {
+    protected void onDangerousWaterLack(IGregTechTileEntity tile, long ignoredTicks) {
         tile.doExplosion(2048L);
     }
 
     protected final void pushSteamToSide(IGregTechTileEntity aBaseMetaTileEntity, int aSide) {
         IFluidHandler tTileEntity = aBaseMetaTileEntity.getITankContainerAtSide((byte) aSide);
-        if (tTileEntity == null)
-            return;
+        if (tTileEntity == null) return;
         FluidStack tDrained = aBaseMetaTileEntity.drain(ForgeDirection.getOrientation(aSide), Math.max(1, this.mSteam.amount / 2), false);
-        if (tDrained == null)
-            return;
+        if (tDrained == null) return;
         int tFilledAmount = tTileEntity.fill(ForgeDirection.getOrientation(aSide).getOpposite(), tDrained, false);
-        if (tFilledAmount <= 0)
-            return;
+        if (tFilledAmount <= 0) return;
         tTileEntity.fill(ForgeDirection.getOrientation(aSide).getOpposite(), aBaseMetaTileEntity.drain(ForgeDirection.getOrientation(aSide), tFilledAmount, true), true);
     }
 
     protected void pushSteamToInventories(IGregTechTileEntity aBaseMetaTileEntity) {
         for (int i = 1; (this.mSteam != null) && (i < 6); i++) {
-            if (i == aBaseMetaTileEntity.getFrontFacing())
-                continue;
+            if (i == aBaseMetaTileEntity.getFrontFacing()) continue;
             pushSteamToSide(aBaseMetaTileEntity, i);
         }
     }
@@ -342,19 +339,9 @@ public abstract class GT_MetaTileEntity_Boiler extends GT_MetaTileEntity_BasicTa
     @Override
     public void doSound(byte aIndex, double aX, double aY, double aZ) {
         if (aIndex == GT_MetaTileEntity_Boiler.SOUND_EVENT_LET_OFF_EXCESS_STEAM) {
-            GT_Utility.doSoundAtClient(GregTech_API.sSoundList.get(4), 2, 1.0F, aX, aY, aZ);
-
-            new WorldSpawnedEventBuilder.ParticleEventBuilder()
-                    .setIdentifier("largesmoke")
-                    .setWorld(getBaseMetaTileEntity().getWorld())
-                    .setMotion(0D, 0D, 0D)
-                    .<WorldSpawnedEventBuilder.ParticleEventBuilder>times(8, x -> x
-                            .setPosition(
-                                    aX - 0.5D + XSTR_INSTANCE.nextFloat(),
-                                    aY,
-                                    aZ - 0.5D + XSTR_INSTANCE.nextFloat()
-                            ).run()
-                    );
+            GT_Utility.doSoundAtClient(SoundResource.RANDOM_FIZZ, 2, 1.0F, aX, aY, aZ);
+
+            new ParticleEventBuilder().setIdentifier(ParticleFX.CLOUD).setWorld(getBaseMetaTileEntity().getWorld()).setMotion(0D, 0D, 0D).<ParticleEventBuilder>times(8, x -> x.setPosition(aX - 0.5D + XSTR_INSTANCE.nextFloat(), aY, aZ - 0.5D + XSTR_INSTANCE.nextFloat()).run());
         }
     }
 
diff --git a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Bronze.java b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Bronze.java
index bdd291a83c..4b4a0299c1 100644
--- a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Bronze.java
+++ b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Bronze.java
@@ -3,6 +3,7 @@ package gregtech.common.tileentities.boilers;
 import cpw.mods.fml.relauncher.Side;
 import cpw.mods.fml.relauncher.SideOnly;
 import gregtech.GT_Mod;
+import gregtech.api.enums.ParticleFX;
 import gregtech.api.enums.Materials;
 import gregtech.api.enums.OrePrefixes;
 import gregtech.api.interfaces.ITexture;
@@ -12,7 +13,7 @@ import gregtech.api.objects.XSTR;
 import gregtech.api.render.TextureFactory;
 import gregtech.api.util.GT_OreDictUnificator;
 import gregtech.api.util.GT_Utility;
-import gregtech.api.util.WorldSpawnedEventBuilder;
+import gregtech.api.util.WorldSpawnedEventBuilder.ParticleEventBuilder;
 import gregtech.common.GT_Pollution;
 import gregtech.common.gui.GT_Container_Boiler;
 import gregtech.common.gui.GT_GUIContainer_Boiler;
@@ -36,7 +37,7 @@ public class GT_MetaTileEntity_Boiler_Bronze extends GT_MetaTileEntity_Boiler {
         super(aID, aName, aNameRegional, new String[]{
                 "An early way to get Steam Power",
                 "Produces 120L of Steam per second",
-                "Causes "+Integer.toString(GT_Mod.gregtechproxy.mPollutionSmallCoalBoilerPerSecond)+" Pollution per second"});
+                "Causes " + GT_Mod.gregtechproxy.mPollutionSmallCoalBoilerPerSecond + " Pollution per second"});
     }
 
     public GT_MetaTileEntity_Boiler_Bronze(int aID, String aName, String aNameRegional, String[] aDescription) {
@@ -95,6 +96,11 @@ public class GT_MetaTileEntity_Boiler_Bronze extends GT_MetaTileEntity_Boiler {
         return new GT_MetaTileEntity_Boiler_Bronze(this.mName, this.mTier, this.mDescriptionArray, this.mTextures);
     }
 
+    /**
+     * Draws random flames and smoke particles in front of active boiler
+     *
+     * @param aBaseMetaTileEntity The entity that will handle the {@link Block#randomDisplayTick}
+     */
     @SideOnly(Side.CLIENT)
     @Override
     public void onRandomDisplayTick(IGregTechTileEntity aBaseMetaTileEntity) {
@@ -102,47 +108,43 @@ public class GT_MetaTileEntity_Boiler_Bronze extends GT_MetaTileEntity_Boiler {
 
             final byte frontFacing = aBaseMetaTileEntity.getFrontFacing();
 
-            final double oX = aBaseMetaTileEntity.getOffsetX(frontFacing, 1) + 0.5F;
-            final double oY = aBaseMetaTileEntity.getOffsetY(frontFacing, 1) + XSTR_INSTANCE.nextFloat() * 6.0F / 16.0F;
-            final double oZ = aBaseMetaTileEntity.getOffsetZ(frontFacing, 1) + 0.5F;
-            final double offset = -0.48F;
-            final double horizontal = XSTR_INSTANCE.nextFloat() * 0.6F - 0.3F;
-
-            final double x, z;
+            if (frontFacing > 1
+                && aBaseMetaTileEntity.getCoverIDAtSide(frontFacing) == 0
+                && !aBaseMetaTileEntity.getOpacityAtSide(frontFacing)) {
+
+                final double oX = aBaseMetaTileEntity.getOffsetX(frontFacing, 1) + 8D / 16D;
+                final double oY = aBaseMetaTileEntity.getOffsetY(frontFacing, 1);
+                final double oZ = aBaseMetaTileEntity.getOffsetZ(frontFacing, 1) + 8D / 16D;
+                final double offset = -0.48D;
+                final double horizontal = XSTR_INSTANCE.nextFloat() * 10D / 16D - 5D / 16D;
+
+                final double x, y, z;
+
+                y = oY + XSTR_INSTANCE.nextFloat() * 6D / 16D;
+
+                if (frontFacing == ForgeDirection.WEST.ordinal()) {
+                    x = oX - offset;
+                    z = oZ + horizontal;
+                } else if (frontFacing == ForgeDirection.EAST.ordinal()) {
+                    x = oX + offset;
+                    z = oZ + horizontal;
+                } else if (frontFacing == ForgeDirection.NORTH.ordinal()) {
+                    x = oX + horizontal;
+                    z = oZ - offset;
+                } else // if (frontFacing == ForgeDirection.SOUTH.ordinal())
+                {
+                    x = oX + horizontal;
+                    z = oZ + offset;
+                }
 
-            if (frontFacing == ForgeDirection.WEST.ordinal())
-            {
-                x = (oX - offset);
-                z = oZ + horizontal;
-            }
-            else if (frontFacing == ForgeDirection.EAST.ordinal())
-            {
-                x = oX + offset;
-                z = oZ + horizontal;
+                ParticleEventBuilder particleEventBuilder =
+                    (new ParticleEventBuilder())
+                        .setMotion(0D, 0D, 0D)
+                        .setPosition(x, y, z)
+                        .setWorld(getBaseMetaTileEntity().getWorld());
+                particleEventBuilder.setIdentifier(ParticleFX.SMOKE).run();
+                particleEventBuilder.setIdentifier(ParticleFX.FLAME).run();
             }
-            else if (frontFacing == ForgeDirection.NORTH.ordinal())
-            {
-                x = oX + horizontal;
-                z = oZ - offset;
-            }
-            else // if (frontFacing == ForgeDirection.SOUTH.ordinal())
-            {
-               x = oX + horizontal;
-               z = oZ + offset;
-            }
-
-            new WorldSpawnedEventBuilder.ParticleEventBuilder()
-                    .setMotion(0D, 0.0D, 0D)
-                    .setIdentifier("smoke")
-                    .setPosition(x, oY, z)
-                    .setWorld(getBaseMetaTileEntity().getWorld())
-                    .run();
-            new WorldSpawnedEventBuilder.ParticleEventBuilder()
-                    .setMotion(0D, 0.0D, 0D)
-                    .setIdentifier("flame")
-                    .setPosition(x, oY, z)
-                    .setWorld(getBaseMetaTileEntity().getWorld())
-                    .run();
         }
     }
 
diff --git a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Solar.java b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Solar.java
index 5aa481ecd0..caa1df1543 100644
--- a/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Solar.java
+++ b/src/main/java/gregtech/common/tileentities/boilers/GT_MetaTileEntity_Boiler_Solar.java
@@ -274,11 +274,11 @@ public class GT_MetaTileEntity_Boiler_Solar extends GT_MetaTileEntity_Boiler {
     }
 
     @Override
-    public void getWailaBody(ItemStack itemStack, List<String> currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config) {
+    public void getWailaBody(ItemStack itemStack, List<String> currentTip, IWailaDataAccessor accessor, IWailaConfigHandler config) {
         final NBTTagCompound tag = accessor.getNBTData();
-        currenttip.add(String.format((GOLD + "Solar Boiler Output: " + RESET + "%d/%d L/s"), tag.getInteger("calcificationOutput"), tag.getInteger("maxCalcificationOutput")));
+        currentTip.add(String.format((GOLD + "Solar Boiler Output: " + RESET + "%d/%d L/s"), tag.getInteger("calcificationOutput"), tag.getInteger("maxCalcificationOutput")));
 
-        super.getWailaBody(itemStack, currenttip, accessor, config);
+        super.getWailaBody(itemStack, currentTip, accessor, config);
     }
 
     @Override