Class PlayerElytraBoostEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
com.destroystokyo.paper.event.player.PlayerElytraBoostEvent
- All Implemented Interfaces:
Cancellable
Fired when a player boosts elytra flight with a firework
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the firework entity that was spawnedstatic @NotNull HandlerList
Get the firework itemstack usedboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setShouldConsume
(boolean consume) Set whether to consume the firework or notboolean
Get whether to consume the firework or notMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
asynchronous, callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerElytraBoostEvent
-
-
Method Details
-
getItemStack
Get the firework itemstack used- Returns:
- ItemStack of firework
-
getFirework
Get the firework entity that was spawned- Returns:
- Firework entity
-
shouldConsume
public boolean shouldConsume()Get whether to consume the firework or not- Returns:
- True to consume
-
setShouldConsume
public void setShouldConsume(boolean consume) Set whether to consume the firework or not- Parameters:
consume
- True to consume
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
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
-