com.bgsoftware.superiorskyblock.api.events

Class IslandEnterEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandEnterEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

Direct Known Subclasses:

IslandEnterProtectedEvent

public class IslandEnterEvent
extends IslandEvent
implements org.bukkit.event.Cancellable

IslandEnterEvent is called when a player is walking into an island's area.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IslandEnterEvent.EnterCause Used to determine the cause of entering.

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class com.bgsoftware.superiorskyblock.api.events.IslandEvent

island

Constructor Summary

Constructors

Constructor and Description
IslandEnterEvent(SuperiorPlayer superiorPlayer, Island island, IslandEnterEvent.EnterCause enterCause) The constructor of the event.

Method Summary

Modifier and Type	Method and Description
org.bukkit.Location	getCancelTeleport() Get the location the player would be teleported if the event is cancelled.
IslandEnterEvent.EnterCause	getCause() Get the cause of entering into the island.
SuperiorPlayer	getPlayer() Get the player who entered to the island's area.
boolean	isCancelled()
void	setCancelled(boolean cancelled)
void	setCancelTeleport(org.bukkit.Location cancelTeleport) Set the location the player would be teleported if the event is cancelled.

Methods inherited from class com.bgsoftware.superiorskyblock.api.events.IslandEvent

getHandlerList, getHandlers, getIsland

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

IslandEnterEvent

public IslandEnterEvent(SuperiorPlayer superiorPlayer,
                        Island island,
                        IslandEnterEvent.EnterCause enterCause)

The constructor of the event.

Parameters:

superiorPlayer - The player who entered to the island's area.

island - The island that the player entered into.

enterCause - The cause of entering into the island.

Method Detail

getPlayer

public SuperiorPlayer getPlayer()

Get the player who entered to the island's area.

getCause

public IslandEnterEvent.EnterCause getCause()

Get the cause of entering into the island.

getCancelTeleport

public org.bukkit.Location getCancelTeleport()

Get the location the player would be teleported if the event is cancelled.

setCancelTeleport

public void setCancelTeleport(org.bukkit.Location cancelTeleport)

Set the location the player would be teleported if the event is cancelled.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable