IMetaDelegate.java

package ic2.api.energy.tile;

import java.util.List;

import net.minecraft.tileentity.TileEntity;

/**
 * Interface for grouping multi-block structures to a single energy net delegate.
 * 
 * The energy net uses TileEntity to refer to a specific xyz+world position. If multiple of those
 * positions should belong to the same functional structure, i.e. they consume or produce energy
 * only once for the whole multi-block instead of once per every single block, this interface
 * allows to do so.
 * 
 * The tile entity implementing IMetaDelegate has to be added/removed to/from the energy net
 * instead of every single sub-TileEntity. The energy net interaction will be handled by the
 * IMetaDelegate TileEntity as well.
 * 
 * The sub tile array TileEntity[] just provides optional connectivity (IEnergyAcceptor,
 * IEnergyEmitter) and mandatory position (x, y, z, World) data.
 * If the connectivity data on the sub tile is missing, the meta delegate is queried instead.
 * 
 * See ic2/api/energy/usage.txt for an overall description of the energy net api.
 */
public interface IMetaDelegate extends IEnergyTile {
	/**
	 * Get the sub-TileEntities belonging to this Meta TileEntity.
	 * 
	 * @note The list has to be consistent between the EnergyNet Load and Unload events.
	 * @note The list must have at least 1 element.
	 * @note The parent te implementing IMetaDelegate isn't automatically included.
	 * 
	 * @return sub-TileEntity array
	 */
	List<TileEntity> getSubTiles();
}