Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.world.PortalCreateEvent Class Reference
Inheritance diagram for org.bukkit.event.world.PortalCreateEvent:
org.bukkit.event.world.WorldEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Classes

enum  CreateReason
 

Public Member Functions

 PortalCreateEvent (final Collection< Block > blocks, final World world, CreateReason reason)
 
ArrayList< BlockgetBlocks ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
CreateReason getReason ()
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.world.WorldEvent
 WorldEvent (final World world)
 
World getWorld ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Detailed Description

Called when a portal is created

Definition at line 14 of file PortalCreateEvent.java.

Member Function Documentation

ArrayList<Block> org.bukkit.event.world.PortalCreateEvent.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

Definition at line 32 of file PortalCreateEvent.java.

32  {
33  return this.blocks;
34  }
CreateReason org.bukkit.event.world.PortalCreateEvent.getReason ( )

Gets the reason for the portal's creation

Returns
CreateReason for the portal's creation

Definition at line 49 of file PortalCreateEvent.java.

49  {
50  return reason;
51  }
boolean org.bukkit.event.world.PortalCreateEvent.isCancelled ( )

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 36 of file PortalCreateEvent.java.

36  {
37  return cancel;
38  }
void org.bukkit.event.world.PortalCreateEvent.setCancelled ( boolean  cancel)

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 40 of file PortalCreateEvent.java.

40  {
41  this.cancel = cancel;
42  }

The documentation for this class was generated from the following file: