buildcraft.api.mj

Interface IMjReceiver

All Superinterfaces:

IMjConnector

All Known Subinterfaces:

IMjRedstoneReceiver

All Known Implementing Classes:

MjBatteryReceiver, MjRedstoneBatteryReceiver, PipeBehaviourEmzuli, PipeBehaviourObsidian, PipeBehaviourStripes, PipeBehaviourWood, PipeBehaviourWoodDiamond, PipeFlowPower.Section, TileAutoWorkbenchBase, TileAutoWorkbenchFluids, TileAutoWorkbenchItems, TilePowerConsumerTester

public interface IMjReceiver
extends IMjConnector

Designates a machine that can receive power.

Method Summary

Modifier and Type	Method and Description
default boolean	canReceive() Checks to see if receivePower(long, boolean) *might* accept any power right now, ignoring the amount of power contained right now (if any).
long	getPowerRequested()
long	receivePower(long microJoules, boolean simulate) Receives power.

Methods inherited from interface buildcraft.api.mj.IMjConnector

canConnect

Method Detail

getPowerRequested

long getPowerRequested()

Returns:

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

receivePower

long receivePower(long microJoules,
                  boolean simulate)

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 canReceive() before calling this - implementors should check all of the conditions in canReceive() before accepting power.

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.

canReceive

default boolean canReceive()

Checks to see if receivePower(long, boolean) *might* accept any power right now, ignoring the amount of power contained right now (if any).

Returns:

True if this IMjReceiver can receive power right now.