org.spongepowered.api.event.item.inventory

Interface ChangeInventoryEvent.Pickup.Pre

All Superinterfaces:

Cancellable, Event, TargetEntityEvent, TargetInventoryEvent, TargetItemEvent

Enclosing interface:

ChangeInventoryEvent.Pickup

public static interface ChangeInventoryEvent.Pickup.Pre
extends TargetInventoryEvent, TargetItemEvent, Cancellable

Fires before an Item is picked up.

Modifying the picked up items causes this event to be automatically canceled if the inventory does not fit the entire list.

Method Summary

Modifier and Type	Method and Description
Optional<List<ItemStackSnapshot>>	getCustom() Returns the custom set list of items to add to the inventory or Optional.empty() if not set.
List<ItemStackSnapshot>	getFinal() Returns the proposed final list of items to add to the inventory.
default ItemStackSnapshot	getOriginalStack() Returns the original picked up ItemStackSnapshot to add to the inventory.
void	setCustom(List<ItemStackSnapshot> items) Sets the items to add to the inventory.

Methods inherited from interface org.spongepowered.api.event.item.inventory.TargetInventoryEvent

getTargetInventory

Methods inherited from interface org.spongepowered.api.event.entity.item.TargetItemEvent

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

getOriginalStack

default ItemStackSnapshot getOriginalStack()

Returns the original picked up ItemStackSnapshot to add to the inventory.

Returns:

The original picked up item

getCustom

Optional<List<ItemStackSnapshot>> getCustom()

Returns the custom set list of items to add to the inventory or Optional.empty() if not set.

Returns:

The custom set list

setCustom

void setCustom(List<ItemStackSnapshot> items)

Sets the items to add to the inventory.

If all items do not fit the inventory this event will be automatically canceled.

Parameters:

items - The items to add to the inventory

getFinal

List<ItemStackSnapshot> getFinal()

Returns the proposed final list of items to add to the inventory.

If a custom list was set all items have to fit the inventory or this event will be automatically canceled.

Returns:

The proposed final list