ASkyBlockAPI

java.lang.Object
- com.wasteofplastic.askyblock.ASkyBlockAPI

```
public class ASkyBlockAPI
extends java.lang.Object
```
Provides a programming interface. The aim of this class is to provide a fairly static set of calls for other plugins to use. If you try to hook into other classes in the code, they may change and break your code.

Author:

tastybento

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`calculateIslandLevel(java.util.UUID playerUUID)` Calculates the island level.
`java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>>`	`getAllChallenges()` Get all the challenges
`java.util.Map<java.lang.String,java.lang.Boolean>`	`getChallengeStatus(java.util.UUID playerUUID)`
`java.util.Map<java.lang.String,java.lang.Integer>`	`getChallengeTimes(java.util.UUID playerUUID)`
`java.util.Set<org.bukkit.Location>`	`getCoopIslands(org.bukkit.entity.Player player)` Find out which coop islands player is a part of
`org.bukkit.Location`	`getHomeLocation(java.util.UUID playerUUID)`
`static ASkyBlockAPI`	`getInstance()`
`com.wasteofplastic.askyblock.Island`	`getIslandAt(org.bukkit.Location location)` Returns the Island object for an island at this location or null if one does not exist
`int`	`getIslandCount()`
`int`	`getIslandLevel(java.util.UUID playerUUID)` Deprecated. Island level is now a long and the int value may not be accurate for very large values. Use getLongIslandLevel(UUID playerUUID) instead. Returns the island level from the last time it was calculated. Note this does not calculate the island level.
`org.bukkit.Location`	`getIslandLocation(java.util.UUID playerUUID)` Provides the location of the player's island, either the team island or their own
`java.lang.String`	`getIslandName(java.util.UUID owner)` Get name of the island owned by owner
`com.wasteofplastic.askyblock.Island`	`getIslandOwnedBy(java.util.UUID playerUUID)` Obtains a copy of the island object owned by playerUUID
`org.bukkit.World`	`getIslandWorld()` Get the island overworld
`long`	`getLongIslandLevel(java.util.UUID playerUUID)` Returns the island level from the last time it was calculated.
`java.util.Map<java.util.UUID,java.lang.Long>`	`getLongTopTen()` Get the top ten list
`org.bukkit.World`	`getNetherWorld()` Get the nether world
`java.util.HashMap<java.util.UUID,com.wasteofplastic.askyblock.Island>`	`getOwnedIslands()` Get a copy of the ownership map of islands
`java.util.UUID`	`getOwner(org.bukkit.Location location)` Returns the owner of an island from the location.
`int`	`getResetsLeft(java.util.UUID playerUUID)` Get the number of resets left for this player
`org.bukkit.Location`	`getSpawnLocation()` Provides spawn location
`int`	`getSpawnRange()` Provides the spawn range
`java.util.UUID`	`getTeamLeader(java.util.UUID playerUUID)` Get Team Leader
`java.util.List<java.util.UUID>`	`getTeamMembers(java.util.UUID playerUUID)` Get a list of team members.
`java.util.Map<java.util.UUID,java.lang.Integer>`	`getTopTen()` Deprecated. Island levels are now stored as longs, so the int value may not be accurate Get the top ten list
`org.bukkit.Location`	`getWarp(java.util.UUID playerUUID)` Provides location of the player's warp sign
`java.lang.String`	`getWarpOwner(org.bukkit.Location location)` Get the owner of the warp at location
`boolean`	`hasIsland(java.util.UUID playerUUID)` Status of island ownership.
`boolean`	`inTeam(java.util.UUID playerUUID)`
`boolean`	`isAtSpawn(org.bukkit.Location location)` Checks if a location is at spawn or not
`boolean`	`isCoop(org.bukkit.entity.Player player)` Player is in a coop or not
`boolean`	`islandAtLocation(org.bukkit.Location location)` Determines if an island is at a location in this area location.
`boolean`	`isLeader(java.util.UUID playerUUID)` Find out if this player is a team leader or not.
`boolean`	`isNewNether()` Whether the new nether is being used or not
`boolean`	`isOnIsland(org.bukkit.entity.Player owner, org.bukkit.entity.Player target)` Checks to see if a player is trespassing on another player's island.
`java.util.Set<java.util.UUID>`	`listWarps()` Lists all the known warps.
`boolean`	`locationIsOnIsland(org.bukkit.entity.Player player, org.bukkit.Location location)` Checks if a specific location is within the protected range of an island owned by the player
`org.bukkit.Location`	`locationIsOnIsland(java.util.Set<org.bukkit.Location> islandTestLocations, org.bukkit.Location loc)` Finds out if location is within a set of island locations and returns the one that is there or null if not.
`boolean`	`playerIsOnIsland(org.bukkit.entity.Player player)` Checks if an online player is on their island, on a team island or on a coop island
`boolean`	`setIslandBiome(org.bukkit.Location islandLoc, org.bukkit.block.Biome biomeType)` Sets all blocks in an island to a specified biome type
`void`	`setIslandLevel(java.util.UUID playerUUID, int level)` Sets the player's island level.
`void`	`setIslandName(java.util.UUID owner, java.lang.String name)` Set the island name
`boolean`	`setMessage(java.util.UUID playerUUID, java.lang.String message)` Sets a message for the player to receive next time they login
`void`	`setResetsLeft(java.util.UUID playerUUID, int resets)` Set the number of resets left for this player
`void`	`tellOfflineTeam(java.util.UUID playerUUID, java.lang.String message)` Sends a message to every player in the team that is offline If the player is not in a team, nothing happens.
`void`	`updateWarpPanel()` Forces the warp panel to update and the warp list event to fire so that the warps can be sorted how you like.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static ASkyBlockAPI getInstance()
```
    Returns:
    
    the instance
  - getChallengeStatus
```
public java.util.Map<java.lang.String,java.lang.Boolean> getChallengeStatus(java.util.UUID playerUUID)
```
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    Map of all of the known challenges with a boolean marking them as complete (true) or incomplete (false). This is a view of the challenges map that only allows read operations.
  - getChallengeTimes
```
public java.util.Map<java.lang.String,java.lang.Integer> getChallengeTimes(java.util.UUID playerUUID)
```
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    Map of all of the known challenges and how many times each one has been completed. This is a view of the challenges map that only allows read operations.
  - getHomeLocation
```
public org.bukkit.Location getHomeLocation(java.util.UUID playerUUID)
```
  - getIslandLevel
```
public int getIslandLevel(java.util.UUID playerUUID)
```
    Deprecated. Island level is now a long and the int value may not be accurate for very large values. Use getLongIslandLevel(UUID playerUUID) instead. Returns the island level from the last time it was calculated. Note this does not calculate the island level.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    the last level calculated for the island or zero if none.
  - getLongIslandLevel
```
public long getLongIslandLevel(java.util.UUID playerUUID)
```
    Returns the island level from the last time it was calculated. Note this does not calculate the island level.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    the last level calculated for the island or zero if none.
  - setIslandLevel
```
public void setIslandLevel(java.util.UUID playerUUID,
                           int level)
```
    Sets the player's island level. Does not calculate it and does not set the level of any team members. You will need to check if the player is in a team and individually set the level of each team member. This value will be overwritten if the players run the build-in level command or if the island level is calculated some other way, e.g. at login or via an admin command.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    level - - level to set
  - calculateIslandLevel
```
public boolean calculateIslandLevel(java.util.UUID playerUUID)
```
    Calculates the island level. Only the fast calc is supported. The island calculation runs async and fires an IslandLevelEvent when completed or use getIslandLevel(playerUUID). See https://gist.github.com/tastybento/e81d2403c03f2fe26642 for example code.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    true if player has an island, false if not
  - getIslandLocation
```
public org.bukkit.Location getIslandLocation(java.util.UUID playerUUID)
```
    Provides the location of the player's island, either the team island or their own
    
    Parameters:
    
    playerUUID - - the player's UUID - players UUID
    
    Returns:
    
    Location of island
  - getOwner
```
public java.util.UUID getOwner(org.bukkit.Location location)
```
    Returns the owner of an island from the location. Uses the grid lookup and is quick
    
    Parameters:
    
    location - - location to check
    
    Returns:
    
    UUID of owner
  - getTeamLeader
```
public java.util.UUID getTeamLeader(java.util.UUID playerUUID)
```
    Get Team Leader
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    UUID of Team Leader or null if there is none. Use inTeam to check.
  - getTeamMembers
```
public java.util.List<java.util.UUID> getTeamMembers(java.util.UUID playerUUID)
```
    Get a list of team members. This is a copy and changing the return value will not affect the membership.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    List of team members, including the player. Empty if there are none.
  - getWarp
```
public org.bukkit.Location getWarp(java.util.UUID playerUUID)
```
    Provides location of the player's warp sign
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    Location of sign or null if one does not exist
  - getWarpOwner
```
public java.lang.String getWarpOwner(org.bukkit.Location location)
```
    Get the owner of the warp at location
    
    Parameters:
    
    location - - location of the warp
    
    Returns:
    
    Returns name of player or empty string if there is no warp at that spot
  - hasIsland
```
public boolean hasIsland(java.util.UUID playerUUID)
```
    Status of island ownership. Team members do not have islands of their own, only leaders do.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    true if player has an island, false if the player does not.
  - inTeam
```
public boolean inTeam(java.util.UUID playerUUID)
```
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    true if in a team
  - islandAtLocation
```
public boolean islandAtLocation(org.bukkit.Location location)
```
    Determines if an island is at a location in this area location. Also checks if the spawn island is in this area. Checks for bedrock within limits and also looks in the file system. Quite processor intensive.
    
    Parameters:
    
    location - - location to check
    
    Returns:
    
    true if there is an island in that location, false if not
  - isOnIsland
```
public boolean isOnIsland(org.bukkit.entity.Player owner,
                          org.bukkit.entity.Player target)
```
    Checks to see if a player is trespassing on another player's island. Both players must be online.
    
    Parameters:
    
    owner - - player owner or team member of an island
    
    target - - player who may be doing the trespassing
    
    Returns:
    
    true if they are on the island otherwise false.
  - listWarps
```
public java.util.Set<java.util.UUID> listWarps()
```
    Lists all the known warps. As each player can have only one warp, the player's UUID is used. It can be displayed however you like to other users. This is a copy of the set and changing it will not affect the actual set of warps.
    
    Returns:
    
    String set of warps
  - updateWarpPanel
```
public void updateWarpPanel()
```
    Forces the warp panel to update and the warp list event to fire so that the warps can be sorted how you like.
  - locationIsOnIsland
```
public boolean locationIsOnIsland(org.bukkit.entity.Player player,
                                  org.bukkit.Location location)
```
    Checks if a specific location is within the protected range of an island owned by the player
    
    Parameters:
    
    player - - player object
    
    location - - location to check
    
    Returns:
    
    true if the location is on an island owner by player
  - locationIsOnIsland
```
public org.bukkit.Location locationIsOnIsland(java.util.Set<org.bukkit.Location> islandTestLocations,
                                              org.bukkit.Location loc)
```
    Finds out if location is within a set of island locations and returns the one that is there or null if not. The islandTestLocations should be the center location of an island. The check is done to see if loc is inside the protected range of any of the islands given.
    
    Parameters:
    
    islandTestLocations - - Set of island locations to check
    
    loc - - location to check
    
    Returns:
    
    the island location that is in the set of locations or null if none
  - playerIsOnIsland
```
public boolean playerIsOnIsland(org.bukkit.entity.Player player)
```
    Checks if an online player is on their island, on a team island or on a coop island
    
    Parameters:
    
    player - - the player who is being checked
    
    Returns:
    
    - true if they are on their island, otherwise false
  - setIslandBiome
```
public boolean setIslandBiome(org.bukkit.Location islandLoc,
                              org.bukkit.block.Biome biomeType)
```
    Sets all blocks in an island to a specified biome type
    
    Parameters:
    
    islandLoc - - island location
    
    biomeType - - biome type
    
    Returns:
    
    true if the setting was successful
  - setMessage
```
public boolean setMessage(java.util.UUID playerUUID,
                          java.lang.String message)
```
    Sets a message for the player to receive next time they login
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    message - - message to set
    
    Returns:
    
    true if player is offline, false if online
  - tellOfflineTeam
```
public void tellOfflineTeam(java.util.UUID playerUUID,
                            java.lang.String message)
```
    Sends a message to every player in the team that is offline If the player is not in a team, nothing happens.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    message - - message to send
  - isCoop
```
public boolean isCoop(org.bukkit.entity.Player player)
```
    Player is in a coop or not
    
    Parameters:
    
    player - - player object to check
    
    Returns:
    
    true if player is in a coop, otherwise false
  - getCoopIslands
```
public java.util.Set<org.bukkit.Location> getCoopIslands(org.bukkit.entity.Player player)
```
    Find out which coop islands player is a part of
    
    Parameters:
    
    player - - player object to check
    
    Returns:
    
    set of locations of islands or empty if none
  - getSpawnLocation
```
public org.bukkit.Location getSpawnLocation()
```
    Provides spawn location
    
    Returns:
    
    Location of spawn's central point
  - getSpawnRange
```
public int getSpawnRange()
```
    Provides the spawn range
    
    Returns:
    
    spawn range
  - isAtSpawn
```
public boolean isAtSpawn(org.bukkit.Location location)
```
    Checks if a location is at spawn or not
    
    Parameters:
    
    location - - location to check
    
    Returns:
    
    true if at spawn
  - getIslandWorld
```
public org.bukkit.World getIslandWorld()
```
    Get the island overworld
    
    Returns:
    
    the island overworld
  - getNetherWorld
```
public org.bukkit.World getNetherWorld()
```
    Get the nether world
    
    Returns:
    
    the nether world
  - isNewNether
```
public boolean isNewNether()
```
    Whether the new nether is being used or not
    
    Returns:
    
    true if new nether is being used
  - getTopTen
```
public java.util.Map<java.util.UUID,java.lang.Integer> getTopTen()
```
    Deprecated. Island levels are now stored as longs, so the int value may not be accurate Get the top ten list
    
    Returns:
    
    Top ten list
  - getLongTopTen
```
public java.util.Map<java.util.UUID,java.lang.Long> getLongTopTen()
```
    Get the top ten list
    
    Returns:
    
    Top ten list
  - getIslandOwnedBy
```
public com.wasteofplastic.askyblock.Island getIslandOwnedBy(java.util.UUID playerUUID)
```
    Obtains a copy of the island object owned by playerUUID
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    copy of Island object
  - getIslandAt
```
public com.wasteofplastic.askyblock.Island getIslandAt(org.bukkit.Location location)
```
    Returns the Island object for an island at this location or null if one does not exist
    
    Parameters:
    
    location - - location requested
    
    Returns:
    
    copy of Island object
  - getIslandCount
```
public int getIslandCount()
```
    Returns:
    
    how many islands are in the world (that the plugin knows of)
  - getOwnedIslands
```
public java.util.HashMap<java.util.UUID,com.wasteofplastic.askyblock.Island> getOwnedIslands()
```
    Get a copy of the ownership map of islands
    
    Returns:
    
    Hashmap of owned islands with owner UUID as a key
  - getIslandName
```
public java.lang.String getIslandName(java.util.UUID owner)
```
    Get name of the island owned by owner
    
    Parameters:
    
    owner - - player's UUID
    
    Returns:
    
    Returns the name of owner's island, or the owner's name if there is none.
  - setIslandName
```
public void setIslandName(java.util.UUID owner,
                          java.lang.String name)
```
    Set the island name
    
    Parameters:
    
    owner - - player's UUID
    
    name - - name to set
  - getAllChallenges
```
public java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> getAllChallenges()
```
    Get all the challenges
    
    Returns:
    
    challenges per level
  - getResetsLeft
```
public int getResetsLeft(java.util.UUID playerUUID)
```
    Get the number of resets left for this player
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    Number of resets left
  - setResetsLeft
```
public void setResetsLeft(java.util.UUID playerUUID,
                          int resets)
```
    Set the number of resets left for this player
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    resets - - number to set
  - isLeader
```
public boolean isLeader(java.util.UUID playerUUID)
```
    Find out if this player is a team leader or not. If the player is not in a team, the result will always be false.
    
    Parameters:
    
    playerUUID - - the player's UUID - player's UUID
    
    Returns:
    
    true if the player is in a team and is the leader

Class ASkyBlockAPI

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getChallengeStatus

getChallengeTimes

getHomeLocation

getIslandLevel

getLongIslandLevel

setIslandLevel

calculateIslandLevel

getIslandLocation

getOwner

getTeamLeader

getTeamMembers

getWarp

getWarpOwner

hasIsland

inTeam

islandAtLocation

isOnIsland

listWarps

updateWarpPanel

locationIsOnIsland

locationIsOnIsland

playerIsOnIsland

setIslandBiome

setMessage

tellOfflineTeam

isCoop

getCoopIslands

getSpawnLocation

getSpawnRange

isAtSpawn

getIslandWorld

getNetherWorld

isNewNether

getTopTen

getLongTopTen

getIslandOwnedBy

getIslandAt

getIslandCount

getOwnedIslands

getIslandName

setIslandName

getAllChallenges

getResetsLeft

setResetsLeft

isLeader