Package org.bukkit.event.entity
Class PotionSplashEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.ProjectileHitEvent
org.bukkit.event.entity.PotionSplashEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
WaterBottleSplashEvent
Called when a splash potion hits an area
-
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
ConstructorDescriptionPotionSplashEvent
(@NotNull ThrownPotion potion, @NotNull Map<LivingEntity, Double> affectedEntities) Deprecated.PotionSplashEvent
(@NotNull ThrownPotion potion, @Nullable Entity hitEntity, @Nullable Block hitBlock, @Nullable BlockFace hitFace, @NotNull Map<LivingEntity, Double> affectedEntities) -
Method Summary
Modifier and TypeMethodDescriptionRetrieves a list of all effected entitiesReturns the Entity involved in this eventstatic @NotNull HandlerList
double
getIntensity
(@NotNull LivingEntity entity) Gets the intensity of the potion's effects for given entity; This depends on the distance to the impact centerGets the potion which caused this eventboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Whether to cancel the action that occurs when the projectile hits.void
setIntensity
(@NotNull LivingEntity entity, double intensity) Overwrites the intensity for a given entityMethods inherited from class org.bukkit.event.entity.ProjectileHitEvent
getHitBlock, getHitBlockFace, getHitEntity
Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Field Details
-
affectedEntities
-
-
Constructor Details
-
PotionSplashEvent
@Deprecated(since="1.20.2") public PotionSplashEvent(@NotNull @NotNull ThrownPotion potion, @NotNull @NotNull Map<LivingEntity, Double> affectedEntities) Deprecated. -
PotionSplashEvent
-
-
Method Details
-
getEntity
Description copied from class:EntityEvent
Returns the Entity involved in this event- Overrides:
getEntity
in classProjectileHitEvent
- Returns:
- Entity who is involved in this event
-
getPotion
Gets the potion which caused this event- Returns:
- The thrown potion entity
-
getAffectedEntities
Retrieves a list of all effected entities- Returns:
- A fresh copy of the affected entity list
-
getIntensity
Gets the intensity of the potion's effects for given entity; This depends on the distance to the impact center- Parameters:
entity
- Which entity to get intensity for- Returns:
- intensity relative to maximum effect; 0.0: not affected; 1.0: fully hit by potion effects
-
setIntensity
Overwrites the intensity for a given entity- Parameters:
entity
- For which entity to define a new intensityintensity
- relative to maximum effect
-
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
- Overrides:
isCancelled
in classProjectileHitEvent
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from class:ProjectileHitEvent
Whether to cancel the action that occurs when the projectile hits. In the case of an entity, it will not collide (unless it's a firework, then useFireworkExplodeEvent
).
In the case of a block, some blocks (eg target block, bell) will not perform the action associated.
This does NOT prevent block collisions, and explosions will still occur unless their respective events are cancelled.- Specified by:
setCancelled
in interfaceCancellable
- Overrides:
setCancelled
in classProjectileHitEvent
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Overrides:
getHandlers
in classProjectileHitEvent
-
getHandlerList
-