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

public class BlockDispenseEvent
extends BlockEvent
implements Cancellable

Called when an item is dispensed from a block.

If this event is cancelled, the block will not dispense the item.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class BlockEvent

block

Constructor Summary

Constructors

Constructor	Description
BlockDispenseEvent(@NotNull Block block, @NotNull ItemStack item, @NotNull Vector velocity)

Method Summary

Modifier and Type	Method	Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull ItemStack	getItem()	Gets the item that is being dispensed.
@NotNull Vector	getVelocity()	Gets the velocity in meters per tick.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setItem(@NotNull ItemStack item)	Sets the item being dispensed.
void	setVelocity(@NotNull Vector velocity)	Sets the velocity of the item being dispensed in meters per tick.

Methods inherited from class BlockEvent

getBlock

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BlockDispenseEvent

@Internal
public BlockDispenseEvent(@NotNull
 @NotNull Block block,
 @NotNull
 @NotNull ItemStack item,
 @NotNull
 @NotNull Vector velocity)

Method Details

getItem

@NotNull
public @NotNull ItemStack getItem()

Gets the item that is being dispensed. Modifying the returned item will have no effect, you must use setItem(ItemStack) instead.

Returns:

An ItemStack for the item being dispensed

Since:

1.0.0

setItem

public void setItem(@NotNull
 @NotNull ItemStack item)

Sets the item being dispensed.

Parameters:

item - the item being dispensed

Since:

1.0.0

getVelocity

@NotNull
public @NotNull Vector getVelocity()

Gets the velocity in meters per tick.

Note: Modifying the returned Vector will not change the velocity, you must use setVelocity(Vector) instead.

Returns:

A Vector for the dispensed item's velocity

Since:

1.0.0

setVelocity

public void setVelocity(@NotNull
 @NotNull Vector velocity)

Sets the velocity of the item being dispensed in meters per tick.

Parameters:

velocity - the velocity of the item being dispensed

Since:

1.0.0

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 interface Cancellable

Returns:

true if this event is cancelled

Since:

1.0.0

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 interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

Since:

1.0.0

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

Since:

1.1.0

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

Since:

1.1.0