org.spongepowered.api.entity

Interface Equipable

All Superinterfaces:

Carrier, Identifiable

All Known Subinterfaces:

ArmorEquipable, ArmorStand, Giant, Human, Humanoid, Husk, Player, Skeleton, Stray, User, WhiteSkeleton, WitherSkeleton, Zombie, ZombiePigman, ZombieVillager

public interface Equipable
extends Identifiable, Carrier

Represents an entity that has an EquipmentInventory.

Method Summary

Modifier and Type	Method and Description
boolean	canEquip(EquipmentType type) Gets whether this entity can equip equipment of the specified type (eg.
boolean	canEquip(EquipmentType type, ItemStack equipment) Gets whether this entity can equip the supplied equipment in its slot of the specified type (eg.
boolean	equip(EquipmentType type, ItemStack equipment) Sets the item currently equipped by the entity in the specified slot, if the entity has such a slot.
Optional<ItemStack>	getEquipped(EquipmentType type) Gets the item currently equipped by this entity in the specified slot.

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.item.inventory.Carrier

getInventory

Method Detail

canEquip

boolean canEquip(EquipmentType type)

Gets whether this entity can equip equipment of the specified type (eg. whether calling equip(org.spongepowered.api.item.inventory.equipment.EquipmentType, org.spongepowered.api.item.inventory.ItemStack) will fail because the entity doesn't have this type of slot.

Parameters:

type - The type of equipment slot to query

Returns:

true if this entity can equip items of the specified type

canEquip

boolean canEquip(EquipmentType type,
                 @Nullable
                 ItemStack equipment)

Gets whether this entity can equip the supplied equipment in its slot of the specified type (eg. whether calling equip(org.spongepowered.api.item.inventory.equipment.EquipmentType, org.spongepowered.api.item.inventory.ItemStack) with the specified slot type and item will succeed)

Parameters:

type - The type of equipment slot to query

equipment - The equipment to check for

Returns:

true if can equip the supplied equipment

getEquipped

Optional<ItemStack> getEquipped(EquipmentType type)

Gets the item currently equipped by this entity in the specified slot.

Parameters:

type - The type of equipment slot to query

Returns:

The item in the equipped slot, if available

equip

boolean equip(EquipmentType type,
              @Nullable
              ItemStack equipment)

Sets the item currently equipped by the entity in the specified slot, if the entity has such a slot.

Supplying null will unequip any currently equipped item.

Parameters:

type - The type of equipment slot to set

equipment - The equipment to set or null to remove any equipped item

Returns:

true if the item was successfully equipped, false if the item could not be equipped because the entity doesn't support the specified equipment type or because the item was incompatible with the specified slot.