Package org.bukkit.event.entity
Class EntityShootBowEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityShootBowEvent
- All Implemented Interfaces:
Cancellable
Called when a LivingEntity shoots a bow firing an arrow
-
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
ConstructorsConstructorDescriptionEntityShootBowEvent
(@NotNull LivingEntity shooter, @Nullable ItemStack bow, @NotNull Entity projectile, float force) Deprecated, for removal: This API element is subject to removal in a future version.EntityShootBowEvent
(@NotNull LivingEntity shooter, @Nullable ItemStack bow, @NotNull ItemStack arrowItem, @NotNull Entity projectile, float force) Deprecated, for removal: This API element is subject to removal in a future version.EntityShootBowEvent
(@NotNull LivingEntity shooter, @Nullable ItemStack bow, @Nullable ItemStack consumable, @NotNull Entity projectile, @NotNull EquipmentSlot hand, float force, boolean consumeItem) -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.getBow()
Gets the bow ItemStack used to fire the arrow.Get the ItemStack to be consumed in this event (if any).boolean
Deprecated.Returns the Entity involved in this eventfloat
getForce()
Gets the force the arrow was launched withgetHand()
Get the hand from which the bow was shot.static @NotNull HandlerList
Gets the projectile which will be launched by this eventboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setConsumeArrow
(boolean consumeArrow) Deprecated.void
setConsumeItem
(boolean consumeItem) Deprecated.not currently functionalvoid
setProjectile
(@NotNull Entity projectile) Replaces the projectile which will be launchedboolean
Get whether the consumable item should be consumed in this event.Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
EntityShootBowEvent
@Internal @Deprecated(forRemoval=true) public EntityShootBowEvent(@NotNull @NotNull LivingEntity shooter, @Nullable @Nullable ItemStack bow, @NotNull @NotNull Entity projectile, float force) Deprecated, for removal: This API element is subject to removal in a future version. -
EntityShootBowEvent
@Internal @Deprecated(forRemoval=true) public EntityShootBowEvent(@NotNull @NotNull LivingEntity shooter, @Nullable @Nullable ItemStack bow, @NotNull @NotNull ItemStack arrowItem, @NotNull @NotNull Entity projectile, float force) Deprecated, for removal: This API element is subject to removal in a future version. -
EntityShootBowEvent
-
-
Method Details
-
getEntity
Description copied from class:EntityEvent
Returns the Entity involved in this event- Overrides:
getEntity
in classEntityEvent
- Returns:
- Entity who is involved in this event
-
getBow
Gets the bow ItemStack used to fire the arrow.- Returns:
- the bow involved in this event
-
getConsumable
Get the ItemStack to be consumed in this event (if any).
For instance, bows will consume an arrow ItemStack in a player's inventory.- Returns:
- the consumable item
-
getProjectile
Gets the projectile which will be launched by this event- Returns:
- the launched projectile
-
setProjectile
Replaces the projectile which will be launched- Parameters:
projectile
- the new projectile
-
getHand
Get the hand from which the bow was shot.- Returns:
- the hand
-
getForce
public float getForce()Gets the force the arrow was launched with- Returns:
- bow shooting force, up to 1.0
-
setConsumeItem
Deprecated.not currently functionalSet whether the consumable item should be consumed in this event.If set to
false
, it is recommended that a call toPlayer.updateInventory()
is made as the client may disagree with the server's decision to not consume a consumable item.This value is ignored for entities where items are not required (skeletons, pillagers, etc.) or with crossbows (as no item is being consumed).
- Parameters:
consumeItem
- whether to consume the item
-
shouldConsumeItem
public boolean shouldConsumeItem()Get whether the consumable item should be consumed in this event.- Returns:
true
if consumed,false
otherwise
-
getArrowItem
Deprecated. -
setConsumeArrow
Deprecated. -
getConsumeArrow
Deprecated. -
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
-