Anvilcraft/buildcraft
3
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Expand PowerHandler Javadocs some more

Browse source
This commit is contained in:
CovertJaguar 2013-10-05 07:46:47 -07:00
parent 782002b458
commit 7bbb853aae
1 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
common/buildcraft/api/power/PowerHandler.java
View file

@ -11,6 +11,24 @@ import buildcraft.api.core.SafeTimeTracker;
import net.minecraft.nbt.NBTTagCompound; import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.common.ForgeDirection; import net.minecraftforge.common.ForgeDirection;
/**
* The PowerHandler is similar to FluidTank in that it holds your power and
* allows standardized interaction between machines.
*
* To receive power to your machine you needs create an instance of PowerHandler
* and implement IPowerReceptor on the TileEntity.
*
* If you plan emit power, you need only implement IPowerEmitter. You do not
* need a PowerHandler. Engines have a PowerHandler because they can also
* receive power from other Engines.
*
* See TileRefinery for a simple example of a power using machine.
*
* @see IPowerReceptor
* @see IPowerEmitter
*
* @author CovertJaguar <http://www.railcraft.info/>
*/
public final class PowerHandler { public final class PowerHandler {
public static enum Type { public static enum Type {
@ -85,9 +103,9 @@ public final class PowerHandler {
/** /**
* Taxes a flat rate on all incoming power. * Taxes a flat rate on all incoming power.
* *
* Defaults to 0% tax rate. * Defaults to 0% tax rate.
* *
* @return percent of input to tax * @return percent of input to tax
*/ */
public float getTaxPercent() { public float getTaxPercent() {
@ -168,6 +186,16 @@ public final class PowerHandler {
this.activationEnergy = activationEnergy; this.activationEnergy = activationEnergy;
} }
/**
* Allows you define perdition in terms of loss/ticks.
*
* This function is mostly for legacy implementations. See
* PerditionCalculator for more complex perdition formulas.
*
* @param powerLoss
* @param powerLossRegularity
* @see PerditionCalculator
*/
public void configurePowerPerdition(int powerLoss, int powerLossRegularity) { public void configurePowerPerdition(int powerLoss, int powerLossRegularity) {
if (powerLoss == 0 || powerLossRegularity == 0) { if (powerLoss == 0 || powerLossRegularity == 0) {
perdition = new PerditionCalculator(0); perdition = new PerditionCalculator(0);
@ -343,6 +371,8 @@ public final class PowerHandler {
/** /**
* Add power to the PowerReceiver from an external source. * Add power to the PowerReceiver from an external source.
* *
* IPowerEmitters are responsible for calling this themselves.
*
* @param quantity * @param quantity
* @param from * @param from
* @return the amount of power used * @return the amount of power used
@ -358,7 +388,7 @@ public final class PowerHandler {
} }
updateSources(from); updateSources(from);
used -= used * getPerdition().getTaxPercent(); used -= used * getPerdition().getTaxPercent();
used = addEnergy(used); used = addEnergy(used);