Mekanism-tilera-Edition/common/mekanism/common/IElectricChest.java
2013-06-28 18:01:00 -04:00

102 lines
2.9 KiB
Java

package mekanism.common;
import net.minecraft.item.ItemStack;
/**
* Internal interface used for managing Electric Chests.
* @author aidancbrady
*
*/
public interface IElectricChest
{
/**
* Sets the 'authenticated' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param auth - new value
*/
public void setAuthenticated(ItemStack itemStack, boolean auth);
/**
* Retrieves the 'authenticated' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return authenticated value
*/
public boolean getAuthenticated(ItemStack itemStack);
/**
* Sets the 'password' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param pass - new value
*/
public void setPassword(ItemStack itemStack, String pass);
/**
* Retrieves the 'password' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return authenticated value
*/
public String getPassword(ItemStack itemStack);
/**
* Sets the 'locked' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param locked - new value
*/
public void setLocked(ItemStack itemStack, boolean locked);
/**
* Retrieves the 'locked' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return authenticated value
*/
public boolean getLocked(ItemStack itemStack);
/**
* Sets the 'open' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param open - new value
*/
public void setOpen(ItemStack itemStack, boolean open);
/**
* Retrieves the 'open' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return open value
*/
public boolean getOpen(ItemStack itemStack);
/**
* Sets the 'lidAngle' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param lidAngle - new value
*/
public void setLidAngle(ItemStack itemStack, float lidAngle);
/**
* Retrieves the 'lidAngle' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return lidAngle value
*/
public float getLidAngle(ItemStack itemStack);
/**
* Sets the 'prevLidAngle' value of this electric chest to a new value.
* @param itemStack - electric chest ItemStack
* @param prevLidAngle - new value
*/
public void setPrevLidAngle(ItemStack itemStack, float prevLidAngle);
/**
* Retrieves the 'prevLidAngle' value of this electric chest.
* @param itemStack - electric chest ItemStack
* @return prevLidAngle value
*/
public float getPrevLidAngle(ItemStack itemStack);
/**
* Whether or not the given ItemStack is an electric chest.
* @param itemStack - stack to check
* @return if the stack is an electric chest
*/
public boolean isElectricChest(ItemStack itemStack);
}