Javadoc update

This commit is contained in:
pahimar 2012-10-27 17:41:02 -04:00
parent 942f97eda3
commit e3ef89d38e
43 changed files with 387 additions and 14 deletions

View file

@ -14,7 +14,15 @@ import net.minecraft.src.InventoryPlayer;
import net.minecraft.src.StatCollector;
import net.minecraft.src.TileEntityFurnace;
@SideOnly(Side.CLIENT)
/**
* GuiCalcinator
*
* Calcinator Gui class
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class GuiCalcinator extends GuiContainer {
private TileCalcinator calcinator;

View file

@ -11,7 +11,15 @@ import net.minecraft.src.GuiContainer;
import net.minecraft.src.StatCollector;
import net.minecraft.src.World;
@SideOnly(Side.CLIENT)
/**
* GuiPortableCrafting
*
* Portable Crafting Gui class
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class GuiPortableCrafting extends GuiContainer {
public GuiPortableCrafting(EntityPlayer player, World world, int x, int y, int z) {

View file

@ -8,6 +8,15 @@ import net.minecraft.src.ModelBase;
import net.minecraft.src.ModelRenderer;
import net.minecraftforge.client.ForgeHooksClient;
/**
* ModelCalcinator
*
* Model for the Calcinator
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ModelCalcinator extends ModelBase {
private static final int TEXTURE_HEIGHT = 128;

View file

@ -9,6 +9,15 @@ import net.minecraft.src.ModelRenderer;
import net.minecraft.src.TileEntity;
import net.minecraft.src.TileEntitySpecialRenderer;
/**
* RenderCalcinator
*
* Renders the Calcinator in game as a TESR (Tile Entity Special Render)
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RenderCalcinator extends TileEntitySpecialRenderer {
static final float scale = (float) (1.0 / 16.0);

View file

@ -8,6 +8,15 @@ import net.minecraft.src.Tessellator;
import net.minecraftforge.client.ForgeHooksClient;
import net.minecraftforge.client.IItemRenderer;
/**
* RenderItemCalcinator
*
* Renders the Calcinator in game as an item (in hand, on the ground, and in inventory)
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RenderItemCalcinator implements IItemRenderer {
private ModelCalcinator calcinatorModel;

View file

@ -8,6 +8,15 @@ import cpw.mods.fml.client.FMLTextureFX;
import ee3.common.block.ModBlocks;
import ee3.common.lib.Reference;
/**
* TextureRedWaterFX
*
* TextureFX for still Red Water
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class TextureRedWaterFX extends FMLTextureFX {
protected float[] red = new float[256];

View file

@ -8,6 +8,15 @@ import cpw.mods.fml.client.FMLTextureFX;
import ee3.common.block.ModBlocks;
import ee3.common.lib.Reference;
/**
* TextureRedWaterFlowFX
*
* TextureFX for flowing Red Water
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class TextureRedWaterFlowFX extends FMLTextureFX {
protected float[] red = new float[256];

View file

@ -5,6 +5,15 @@ import net.minecraft.src.BlockFlowing;
import net.minecraft.src.CreativeTabs;
import net.minecraft.src.Material;
/**
* BlockRedWaterFlowing
*
* Class for the flowing version of Red Water
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class BlockRedWaterFlowing extends BlockFlowing {
protected BlockRedWaterFlowing(int id, Material material) {

View file

@ -5,6 +5,15 @@ import net.minecraft.src.BlockStationary;
import net.minecraft.src.CreativeTabs;
import net.minecraft.src.Material;
/**
* BlockRedWaterFlowing
*
* Class for the still version of Red Water
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class BlockRedWaterStill extends BlockStationary {
protected BlockRedWaterStill(int id, Material material) {

View file

@ -9,6 +9,15 @@ import net.minecraft.src.Item;
import net.minecraft.src.ItemStack;
import net.minecraft.src.Material;
/**
* ModBlocks
*
* Class containing all the EE3 custom blocks
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ModBlocks {
/* Block name constants */

View file

@ -9,6 +9,15 @@ import net.minecraft.src.ItemStack;
import net.minecraft.src.Slot;
import net.minecraft.src.TileEntityFurnace;
/**
* ContainerCalcinator
*
* The container class for the Calcinator
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ContainerCalcinator extends Container {
private TileCalcinator calcinator;

View file

@ -5,6 +5,15 @@ import net.minecraft.src.EntityPlayer;
import net.minecraft.src.InventoryPlayer;
import net.minecraft.src.World;
/**
* ContainerPortableCrafting
*
* Container class for the portable crafting interface
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ContainerPortableCrafting extends ContainerWorkbench {
public ContainerPortableCrafting(InventoryPlayer inventoryPlayer, World world, int x, int y, int z) {

View file

@ -11,6 +11,15 @@ import net.minecraftforge.event.ForgeSubscribe;
import net.minecraftforge.event.entity.living.LivingDeathEvent;
import net.minecraftforge.event.entity.living.LivingEvent.LivingUpdateEvent;
/**
* EntityLivingHandler
*
* Class containing all EE3 custom event related logic for EntityLiving events
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class EntityLivingHandler {
@ForgeSubscribe

View file

@ -5,6 +5,15 @@ import java.util.ArrayList;
import ee3.common.core.helper.GeneralHelper;
import net.minecraft.src.ItemStack;
/**
* EquivalencyHandler
*
* Class to handle all the equivalency relationships between items/etc
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class EquivalencyHandler {
private static final EquivalencyHandler instance = new EquivalencyHandler();

View file

@ -3,6 +3,15 @@ package ee3.common.core.handlers;
import net.minecraft.src.ItemStack;
import cpw.mods.fml.common.IFuelHandler;
/**
* FuelHandler
*
* Class for querying and returning fuel values for items
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class FuelHandler implements IFuelHandler {
@Override

View file

@ -3,6 +3,15 @@ package ee3.common.core.handlers;
import net.minecraftforge.event.ForgeSubscribe;
import net.minecraftforge.event.entity.player.PlayerDestroyItemEvent;
/**
* PlayerDestroyItemHandler
*
* Class containing all EE3 custom event related logic for PlayerDestroyItem events
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class PlayerDestroyItemHandler {
@ForgeSubscribe

View file

@ -10,6 +10,15 @@ import ee3.common.lib.Colours;
import ee3.common.lib.ConfigurationSettings;
import ee3.common.lib.Reference;
/**
* VersionCheckTickHandler
*
* Class for notifying the player on their client when they get in game the outcome of the remote version check
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class VersionCheckTickHandler implements ITickHandler {
private static boolean initialized = false;

View file

@ -6,6 +6,15 @@ import net.minecraft.src.Block;
import net.minecraft.src.Item;
import net.minecraft.src.ItemStack;
/**
* GeneralHelper
*
* General helper methods for EE3
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class GeneralHelper {
public static ItemStack convertObjectToItemStack(Object obj) {

View file

@ -5,6 +5,15 @@ import net.minecraft.src.EntityAgeable;
import net.minecraft.src.EntityLiving;
import net.minecraft.src.EntityPlayer;
/**
* ItemDropHelper
*
* Helper methods for dropping items in game
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ItemDropHelper {
private static double rand;

View file

@ -8,6 +8,15 @@ import cpw.mods.fml.common.FMLLog;
import ee3.common.EquivalentExchange3;
import ee3.common.lib.Reference;
/**
* LogHelper
*
* Helper methods for logging to the EE3 logger
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class LogHelper {
private static Logger eeLogger = Logger.getLogger(Reference.MOD_NAME);

View file

@ -3,6 +3,15 @@ package ee3.common.core.helper;
import net.minecraft.src.ItemStack;
import net.minecraft.src.NBTTagCompound;
/**
* NBTHelper
*
* Helper methods for manipulating NBT data on ItemStacks
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class NBTHelper {
/**

View file

@ -2,20 +2,17 @@ package ee3.common.core.helper;
import net.minecraft.src.ItemStack;
/**
* QualityHelper
*
* Helper methods for determining the quality tier of items
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class QualityHelper {
/*
* Legend for the dust table quality lookup, comparison is based off of quality tiers
*
* Item Quality
* |_0_|_1_|_2_|_3_|_4_|_5_|
* Fuel 0 | 0 | 0 | 0 | 1 | 1 | 1 |
* Quality 1 | 0 | 1 | 1 | 1 | 2 | 2 |
* 2 | 0 | 1 | 2 | 2 | 2 | 2 |
* 3 | 1 | 1 | 2 | 3 | 3 | 3 |
* 4 | 1 | 2 | 2 | 3 | 4 | 4 |
* 5 | 1 | 2 | 2 | 3 | 4 | 5 |
*/
private static int[][] dustTable = {
{0, 0, 0, 1, 1, 1},
{0, 1, 1, 1, 2, 2},

View file

@ -8,6 +8,15 @@ import net.minecraft.src.Item;
import net.minecraft.src.ItemStack;
import cpw.mods.fml.common.registry.GameRegistry;
/**
* RecipeHelper
*
* Helper methods for adding recipes
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RecipeHelper {
public static void addRecipe(ItemStack output, Object... input) {

View file

@ -8,6 +8,15 @@ import net.minecraft.src.EntityLiving;
import net.minecraft.src.MathHelper;
import net.minecraft.src.World;
/**
* RedWaterHelper
*
* Helper methods for Red Water related effects
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RedWaterHelper {
public static boolean handleRedWaterDetection(EntityLiving entity) {

View file

@ -13,6 +13,15 @@ import net.minecraft.src.ItemStack;
import net.minecraft.src.Material;
import net.minecraft.src.World;
/**
* TransmutationHelper
*
* Helper methods for transmutation related things
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class TransmutationHelper {
public static boolean transmuteInWorld(World world, EntityPlayer player, ItemStack stack, int x, int y, int z) {

View file

@ -4,6 +4,15 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* EMCEntry
*
* Holds the breakdown of how much, and what kinds, of EMC an object has
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class EMCEntry {
private float cost, recoveryPercentage;

View file

@ -7,6 +7,15 @@ import net.minecraft.src.Block;
import net.minecraft.src.Item;
import net.minecraft.src.ItemStack;
/**
* EMCRegistry
*
* Registry containing all EMC entries for objects
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class EMCRegistry {
private static final EMCRegistry emcRegistry = new EMCRegistry();

View file

@ -1,5 +1,14 @@
package ee3.common.emc;
/**
* EMCType
*
* Enum containing the different types of EMC available in the mod
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public enum EMCType {
CORPOREAL, KINETIC, TEMPORAL, ESSENTIA, AMORPHOUS, VOID, OMNI
}

View file

@ -1,5 +1,14 @@
package ee3.common.item;
/**
* ITransmutationStone
*
* Transmutation Stone interface, for use amongst all different kinds of transmutation stones
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public interface ITransmutationStone {
public abstract void openPortableCraftingGui();

View file

@ -1,5 +1,14 @@
package ee3.common.item;
/**
* ItemInertStone
*
* An inert stone
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ItemInertStone extends ItemEE {
public ItemInertStone(int id) {

View file

@ -1,5 +1,14 @@
package ee3.common.lib;
/**
* Colours
*
* Library containing the default colour values used in the mod
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class Colours {
public static final String PURE_RED = "ff0000";

View file

@ -2,6 +2,15 @@ package ee3.common.lib;
import ee3.common.item.ModItems;
/**
* ConfigurationSettings
*
* Stores the various configuration settings read in from configuration files
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class ConfigurationSettings {
/*

View file

@ -1,5 +1,14 @@
package ee3.common.lib;
/**
* GuiIds
*
* Library containing the various ids for different Guis in the mod
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class GuiIds {
public static final int PORTABLE_CRAFTING = 1;

View file

@ -1,5 +1,14 @@
package ee3.common.lib;
/**
* PacketIds
*
* Library containing the various ids for different packets in the mod
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class PacketIds {
public static final int KEYBINDING_PRESSED = 0;

View file

@ -1,5 +1,14 @@
package ee3.common.lib;
/**
* RenderIds
*
* Library containing the various ids for different renders in the mod
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RenderIds {
public static int calcinatorRenderId;

View file

@ -7,6 +7,15 @@ import java.io.IOException;
import cpw.mods.fml.common.network.Player;
import net.minecraft.src.INetworkManager;
/**
* PacketEE
*
* General packet for EE3 related packets
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class PacketEE {
protected PacketTypeHandler packetType;

View file

@ -15,6 +15,15 @@ import net.minecraft.src.EntityPlayer;
import net.minecraft.src.INetworkManager;
import net.minecraft.src.Packet250CustomPayload;
/**
* PacketKeyPressed
*
* Packet specifically for notifying the server of client key pressed events
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class PacketKeyPressed extends PacketEE {
public String key;

View file

@ -9,6 +9,15 @@ import cpw.mods.fml.common.network.Player;
import net.minecraft.src.INetworkManager;
import net.minecraftforge.common.ForgeDirection;
/**
* PacketTileUpdate
*
* Packet specifically for updating/synching tile entities between client and server
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class PacketTileUpdate extends PacketEE {
public int x, y, z;

View file

@ -8,6 +8,15 @@ import ee3.common.lib.Reference;
import net.minecraft.src.Packet;
import net.minecraft.src.Packet250CustomPayload;
/**
* PacketTypeHandler
*
* Handler that routes packets to the appropriate destinations depending on what kind of packet they are
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public enum PacketTypeHandler {
KEY(PacketKeyPressed.class),
TILE(PacketTileUpdate.class);

View file

@ -1,5 +1,14 @@
package ee3.common.recipe;
/**
* RecipesCalcinator
*
* Calcinator recipes
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RecipesCalcinator {
}

View file

@ -18,6 +18,15 @@ import ee3.common.core.helper.RecipeHelper;
import ee3.common.item.ModItems;
import ee3.common.lib.Reference;
/**
* RecipesTransmutationStone
*
* Transmutation Stone recipes
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class RecipesTransmutationStone {
private static ItemStack philStone = new ItemStack(ModItems.philStone, 1, -1);

View file

@ -6,6 +6,15 @@ import net.minecraft.src.ItemStack;
import net.minecraft.src.NBTTagCompound;
import net.minecraft.src.NBTTagList;
/**
* TileCalcinator
*
* Calcinator tile entity, and all the logic associated with it
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class TileCalcinator extends TileEE implements IInventory {
/**

View file

@ -5,6 +5,15 @@ import net.minecraft.src.EntityPlayer;
import net.minecraft.src.NBTTagCompound;
import net.minecraft.src.TileEntity;
/**
* TileEE
*
* General tile entity for EE3 related tile entities
*
* @author pahimar
* @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html)
*
*/
public class TileEE extends TileEntity {
private byte direction;