org.spongepowered.api.entity

Interface ArmorEquipable

All Superinterfaces:

Carrier, Equipable, Identifiable

All Known Subinterfaces:

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

public interface ArmorEquipable
extends Equipable

Represents an entity that can be equipped with armor and a held item. Each method here is a shorthand for the appropriate Equipable.getEquipped(org.spongepowered.api.item.inventory.equipment.EquipmentType) or Equipable.equip(org.spongepowered.api.item.inventory.equipment.EquipmentType, org.spongepowered.api.item.inventory.ItemStack) method call.

Classes implementing this interface should provide all of the supplied equipment slot types. Classes which do not support all slot types in this interface should instead implement Equipable.

Method Summary

Modifier and Type	Method and Description
default Optional<ItemStack>	getBoots() Gets the boots currently being worn by this entity.
default Optional<ItemStack>	getChestplate() Gets the chestplate currently being worn by this entity.
default Optional<ItemStack>	getHelmet() Gets the helmet currently being worn by this entity.
Optional<ItemStack>	getItemInHand(HandType handType) Gets the current equipped item in hand if available.
default Optional<ItemStack>	getLeggings() Gets the leggings currently being worn by this entity.
default void	setBoots(ItemStack boots) Sets the boots currently being worn by this entity.
default void	setChestplate(ItemStack chestplate) Sets the chestplate currently being worn by this entity.
default void	setHelmet(ItemStack helmet) Sets the helmet currently being worn by this entity.
void	setItemInHand(HandType hand, ItemStack itemInHand) Sets the item in hand for this entity.
default void	setLeggings(ItemStack leggings) Sets the leggings currently being worn by this entity.

Methods inherited from interface org.spongepowered.api.entity.Equipable

canEquip, canEquip, equip, getEquipped

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

getUniqueId

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

getInventory

Method Detail

getHelmet

default Optional<ItemStack> getHelmet()

Gets the helmet currently being worn by this entity.

Having the helmet as null will result in having nothing equipped in the helmet slot.

Returns:

The helmet, if available

setHelmet

default void setHelmet(@Nullable
                       ItemStack helmet)

Sets the helmet currently being worn by this entity.

Having the helmet as null will result in having nothing equipped in the helmet slot.

Parameters:

helmet - The helmet to put on the entity

getChestplate

default Optional<ItemStack> getChestplate()

Gets the chestplate currently being worn by this entity.

Having the chestplate as null will result in having nothing equipped in the chestplate slot.

Returns:

The chestplate, if available

setChestplate

default void setChestplate(@Nullable
                           ItemStack chestplate)

Sets the chestplate currently being worn by this entity.

Having the chestplate as null will result in having nothing equipped in the chestplate slot.

Parameters:

chestplate - The chestplate to put on the entity

getLeggings

default Optional<ItemStack> getLeggings()

Gets the leggings currently being worn by this entity.

Having the leggings as null will result in having nothing equipped in the leggings slot.

Returns:

The leggings, if available

setLeggings

default void setLeggings(@Nullable
                         ItemStack leggings)

Sets the leggings currently being worn by this entity.

Having the leggings as null will result in having nothing equipped in the leggings slot.

Parameters:

leggings - The leggings to put on the entity

getBoots

default Optional<ItemStack> getBoots()

Gets the boots currently being worn by this entity.

Having the boots as null will result in having nothing equipped in the boots slot.

Returns:

The boots, if available

setBoots

default void setBoots(@Nullable
                      ItemStack boots)

Sets the boots currently being worn by this entity.

Having the boots as null will result in having nothing equipped in the boots slot.

Parameters:

boots - The boots to put on the entity

getItemInHand

Optional<ItemStack> getItemInHand(HandType handType)

Gets the current equipped item in hand if available.

Having the item in hand as null will result in having nothing equipped in the item in hand slot.

Parameters:

handType - The hand type to retrieve from

Returns:

The current item in hand, if available

setItemInHand

void setItemInHand(HandType hand,
                   @Nullable
                   ItemStack itemInHand)

Sets the item in hand for this entity.

Having the item in hand as null will result in having nothing equipped in the item in hand slot.

Parameters:

hand - The hand type to set to

itemInHand - The item in hand