org.spongepowered.api.item.inventory.equipment

Interface EquipmentInventory

All Superinterfaces:

CarriedInventory<ArmorEquipable>, Inventory, Iterable<Inventory>, Nameable, OrderedInventory

public interface EquipmentInventory
extends OrderedInventory, CarriedInventory<ArmorEquipable>

Equipment inventory for Carriers that can carry equipment.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.item.inventory.Inventory

Inventory.Builder

Method Summary

Modifier and Type	Method and Description
Optional<Slot>	getSlot(EquipmentSlotType equipmentType) Gets the Slot for the specified equipment type.
Optional<Slot>	getSlot(EquipmentType equipmentType) Gets the Slot for the specified equipment type.
Optional<ItemStack>	peek(EquipmentSlotType equipmentType) Gets without removing the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	peek(EquipmentSlotType equipmentType, int limit) Gets without removing the items from the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	peek(EquipmentType equipmentType) Gets without removing the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	peek(EquipmentType equipmentType, int limit) Gets without removing the items from the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	poll(EquipmentSlotType equipmentType) Gets and remove the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	poll(EquipmentSlotType equipmentType, int limit) Gets and remove the items from the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	poll(EquipmentType equipmentType) Gets and remove the stack for the specified equipment type in this Inventory.
Optional<ItemStack>	poll(EquipmentType equipmentType, int limit) Gets and remove the items from the stack for the specified equipment type in this Inventory.
InventoryTransactionResult	set(EquipmentSlotType equipmentType, ItemStack stack) Sets the item for the specified equipment type.
InventoryTransactionResult	set(EquipmentType equipmentType, ItemStack stack) Sets the item for the specified equipment type.

Methods inherited from interface org.spongepowered.api.item.inventory.type.OrderedInventory

getSlot, peek, peek, poll, poll, set

Methods inherited from interface org.spongepowered.api.item.inventory.type.CarriedInventory

getCarrier

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

builder, canFit, capacity, clear, contains, contains, containsAny, containsInventory, first, getArchetype, getInventoryProperty, getInventoryProperty, getMaxStackSize, getPlugin, getProperties, getProperties, getProperty, getProperty, hasChildren, intersect, next, offer, parent, peek, peek, poll, poll, query, query, query, query, query, query, query, queryAny, root, set, setMaxStackSize, size, slots, totalItems, transform, union

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.spongepowered.api.Nameable

getName

Method Detail

poll

Optional<ItemStack> poll(EquipmentSlotType equipmentType)

Gets and remove the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

Returns:

removed ItemStack, per the semantics of Inventory.poll()

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(EquipmentSlotType equipmentType,
                         int limit)

Gets and remove the items from the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

limit - item limit

Returns:

removed ItemStack, per the semantics of Inventory.poll()

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(EquipmentType equipmentType)

Gets and remove the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

Returns:

removed ItemStack, per the semantics of Inventory.poll()

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(EquipmentType equipmentType,
                         int limit)

Gets and remove the items from the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

limit - item limit

Returns:

removed ItemStack, per the semantics of Inventory.poll()

See Also:

Inventory.poll()

peek

Optional<ItemStack> peek(EquipmentSlotType equipmentType)

Gets without removing the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

Returns:

removed ItemStack, per the semantics of Inventory.peek()

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(EquipmentSlotType equipmentType,
                         int limit)

Gets without removing the items from the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

limit - item limit

Returns:

removed ItemStack, per the semantics of Inventory.peek()

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(EquipmentType equipmentType)

Gets without removing the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

Returns:

removed ItemStack, per the semantics of Inventory.peek()

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(EquipmentType equipmentType,
                         int limit)

Gets without removing the items from the stack for the specified equipment type in this Inventory.

Parameters:

equipmentType - Type of equipment slot to query for

limit - item limit

Returns:

removed ItemStack, per the semantics of Inventory.peek()

See Also:

Inventory.peek()

set

InventoryTransactionResult set(EquipmentSlotType equipmentType,
                               ItemStack stack)

Sets the item for the specified equipment type.

Parameters:

equipmentType - Type of equipment slot to set

stack - stack to insert

Returns:

operation result, for details see Inventory.set(org.spongepowered.api.item.inventory.ItemStack)

See Also:

Inventory.set(ItemStack)

set

InventoryTransactionResult set(EquipmentType equipmentType,
                               ItemStack stack)

Sets the item for the specified equipment type.

Parameters:

equipmentType - Type of equipment slot to set

stack - stack to insert

Returns:

operation result, for details see Inventory.set(org.spongepowered.api.item.inventory.ItemStack)

See Also:

Inventory.set(ItemStack)

getSlot

Optional<Slot> getSlot(EquipmentSlotType equipmentType)

Gets the Slot for the specified equipment type.

Parameters:

equipmentType - Type of equipment slot to set

Returns:

matching slot or Optional.empty() if no matching slot

getSlot

Optional<Slot> getSlot(EquipmentType equipmentType)

Gets the Slot for the specified equipment type.

Parameters:

equipmentType - Type of equipment slot to set

Returns:

matching slot or Optional.empty() if no matching slot