Package org.bukkit.event.world
Class PortalCreateEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.world.WorldEvent
org.bukkit.event.world.PortalCreateEvent
- All Implemented Interfaces:
Cancellable
Called when a portal is created
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enum to specify the various reasons for a portal's creationNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ConstructorDescriptionPortalCreateEvent
(@NotNull List<BlockState> blocks, @NotNull World world, @Nullable Entity entity, @NotNull PortalCreateEvent.CreateReason reason) PortalCreateEvent
(@NotNull List<BlockState> blocks, @NotNull World world, @NotNull PortalCreateEvent.CreateReason reason) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionGets an array list of all the blocks associated with the created portalReturns the Entity that triggered this portal creation (if available)static @NotNull HandlerList
Gets the reason for the portal's creationboolean
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.world.WorldEvent
getWorld
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PortalCreateEvent
@Deprecated public PortalCreateEvent(@NotNull @NotNull List<BlockState> blocks, @NotNull @NotNull World world, @NotNull @NotNull PortalCreateEvent.CreateReason reason) Deprecated. -
PortalCreateEvent
-
-
Method Details
-
getBlocks
Gets an array list of all the blocks associated with the created portal- Returns:
- array list of all the blocks associated with the created portal
-
getEntity
Returns the Entity that triggered this portal creation (if available)- Returns:
- Entity involved in this event
-
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
-
getReason
Gets the reason for the portal's creation- Returns:
- CreateReason for the portal's creation
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-