org.bukkit.event.entity

Class FireworkExplodeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.FireworkExplodeEvent

All Implemented Interfaces:

Cancellable

public class FireworkExplodeEvent
extends EntityEvent
implements Cancellable

Called when a firework explodes.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor and Description
FireworkExplodeEvent(@NotNull Firework what)

Method Summary

Modifier and Type	Method and Description
@NotNull Firework	getEntity() Returns the Entity involved in this event
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Set the cancelled state of this event.

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntityType

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

FireworkExplodeEvent

public FireworkExplodeEvent(@NotNull
                            @NotNull Firework what)

Method Detail

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

setCancelled

public void setCancelled(boolean cancel)

Set the cancelled state of this event. If the firework explosion is cancelled, the firework will still be removed, but no particles will be displayed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - whether to cancel or not.

getEntity

@NotNull
public @NotNull Firework getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()