NTM Energy API: Implementing HE Power in Your Mod

package api.hbm.energymk2;

import net.minecraftforge.common.util.ForgeDirection;

public interface IEnergyConnectorMK2 {
    /**
     * Whether the given side can be connected to.
     * dir refers to the side of THIS block, not the connecting block.
     */
    public default boolean canConnect(ForgeDirection dir) {
        return dir != ForgeDirection.UNKNOWN;
    }
}

package api.hbm.energymk2;

import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.Vec3;

public interface IEnergyHandlerMK2 extends IEnergyConnectorMK2, ILoadedTile {

    public long getPower();
    public void setPower(long power);
    public long getMaxPower();

    /** Returns the world-space position used for debug energy particles. */
    public default Vec3 getDebugParticlePosMK2() {
        TileEntity te = (TileEntity) this;
        Vec3 vec = Vec3.createVectorHelper(te.xCoord + 0.5, te.yCoord + 1, te.zCoord + 0.5);
        return vec;
    }

    /** Populates an NBTTagCompound for EnergyControl mod display. */
    public default void provideInfoForECMK2(NBTTagCompound data) {
        data.setLong(CompatEnergyControl.L_ENERGY_HE, this.getPower());
        data.setLong(CompatEnergyControl.L_CAPACITY_HE, this.getMaxPower());
    }
}

package api.hbm.energymk2;

import net.minecraft.world.World;
import net.minecraftforge.common.util.ForgeDirection;

public interface IEnergyProviderMK2 extends IEnergyHandlerMK2 {

    /** Removes power from internal storage. Default has no sanity check. */
    public default void usePower(long power) {
        this.setPower(this.getPower() - power);
    }

    /**
     * Maximum HE that can be pushed per tick.
     * Defaults to getMaxPower() — override for throttled generators.
     */
    public default long getProviderSpeed() {
        return this.getMaxPower();
    }

    /**
     * Call once per adjacent face every update tick.
     * Registers this tile as a provider on any connected PowerNetMK2,
     * or directly transfers to an adjacent IEnergyReceiverMK2.
     */
    public default void tryProvide(World world, int x, int y, int z, ForgeDirection dir) { ... }
}

package api.hbm.energymk2;

import net.minecraft.world.World;
import net.minecraftforge.common.util.ForgeDirection;

public interface IEnergyReceiverMK2 extends IEnergyHandlerMK2 {

    /** Called by the network to deposit power. Returns the overshoot (unaccepted amount). */
    public default long transferPower(long power) { ... }

    /**
     * Maximum HE accepted per tick from the network.
     * Defaults to getMaxPower().
     */
    public default long getReceiverSpeed() {
        return this.getMaxPower();
    }

    /** If true, adjacent providers may bypass the cable network and push power directly. */
    public default boolean allowDirectProvision() { return true; }

    /** Subscribe to a PowerNetMK2 via the cable at (x,y,z) on face dir. Call every tick. */
    public default void trySubscribe(World world, int x, int y, int z, ForgeDirection dir) { ... }

    /** Unsubscribe from the net at (x,y,z). Call on tile invalidation/chunk unload. */
    public default void tryUnsubscribe(World world, int x, int y, int z) { ... }

    /** Priority relative to other receivers on the same network. */
    public default ConnectionPriority getPriority() {
        return ConnectionPriority.NORMAL;
    }

    public enum ConnectionPriority {
        LOWEST, LOW, NORMAL, HIGH, HIGHEST
    }
}

package api.hbm.energymk2;

import api.hbm.energymk2.Nodespace.PowerNode;

public interface IEnergyConductorMK2 extends IEnergyConnectorMK2 {

    /**
     * Creates a PowerNode centred on this tile with connections to all six
     * cardinal neighbours. Override to limit connectivity (e.g. axis-locked cables).
     */
    public default PowerNode createNode() { ... }
}

package api.hbm.energymk2;

public class PowerNetMK2 extends NodeNet<IEnergyReceiverMK2, IEnergyProviderMK2, PowerNode> {

    /** Total HE transferred through this net since last reset. */
    public long energyTracker = 0L;

    /**
     * Per-tick distribution: sums provider supply, sums receiver demand
     * (split by ConnectionPriority), then distributes proportionally.
     * Stale entries older than 3000 ms are pruned automatically.
     */
    @Override
    public void update() { ... }

    /**
     * Diode variant: pushes a fixed amount of power into the net's receivers
     * without drawing from registered providers. Returns the remainder.
     */
    public long sendPowerDiode(long power) { ... }
}

package api.hbm.energymk2;

public class Nodespace {

    /** Retrieve the PowerNode at a world position, or null if none exists. */
    @Deprecated
    public static PowerNode getNode(World world, int x, int y, int z) { ... }

    /** Register a PowerNode into the global node space. */
    @Deprecated
    public static void createNode(World world, PowerNode node) { ... }

    /** Remove the PowerNode at a position (call when a cable is broken). */
    @Deprecated
    public static void destroyNode(World world, int x, int y, int z) { ... }
}