package mods.immibis.core.api.multipart;

import java.util.List;

import net.minecraft.client.particle.EffectRenderer;
import net.minecraft.client.renderer.RenderBlocks;
import net.minecraft.entity.Entity;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import net.minecraft.util.AxisAlignedBB;
import net.minecraft.util.MovingObjectPosition;
import net.minecraft.util.Vec3;
import net.minecraftforge.common.util.ForgeDirection;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;

/**
 * Contains common methods from ICoverSystem and IMultipartTile.
 */
public interface IPartContainer {
	
	/**
	 * Gets the speed at which a player breaks a part.
	 * See Block.getPlayerRelativeBlockHardness. 
	 * @param ply The player.
	 * @param The part.
	 * @return The speed.
	 */
	float getPlayerRelativePartHardness(EntityPlayer ply, int part);
	
	/**
	 * Called when the player middle-clicks on a part.
	 * @param rayTrace The location under the player's crosshair.
	 * @param part The part number they middle-clicked on.
	 * @return The itemstack to pick.
	 */
	public ItemStack pickPart(MovingObjectPosition rayTrace, int part);
	
	/**
	 * Checks if a given face of this block is solid.
	 * Used to determine the result of Block.isBlockSolidOnSide.
	 */
	public boolean isPartContainerSideSolid(ForgeDirection side);
	
	/**
	 * Called when a player finishes breaking a part.
	 * @param ply The player breaking the part.
	 * @param subhit The part being broken.
	 * @param harvest Whether items/XP/etc should be dropped.
	 */
	public void removePartByPlayer(EntityPlayer ply, int part, boolean harvest);
	
	/**
	 * Returns the AABB of a part, in tile-local coordinates.
	 * Currently used for drawing the selection box.
	 * May return null, in which case no selection box is drawn.
	 * 
	 * @param part The part ID to check.
	 * @return The AABB of the part, or null.
	 */
	public AxisAlignedBB getPartAABBFromPool(int part);
	
	/**
	 * Renders all the parts.
	 * @param render The render context.
	 * @return True if anything was rendered.
	 */
	@SideOnly(Side.CLIENT)
	public boolean renderPartContainer(RenderBlocks render);
	
	/**
	 * Renders one part.
	 * @param render The render context.
	 * @param part The part number.
	 * @return True if anything was rendered.
	 */
	@SideOnly(Side.CLIENT)
	public boolean renderPart(RenderBlocks render, int part);
	
	/**
	 * Creates particles when a part is destroyed.
	 * If the part number is invalid, returns false.
	 * Otherwise, creates particles if applicable, and returns true.
	 */
	@SideOnly(Side.CLIENT)
	public boolean addPartDestroyEffects(int part, EffectRenderer er);

	/**
	 * Returns true if the given player can currently harvest the given part (using their selected item)
	 * @param player The player to check.
	 * @param part The index of the part the player is trying to harvest.
	 * @return True iff the player can harvest the part.
	 */
	public boolean canPlayerHarvestPart(EntityPlayer entityPlayer, int part);

	/**
	 * Adds the complete drops from this cover system to the given list.
	 * Note that is not normally used when breaking microblocks.
	 * @param drops The list to add the drops to.
	 * @param fortune The fortune level involved.
	 */
	public void getPartContainerDrops(List<ItemStack> drops, int fortune);

	/**
	 * Creates particles when a part is punched.
	 * Returns false if anything goes wrong, which indicates to use the default particle effect.
	 * Otherwise, creates particles (if applicable), and returns true.
	 */
	@SideOnly(Side.CLIENT)
	public boolean addPartHitEffects(int part, int sideHit, EffectRenderer er);
	
	/**
	 * Finds the closest intercept of the given ray with parts in this container.
	 * @param src The start of the ray, in world coordinates.
	 * @param dst The end of the ray, in world coordinates.
	 * @return A ray-trace result, or null if the ray does not intersect any parts.
	 */
	public MovingObjectPosition collisionRayTrace(Vec3 src, Vec3 dst);
	
	/**
	 * Returns all collision boxes that intersect the given mask, in world coordinates.
	 * @param mask The mask AABB, in world coordinates.
	 * @param list The list to add the returned boxes to.
	 * 
	 * Used to implement Block.addCollisionBoxesToList.
	 */
	public void getCollidingBoundingBoxes(AxisAlignedBB mask, List<AxisAlignedBB> list, Entity entity);
}