me.eccentric_nz.TARDIS.api

Interface TardisAPI

All Known Implementing Classes:

TARDII

public interface TardisAPI

Method Summary

Modifier and Type	Method and Description
int	getIdOfTARDISPlayerIsIn(org.bukkit.entity.Player p) Get the id of the TARDIS a player is in.
int	getIdOfTARDISPlayerIsIn(java.util.UUID uuid) Get the id of the TARDIS a player is in.
TARDISLocationGetters	getLocationUtils() Get a handle for the TARDIS utilities.
java.util.List<java.lang.String>	getOverWorlds() Get a string list of TARDIS enabled overworlds on the server.
java.util.List<java.lang.String>	getPlayersInTARDIS(int id) Get the players in a TARDIS.
java.util.List<java.lang.String>	getPlayersInTARDIS(org.bukkit.entity.Player p) Get the players in a TARDIS.
java.util.List<java.lang.String>	getPlayersInTARDIS(java.util.UUID uuid) Get the players in a TARDIS.
org.bukkit.Location	getRandomEndLocation(org.bukkit.entity.Player p) Get a random THE_END location from a random world.
org.bukkit.Location	getRandomEndLocation(java.lang.String world, org.bukkit.entity.Player p) Get a random THE_END location from a specific world.
org.bukkit.Location	getRandomLocation(java.util.List<java.lang.String> worlds, org.bukkit.entity.Player p) Get a random location from a provided list of worlds in a random environment.
org.bukkit.Location	getRandomLocation(java.util.List<java.lang.String> worlds, org.bukkit.World.Environment environment, Parameters params) Get a random location from a provided list of worlds in the specified environment.
org.bukkit.Location	getRandomLocation(java.util.List<java.lang.String> worlds, org.bukkit.World.Environment environment, org.bukkit.entity.Player p) Get a random location from a provided list of worlds in the specified environment.
org.bukkit.Location	getRandomNetherLocation(org.bukkit.entity.Player p) Get a random OVERWORLD location from a random world.
org.bukkit.Location	getRandomNetherLocation(java.lang.String world, org.bukkit.entity.Player p) Get a random NETHER location from a specific world.
org.bukkit.Location	getRandomOverworldLocation(org.bukkit.entity.Player p) Get a random OVERWORLD location from a random world.
org.bukkit.Location	getRandomOverworldLocation(java.lang.String world, org.bukkit.entity.Player p) Get a random OVERWORLD location from a specific world.
TARDISPluginRespect	getRespect() Get a handle for the TARDIS Plugin Respect.
java.util.HashMap<java.lang.String,org.bukkit.inventory.ShapedRecipe>	getShapedRecipes() Get the TARDIS shaped recipes.
java.util.HashMap<java.lang.String,org.bukkit.inventory.ShapelessRecipe>	getShapelessRecipes() Get the TARDIS shapeless recipes.
java.util.List<java.lang.String>	getTARDISCompanions(int id) Get the companions of a TARDIS.
java.util.List<java.lang.String>	getTARDISCompanions(org.bukkit.entity.Player p) Get the companions of a TARDIS.
java.util.List<java.lang.String>	getTARDISCompanions(java.util.UUID uuid) Get the companions of a TARDIS.
org.bukkit.Location	getTARDISCurrentLocation(int id) Retrieves a TARDIS's current location.
org.bukkit.Location	getTARDISCurrentLocation(org.bukkit.entity.Player p) Retrieves a TARDIS's current location.
org.bukkit.Location	getTARDISCurrentLocation(java.util.UUID uuid) Retrieves a TARDIS's current location.
Tardis	getTardisData(int id) Get information from the database for a TARDIS.
Tardis	getTardisData(org.bukkit.entity.Player player) Convenience method to get information from the database for a TARDIS.
Tardis	getTardisData(java.util.UUID uuid) Convenience method to get information from the database for a TARDIS.
TARDISData	getTARDISMapData(int id) Retries the Current TARDIS location, chameleon preset, powered and siege status for the Dynmap-TARDIS plugin.
org.bukkit.Location	getTARDISNextLocation(int id) Retrieves a TARDIS's next location.
java.lang.String	getTARDISPlayerIsIn(org.bukkit.entity.Player p) Get the TARDIS a player is in.
java.lang.String	getTARDISPlayerIsIn(java.util.UUID uuid) Get the TARDIS a player is in.
java.util.HashMap<java.lang.String,java.lang.Integer>	getTimelordMap() Fetches a map of TARDIS owners and ids.
TARDISUtils	getUtils() Get a handle for the TARDIS utilities.
java.util.List<java.lang.String>	getWallFloorBlocks() Get the TARDIS wall and floor block names.
java.util.List<java.lang.String>	getWorlds() Get a string list of TARDIS enabled worlds on the server.
boolean	isPlayerGeneticallyModified(org.bukkit.entity.Player p) Get whether a player is currently genetically modified.
boolean	isPlayerGeneticallyModified(java.util.UUID uuid) Get whether a player is currently genetically modified.
boolean	isPlayerInZeroRoom(org.bukkit.entity.Player p) Get whether a player is in a Zero room.
boolean	isPlayerInZeroRoom(java.util.UUID uuid) Get whether a player is in a Zero room.
boolean	setChameleonPreset(int id, PRESET preset, boolean rebuild) Set the Chameleon Preset for a TARDIS.
boolean	setChameleonPreset(org.bukkit.entity.Player player, PRESET preset, boolean rebuild) Convenience method to set the Chameleon Preset for a TARDIS.
boolean	setChameleonPreset(java.util.UUID uuid, PRESET preset, boolean rebuild) Convenience method to set the Chameleon Preset for a TARDIS.
java.lang.String	setDesktopWallAndFloor(int id, java.lang.String wall, java.lang.String floor, boolean artron) Change the desktop theme of a TARDIS.
java.lang.String	setDesktopWallAndFloor(java.util.UUID uuid, java.lang.String wall, java.lang.String floor, boolean artron) Convenience method to change the desktop theme of a TARDIS.
boolean	setDestination(int id, org.bukkit.Location location, boolean travel) Set a TARDIS's next destination.
boolean	setDestination(org.bukkit.entity.Player player, org.bukkit.Location location, boolean travel) Convenience method to set a TARDIS's next destination.
boolean	setDestination(java.util.UUID uuid, org.bukkit.Location location, boolean travel) Convenience method to set a TARDIS's next destination.
void	spawnAbandonedTARDIS(org.bukkit.Location location) Convenience method to spawn an abandoned TARDIS at the specified Bukkit Location.
void	spawnAbandonedTARDIS(org.bukkit.Location location, java.lang.String type, PRESET preset, COMPASS direction) Spawn an abandoned TARDIS at the specified Bukkit Location.

Method Detail

getTimelordMap

java.util.HashMap<java.lang.String,java.lang.Integer> getTimelordMap()

Fetches a map of TARDIS owners and ids.

Returns:

a map of TARDIS owner names and TARDIS ids

getTARDISCurrentLocation

org.bukkit.Location getTARDISCurrentLocation(int id)

Retrieves a TARDIS's current location.

Parameters:

id - the TARDIS id to retrieve the location for

Returns:

the current TARDIS location or null if not found

getTARDISCurrentLocation

org.bukkit.Location getTARDISCurrentLocation(org.bukkit.entity.Player p)

Retrieves a TARDIS's current location.

Parameters:

p - the Time Lord of the TARDIS to retrieve the location for

Returns:

the current TARDIS location or null if not found

getTARDISCurrentLocation

org.bukkit.Location getTARDISCurrentLocation(java.util.UUID uuid)

Retrieves a TARDIS's current location.

Parameters:

uuid - the UUID of the TARDIS' Time Lord to retrieve the location for

Returns:

the current TARDIS location or null if not found

getTARDISNextLocation

org.bukkit.Location getTARDISNextLocation(int id)

Retrieves a TARDIS's next location.

Parameters:

id - the TARDIS id to retrieve the location for

Returns:

the current TARDIS location or null if not found

getTARDISMapData

TARDISData getTARDISMapData(int id)

Retries the Current TARDIS location, chameleon preset, powered and siege status for the Dynmap-TARDIS plugin.

Parameters:

id - the TARDIS id to retrieve the data for

Returns:

the current TARDIS data or null if not found

getRandomLocation

org.bukkit.Location getRandomLocation(java.util.List<java.lang.String> worlds,
                                      org.bukkit.World.Environment environment,
                                      Parameters params)

Get a random location from a provided list of worlds in the specified environment. If environment is null, then it will choose a random one.

Parameters:

worlds - a List of world names to search

environment - the world type to search

params - a Parameters object determining what flags to check for when getting the Location

Returns:

a random Location or null if one could not be found

getRandomLocation

org.bukkit.Location getRandomLocation(java.util.List<java.lang.String> worlds,
                                      org.bukkit.World.Environment environment,
                                      org.bukkit.entity.Player p)

Get a random location from a provided list of worlds in the specified environment. If environment is null, then it will choose a random one.

Parameters:

worlds - a List of world names to search

environment - the world type to search

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomLocation

org.bukkit.Location getRandomLocation(java.util.List<java.lang.String> worlds,
                                      org.bukkit.entity.Player p)

Get a random location from a provided list of worlds in a random environment.

Parameters:

worlds - a List of world names to search

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomOverworldLocation

org.bukkit.Location getRandomOverworldLocation(org.bukkit.entity.Player p)

Get a random OVERWORLD location from a random world.

Parameters:

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomOverworldLocation

org.bukkit.Location getRandomOverworldLocation(java.lang.String world,
                                               org.bukkit.entity.Player p)

Get a random OVERWORLD location from a specific world.

Parameters:

world - the world to search

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomNetherLocation

org.bukkit.Location getRandomNetherLocation(org.bukkit.entity.Player p)

Get a random OVERWORLD location from a random world.

Parameters:

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomNetherLocation

org.bukkit.Location getRandomNetherLocation(java.lang.String world,
                                            org.bukkit.entity.Player p)

Get a random NETHER location from a specific world.

Parameters:

world - the world to search

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomEndLocation

org.bukkit.Location getRandomEndLocation(org.bukkit.entity.Player p)

Get a random THE_END location from a random world.

Parameters:

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getRandomEndLocation

org.bukkit.Location getRandomEndLocation(java.lang.String world,
                                         org.bukkit.entity.Player p)

Get a random THE_END location from a specific world.

Parameters:

world - the world to search

p - the player to get the location for

Returns:

a random Location or null if one could not be found

getWorlds

java.util.List<java.lang.String> getWorlds()

Get a string list of TARDIS enabled worlds on the server.

Returns:

a list of worlds

getOverWorlds

java.util.List<java.lang.String> getOverWorlds()

Get a string list of TARDIS enabled overworlds on the server.

Returns:

a list of worlds

getTARDISPlayerIsIn

java.lang.String getTARDISPlayerIsIn(org.bukkit.entity.Player p)

Get the TARDIS a player is in.

Parameters:

p - the player to query

Returns:

a string containing the Time Lord (player name) of the TARDIS the player is in

getTARDISPlayerIsIn

java.lang.String getTARDISPlayerIsIn(java.util.UUID uuid)

Get the TARDIS a player is in.

Parameters:

uuid - the UUID of the player

Returns:

a string containing the Time Lord (player name) of the TARDIS the player is in

getIdOfTARDISPlayerIsIn

int getIdOfTARDISPlayerIsIn(org.bukkit.entity.Player p)

Get the id of the TARDIS a player is in.

Parameters:

p - the player to query

Returns:

the id of the TARDIS the player is in

getIdOfTARDISPlayerIsIn

int getIdOfTARDISPlayerIsIn(java.util.UUID uuid)

Get the id of the TARDIS a player is in.

Parameters:

uuid - the UUID of the player

Returns:

the id of the TARDIS the player is in

getPlayersInTARDIS

java.util.List<java.lang.String> getPlayersInTARDIS(int id)

Get the players in a TARDIS.

Parameters:

id - the tardis_id of the TARDIS

Returns:

a List of player names

getPlayersInTARDIS

java.util.List<java.lang.String> getPlayersInTARDIS(org.bukkit.entity.Player p)

Get the players in a TARDIS.

Parameters:

p - the Player who is the TARDIS' Time Lord

Returns:

a List of (online) player names

getPlayersInTARDIS

java.util.List<java.lang.String> getPlayersInTARDIS(java.util.UUID uuid)

Get the players in a TARDIS.

Parameters:

uuid - the UUID of the TARDIS' Time Lord

Returns:

a List of (online) player names

getTARDISCompanions

java.util.List<java.lang.String> getTARDISCompanions(int id)

Get the companions of a TARDIS.

Parameters:

id - the tardis_id of the TARDIS

Returns:

a List of companion names

getTARDISCompanions

java.util.List<java.lang.String> getTARDISCompanions(org.bukkit.entity.Player p)

Get the companions of a TARDIS.

Parameters:

p - the Player who is the TARDIS' Time Lord

Returns:

a List of (online) companion names

getTARDISCompanions

java.util.List<java.lang.String> getTARDISCompanions(java.util.UUID uuid)

Get the companions of a TARDIS.

Parameters:

uuid - the UUID of the TARDIS' Time Lord

Returns:

a List of (online) companion names

isPlayerInZeroRoom

boolean isPlayerInZeroRoom(org.bukkit.entity.Player p)

Get whether a player is in a Zero room.

Parameters:

p - the player to query

Returns:

true if the player is in the Zero room, otherwise false

isPlayerInZeroRoom

boolean isPlayerInZeroRoom(java.util.UUID uuid)

Get whether a player is in a Zero room.

Parameters:

uuid - the UUID of the player to query

Returns:

true if the player is in the Zero room, otherwise false

isPlayerGeneticallyModified

boolean isPlayerGeneticallyModified(org.bukkit.entity.Player p)

Get whether a player is currently genetically modified.

Parameters:

p - the player to query

Returns:

true if the player is in the Zero room, otherwise false

isPlayerGeneticallyModified

boolean isPlayerGeneticallyModified(java.util.UUID uuid)

Get whether a player is currently genetically modified.

Parameters:

uuid - the UUID of the player to query

Returns:

true if the player is in the Zero room, otherwise false

getUtils

TARDISUtils getUtils()

Get a handle for the TARDIS utilities.

Returns:

the TARDIS Utilities instance

getLocationUtils

TARDISLocationGetters getLocationUtils()

Get a handle for the TARDIS utilities.

Returns:

the TARDIS Utilities instance

getRespect

TARDISPluginRespect getRespect()

Get a handle for the TARDIS Plugin Respect.

Returns:

the TARDIS Plugin Respect instance

getShapedRecipes

java.util.HashMap<java.lang.String,org.bukkit.inventory.ShapedRecipe> getShapedRecipes()

Get the TARDIS shaped recipes.

Returns:

a HashMap<String, ShapedRecipe> containing the TARDIS shaped recipes

getShapelessRecipes

java.util.HashMap<java.lang.String,org.bukkit.inventory.ShapelessRecipe> getShapelessRecipes()

Get the TARDIS shapeless recipes.

Returns:

a HashMap<String, ShapelessRecipe> containing the TARDIS shapeless recipes

getWallFloorBlocks

java.util.List<java.lang.String> getWallFloorBlocks()

Get the TARDIS wall and floor block names.

Returns:

a String List containing the TARDIS wall and floor block names

setDestination

boolean setDestination(int id,
                       org.bukkit.Location location,
                       boolean travel)

Set a TARDIS's next destination.

Parameters:

id - the TARDIS id to set the destination for

location - the next location to travel to

travel - whether the TARDIS should travel to the destination

Returns:

true if the destination was set successfully

setDestination

boolean setDestination(java.util.UUID uuid,
                       org.bukkit.Location location,
                       boolean travel)

Convenience method to set a TARDIS's next destination.

Parameters:

uuid - the UUID of the Time Lord (player) to set the destination for

location - the next location to travel to

travel - whether the TARDIS should travel to the destination

Returns:

true if the destination was set successfully

setDestination

boolean setDestination(org.bukkit.entity.Player player,
                       org.bukkit.Location location,
                       boolean travel)

Convenience method to set a TARDIS's next destination.

Parameters:

player - the Time Lord (player) to set the destination for

location - the next location to travel to

travel - whether the TARDIS should travel to the destination

Returns:

true if the destination was set successfully

getTardisData

Tardis getTardisData(int id)

Get information from the database for a TARDIS.

Parameters:

id - the TARDIS id to get information for

Returns:

return a Tardis data object, or null if no data was found

getTardisData

Tardis getTardisData(java.util.UUID uuid)

Convenience method to get information from the database for a TARDIS.

Parameters:

uuid - the UUID of the Time Lord (player) of the TARDIS id to get information for

Returns:

return a Tardis data object, or null if no data was found

getTardisData

Tardis getTardisData(org.bukkit.entity.Player player)

Convenience method to get information from the database for a TARDIS.

Parameters:

player - the Time Lord (player) of the TARDIS to get information for

Returns:

return a Tardis data object, or null if no data was found

setChameleonPreset

boolean setChameleonPreset(int id,
                           PRESET preset,
                           boolean rebuild)

Set the Chameleon Preset for a TARDIS.

Parameters:

id - the TARDIS id to set the destination for

preset - the exterior preset to use

rebuild - whether to rebuild the TARDIS exterior

Returns:

true if the preset was set

setChameleonPreset

boolean setChameleonPreset(java.util.UUID uuid,
                           PRESET preset,
                           boolean rebuild)

Convenience method to set the Chameleon Preset for a TARDIS.

Parameters:

uuid - the UUID of the Time Lord (player) of the TARDIS to set the destination for

preset - the exterior preset to use

rebuild - whether to rebuild the TARDIS exterior

Returns:

true if the preset was set

setChameleonPreset

boolean setChameleonPreset(org.bukkit.entity.Player player,
                           PRESET preset,
                           boolean rebuild)

Convenience method to set the Chameleon Preset for a TARDIS.

Parameters:

player - the Time Lord (player) of the TARDIS to set the destination for

preset - the exterior preset to use

rebuild - whether to rebuild the TARDIS exterior

Returns:

true if the preset was set

spawnAbandonedTARDIS

void spawnAbandonedTARDIS(org.bukkit.Location location,
                          java.lang.String type,
                          PRESET preset,
                          COMPASS direction)
                   throws TARDISException

Spawn an abandoned TARDIS at the specified Bukkit Location.

Parameters:

location - the location to spawn the TARDIS

type - the type of interior to build

preset - the Chameleon preset of the exterior

direction - the direction of the TARDIS exterior ( this is the direction the player is facing when looking at the door)

Throws:

TARDISException - if the console type is not valid or TARDIS abandonment is disabled on the server

spawnAbandonedTARDIS

void spawnAbandonedTARDIS(org.bukkit.Location location)

Convenience method to spawn an abandoned TARDIS at the specified Bukkit Location. The interior will default to BUDGET, the exterior Chameleon Preset to FACTORY and the direction to SOUTH.

Parameters:

location - the location to spawn the TARDIS

setDesktopWallAndFloor

java.lang.String setDesktopWallAndFloor(int id,
                                        java.lang.String wall,
                                        java.lang.String floor,
                                        boolean artron)

Change the desktop theme of a TARDIS.

Parameters:

id - the TARDIS id to change the desktop for

wall - the wall block type to change to

floor - the floor block type to change to

artron - whether to check for and charge Artron Energy

Returns:

a comma separated String containing the wall and floor block names (so they can be restored) if the walls and floor were successfully changed, an empty String if not

setDesktopWallAndFloor

java.lang.String setDesktopWallAndFloor(java.util.UUID uuid,
                                        java.lang.String wall,
                                        java.lang.String floor,
                                        boolean artron)
                                 throws TARDISException

Convenience method to change the desktop theme of a TARDIS.

Parameters:

uuid - the UUID of the Time Lord (player) of the TARDIS to change the desktop for

wall - the wall block type to change to

floor - the floor block type to change to

artron - whether to check for and charge Artron Energy

Returns:

a comma separated String containing the wall and floor block names (so they can be restored) if the walls and floor were successfully changed, an empty String if not

Throws:

TARDISException - if the wall or floor type is not valid