Package org.bukkit.event.entity

Class EntityPortalEnterEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.EntityPortalEnterEvent

All Implemented Interfaces:

Cancellable

public class EntityPortalEnterEvent
extends EntityEvent
implements Cancellable

Called when an entity comes into contact with a portal

Cancelling this event prevents any further processing of the portal for that tick.

See Also:

• EntityInsideBlockEvent

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	Description
EntityPortalEnterEvent(@NotNull Entity entity, @NotNull Location location)	Deprecated.
EntityPortalEnterEvent(@NotNull Entity entity, @NotNull Location location, PortalType portalType)

Method Summary

Modifier and Type	Method	Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Location	getLocation()	Gets the portal block the entity is touching
@NotNull PortalType	getPortalType()	Get the portal type.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

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

getEntity, getEntityType

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

EntityPortalEnterEvent

@Deprecated(since="1.21")
public EntityPortalEnterEvent(@NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull Location location)

Deprecated.

EntityPortalEnterEvent

@Internal
public EntityPortalEnterEvent(@NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull Location location,
 @NotNull
 PortalType portalType)

Method Details

getLocation

@NotNull
public @NotNull Location getLocation()

Gets the portal block the entity is touching

Returns:

The portal block the entity is touching

getPortalType

public @NotNull PortalType getPortalType()

Get the portal type.

Returns:

the portal type

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)

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 interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()