com.bgsoftware.superiorskyblock.api.events

Class IslandSetVisitorHomeEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandSetVisitorHomeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

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

IslandSetVisitorHomeEvent is called when a new visitor home is set to the island.

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
org.bukkit.Location	getIslandVisitorHome() Get the new island visitor home location of the island.
SuperiorPlayer	getPlayer() Get the player who changed the island home, if exists.
boolean	isCancelled()
void	setCancelled(boolean cancelled)
void	setIslandHome(org.bukkit.Location islandVisitorHome) Set the new visitor 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

IslandSetVisitorHomeEvent

public IslandSetVisitorHomeEvent(SuperiorPlayer superiorPlayer,
                                 Island island,
                                 org.bukkit.Location islandVisitorHome)

The constructor of the event.

Parameters:

superiorPlayer - The player that changed the island visitor home.

island - The island that the visitor home was changed for.

islandVisitorHome - The new island visitor home of the island.

Method Detail

getPlayer

public SuperiorPlayer getPlayer()

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

getIslandVisitorHome

public org.bukkit.Location getIslandVisitorHome()

Get the new island visitor home location of the island.

setIslandHome

public void setIslandHome(org.bukkit.Location islandVisitorHome)

Set the new visitor home location of the island. Setting the visitor home location outside the island's area may lead to undefined behaviors.

Parameters:

islandVisitorHome - The new home visitor location for the island.

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