aboutsummaryrefslogtreecommitdiff
path: root/src/Java/gtPlusPlus/xmod/gregtech/api/energy
diff options
context:
space:
mode:
authordraknyte1 <draknyte1@hotmail.com>2016-11-04 15:23:26 +1000
committerdraknyte1 <draknyte1@hotmail.com>2016-11-04 15:23:26 +1000
commit0669f5eb9d5029a8b94ec552171b0837605f7747 (patch)
tree6b40e64c04d51b7a33cf2f0b35f7232cf37c4247 /src/Java/gtPlusPlus/xmod/gregtech/api/energy
parent3654052fb63a571c5eaca7f20714b87c17f7e966 (diff)
downloadGT5-Unofficial-0669f5eb9d5029a8b94ec552171b0837605f7747.tar.gz
GT5-Unofficial-0669f5eb9d5029a8b94ec552171b0837605f7747.tar.bz2
GT5-Unofficial-0669f5eb9d5029a8b94ec552171b0837605f7747.zip
$ Cleaned up the entire project.
> Much neat, very nices.
Diffstat (limited to 'src/Java/gtPlusPlus/xmod/gregtech/api/energy')
-rw-r--r--src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItem.java7
-rw-r--r--src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItemManager.java142
2 files changed, 91 insertions, 58 deletions
diff --git a/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItem.java b/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItem.java
index 4ec4589c03..561899ea99 100644
--- a/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItem.java
+++ b/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItem.java
@@ -10,7 +10,8 @@ import net.minecraft.item.ItemStack;
*/
public interface IC2ElectricItem {
/**
- * Determine if the item can be used in a machine or as an armor part to supply energy.
+ * Determine if the item can be used in a machine or as an armor part to
+ * supply energy.
*
* @return Whether the item can supply energy
*/
@@ -39,7 +40,8 @@ public interface IC2ElectricItem {
/**
* Get the item's tier, lower tiers can't send energy to higher ones.
- * Batteries are Tier 1, Energy Crystals are Tier 2, Lapotron Crystals are Tier 3.
+ * Batteries are Tier 1, Energy Crystals are Tier 2, Lapotron Crystals are
+ * Tier 3.
*
* @return Item's tier
*/
@@ -52,4 +54,3 @@ public interface IC2ElectricItem {
*/
double getTransferLimit(ItemStack itemStack);
}
-
diff --git a/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItemManager.java b/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItemManager.java
index 311947e5e6..9ffc803494 100644
--- a/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItemManager.java
+++ b/src/Java/gtPlusPlus/xmod/gregtech/api/energy/IC2ElectricItemManager.java
@@ -4,92 +4,124 @@ import net.minecraft.entity.EntityLivingBase;
import net.minecraft.item.ItemStack;
/**
- * This interface specifies a manager to handle the various tasks for electric items.
+ * This interface specifies a manager to handle the various tasks for electric
+ * items.
*
- * The default implementation does the following:
- * - store and retrieve the charge
- * - handle charging, taking amount, tier, transfer limit, canProvideEnergy and simulate into account
- * - replace item IDs if appropriate (getChargedItemId() and getEmptyItemId())
- * - update and manage the damage value for the visual charge indicator
- *
- * @note If you're implementing your own variant (ISpecialElectricItem), you can delegate to the
- * default implementations through ElectricItem.rawManager. The default implementation is designed
- * to minimize its dependency on its own constraints/structure and delegates most work back to the
- * more atomic features in the gateway manager.
+ * The default implementation does the following: - store and retrieve the
+ * charge - handle charging, taking amount, tier, transfer limit,
+ * canProvideEnergy and simulate into account - replace item IDs if appropriate
+ * (getChargedItemId() and getEmptyItemId()) - update and manage the damage
+ * value for the visual charge indicator
+ *
+ * @note If you're implementing your own variant (ISpecialElectricItem), you can
+ * delegate to the default implementations through
+ * ElectricItem.rawManager. The default implementation is designed to
+ * minimize its dependency on its own constraints/structure and delegates
+ * most work back to the more atomic features in the gateway manager.
*/
public interface IC2ElectricItemManager {
/**
+ * Determine if the specified electric item has at least a specific amount
+ * of EU. This is supposed to be used in the item code during operation, for
+ * example if you want to implement your own electric item. BatPacks are not
+ * taken into account.
+ *
+ * @param itemStack
+ * electric item's stack
+ * @param amount
+ * minimum amount of energy required
+ * @return true if there's enough energy
+ */
+ boolean canUse(ItemStack stack, double amount);
+
+ /**
* Charge an item with a specified amount of energy.
*
- * @param itemStack electric item's stack
- * @param amount amount of energy to charge in EU
- * @param tier tier of the charging device, has to be at least as high as the item to charge
- * @param ignoreTransferLimit ignore the transfer limit specified by getTransferLimit()
- * @param simulate don't actually change the item, just determine the return value
+ * @param itemStack
+ * electric item's stack
+ * @param amount
+ * amount of energy to charge in EU
+ * @param tier
+ * tier of the charging device, has to be at least as high as the
+ * item to charge
+ * @param ignoreTransferLimit
+ * ignore the transfer limit specified by getTransferLimit()
+ * @param simulate
+ * don't actually change the item, just determine the return
+ * value
* @return Energy transferred into the electric item
*/
double charge(ItemStack stack, double amount, int tier, boolean ignoreTransferLimit, boolean simulate);
/**
+ * Charge an item from the BatPack a player is wearing. This is supposed to
+ * be used in the item code during operation, for example if you want to
+ * implement your own electric item. use() already contains this
+ * functionality.
+ *
+ * @param itemStack
+ * electric item's stack
+ * @param entity
+ * entity holding the item
+ */
+ void chargeFromArmor(ItemStack stack, EntityLivingBase entity);
+
+ /**
* Discharge an item by a specified amount of energy
*
- * @param itemStack electric item's stack
- * @param amount amount of energy to discharge in EU
- * @param tier tier of the discharging device, has to be at least as high as the item to discharge
- * @param ignoreTransferLimit ignore the transfer limit specified by getTransferLimit()
- * @param externally use the supplied item externally, i.e. to power something else as if it was a battery
- * @param simulate don't actually discharge the item, just determine the return value
+ * @param itemStack
+ * electric item's stack
+ * @param amount
+ * amount of energy to discharge in EU
+ * @param tier
+ * tier of the discharging device, has to be at least as high as
+ * the item to discharge
+ * @param ignoreTransferLimit
+ * ignore the transfer limit specified by getTransferLimit()
+ * @param externally
+ * use the supplied item externally, i.e. to power something else
+ * as if it was a battery
+ * @param simulate
+ * don't actually discharge the item, just determine the return
+ * value
* @return Energy retrieved from the electric item
*/
- double discharge(ItemStack stack, double amount, int tier, boolean ignoreTransferLimit, boolean externally, boolean simulate);
+ double discharge(ItemStack stack, double amount, int tier, boolean ignoreTransferLimit, boolean externally,
+ boolean simulate);
/**
* Determine the charge level for the specified item.
- *
- * @param itemStack ItemStack containing the electric item
+ *
+ * @param itemStack
+ * ItemStack containing the electric item
* @return charge level in EU
*/
double getCharge(ItemStack stack);
/**
- * Determine if the specified electric item has at least a specific amount of EU.
- * This is supposed to be used in the item code during operation, for example if you want to implement your own electric item.
- * BatPacks are not taken into account.
+ * Get the tool tip to display for electric items.
*
- * @param itemStack electric item's stack
- * @param amount minimum amount of energy required
- * @return true if there's enough energy
+ * @param itemStack
+ * ItemStack to determine the tooltip for
+ * @return tool tip string or null for none
*/
- boolean canUse(ItemStack stack, double amount);
+ String getToolTip(ItemStack stack);
/**
- * Try to retrieve a specific amount of energy from an Item, and if applicable, a BatPack.
- * This is supposed to be used in the item code during operation, for example if you want to implement your own electric item.
+ * Try to retrieve a specific amount of energy from an Item, and if
+ * applicable, a BatPack. This is supposed to be used in the item code
+ * during operation, for example if you want to implement your own electric
+ * item.
*
- * @param itemStack electric item's stack
- * @param amount amount of energy to discharge in EU
- * @param entity entity holding the item
+ * @param itemStack
+ * electric item's stack
+ * @param amount
+ * amount of energy to discharge in EU
+ * @param entity
+ * entity holding the item
* @return true if the operation succeeded
*/
boolean use(ItemStack stack, double amount, EntityLivingBase entity);
- /**
- * Charge an item from the BatPack a player is wearing.
- * This is supposed to be used in the item code during operation, for example if you want to implement your own electric item.
- * use() already contains this functionality.
- *
- * @param itemStack electric item's stack
- * @param entity entity holding the item
- */
- void chargeFromArmor(ItemStack stack, EntityLivingBase entity);
-
- /**
- * Get the tool tip to display for electric items.
- *
- * @param itemStack ItemStack to determine the tooltip for
- * @return tool tip string or null for none
- */
- String getToolTip(ItemStack stack);
-
// TODO: add tier getter
}