com.bgsoftware.superiorskyblock.api.hooks

Interface WorldsProvider

public interface WorldsProvider

Method Summary

Modifier and Type	Method and Description
void	finishIslandCreation(org.bukkit.Location islandLocation, java.util.UUID islandOwner, java.util.UUID islandUUID) Callback upon finishing of creation of islands.
org.bukkit.World	getIslandsWorld(Island island, org.bukkit.World.Environment environment) Get the world of an island by the environment.
org.bukkit.Location	getNextLocation(org.bukkit.Location previousLocation, int islandsHeight, int maxIslandSize, java.util.UUID islandOwner, java.util.UUID islandUUID) Get the location for a new island that is created.
boolean	isEndEnabled() Check whether or not end worlds are enabled.
boolean	isEndUnlocked() Check whether or not end worlds are unlocked for islands by default.
boolean	isIslandsWorld(org.bukkit.World world) Checks if the given world is an islands world.
boolean	isNetherEnabled() Check whether or not nether worlds are enabled.
boolean	isNetherUnlocked() Check whether or not nether worlds are unlocked for islands by default.
boolean	isNormalEnabled() Check whether or not normal worlds are enabled.
boolean	isNormalUnlocked() Check whether or not normal worlds are unlocked for islands by default.
void	prepareTeleport(Island island, org.bukkit.Location location, java.lang.Runnable finishCallback) Prepare teleportation of an entity to an island.
void	prepareWorlds() Prepare all the island worlds on startup.

Method Detail

prepareWorlds

void prepareWorlds()

Prepare all the island worlds on startup. They must be loaded so SSB will be able to load the islands!

getIslandsWorld

@Nullable
org.bukkit.World getIslandsWorld(Island island,
                                            org.bukkit.World.Environment environment)

Get the world of an island by the environment.

Parameters:

environment - The world environment.

island - The island to check.

isIslandsWorld

boolean isIslandsWorld(org.bukkit.World world)

Checks if the given world is an islands world.

Parameters:

world - The world to check.

getNextLocation

org.bukkit.Location getNextLocation(org.bukkit.Location previousLocation,
                                    int islandsHeight,
                                    int maxIslandSize,
                                    java.util.UUID islandOwner,
                                    java.util.UUID islandUUID)

Get the location for a new island that is created.

Parameters:

previousLocation - The location of the previous island that was created.

islandsHeight - The default islands height.

maxIslandSize - The default maximum island size.

islandOwner - The owner of the island.

islandUUID - The UUID of the island.

finishIslandCreation

void finishIslandCreation(org.bukkit.Location islandLocation,
                          java.util.UUID islandOwner,
                          java.util.UUID islandUUID)

Callback upon finishing of creation of islands.

Parameters:

islandLocation - The location of the new island.

islandOwner - The owner of the island.

islandUUID - The UUID of the island.

prepareTeleport

void prepareTeleport(Island island,
                     org.bukkit.Location location,
                     java.lang.Runnable finishCallback)

Prepare teleportation of an entity to an island.

Parameters:

island - The target island.

location - The location that the entity will be teleported to.

finishCallback - Callback function after the preparation is finished.

isNormalEnabled

boolean isNormalEnabled()

Check whether or not normal worlds are enabled.

isNormalUnlocked

boolean isNormalUnlocked()

Check whether or not normal worlds are unlocked for islands by default.

isNetherEnabled

boolean isNetherEnabled()

Check whether or not nether worlds are enabled.

isNetherUnlocked

boolean isNetherUnlocked()

Check whether or not nether worlds are unlocked for islands by default.

isEndEnabled

boolean isEndEnabled()

Check whether or not end worlds are enabled.

isEndUnlocked

boolean isEndUnlocked()

Check whether or not end worlds are unlocked for islands by default.