net.citizensnpcs.api.trait.trait

Class Equipment

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.api.trait.trait.Equipment

All Implemented Interfaces:

Runnable, Listener

public class Equipment
extends Trait

Represents an NPC's equipment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Equipment.EquipmentSlot

Field Summary

Fields inherited from class net.citizensnpcs.api.trait.Trait

npc

Constructor Summary

Constructors

Constructor and Description
Equipment()

Method Summary

Modifier and Type	Method and Description
ItemStack	get(Equipment.EquipmentSlot slot)
ItemStack	get(int slot) Get an NPC's equipment from the given slot.
ItemStack[]	getEquipment() Get all of an NPC's equipment.
Map<Equipment.EquipmentSlot,ItemStack>	getEquipmentBySlot() Get all of the equipment as a Map.
void	load(DataKey key) Loads a trait.
void	onSpawn() Called when an NPC is spawned.
void	save(DataKey key) Saves a trait.
void	set(Equipment.EquipmentSlot slot, ItemStack item)
void	set(int slot, ItemStack item) Set the armor from the given slot as the given item.
String	toString()

Methods inherited from class net.citizensnpcs.api.trait.Trait

getName, getNPC, isRunImplemented, linkToNPC, onAttach, onCopy, onDespawn, onRemove, run

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Equipment

public Equipment()

Method Detail

get

public ItemStack get(Equipment.EquipmentSlot slot)

See Also:

get(int)

get

public ItemStack get(int slot)

Get an NPC's equipment from the given slot.

Parameters:

slot - Slot where the armor is located (0-5)

Returns:

ItemStack from the given armor slot

getEquipment

public ItemStack[] getEquipment()

Get all of an NPC's equipment.

Returns:

An array of an NPC's equipment

getEquipmentBySlot

public Map<Equipment.EquipmentSlot,ItemStack> getEquipmentBySlot()

Get all of the equipment as a Map.

Returns:

A mapping of slot to item

load

public void load(DataKey key)
          throws NPCLoadException

Description copied from class: Trait

Loads a trait.

Overrides:

load in class Trait

Parameters:

key - DataKey to load from

Throws:

NPCLoadException - Thrown if this trait failed to load properly

onSpawn

public void onSpawn()

Description copied from class: Trait

Called when an NPC is spawned. NPC.getEntity() will return null until this is called. This is also called onAttach when the NPC is already spawned.

Overrides:

onSpawn in class Trait

save

public void save(DataKey key)

Description copied from class: Trait

Saves a trait.

Overrides:

save in class Trait

Parameters:

key - DataKey to save to

set

public void set(Equipment.EquipmentSlot slot,
                ItemStack item)

See Also:

set(int, ItemStack)

set

public void set(int slot,
                ItemStack item)

Set the armor from the given slot as the given item.

Parameters:

slot - Slot of the armor (must be between 0 and 5)

item - Item to set the armor as

toString

public String toString()

Overrides:

toString in class Object