Package net.neoforged.neoforge.transfer.energy

Class LimitingEnergyHandler

java.lang.Object

net.neoforged.neoforge.transfer.energy.DelegatingEnergyHandler

net.neoforged.neoforge.transfer.energy.LimitingEnergyHandler

All Implemented Interfaces:

EnergyHandler

public class LimitingEnergyHandler
extends DelegatingEnergyHandler

An energy handler that will apply additional per-insert and per-extract limits to another handler.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxExtract
protected int	maxInsert

Fields inherited from class net.neoforged.neoforge.transfer.energy.DelegatingEnergyHandler

delegate

Constructor Summary

Constructors

Constructor	Description
LimitingEnergyHandler(Supplier<EnergyHandler> delegate, int maxInsert, int maxExtract)	Creates a new limiting energy handler.
LimitingEnergyHandler(EnergyHandler delegate, int maxInsert, int maxExtract)	Creates a new limiting energy handler.

Method Summary

Modifier and Type	Method	Description
int	extract(int amount, TransactionContext transaction)	Extracts up to the given amount of energy from the handler.
int	insert(int amount, TransactionContext transaction)	Inserts up to the given amount of energy into the handler.

Methods inherited from class net.neoforged.neoforge.transfer.energy.DelegatingEnergyHandler

getAmountAsLong, getCapacityAsLong, getDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.neoforge.transfer.energy.EnergyHandler

getAmountAsInt, getCapacityAsInt

Field Details

maxInsert

protected int maxInsert

maxExtract

protected int maxExtract

Constructor Details

LimitingEnergyHandler

public LimitingEnergyHandler(EnergyHandler delegate,
 int maxInsert,
 int maxExtract)

Creates a new limiting energy handler.

See Also:

• LimitingEnergyHandler(java.util.function.Supplier<net.neoforged.neoforge.transfer.energy.EnergyHandler>,int,int)

LimitingEnergyHandler

public LimitingEnergyHandler(Supplier<EnergyHandler> delegate,
 int maxInsert,
 int maxExtract)

Creates a new limiting energy handler.

Parameters:

delegate - energy handler to wrap

maxInsert - maximum amount of energy that can be inserted in one operation. Can be 0 to disallow insertion entirely.

maxExtract - maximum amount of energy that can be extracted in one operation. Can be 0 to disallow extraction entirely.

Method Details

insert

public int insert(int amount,
 TransactionContext transaction)

Description copied from interface: EnergyHandler

Inserts up to the given amount of energy into the handler.

Changes to the handler are made in the context of a transaction.

Specified by:

insert in interface EnergyHandler

Overrides:

insert in class DelegatingEnergyHandler

Parameters:

amount - The maximum amount of energy to insert. Must be non-negative.

transaction - The transaction that this operation is part of.

Returns:

The amount that was inserted. Between 0 (inclusive, nothing was inserted) and amount (inclusive, everything was inserted).

extract

public int extract(int amount,
 TransactionContext transaction)

Description copied from interface: EnergyHandler

Extracts up to the given amount of energy from the handler.

Changes to the handler are made in the context of a transaction.

Specified by:

extract in interface EnergyHandler

Overrides:

extract in class DelegatingEnergyHandler

Parameters:

amount - The maximum amount of energy to extract. Must be non-negative.

transaction - The transaction that this operation is part of.

Returns:

The amount that was extracted. Between 0 (inclusive, nothing was extracted) and amount (inclusive, everything was extracted).