org.spongepowered.api.event.item.inventory

Interface UseItemStackEvent.Stop

All Superinterfaces:

Cancellable, Event, UseItemStackEvent

Enclosing interface:

UseItemStackEvent

public static interface UseItemStackEvent.Stop
extends UseItemStackEvent, Cancellable

Called after UseItemStackEvent.Tick when an ItemType has finished being used.

Examples:

• Stop eating halfway through
• Stop defending with sword
• Stop drawing bow. This case would fire the arrow

Duration on this event is how long the item had left in its countdown before 'finishing'.

In Vanilla, this is only fired for players, not other entities.

In Vanilla, setting the duration on this event will have no effect.

Cancelling this event will prevent the ItemType from being notified that it has stopped being used. The only vanilla ItemType this would affect are bows, and it would cause the bow to NOT fire.

Nested Class Summary

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

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

Method Summary

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

getItemStackInUse, getOriginalRemainingDuration, getRemainingDuration, setRemainingDuration

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

getCause, getContext, getSource

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

isCancelled, setCancelled