com.bgsoftware.superiorskyblock.api.island.warps

Interface IslandWarp

public interface IslandWarp

Method Summary

Modifier and Type	Method and Description
WarpCategory	getCategory() Get the category of the warp.
org.bukkit.inventory.ItemStack	getIcon(SuperiorPlayer superiorPlayer) Get the icon of the warp after all placeholders are parsed.
Island	getIsland() Get the island of this warp.
org.bukkit.Location	getLocation() Get the location of the warp.
java.lang.String	getName() Get the name of the warp.
org.bukkit.inventory.ItemStack	getRawIcon() Get the icon of the warp.
boolean	hasPrivateFlag() Check if the warp is private or public to visitors.
void	setIcon(org.bukkit.inventory.ItemStack icon) Set the icon of the warp.
void	setLocation(org.bukkit.Location location) Set the location of the warp.
void	setName(java.lang.String name) Set the name of the warp.
void	setPrivateFlag(boolean privateFlag) Set the private flag of the island warp.

Method Detail

getIsland

Island getIsland()

Get the island of this warp.

getName

java.lang.String getName()

Get the name of the warp.

setName

void setName(java.lang.String name)

Set the name of the warp. Do not call this method - use Island#renameWarp instead!

Parameters:

name - The new name to set.

getLocation

org.bukkit.Location getLocation()

Get the location of the warp.

setLocation

void setLocation(org.bukkit.Location location)

Set the location of the warp.

Parameters:

location - The new location to set.

hasPrivateFlag

boolean hasPrivateFlag()

Check if the warp is private or public to visitors.

setPrivateFlag

void setPrivateFlag(boolean privateFlag)

Set the private flag of the island warp.

Parameters:

privateFlag - The flag to set.

getRawIcon

@Nullable
org.bukkit.inventory.ItemStack getRawIcon()

Get the icon of the warp. May be null if the warp has no special icon.

getIcon

@Nullable
org.bukkit.inventory.ItemStack getIcon(@Nullable
                                                  SuperiorPlayer superiorPlayer)

Get the icon of the warp after all placeholders are parsed. May be null if the warp has no special icon.

Parameters:

superiorPlayer - The player to parse the placeholders for

setIcon

void setIcon(@Nullable
             org.bukkit.inventory.ItemStack icon)

Set the icon of the warp. May be null if the warp should have no special icon.

Parameters:

icon - The icon to set.

getCategory

WarpCategory getCategory()

Get the category of the warp.