buildcraft.api.mj

Class MjAPI

java.lang.Object

buildcraft.api.mj.MjAPI

public final class MjAPI
extends java.lang.Object

The class MjAPI provides services to the Minecraft Joules power framework. BuildCraft implements a default power model on top of this, the "kinesis" power model. Third party mods may provide they own version of Minecraft Joules batteries and provide different models.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_POWER_FRAMEWORK

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canReceive(IBatteryObject battery)
static boolean	canSend(IBatteryObject battery)
static IBatteryObject	createBattery(java.lang.Object o, java.lang.String kind, net.minecraftforge.common.util.ForgeDirection side) Create new battery instance.
static IBatteryObject[]	getAllMjBatteries(java.lang.Object o)
static IBatteryObject[]	getAllMjBatteries(java.lang.Object o, net.minecraftforge.common.util.ForgeDirection direction)
static double	getIOLimit(IBatteryObject batteryObject, IOMode mode)
static IBatteryObject	getMjBattery(java.lang.Object o)
static IBatteryObject	getMjBattery(java.lang.Object o, net.minecraftforge.common.util.ForgeDirection side)
static IBatteryObject	getMjBattery(java.lang.Object o, java.lang.String kind)
static IBatteryObject	getMjBattery(java.lang.Object o, java.lang.String kindRaw, net.minecraftforge.common.util.ForgeDirection sideRaw) Returns the battery related to the object given in parameter.
static boolean	isActive(IBatteryObject battery)
static boolean	isCacheable(IBatteryObject battery)
static MjReconfigurator	reconfigure() Obtain battery parameters reconfigurator.
static void	registerMJBatteryKind(java.lang.String kind, java.lang.Class<? extends IBatteryObject> clazz) Register new battery kind implementation.
static void	resetBatteriesCache(IBatteryObject battery) Remove cached instance of passed battery
static void	resetBatteriesCache(net.minecraft.tileentity.TileEntity tile) Reset all caches for passed tile
static double	transferEnergy(IBatteryObject fromBattery, IBatteryObject toBattery) Transfer maximal energy amount from battery "fromBattery" to "toBattery"
static double	transferEnergy(IBatteryObject fromBattery, IBatteryObject toBattery, double mj) Transfer mj energy amount from battery "fromBattery" to "toBattery"
static void	updateEntity(net.minecraft.tileentity.TileEntity tile) Helper method which you should invoke in every game tick for supporting Active IO modes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_POWER_FRAMEWORK

public static final java.lang.String DEFAULT_POWER_FRAMEWORK

See Also:

Constant Field Values

Method Detail

getMjBattery

public static IBatteryObject getMjBattery(java.lang.Object o)

See Also:

getMjBattery(Object, String, ForgeDirection)

getMjBattery

public static IBatteryObject getMjBattery(java.lang.Object o,
                          java.lang.String kind)

See Also:

getMjBattery(Object, String, ForgeDirection)

getMjBattery

public static IBatteryObject getMjBattery(java.lang.Object o,
                          net.minecraftforge.common.util.ForgeDirection side)

See Also:

getMjBattery(Object, String, ForgeDirection)

getMjBattery

public static IBatteryObject getMjBattery(java.lang.Object o,
                          java.lang.String kindRaw,
                          net.minecraftforge.common.util.ForgeDirection sideRaw)

Returns the battery related to the object given in parameter.

createBattery

public static IBatteryObject createBattery(java.lang.Object o,
                           java.lang.String kind,
                           net.minecraftforge.common.util.ForgeDirection side)

Create new battery instance. This method ignore all providers/caches and only create battery for given kind/side.

Parameters:

o - Object which contains MjBattery

kind - Kind of power

side - Side of block

Returns:

New IBatteryObject implementation registered for given kind of power

getAllMjBatteries

public static IBatteryObject[] getAllMjBatteries(java.lang.Object o)

Returns:

All non-sided batteries for passed object

getAllMjBatteries

public static IBatteryObject[] getAllMjBatteries(java.lang.Object o,
                                 net.minecraftforge.common.util.ForgeDirection direction)

Parameters:

direction - Side of block

Returns:

All sided batteries for passed object

registerMJBatteryKind

public static void registerMJBatteryKind(java.lang.String kind,
                         java.lang.Class<? extends IBatteryObject> clazz)

Register new battery kind implementation. Allowing to have a custom power types alongside default "kinesis" kind

Parameters:

kind - Kind name

clazz - Battery implementation class

canReceive

public static boolean canReceive(IBatteryObject battery)

See Also:

IOMode.canReceive

canSend

public static boolean canSend(IBatteryObject battery)

See Also:

IOMode.canSend

isActive

public static boolean isActive(IBatteryObject battery)

See Also:

IOMode.active

isCacheable

public static boolean isCacheable(IBatteryObject battery)

See Also:

MjBattery.cacheable()

getIOLimit

public static double getIOLimit(IBatteryObject batteryObject,
                IOMode mode)

Returns:

Actual IO limit for passed mode (only send/receive supported)

See Also:

MjBattery.maxReceivedPerCycle(), MjBattery.maxSendedPerCycle()

reconfigure

public static MjReconfigurator reconfigure()

Obtain battery parameters reconfigurator. Usage:
MjAPI.reconfigure().maxCapacity(battery, 15000);

Returns:

Reconfigurator instance

transferEnergy

public static double transferEnergy(IBatteryObject fromBattery,
                    IBatteryObject toBattery,
                    double mj)

Transfer mj energy amount from battery "fromBattery" to "toBattery"

Parameters:

fromBattery - Source battery

toBattery - Target battery

mj - Amount of energy

Returns:

Transferred amount

transferEnergy

public static double transferEnergy(IBatteryObject fromBattery,
                    IBatteryObject toBattery)

Transfer maximal energy amount from battery "fromBattery" to "toBattery"

Parameters:

fromBattery - Source battery

toBattery - Target battery

Returns:

Transferred amount

updateEntity

public static void updateEntity(net.minecraft.tileentity.TileEntity tile)

Helper method which you should invoke in every game tick for supporting Active IO modes

Parameters:

tile - Tile which contains active battery

resetBatteriesCache

public static void resetBatteriesCache(net.minecraft.tileentity.TileEntity tile)

Reset all caches for passed tile

resetBatteriesCache

public static void resetBatteriesCache(IBatteryObject battery)

Remove cached instance of passed battery