IEnergyTransfer.java

/*------------------------------------------------------------------------------
 Copyright (c) CovertJaguar, 2011-2016

 This work (the API) is licensed under the "MIT" License,
 see LICENSE.md for details.
 -----------------------------------------------------------------------------*/

package mods.railcraft.api.carts;

/**
 * This interface is implemented by the Energy Cart
 * and is used by the Energy Loaders to charge/discharge carts.
 * It is roughly equivalent to the IItemTransfer interface
 * and based on ElectricItem and IElectricItem.
 *
 * This interface has been superseded by the CapabilityCartCharge
 * interface for general use. It remains in use solely for the
 * IC2 based Energy Loaders.
 *
 * @author CovertJaguar <http://www.railcraft.info>
 */
public interface IEnergyTransfer {

    /**
     * Injects the specified amount of EU into the device.
     *
     * The function returns the remainder of the EU after
     * any EU used is subtracted.
     *
     * @param source              Object initiating the transfer, should be an Entity or Tile Entity
     * @param amount              amount of energy to transfer in EU
     * @param tier                tier of the source device, has to be at least as high as the target device
     * @param ignoreTransferLimit ignore the transfer limit specified by getTransferLimit()
     * @param simulate            don't actually change the item, just determine the return value
     * @return The amount of EU not used
     */
    double injectEnergy(Object source, double amount, int tier, boolean ignoreTransferLimit, boolean simulate, boolean passAlong);

    /**
     * Requests a certain amount of EU from the device.
     *
     * The is function will subtract EU from the device's store of power
     * and return a portion up to, but not exceeding, the amount of EU requested.
     *
     * @param source              Object initiating the transfer, should be an Entity or Tile Entity
     * @param amount              amount of energy to transfer in EU
     * @param tier                tier of the source device, has to be at least as high as the target device
     * @param ignoreTransferLimit ignore the transfer limit specified by getTransferLimit()
     * @param simulate            don't actually change the item, just determine the return value
     * @param passAlong           whether neighboring carts should be asked to provide any missing power.
     * @return The amount of EU transferred
     */
    double extractEnergy(Object source, double amount, int tier, boolean ignoreTransferLimit, boolean simulate, boolean passAlong);

    /**
     * Return true if energy can be injected into this device.
     *
     * @return true if can inject energy
     */
    boolean canInjectEnergy();

    /**
     * Return true if energy can be extracted from this device.
     *
     * @return true if can extract energy
     */
    boolean canExtractEnergy();

    /**
     * The max capacity of the device.
     *
     * @return max capacity
     */
    int getCapacity();

    /**
     * Returns the current energy contained in the device.
     *
     * @return current energy
     */
    double getEnergy();

    int getTier();

    /**
     * The device's transfer rate in EU/t.
     *
     * @return the transfer rate
     */
    int getTransferLimit();

}