org.bukkit.event.world
Class PortalCreateEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.world.WorldEvent
          extended by org.bukkit.event.world.PortalCreateEvent
All Implemented Interfaces:
Cancellable

public class PortalCreateEvent
extends WorldEvent
implements Cancellable

Called when a portal is created


Nested Class Summary
static class PortalCreateEvent.CreateReason
          An enum to specify the various reasons for a portal's creation
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Constructor Summary
PortalCreateEvent(Collection<Block> blocks, World world, PortalCreateEvent.CreateReason reason)
           
 
Method Summary
 ArrayList<Block> getBlocks()
          Gets an array list of all the blocks associated with the created portal
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 PortalCreateEvent.CreateReason getReason()
          Gets the reason for the portal's creation
 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.world.WorldEvent
getWorld
 
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalCreateEvent

public PortalCreateEvent(Collection<Block> blocks,
                         World world,
                         PortalCreateEvent.CreateReason reason)
Method Detail

getBlocks

public ArrayList<Block> 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

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

getReason

public PortalCreateEvent.CreateReason getReason()
Gets the reason for the portal's creation

Returns:
CreateReason for the portal's creation

getHandlers

public HandlerList getHandlers()
Specified by:
getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.