Package earth.terrarium.botarium.common.energy.impl

Class InsertOnlyEnergyContainer

java.lang.Object

earth.terrarium.botarium.common.energy.impl.SimpleEnergyContainer

earth.terrarium.botarium.common.energy.impl.InsertOnlyEnergyContainer

All Implemented Interfaces:

EnergyContainer, Serializable, net.minecraft.world.Clearable

public class InsertOnlyEnergyContainer
extends SimpleEnergyContainer

Constructor Summary

Constructors

Constructor	Description
InsertOnlyEnergyContainer(long energyCapacity)
InsertOnlyEnergyContainer(long maxCapacity, long maxInsert)

Method Summary

Modifier and Type	Method	Description
boolean	allowsExtraction()
long	extractEnergy(long maxAmount, boolean simulate)	Extracts a given amount of energy into the container.
long	internalExtract(long maxAmount, boolean simulate)	An internal version of EnergyContainer.extractEnergy(long, boolean) that is used by mod authors looking to directly interact with their own containers.
long	maxExtract()

Methods inherited from class earth.terrarium.botarium.common.energy.impl.SimpleEnergyContainer

allowsInsertion, clearContent, createSnapshot, deserialize, getMaxCapacity, getStoredEnergy, insertEnergy, internalInsert, maxInsert, serialize, setEnergy

Methods inherited from class java.lang.Object

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

Methods inherited from interface earth.terrarium.botarium.common.energy.base.EnergyContainer

readSnapshot

Constructor Details

InsertOnlyEnergyContainer

public InsertOnlyEnergyContainer(long energyCapacity)

InsertOnlyEnergyContainer

public InsertOnlyEnergyContainer(long maxCapacity,
 long maxInsert)

Method Details

maxExtract

public long maxExtract()

Specified by:

maxExtract in interface EnergyContainer

Overrides:

maxExtract in class SimpleEnergyContainer

Returns:

The maximum amount of energy that can be extracted from the container at a time.

allowsExtraction

public boolean allowsExtraction()

Specified by:

allowsExtraction in interface EnergyContainer

Overrides:

allowsExtraction in class SimpleEnergyContainer

Returns:

Whether the container allows for energy to be extracted.

extractEnergy

public long extractEnergy(long maxAmount,
 boolean simulate)

Description copied from interface: EnergyContainer

Extracts a given amount of energy into the container.

Specified by:

extractEnergy in interface EnergyContainer

Overrides:

extractEnergy in class SimpleEnergyContainer

Parameters:

maxAmount - The amount to be extracted from the container.

simulate - If true, the container will not be modified.

Returns:

The amount of energy that was removed from the container.

internalExtract

public long internalExtract(long maxAmount,
 boolean simulate)

Description copied from interface: EnergyContainer

An internal version of EnergyContainer.extractEnergy(long, boolean) that is used by mod authors looking to directly interact with their own containers.

You should not call this method for other mod's containers, instead use EnergyContainer.extractEnergy(long, boolean).

Specified by:

internalExtract in interface EnergyContainer

Overrides:

internalExtract in class SimpleEnergyContainer