Added PneumaticCraft API

Author: MaartenKok8

java/pneumaticCraft/api/block/BlockSupplier.java

@@ -0,0 +1,71 @@
+package pneumaticCraft.api.block;
+
+import net.minecraft.block.Block;
+
+public class BlockSupplier{
+    private static Class blockClass;
+
+    public static Block getBlock(String blockName){
+        try {
+            if(blockClass == null) blockClass = Class.forName("pneumaticCraft.common.block.Blocks");
+            return (Block)blockClass.getField(blockName).get(null);
+        } catch(Exception e) {
+            System.err.println("[PneumaticCraft API] Block supply failed for block: " + blockName);
+            return null;
+        }
+    }
+
+    /*
+     The following is a list of all the block names that can be passed as argument in getBlock(String) to get a PneumaticCraft block.
+     
+     
+     pressureTube               meta = tube type
+     airCompressor
+     airCannon
+     pressureChamberWall        meta < 6 ? wall : window
+     pressureChamberValve
+     pressureChamberInterface
+     squidPlant
+     fireFlower
+     creeperPlant
+     slimePlant
+     rainPlant
+     enderPlant
+     lightningPlant
+     adrenalinePlant
+     burstPlant
+     potionPlant
+     repulsionPlant
+     heliumPlant
+     flyingFlower
+     musicPlant
+     propulsionPlant
+     chopperPlant
+     chargingStation
+     elevatorBase
+     elevatorFrame
+     vacuumPump
+     pneumaticDoorBase
+     pneumaticDoor
+     assemblyPlatform
+     assemblyIOUnit
+     assemblyDrill
+     assemblyLaser
+     assemblyController
+     advancedPressureTube       meta = tube type (like 'pressureTube')
+     compressedIron
+     uvLightBox
+     etchingAcid
+     securityStation
+     universalSensor
+     pneumaticGenerator
+     electricCompressor
+     pneumaticEngine
+     kineticCompressor
+     aerialInterface
+     electrostaticCompressor
+     aphorismTile
+     omnidirectionalHopper
+
+     */
+}

java/pneumaticCraft/api/block/IPneumaticWrenchable.java

@@ -0,0 +1,14 @@
+package pneumaticCraft.api.block;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.world.World;
+import net.minecraftforge.common.ForgeDirection;
+
+/**
+ * Should be implemented by any block that allows to be rotated by a Pneumatic Wrench. It uses almost the same
+ * rotate method as the Vanilla (Forge) method. However it uses energy to rotate (when rotateBlock() return true).
+ */
+public interface IPneumaticWrenchable{
+
+    public boolean rotateBlock(World world, EntityPlayer player, int x, int y, int z, ForgeDirection side);
+}

java/pneumaticCraft/api/client/GuiAnimatedStatSupplier.java

@@ -0,0 +1,49 @@
+package pneumaticCraft.api.client;
+
+import net.minecraft.client.gui.inventory.GuiContainer;
+import net.minecraft.item.ItemStack;
+
+/**
+ * With this class you can retrieve new instances of the PneumaticCraft's IGuiAnimatedStat implementation. You can use these in Gui's as 
+ * well as anywhere you like. When you use these in Gui's you need to pass a valid GuiContainer instance, if you don't you can just pass
+ * null.
+ */
+public class GuiAnimatedStatSupplier{
+    private static Class animatedStatClass;
+
+    public static IGuiAnimatedStat getAnimatedStat(GuiContainer gui, int backgroundColor){
+        return getAnimatedStat(new Class[]{GuiContainer.class, int.class}, gui, backgroundColor);
+    }
+
+    /**
+     * Returns a GuiAnimatedStat which uses an itemstack as statistic icon.
+     * @param gui
+     * @param iconStack
+     * @param backgroundColor
+     * @return
+     */
+    public static IGuiAnimatedStat getAnimatedStat(GuiContainer gui, ItemStack iconStack, int backgroundColor){
+        return getAnimatedStat(new Class[]{GuiContainer.class, int.class, ItemStack.class}, gui, backgroundColor, iconStack);
+    }
+
+    /**
+     * Returns a GuiAnimatedStat which uses a texture location as statistic icon.
+     * @param gui
+     * @param iconTexture
+     * @param backgroundColor
+     * @return
+     */
+    public static IGuiAnimatedStat getAnimatedStat(GuiContainer gui, String iconTexture, int backgroundColor){
+        return getAnimatedStat(new Class[]{GuiContainer.class, int.class, String.class}, gui, backgroundColor, iconTexture);
+    }
+
+    private static IGuiAnimatedStat getAnimatedStat(Class[] constructorClasses, Object... constructorParameters){
+        try {
+            if(animatedStatClass == null) animatedStatClass = Class.forName("pneumaticCraft.client.gui.GuiAnimatedStat");
+            return (IGuiAnimatedStat)animatedStatClass.getConstructor(constructorClasses).newInstance(constructorParameters);
+        } catch(Exception e) {
+            System.err.println("Failed to retrieve an GuiAnimatedStat intance of PneumaticCraft.");
+        }
+        return null;
+    }
+}

java/pneumaticCraft/api/client/GuiElementRenderer.java

@@ -0,0 +1,32 @@
+package pneumaticCraft.api.client;
+
+import java.lang.reflect.Method;
+
+import net.minecraft.client.gui.FontRenderer;
+
+public class GuiElementRenderer{
+    private static Method drawGaugeMethod;
+
+    /**
+     * Draws a Pressure Gauge, the same which is also used in many PneumaticCraft applications.
+     * @param fontRenderer          fontrenderer used to draw the numbers of the pressure gauge.
+     * @param minPressure           The minimal pressure that needs to be displayed (this is -1 in most applications).
+     * @param maxPressure           The maximal pressure that needs to be rendererd (this is 7 for tier one machines, and 25 for tier two).
+     * @param dangerPressure        The transition pressure from green to red (this is 5 for tier one, and 29 for tier two machines).
+     * @param minWorkingPressure    The transition pressure from yellow to green (variates per machine).
+     * @param currentPressure       The pressure that the needle should point to.
+     * @param xPos                  x position of the gauge.
+     * @param yPos                  y position of the gauge.
+     * @param zLevel                z position of the gauge (Gui#zLevel, -90, for in normal GUI's).
+     */
+    public static void drawPressureGauge(FontRenderer fontRenderer, float minPressure, float maxPressure, float dangerPressure, float minWorkingPressure, float currentPressure, int xPos, int yPos, float zLevel){
+        try {
+            if(drawGaugeMethod == null) {
+                drawGaugeMethod = Class.forName("pneumaticCraft.client.gui.GuiUtils").getMethod("drawPressureGauge", FontRenderer.class, float.class, float.class, float.class, float.class, float.class, int.class, int.class, float.class);
+            }
+            drawGaugeMethod.invoke(null, fontRenderer, minPressure, maxPressure, dangerPressure, minWorkingPressure, currentPressure, xPos, yPos, zLevel);
+        } catch(Exception e) {
+            System.err.println("Failed to render a Pressure Gauge from PneumaticCraft.");
+        }
+    }
+}

java/pneumaticCraft/api/client/IGuiAnimatedStat.java

@@ -0,0 +1,187 @@
+package pneumaticCraft.api.client;
+
+import java.awt.Rectangle;
+import java.util.List;
+
+import net.minecraft.client.gui.FontRenderer;
+
+/**
+ * This interface doesn't have to be implemented. In PneumaticCraft there already is one class which implements this interface
+ * which is used many times in PneumaticCraft (GUI stats, Pneumatic Helmet 2D and 3D stats). You can get an instance of this
+ * class as well. Information about this you can find in GuiAnimatedStatSupplier.java. Implementing your own version of
+ * animated stats can be implemented as well via this interface, and they will interact with the PneumaticCraft GuiAnimatedStats
+ * if you implement it correctly.
+ */
+
+public interface IGuiAnimatedStat{
+
+    /**
+     * When you call this method with a set of coordinates representing the button location and dimensions, you'll get
+     * these parameters back scaled to the GuiAnimatedStat's scale.
+     * @param origX Button start X.
+     * @param origY Button start Y.
+     * @param width Button width.
+     * @param height Button height.
+     * @return rectangle containing the new location and dimensions.
+     */
+    public Rectangle getButtonScaledRectangle(int origX, int origY, int width, int height);
+
+    /**
+     * When passed 0.5F for example, the text of the stat will be half as big (so more text can fit into a certain area).
+     * @param scale
+     */
+    public void scaleTextSize(float scale);
+
+    /**
+     * Returns true if the statistic expands to the left.
+     * @return
+     */
+    public boolean isLeftSided();
+
+    /**
+     * Returns true if the statistic is done with expanding (when text will be displayed).
+     * @return
+     */
+    public boolean isDoneExpanding();
+
+    /**
+     * Pass true if the statistic should expand to the left, otherwise false.
+     * @param leftSided
+     */
+    public void setLeftSided(boolean leftSided);
+
+    /**
+     * Sets the main text of this stat. Every line should be stored in a seperate list element. Upon rendering,
+     * EnumChatFormattings will be respected. When you call this method, Too long lines will be divided into multiple shorter ones
+     * to fit in the GUI.
+     * @param text
+     */
+    public void setText(List<String> text);
+
+    /**
+     * Sets the line to a single line. Upon rendering,
+     * EnumChatFormattings will be respected. When you call this method, Too long lines will be divided into multiple shorter ones
+     * to fit in the GUI.
+     * @param text
+     */
+    public void setText(String text);
+
+    /**
+     * Sets the main text of this stat. Every line should be stored in a seperate list element. Upon rendering,
+     * EnumChatFormattings will be respected. This version of the text setting doesn't handle too long lines.
+     * @param text
+     */
+    public void setTextWithoutCuttingString(List<String> text);
+
+    /**
+     * Sets the title of this stat. It will automatically get the yellow color assigned.
+     * @param title
+     */
+    public void setTitle(String title);
+
+    /**
+     * Returns the title of this stat (obviously without color prefix).
+     * @return
+     */
+    public String getTitle();
+
+    /**
+     * Defines what dimensions the stat should have when it is not expanded (default 17x17) and resets the stat to these dimensions.
+     * Used in PneumaticCraft by the block/entity tracker stats, they are 0x0 when not expanded so it looks like they expand
+     * (and appear) from nothing.
+     * @param minWidth
+     * @param minHeight
+     */
+    public void setMinDimensionsAndReset(int minWidth, int minHeight);
+
+    /**
+     * When this stat gets a parent stat assigned, the y of this stat will be the same as the parent's plus this stat's
+     * baseY. This will cause this stat to move up and down when the parent's stat expands/moves.
+     * @param stat
+     */
+    public void setParentStat(IGuiAnimatedStat stat);
+
+    /**
+     * Sets the x location of this stat.
+     * @param x
+     */
+    public void setBaseX(int x);
+
+    /**
+     * Sets the base Y of this stat.
+     * @param y
+     */
+    public void setBaseY(int y);
+
+    /**
+     * Returns the real Y of this stat. This is the same as getBaseY when there is no parent stat, but if there is this method
+     * returns the value described in setParentStat(IGuiAnimatedStat stat).
+     * @return
+     */
+    public int getAffectedY();
+
+    public int getBaseX();
+
+    public int getBaseY();
+
+    /**
+     * Returns the Y size of this stat.
+     * @return
+     */
+    public int getHeight();
+
+    /**
+     * Returns the X size of this stat.
+     * @return
+     */
+    public int getWidth();
+
+    /**
+     * This method should be called every game tick to update the logic of the stat (expanding of the stat).
+     * NOTE!! PneumaticCraft's version of GuiAnimatedStat registers the stat when it creates an instance to automatically invoke the
+     * update() method every tick. This means that if you use GuiAnimatedStatSupplier.getAnimatedStat() you shouldn't call update()
+     * yourself!
+     */
+    public void update();
+
+    /**
+     * Should be called every render tick when and where you want to render the stat.
+     * @param fontRenderer
+     * @param zLevel
+     * @param partialTicks
+     */
+    public void render(FontRenderer fontRenderer, float zLevel, float partialTicks);
+
+    /**
+     * This method will handle mouse clicks. This will handle open/closing of the stat when the mouse clicks it.
+     * @param x
+     * @param y
+     * @param button
+     * @return
+     */
+    public boolean mouseClicked(int x, int y, int button);
+
+    /**
+     * Forces the stat to close.
+     */
+    public void closeWindow();
+
+    /**
+     * Forces the stat to expand.
+     */
+    public void openWindow();
+
+    /**
+     * Returns true if the stat is expanding.
+     * @return
+     */
+    public boolean isClicked();
+
+    /**
+     * Will handle the tooltip.
+     * @param fontRenderer
+     * @param x
+     * @param y
+     */
+    public void onMouseHovering(FontRenderer fontRenderer, int x, int y);
+}