Class LingeringPotionSplashEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.ProjectileHitEvent

org.bukkit.event.entity.LingeringPotionSplashEvent

All Implemented Interfaces:

Cancellable

public class LingeringPotionSplashEvent
extends ProjectileHitEvent
implements Cancellable

Called when a splash potion hits an area

Since:

1.9.4

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
LingeringPotionSplashEvent(@NotNull ThrownPotion potion, @NotNull AreaEffectCloud effectCloud)	Deprecated, for removal: This API element is subject to removal in a future version.
LingeringPotionSplashEvent(@NotNull ThrownPotion potion, @Nullable Entity hitEntity, @Nullable Block hitBlock, @Nullable BlockFace hitFace, @NotNull AreaEffectCloud effectCloud)

Method Summary

Modifier and Type	Method	Description
boolean	allowsEmptyCreation()	Gets if an empty AreaEffectCloud may be created
void	allowsEmptyCreation(boolean allowEmptyAreaEffectCreation)	Sets if an Empty AreaEffectCloud may be created
@NotNull AreaEffectCloud	getAreaEffectCloud()	Gets the AreaEffectCloud spawned
@NotNull ThrownPotion	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)	Whether to cancel the action that occurs when the projectile hits.

Methods inherited from class ProjectileHitEvent

getHitBlock, getHitBlockFace, getHitEntity

Methods inherited from class EntityEvent

getEntityType

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

LingeringPotionSplashEvent

@Internal
@Deprecated(since="1.20.2",
            forRemoval=true)
public LingeringPotionSplashEvent(@NotNull
 @NotNull ThrownPotion potion,
 @NotNull
 @NotNull AreaEffectCloud effectCloud)

Deprecated, for removal: This API element is subject to removal in a future version.

LingeringPotionSplashEvent

@Internal
public LingeringPotionSplashEvent(@NotNull
 @NotNull ThrownPotion potion,
 @Nullable
 @Nullable Entity hitEntity,
 @Nullable
 @Nullable Block hitBlock,
 @Nullable
 @Nullable BlockFace hitFace,
 @NotNull
 @NotNull AreaEffectCloud effectCloud)

Method Details

getEntity

@NotNull
public @NotNull ThrownPotion getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class ProjectileHitEvent

Returns:

Entity who is involved in this event

Since:

1.9.4

getAreaEffectCloud

@NotNull
public @NotNull AreaEffectCloud getAreaEffectCloud()

Gets the AreaEffectCloud spawned

Returns:

The spawned AreaEffectCloud

Since:

1.9.4

allowsEmptyCreation

public void allowsEmptyCreation(boolean allowEmptyAreaEffectCreation)

Sets if an Empty AreaEffectCloud may be created

Parameters:

allowEmptyAreaEffectCreation - If an Empty AreaEffectCloud may be created

Since:

1.20.2

allowsEmptyCreation

public boolean allowsEmptyCreation()

Gets if an empty AreaEffectCloud may be created

Returns:

if an empty AreaEffectCloud may be created

Since:

1.20.2

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

Overrides:

isCancelled in class ProjectileHitEvent

Returns:

true if this event is cancelled

Since:

1.9.4

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 use FireworkExplodeEvent).
In the case of a block, some blocks (e.g. 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 interface Cancellable

Overrides:

setCancelled in class ProjectileHitEvent

Parameters:

cancel - true if you wish to cancel this event

Since:

1.9.4

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Overrides:

getHandlers in class ProjectileHitEvent

Since:

1.9.4

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

Since:

1.9.4