com.bgsoftware.superiorskyblock.api.events

Class IslandCreateWarpEvent

java.lang.Object

org.bukkit.event.Event

com.bgsoftware.superiorskyblock.api.events.IslandEvent

com.bgsoftware.superiorskyblock.api.events.IslandCreateWarpEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

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

IslandCreateWarpEvent is called when a new warp is created on an 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
IslandCreateWarpEvent(SuperiorPlayer superiorPlayer, Island island, java.lang.String warpName, org.bukkit.Location location, boolean openToPublic, WarpCategory warpCategory) The constructor of the event.

Method Summary

Modifier and Type	Method and Description
org.bukkit.Location	getLocation() Get the location of the new warp.
SuperiorPlayer	getPlayer() Get the player that created the warp.
WarpCategory	getWarpCategory() Get the category of the new warp.
java.lang.String	getWarpName() Get the name of the new warp.
boolean	isCancelled()
boolean	isOpenToPublic() Get whether the warp is opened to the public.
void	setCancelled(boolean 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

IslandCreateWarpEvent

public IslandCreateWarpEvent(SuperiorPlayer superiorPlayer,
                             Island island,
                             java.lang.String warpName,
                             org.bukkit.Location location,
                             boolean openToPublic,
                             @Nullable
                             WarpCategory warpCategory)

The constructor of the event.

Parameters:

superiorPlayer - The player that created the warp.

island - The island that the warp was created on.

warpName - The name of the new warp.

location - The location of the new warp.

openToPublic - Whether the island is open to the public.

warpCategory - The category of the new warp. If null, it means the warp will be added to the first found category; if no category exists, new one will be created for the warp.

Method Detail

getPlayer

public SuperiorPlayer getPlayer()

Get the player that created the warp.

getWarpName

public java.lang.String getWarpName()

Get the name of the new warp.

getLocation

public org.bukkit.Location getLocation()

Get the location of the new warp.

isOpenToPublic

public boolean isOpenToPublic()

Get whether the warp is opened to the public.

getWarpCategory

@Nullable
public WarpCategory getWarpCategory()

Get the category of the new warp. If null, it means the warp will be added to the first found category; if no category exists, new one will be created for the warp.

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