summaryrefslogtreecommitdiff
path: root/TF2 Crates/src/main/java/baubles/api/IBauble.java
blob: bbf1d1936cdcba5beb8400f2208d5611e3bd4c29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package baubles.api;

import net.minecraft.entity.EntityLivingBase;
import net.minecraft.item.ItemStack;

/**
 * 
 * This interface should be extended by items that can be worn in bauble
 * slots
 * 
 * @author Azanor
 */

public interface IBauble {

	/**
	 * This method return the type of bauble this is. Type is used to
	 * determine the slots it can go into.
	 */
	public BaubleType getBaubleType(ItemStack itemstack);

	/**
	 * This method is called once per tick if the bauble is being worn by a
	 * player
	 */
	public void onWornTick(ItemStack itemstack, EntityLivingBase player);

	/**
	 * This method is called when the bauble is equipped by a player
	 */
	public void onEquipped(ItemStack itemstack, EntityLivingBase player);

	/**
	 * This method is called when the bauble is unequipped by a player
	 */
	public void onUnequipped(ItemStack itemstack, EntityLivingBase player);

	/**
	 * can this bauble be placed in a bauble slot
	 */
	public boolean canEquip(ItemStack itemstack, EntityLivingBase player);

	/**
	 * Can this bauble be removed from a bauble slot
	 */
	public boolean canUnequip(ItemStack itemstack,
			EntityLivingBase player);
}