com.bgsoftware.superiorskyblock.api.events

Class IslandSetHomeEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandSetHomeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

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

IslandSetHomeEvent is called when a new home is set to the island.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IslandSetHomeEvent.Reason The reason the home was changed.

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
IslandSetHomeEvent(Island island, org.bukkit.Location islandHome, IslandSetHomeEvent.Reason reason, SuperiorPlayer superiorPlayer) The constructor of the event.

Method Summary

Modifier and Type	Method and Description
org.bukkit.Location	getIslandHome() Get the new island home location of the island.
SuperiorPlayer	getPlayer() Get the player who changed the island home, if exists.
IslandSetHomeEvent.Reason	getReason() Get the reason the home was changed.
boolean	isCancelled()
void	setCancelled(boolean cancelled)
void	setIslandHome(org.bukkit.Location islandHome) Set the new home location of the island.

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

IslandSetHomeEvent

public IslandSetHomeEvent(Island island,
                          org.bukkit.Location islandHome,
                          IslandSetHomeEvent.Reason reason,
                          @Nullable
                          SuperiorPlayer superiorPlayer)

The constructor of the event.

Parameters:

island - The island that the home was changed for.

islandHome - The new island home of the island.

reason - The reason the home was changed.

superiorPlayer - The player that changed the island home, if exists

Method Detail

getIslandHome

public org.bukkit.Location getIslandHome()

Get the new island home location of the island.

setIslandHome

public void setIslandHome(org.bukkit.Location islandHome)

Set the new home location of the island.

Parameters:

islandHome - The home location for the island.

getReason

public IslandSetHomeEvent.Reason getReason()

Get the reason the home was changed.

getPlayer

@Nullable
public SuperiorPlayer getPlayer()

Get the player who changed the island home, if exists.

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