buildcraft.lib.mj

Class MjBatteryReceiver

java.lang.Object

buildcraft.lib.mj.MjBatteryReceiver

All Implemented Interfaces:

IMjConnector, IMjReadable, IMjReceiver

Direct Known Subclasses:

MjRedstoneBatteryReceiver

public class MjBatteryReceiver
extends java.lang.Object
implements IMjReceiver, IMjReadable

Constructor Summary

Constructors

Constructor and Description
MjBatteryReceiver(MjBattery battery)

Method Summary

Modifier and Type	Method and Description
boolean	canConnect(IMjConnector other) Checks to see if this connector can connect to the other connector.
long	getCapacity()
long	getPowerRequested()
long	getStored()
long	receivePower(long microJoules, boolean simulate) Receives power.

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.mj.IMjReceiver

canReceive

Constructor Detail

MjBatteryReceiver

public MjBatteryReceiver(MjBattery battery)

Method Detail

canConnect

public boolean canConnect(@Nonnull
                          IMjConnector other)

Description copied from interface: IMjConnector

Checks to see if this connector can connect to the other connector. By default this should check that the other connector is the same power system.

Specified by:

canConnect in interface IMjConnector

Returns:

getPowerRequested

public long getPowerRequested()

Specified by:

getPowerRequested in interface IMjReceiver

Returns:

The number of microjoules that this receiver currently wants, and can accept.

receivePower

public long receivePower(long microJoules,
                         boolean simulate)

Description copied from interface: IMjReceiver

Receives power. You are encouraged to either:

• Use up all power immediately, or when you next tick.
• Store all power in something like an MjBattery for later usage.
• Refuse all power (if you have no more work to do or your MjBattery is full).

Note that callers are NOT expected to call IMjReceiver.canReceive() before calling this - implementors should check all of the conditions in IMjReceiver.canReceive() before accepting power.

Specified by:

receivePower in interface IMjReceiver

Parameters:

microJoules - The number of micro joules to add.

simulate - If true then just pretend you received power- don't actually change any of your internal state.

Returns:

The excess power.

getStored

public long getStored()

Specified by:

getStored in interface IMjReadable

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface IMjReadable