Class EnergyHandlerAdapter

java.lang.Object
net.neoforged.neoforge.energy.EnergyHandlerAdapter
All Implemented Interfaces:
IEnergyStorage
@Deprecated(since="1.21.9", forRemoval=true) class EnergyHandlerAdapter extends Object implements IEnergyStorage
Deprecated, for removal: This API element is subject to removal in a future version.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final EnergyHandler
    handler
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnergyHandlerAdapter(EnergyHandler handler)
    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.
    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.

    Methods inherited from class Object

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

  • Field Details

    • handler

      private final EnergyHandler handler
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • EnergyHandlerAdapter

      EnergyHandlerAdapter(EnergyHandler handler)
      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