GridManager

All Superinterfaces:: IDatabaseBridgeHolder

public interface GridManager
extends IDatabaseBridgeHolder

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addIslandToPurge(Island island)` Make the island to be deleted when server stops.
`void`	`calcAllIslands()` Calculate the worth of all the islands on the server.
`void`	`calcAllIslands(java.lang.Runnable callback)` Calculate the worth of all the islands on the server.
`void`	`cancelAllIslandPreviews()` Cancel all active island previews.
`void`	`cancelIslandPreview(SuperiorPlayer superiorPlayer)` Cancel the island preview for a specific player.
`void`	`createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonusWorth, java.math.BigDecimal bonusLevel, org.bukkit.block.Biome biome, java.lang.String islandName, boolean offset)` Create a new island.
`void`	`createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonus, org.bukkit.block.Biome biome, java.lang.String islandName)` Create a new island.
`void`	`createIsland(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.math.BigDecimal bonus, org.bukkit.block.Biome biome, java.lang.String islandName, boolean offset)` Create a new island.
`void`	`deleteIsland(Island island)` Delete an island.
`java.util.List<java.util.UUID>`	`getAllIslands(SortingType sortingType)` Get all the islands ordered by a specific sorting type.
`int`	`getBlockAmount(org.bukkit.block.Block block)` Deprecated. see `StackedBlocksManager`
`int`	`getBlockAmount(org.bukkit.Location location)` Deprecated. see `StackedBlocksManager`
`Island`	`getIsland(int position, SortingType sortingType)` Get the island in a specific position from one of the top lists.
`Island`	`getIsland(java.lang.String islandName)` Get an island by it's name.
`Island`	`getIsland(SuperiorPlayer superiorPlayer)` Get the island of a specific player.
`Island`	`getIsland(java.util.UUID uuid)` Get an island by it's owner uuid.
`Island`	`getIslandAt(org.bukkit.Chunk chunk)` Get an island from a chunk.
`Island`	`getIslandAt(org.bukkit.Location location)` Get an island at an exact position in the world.
`Island`	`getIslandByUUID(java.util.UUID uuid)` Get an island by it's uuid.
`IslandCreationAlgorithm`	`getIslandCreationAlgorithm()` Get the currently used island creation algorithm.
`int`	`getIslandPosition(Island island, SortingType sortingType)` Get the position of an island.
`IslandPreview`	`getIslandPreview(SuperiorPlayer superiorPlayer)` Check if a player has an ongoing island preview task.
`java.util.List<Island>`	`getIslands()` Get all the islands unordered.
`java.util.List<Island>`	`getIslands(SortingType sortingType)` Get all the islands ordered by a specific sorting type.
`IslandsContainer`	`getIslandsContainer()` Get the islands container.
`java.util.List<Island>`	`getIslandsToPurge()` Get all the islands that will be deleted when the server stops.
`org.bukkit.World`	`getIslandsWorld(Island island, org.bukkit.World.Environment environment)` Get the world of an island by the environment.
`org.bukkit.Location`	`getLastIslandLocation()` Get the location of the last island that was generated.
`java.util.List<org.bukkit.World>`	`getRegisteredWorlds()` Get all registered worlds.
`int`	`getSize()` Get the amount of islands.
`Island`	`getSpawnIsland()` Get the spawn island object.
`java.util.List<org.bukkit.Location>`	`getStackedBlocks()` Deprecated. see `StackedBlocksManager`
`java.math.BigDecimal`	`getTotalLevel()` Get the total level of all the islands.
`java.math.BigDecimal`	`getTotalWorth()` Get the total worth of all the islands.
`boolean`	`hasActiveCreateRequest(SuperiorPlayer superiorPlayer)` Checks if a player has an active request for creating an island.
`boolean`	`isIslandPurge(Island island)` Check if the island will be deleted when the server stops?
`boolean`	`isIslandsWorld(org.bukkit.World world)` Checks if the given world is an islands world.
`void`	`registerIslandWorld(org.bukkit.World world)` Register a world as a islands world.
`void`	`registerSortingType(SortingType sortingType)` Add a new sorting type to the registry of islands.
`void`	`removeIslandFromPurge(Island island)` Remove the island from being deleted when server stops.
`void`	`setBlockAmount(org.bukkit.block.Block block, int amount)` Deprecated. see `StackedBlocksManager`
`void`	`setIslandCreationAlgorithm(IslandCreationAlgorithm islandCreationAlgorithm)` Set the creation algorithm of islands.
`void`	`setLastIslandLocation(org.bukkit.Location location)` Set the location of the last island.
`void`	`sortIslands(SortingType sortingType)` Sort the islands.
`void`	`sortIslands(SortingType sortingType, java.lang.Runnable onFinish)` Sort the islands.
`void`	`startIslandPreview(SuperiorPlayer superiorPlayer, java.lang.String schemName, java.lang.String islandName)` Start the island preview task for a specific player.
`void`	`transferIsland(java.util.UUID oldOwner, java.util.UUID newOwner)` Transfer an island's leadership to another owner.

Methods inherited from interface com.bgsoftware.superiorskyblock.api.data.IDatabaseBridgeHolder
getDatabaseBridge

- Method Detail
  - createIsland
```
void createIsland(SuperiorPlayer superiorPlayer,
                  java.lang.String schemName,
                  java.math.BigDecimal bonus,
                  org.bukkit.block.Biome biome,
                  java.lang.String islandName)
```
    Create a new island.
    
    Parameters:
    
    superiorPlayer - The new owner for the island.
    
    schemName - The schematic that should be used.
    
    bonus - A starting worth for the island.
    
    biome - A starting biome for the island.
    
    islandName - The name of the new island.
  - createIsland
```
void createIsland(SuperiorPlayer superiorPlayer,
                  java.lang.String schemName,
                  java.math.BigDecimal bonus,
                  org.bukkit.block.Biome biome,
                  java.lang.String islandName,
                  boolean offset)
```
    Create a new island.
    
    Parameters:
    
    superiorPlayer - The new owner for the island.
    
    schemName - The schematic that should be used.
    
    bonus - A starting worth for the island.
    
    biome - A starting biome for the island.
    
    islandName - The name of the new island.
    
    offset - Should the island have an offset for it's values? If disabled, the bonus will be given.
  - createIsland
```
void createIsland(SuperiorPlayer superiorPlayer,
                  java.lang.String schemName,
                  java.math.BigDecimal bonusWorth,
                  java.math.BigDecimal bonusLevel,
                  org.bukkit.block.Biome biome,
                  java.lang.String islandName,
                  boolean offset)
```
    Create a new island.
    
    Parameters:
    
    superiorPlayer - The new owner for the island.
    
    schemName - The schematic that should be used.
    
    bonusWorth - A starting worth for the island.
    
    bonusLevel - A starting level for the island.
    
    biome - A starting biome for the island.
    
    islandName - The name of the new island.
    
    offset - Should the island have an offset for it's values? If disabled, the bonus will be given.
  - setIslandCreationAlgorithm
```
void setIslandCreationAlgorithm(@Nullable
                                IslandCreationAlgorithm islandCreationAlgorithm)
```
    Set the creation algorithm of islands.
    
    Parameters:
    
    islandCreationAlgorithm - The new algorithm to set. If null, the default one will be used.
  - getIslandCreationAlgorithm
```
IslandCreationAlgorithm getIslandCreationAlgorithm()
```
    Get the currently used island creation algorithm.
  - hasActiveCreateRequest
```
boolean hasActiveCreateRequest(SuperiorPlayer superiorPlayer)
```
    Checks if a player has an active request for creating an island.
    
    Parameters:
    
    superiorPlayer - The player to check.
  - startIslandPreview
```
void startIslandPreview(SuperiorPlayer superiorPlayer,
                        java.lang.String schemName,
                        java.lang.String islandName)
```
    Start the island preview task for a specific player.
    
    Parameters:
    
    superiorPlayer - The player to start preview for.
    
    schemName - The schematic to preview.
    
    islandName - The requested island name by the player.
  - cancelIslandPreview
```
void cancelIslandPreview(SuperiorPlayer superiorPlayer)
```
    Cancel the island preview for a specific player.
    
    Parameters:
    
    superiorPlayer - The player to cancel preview for.
  - cancelAllIslandPreviews
```
void cancelAllIslandPreviews()
```
    Cancel all active island previews.
  - getIslandPreview
```
@Nullable
IslandPreview getIslandPreview(SuperiorPlayer superiorPlayer)
```
    Check if a player has an ongoing island preview task.
    
    Parameters:
    
    superiorPlayer - The player to check.
  - deleteIsland
```
void deleteIsland(Island island)
```
    Delete an island.
    
    Parameters:
    
    island - The island to delete.
  - getIsland
```
@Nullable
Island getIsland(SuperiorPlayer superiorPlayer)
```
    Get the island of a specific player.
    
    Parameters:
    
    superiorPlayer - The player to check.
    
    Returns:
    
    The island of the player. May be null.
  - getIsland
```
@Nullable
Island getIsland(int position,
                            SortingType sortingType)
```
    Get the island in a specific position from one of the top lists. Positions are starting from 0.
    
    Parameters:
    
    position - The position to check.
    
    sortingType - The sorting type that should be considered.
    
    Returns:
    
    The island in that position. May be null.
  - getIslandPosition
```
int getIslandPosition(Island island,
                      SortingType sortingType)
```
    Get the position of an island. Positions are starting from 0.
    
    Parameters:
    
    island - The island to check.
    
    sortingType - The sorting type that should be considered.
    
    Returns:
    
    The position of the island.
  - getIsland
```
@Nullable
Island getIsland(java.util.UUID uuid)
```
    Get an island by it's owner uuid.
    
    Parameters:
    
    uuid - The uuid of the owner.
    
    Returns:
    
    The island of the owner. May be null.
  - getIslandByUUID
```
@Nullable
Island getIslandByUUID(java.util.UUID uuid)
```
    Get an island by it's uuid.
    
    Parameters:
    
    uuid - The uuid of the island.
    
    Returns:
    
    The island with that UUID. May be null.
  - getIsland
```
@Nullable
Island getIsland(java.lang.String islandName)
```
    Get an island by it's name.
    
    Parameters:
    
    islandName - The name to check.
    
    Returns:
    
    The island with that name. May be null.
  - getIslandAt
```
@Nullable
Island getIslandAt(@Nullable
                              org.bukkit.Location location)
```
    Get an island at an exact position in the world.
    
    Parameters:
    
    location - The position to check.
    
    Returns:
    
    The island at that position. May be null.
  - getIslandAt
```
@Nullable
Island getIslandAt(@Nullable
                              org.bukkit.Chunk chunk)
```
    Get an island from a chunk.
    
    Parameters:
    
    chunk - The chunk to check.
    
    Returns:
    
    The island at that position. May be null.
  - transferIsland
```
void transferIsland(java.util.UUID oldOwner,
                    java.util.UUID newOwner)
```
    Transfer an island's leadership to another owner.
    
    Parameters:
    
    oldOwner - The old owner of the island.
    
    newOwner - The new owner of the island.
  - getSize
```
int getSize()
```
    Get the amount of islands.
  - sortIslands
```
void sortIslands(SortingType sortingType)
```
    Sort the islands.
    
    Parameters:
    
    sortingType - The sorting type to use.
  - sortIslands
```
void sortIslands(SortingType sortingType,
                 @Nullable
                 java.lang.Runnable onFinish)
```
    Sort the islands.
    
    Parameters:
    
    sortingType - The sorting type to use.
    
    onFinish - Callback runnable.
  - getSpawnIsland
```
Island getSpawnIsland()
```
    Get the spawn island object.
  - getIslandsWorld
```
@Nullable
org.bukkit.World getIslandsWorld(Island island,
                                            org.bukkit.World.Environment environment)
```
    Get the world of an island by the environment. If the environment is not the normal and that environment is disabled in config, null will be returned.
    
    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. Can be the normal world, the nether world (if enabled in config) or the end world (if enabled in config)
  - registerIslandWorld
```
void registerIslandWorld(org.bukkit.World world)
```
    Register a world as a islands world. This will add all protections to that world, however - no islands will by physically there.
    
    Parameters:
    
    world - The world to register as an islands world.
  - getRegisteredWorlds
```
java.util.List<org.bukkit.World> getRegisteredWorlds()
```
    Get all registered worlds.
  - getAllIslands
```
java.util.List<java.util.UUID> getAllIslands(SortingType sortingType)
```
    Get all the islands ordered by a specific sorting type.
    
    Parameters:
    
    sortingType - The sorting type to order the list by.
    
    Returns:
    
    A list of uuids of the island owners.
  - getIslands
```
java.util.List<Island> getIslands()
```
    Get all the islands unordered.
  - getIslands
```
java.util.List<Island> getIslands(SortingType sortingType)
```
    Get all the islands ordered by a specific sorting type.
    
    Parameters:
    
    sortingType - The sorting type to order the list by.
    
    Returns:
    
    A list of uuids of the island owners.
  - getBlockAmount
```
@Deprecated
int getBlockAmount(org.bukkit.block.Block block)
```
    Deprecated. see StackedBlocksManager
    
    Get the block amount of a specific block.
    
    Parameters:
    
    block - The block to check.
  - getBlockAmount
```
@Deprecated
int getBlockAmount(org.bukkit.Location location)
```
    Deprecated. see StackedBlocksManager
    
    Get the block amount of a specific location.
    
    Parameters:
    
    location - The location to check.
  - setBlockAmount
```
@Deprecated
void setBlockAmount(org.bukkit.block.Block block,
                                 int amount)
```
    Deprecated. see StackedBlocksManager
    
    Set a new amount for a specific block.
    
    Parameters:
    
    block - The block to set the amount to.
    
    amount - The new amount of the block.
  - getStackedBlocks
```
@Deprecated
java.util.List<org.bukkit.Location> getStackedBlocks()
```
    Deprecated. see StackedBlocksManager
    
    Get all the stacked blocks on the server.
  - calcAllIslands
```
void calcAllIslands()
```
    Calculate the worth of all the islands on the server.
  - calcAllIslands
```
void calcAllIslands(@Nullable
                    java.lang.Runnable callback)
```
    Calculate the worth of all the islands on the server.
    
    Parameters:
    
    callback - Runnable that will be ran when process is finished.
  - addIslandToPurge
```
void addIslandToPurge(Island island)
```
    Make the island to be deleted when server stops.
    
    Parameters:
    
    island - The island to delete.
  - removeIslandFromPurge
```
void removeIslandFromPurge(Island island)
```
    Remove the island from being deleted when server stops.
    
    Parameters:
    
    island - The island to keep.
  - isIslandPurge
```
boolean isIslandPurge(Island island)
```
    Check if the island will be deleted when the server stops?
  - getIslandsToPurge
```
java.util.List<Island> getIslandsToPurge()
```
    Get all the islands that will be deleted when the server stops.
  - registerSortingType
```
void registerSortingType(SortingType sortingType)
```
    Add a new sorting type to the registry of islands.
    
    Parameters:
    
    sortingType - The new sorting type to register.
  - getTotalWorth
```
java.math.BigDecimal getTotalWorth()
```
    Get the total worth of all the islands. This value is updated every minute, so it might not be 100% accurate.
  - getTotalLevel
```
java.math.BigDecimal getTotalLevel()
```
    Get the total level of all the islands. This value is updated every minute, so it might not be 100% accurate.
  - getLastIslandLocation
```
org.bukkit.Location getLastIslandLocation()
```
    Get the location of the last island that was generated.
  - setLastIslandLocation
```
void setLastIslandLocation(org.bukkit.Location location)
```
    Set the location of the last island. Warning: Do not use this method unless you know what you're doing
    
    Parameters:
    
    location - The location to set.
  - getIslandsContainer
```
IslandsContainer getIslandsContainer()
```
    Get the islands container.

Interface GridManager

Method Summary

Methods inherited from interface com.bgsoftware.superiorskyblock.api.data.IDatabaseBridgeHolder

Method Detail

createIsland

createIsland

createIsland

setIslandCreationAlgorithm

getIslandCreationAlgorithm

hasActiveCreateRequest

startIslandPreview

cancelIslandPreview

cancelAllIslandPreviews

getIslandPreview

deleteIsland

getIsland

getIsland

getIslandPosition

getIsland

getIslandByUUID

getIsland

getIslandAt

getIslandAt

transferIsland

getSize

sortIslands

sortIslands

getSpawnIsland

getIslandsWorld

isIslandsWorld

registerIslandWorld

getRegisteredWorlds

getAllIslands

getIslands

getIslands

getBlockAmount

getBlockAmount

setBlockAmount

getStackedBlocks

calcAllIslands

calcAllIslands

addIslandToPurge

removeIslandFromPurge

isIslandPurge

getIslandsToPurge

registerSortingType

getTotalWorth

getTotalLevel

getLastIslandLocation

setLastIslandLocation

getIslandsContainer