Package org.spongepowered.api.event.item.inventory

Interface UseItemStackEvent

All Superinterfaces:

Event

All Known Subinterfaces:

UseItemStackEvent.Finish, UseItemStackEvent.Replace, UseItemStackEvent.Reset, UseItemStackEvent.Start, UseItemStackEvent.Stop, UseItemStackEvent.Tick

public interface UseItemStackEvent
extends Event

Fired when an ItemStack is used.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UseItemStackEvent.Finish	Fired when an item is finished 'normally', e.g.
static interface	UseItemStackEvent.Replace	Called after UseItemStackEvent.Finish, when the item in the entity's hand is replaced.
static interface	UseItemStackEvent.Reset	Called before an entity's used item state is reset.
static interface	UseItemStackEvent.Start	Called before UseItemStackEvent.Tick when a player starts using an ItemType, typically when they hold right mouse.
static interface	UseItemStackEvent.Stop	Called after UseItemStackEvent.Tick when an ItemType has finished being used.
static interface	UseItemStackEvent.Tick	Called after UseItemStackEvent.Start during each tick as an ItemType is being used.

Method Summary

Modifier and Type	Method	Description
ItemStackSnapshot	itemStackInUse()	Gets the ItemStack being consumed.
Ticks	originalRemainingDuration()	Gets the original remaining duration of ItemStack in use.
Ticks	remainingDuration()	Gets the remaining duration of ItemStack in use.
void	setRemainingDuration(Ticks duration)	Sets the remaining duration of ItemStack in use.

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

cause, context, source

Method Details

originalRemainingDuration

Ticks originalRemainingDuration()

Gets the original remaining duration of ItemStack in use.

Returns:

The original remaining duration

remainingDuration

Ticks remainingDuration()

Gets the remaining duration of ItemStack in use.

Returns:

The remaining duration

setRemainingDuration

void setRemainingDuration(Ticks duration)

Sets the remaining duration of ItemStack in use.

Parameters:

duration - The remaining duration to set

itemStackInUse

ItemStackSnapshot itemStackInUse()

Gets the ItemStack being consumed.

Returns:

The item being consumed