Unicopia/src/main/java/com/minelittlepony/unicopia/spell/IDispenceable.java

package com.minelittlepony.unicopia.spell;

import net.minecraft.dispenser.IBlockSource;
import net.minecraft.util.math.BlockPos;
import net.minecraft.util.EnumFacing;

/**
 * Represents an object with an action to perform when dispensed from a dispenser.
 *
 */
public interface IDispenceable extends IMagicEffect {

	/**
	 * Called when dispensed.
	 *
	 * @param pos		Block position in front of the dispenser
	 * @param facing	Direction of the dispenser
	 * @param source	The dispenser currently dispensing
	 * @param affinity  The affinity of the casting artifact
	 * @return	an ActionResult for the type of action to perform.
	 */
	public SpellCastResult onDispenced(BlockPos pos, EnumFacing facing, IBlockSource source, SpellAffinity affinity);
}