org.bukkit.event.entity

Class EntityCreatePortalEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.EntityCreatePortalEvent

All Implemented Interfaces:

Cancellable

public class EntityCreatePortalEvent
extends EntityEvent
implements Cancellable

Thrown when a Living Entity creates a portal in a world.

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 and Description
EntityCreatePortalEvent(LivingEntity what, List<BlockState> blocks, PortalType type)

Method Summary

Modifier and Type	Method and Description
List<BlockState>	getBlocks() Gets a list of all blocks associated with the portal.
LivingEntity	getEntity() Returns the Entity involved in this event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
PortalType	getPortalType() Gets the type of portal that is trying to be created.
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

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 Detail

EntityCreatePortalEvent

public EntityCreatePortalEvent(@NotNull
                               LivingEntity what,
                               @NotNull
                               List<BlockState> blocks,
                               @NotNull
                               PortalType type)

Method Detail

getEntity

@NotNull
public LivingEntity getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getBlocks

@NotNull
public List<BlockState> getBlocks()

Gets a list of all blocks associated with the portal.

Returns:

List of blocks that will be changed.

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

getPortalType

@NotNull
public PortalType getPortalType()

Gets the type of portal that is trying to be created.

Returns:

Type of portal.

getHandlers

@NotNull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()