net.minecraftforge.energy

クラス EnergyStorage

java.lang.Object

net.minecraftforge.energy.EnergyStorage

すべての実装されたインタフェース:

IEnergyStorage

public class EnergyStorage
extends java.lang.Object
implements IEnergyStorage

Reference implementation of IEnergyStorage. Use/extend this or implement your own. Derived from the Redstone Flux power system designed by King Lemming and originally utilized in Thermal Expansion and related mods. Created with consent and permission of King Lemming and Team CoFH. Released with permission under LGPL 2.1 when bundled with Forge.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	capacity
protected int	energy
protected int	maxExtract
protected int	maxReceive

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
EnergyStorage(int capacity)
EnergyStorage(int capacity, int maxTransfer)
EnergyStorage(int capacity, int maxReceive, int maxExtract)
EnergyStorage(int capacity, int maxReceive, int maxExtract, int energy)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	canExtract() Returns if this storage can have energy extracted.
boolean	canReceive() Used to determine if this storage can receive energy.
int	extractEnergy(int maxExtract, boolean simulate) Removes energy from the storage.
int	getEnergyStored() Returns the amount of energy currently stored.
int	getMaxEnergyStored() Returns the maximum amount of energy that can be stored.
int	receiveEnergy(int maxReceive, boolean simulate) Adds energy to the storage.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

energy

protected int energy

capacity

protected int capacity

maxReceive

protected int maxReceive

maxExtract

protected int maxExtract

コンストラクタの詳細

EnergyStorage

public EnergyStorage(int capacity)

EnergyStorage

public EnergyStorage(int capacity,
                     int maxTransfer)

EnergyStorage

public EnergyStorage(int capacity,
                     int maxReceive,
                     int maxExtract)

EnergyStorage

public EnergyStorage(int capacity,
                     int maxReceive,
                     int maxExtract,
                     int energy)

メソッドの詳細

receiveEnergy

public int receiveEnergy(int maxReceive,
                         boolean simulate)

インタフェースからコピーされた説明: IEnergyStorage

Adds energy to the storage. Returns quantity of energy that was accepted.

定義:

receiveEnergy インタフェース内 IEnergyStorage

パラメータ:

maxReceive - Maximum amount of energy to be inserted.

simulate - If TRUE, the insertion will only be simulated.

戻り値:

Amount of energy that was (or would have been, if simulated) accepted by the storage.

extractEnergy

public int extractEnergy(int maxExtract,
                         boolean simulate)

インタフェースからコピーされた説明: IEnergyStorage

Removes energy from the storage. Returns quantity of energy that was removed.

定義:

extractEnergy インタフェース内 IEnergyStorage

パラメータ:

maxExtract - Maximum amount of energy to be extracted.

simulate - If TRUE, the extraction will only be simulated.

戻り値:

Amount of energy that was (or would have been, if simulated) extracted from the storage.

getEnergyStored

public int getEnergyStored()

インタフェースからコピーされた説明: IEnergyStorage

Returns the amount of energy currently stored.

定義:

getEnergyStored インタフェース内 IEnergyStorage

getMaxEnergyStored

public int getMaxEnergyStored()

インタフェースからコピーされた説明: IEnergyStorage

Returns the maximum amount of energy that can be stored.

定義:

getMaxEnergyStored インタフェース内 IEnergyStorage

canExtract

public boolean canExtract()

インタフェースからコピーされた説明: IEnergyStorage

Returns if this storage can have energy extracted. If this is false, then any calls to extractEnergy will return 0.

定義:

canExtract インタフェース内 IEnergyStorage

canReceive

public boolean canReceive()

インタフェースからコピーされた説明: IEnergyStorage

Used to determine if this storage can receive energy. If this is false, then any calls to receiveEnergy will return 0.

定義:

canReceive インタフェース内 IEnergyStorage