Package net.neoforged.neoforge.energy

Class EnergyStorage

java.lang.Object
net.neoforged.neoforge.energy.EnergyStorage
All Implemented Interfaces:
ValueIOSerializable, IEnergyStorage
@Deprecated(since="1.21.9", forRemoval=true) public class EnergyStorage extends Object implements IEnergyStorage, ValueIOSerializable
Deprecated, for removal: This API element is subject to removal in a future version.
Use SimpleEnergyHandler instead.
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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    capacity
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected int
    energy
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected int
    maxExtract
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected int
    maxReceive
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnergyStorage(int capacity)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    EnergyStorage(int capacity, int maxTransfer)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    EnergyStorage(int capacity, int maxReceive, int maxExtract)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    EnergyStorage(int capacity, int maxReceive, int maxExtract, int energy)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canExtract()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns if this storage can have energy extracted.
    boolean
    canReceive()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Used to determine if this storage can receive energy.
    void
    deserialize(ValueInput input)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    extractEnergy(int toExtract, boolean simulate)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes energy from the storage.
    int
    getEnergyStored()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the amount of energy currently stored.
    int
    getMaxEnergyStored()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the maximum amount of energy that can be stored.
    int
    receiveEnergy(int toReceive, boolean simulate)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds energy to the storage.
    void
    serialize(ValueOutput output)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • energy

      protected int energy
      Deprecated, for removal: This API element is subject to removal in a future version.

    • capacity

      protected int capacity
      Deprecated, for removal: This API element is subject to removal in a future version.

    • maxReceive

      protected int maxReceive
      Deprecated, for removal: This API element is subject to removal in a future version.

    • maxExtract

      protected int maxExtract
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • EnergyStorage

      public EnergyStorage(int capacity)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • EnergyStorage

      public EnergyStorage(int capacity, int maxTransfer)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • EnergyStorage

      public EnergyStorage(int capacity, int maxReceive, int maxExtract)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • EnergyStorage

      public EnergyStorage(int capacity, int maxReceive, int maxExtract, int energy)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • receiveEnergy

      public int receiveEnergy(int toReceive, boolean simulate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Adds energy to the storage. Returns the amount of energy that was accepted.
      Specified by:
      receiveEnergy in interface IEnergyStorage
      Parameters:
      toReceive - The amount of energy being received.
      simulate - If true, the insertion will only be simulated, meaning IEnergyStorage.getEnergyStored() will not change.
      Returns:
      Amount of energy that was (or would have been, if simulated) accepted by the storage.

    • extractEnergy

      public int extractEnergy(int toExtract, boolean simulate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Removes energy from the storage. Returns the amount of energy that was removed.
      Specified by:
      extractEnergy in interface IEnergyStorage
      Parameters:
      toExtract - The amount of energy being extracted.
      simulate - If true, the extraction will only be simulated, meaning IEnergyStorage.getEnergyStored() will not change.
      Returns:
      Amount of energy that was (or would have been, if simulated) extracted from the storage.

    • getEnergyStored

      public int getEnergyStored()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Returns the amount of energy currently stored.
      Specified by:
      getEnergyStored in interface IEnergyStorage

    • getMaxEnergyStored

      public int getMaxEnergyStored()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Returns the maximum amount of energy that can be stored.
      Specified by:
      getMaxEnergyStored in interface IEnergyStorage

    • canExtract

      public boolean canExtract()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Returns if this storage can have energy extracted. If this is false, then any calls to extractEnergy will return 0.
      Specified by:
      canExtract in interface IEnergyStorage

    • canReceive

      public boolean canReceive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IEnergyStorage
      Used to determine if this storage can receive energy. If this is false, then any calls to receiveEnergy will return 0.
      Specified by:
      canReceive in interface IEnergyStorage

    • serialize

      public void serialize(ValueOutput output)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      serialize in interface ValueIOSerializable

    • deserialize

      public void deserialize(ValueInput input)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      deserialize in interface ValueIOSerializable