li.cil.oc.api.driver.item

Interface Chargeable

public interface Chargeable

This interface can be implemented on items that go into a charger.

This provides a generic way of charging items, even such that are not components. Doing it this way enables items to provide another environment, that is unrelated to charging, such as tablets providing their file system, while in the charger.

Method Summary

Modifier and Type	Method and Description
boolean	canCharge(net.minecraft.item.ItemStack stack) Whether the specified item stack can be charged.
double	charge(net.minecraft.item.ItemStack stack, double amount, boolean simulate) Called when checking if an item can be charged or should be charged.

Method Detail

canCharge

boolean canCharge(net.minecraft.item.ItemStack stack)

Whether the specified item stack can be charged.

This is primarily meant to filter meta item subitems that are not meant to be chargeable.

Parameters:

stack - the stack to check for.

Returns:

whether the specified item stack is chargeable.

charge

double charge(net.minecraft.item.ItemStack stack,
              double amount,
              boolean simulate)

Called when checking if an item can be charged or should be charged.

To discharge an item, pass a negative value.

Parameters:

stack - the item to charge.

amount - the amount to inject into the item.

simulate - whether to only simulate injection.

Returns:

the remainder of the energy that could not be injected/extracted.