org.spongepowered.api.event.entity

Interface ChangeEntityEquipmentEvent

All Superinterfaces:

Cancellable, Event, TargetEntityEvent, TargetInventoryEvent

All Known Subinterfaces:

ChangeEntityEquipmentEvent.Break, ChangeEntityEquipmentEvent.TargetHumanoid, ChangeEntityEquipmentEvent.TargetLiving, ChangeEntityEquipmentEvent.TargetPlayer

All Known Implementing Classes:

AbstractChangeEntityEquipmentEvent

public interface ChangeEntityEquipmentEvent
extends TargetEntityEvent, TargetInventoryEvent, Cancellable

Called when an entity changes an equipped item. This can occur whenever a Slot belonging to an Inventory of an Entity is filled with an ItemStack, emptied of an ItemStack, or swapped with an ItemStack. In the event that a change to the ItemStack, the use of the Transaction is recommended.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChangeEntityEquipmentEvent.Break Called when the players equipment is broken or otherwise replaced by an empty item-stack.
static interface	ChangeEntityEquipmentEvent.TargetHumanoid An event where a Humanoid entity is targeted.
static interface	ChangeEntityEquipmentEvent.TargetLiving An event where a Living entity is targeted.
static interface	ChangeEntityEquipmentEvent.TargetPlayer An event where a Player entity is targeted.

Method Summary

Modifier and Type	Method and Description
Optional<Transaction<ItemStackSnapshot>>	getItemStack() Deprecated. Use getTransaction() instead
Optional<ItemStackSnapshot>	getOriginalItemStack() Deprecated. Use getTransaction() instead
Slot	getTargetInventory() Gets the target Inventory of this Event.
default Transaction<ItemStackSnapshot>	getTransaction() Gets the Transaction of ItemStackSnapshots for this event.

Methods inherited from interface org.spongepowered.api.event.entity.TargetEntityEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getOriginalItemStack

@Deprecated
Optional<ItemStackSnapshot> getOriginalItemStack()

Deprecated. Use getTransaction() instead

Gets the previously equipped ItemStack as an ItemStackSnapshot.

The previously equipped item may have been empty.

Returns:

The original itemstack, if available

getItemStack

@Deprecated
Optional<Transaction<ItemStackSnapshot>> getItemStack()

Deprecated. Use getTransaction() instead

Gets the new ItemStack that is being equipped in the relative armor slot.

The itemstack may not exist or the slot is being emptied.

Returns:

The new item stack, if available

getTransaction

default Transaction<ItemStackSnapshot> getTransaction()

Gets the Transaction of ItemStackSnapshots for this event.

Returns:

The transaction of the item

getTargetInventory

Slot getTargetInventory()

Description copied from interface: TargetInventoryEvent

Gets the target Inventory of this Event.

Specified by:

getTargetInventory in interface TargetInventoryEvent

Returns:

The target Inventory