Package org.bukkit.event.block
Class BlockDispenseEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.BlockDispenseEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
BlockDispenseArmorEvent
Called when an item is dispensed from a block.
If a Block Dispense event is cancelled, the block will not dispense the item.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.block.BlockEvent
block
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull HandlerList
getItem()
Gets the item that is being dispensed.Gets the velocity in meters per tick.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
Sets the item being dispensed.void
setVelocity
(@NotNull Vector vel) Sets the velocity of the item being dispensed in meters per tick.Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
BlockDispenseEvent
-
-
Method Details
-
getItem
Gets the item that is being dispensed. Modifying the returned item will have no effect, you must usesetItem(org.bukkit.inventory.ItemStack)
instead.- Returns:
- An ItemStack for the item being dispensed
-
setItem
Sets the item being dispensed.- Parameters:
item
- the item being dispensed
-
getVelocity
Gets the velocity in meters per tick.Note: Modifying the returned Vector will not change the velocity, you must use
setVelocity(org.bukkit.util.Vector)
instead.- Returns:
- A Vector for the dispensed item's velocity
-
setVelocity
Sets the velocity of the item being dispensed in meters per tick.- Parameters:
vel
- the velocity of the item being dispensed
-
isCancelled
public boolean isCancelled()Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-