me.eccentric_nz.TARDIS.travel

Class TARDISArea

java.lang.Object

me.eccentric_nz.TARDIS.travel.TARDISArea

public class TARDISArea
extends java.lang.Object

The control or console room of the Doctor's TARDIS is the space in which the operation of the craft is usually effected. It is dominated by a large, hexagonal console, typically in or near the middle of the room.

Constructor Summary

Constructors

Constructor and Description
TARDISArea(TARDIS plugin)

Method Summary

Modifier and Type	Method and Description
boolean	areaCheckInExile(java.lang.String area, org.bukkit.Location l) Checks if a location is contained within a specific TARDIS area.
boolean	areaCheckInExisting(org.bukkit.Location l) Checks if a location is contained within any TARDIS area.
TARDISAreaCheck	areaCheckInExistingArea(org.bukkit.Location l) Checks if a location is contained within any TARDIS area.
boolean	areaCheckLocPlayer(org.bukkit.entity.Player p, org.bukkit.Location l) Checks if a player has permission to travel to a TARDIS area.
java.lang.String	getExileArea(org.bukkit.entity.Player p) Gets the TARDIS area a player is exiled to.
org.bukkit.Location	getNextSpot(java.lang.String area) Gets the next available parking spot in a specified TARDIS area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TARDISArea

public TARDISArea(TARDIS plugin)

Method Detail

areaCheckInExisting

public boolean areaCheckInExisting(org.bukkit.Location l)

Checks if a location is contained within any TARDIS area.

Parameters:

l - a location object to check.

Returns:

true or false depending on whether the location is within an existing TARDIS area

areaCheckInExistingArea

public TARDISAreaCheck areaCheckInExistingArea(org.bukkit.Location l)

Checks if a location is contained within any TARDIS area.

Parameters:

l - a location object to check.

Returns:

a TARDISAreaCheck <Area, Boolean> with values dependent on whether the location is within an existing TARDIS area

areaCheckInExile

public boolean areaCheckInExile(java.lang.String area,
                                org.bukkit.Location l)

Checks if a location is contained within a specific TARDIS area.

Parameters:

area - the TARDIS area to check in.

l - a location object to check.

Returns:

true or false depending on whether the location is in the specified TARDIS area

areaCheckLocPlayer

public boolean areaCheckLocPlayer(org.bukkit.entity.Player p,
                                  org.bukkit.Location l)

Checks if a player has permission to travel to a TARDIS area.

Parameters:

p - a player to check.

l - a location object to check.

Returns:

true or false depending on whether the player has permission

getNextSpot

public org.bukkit.Location getNextSpot(java.lang.String area)

Gets the next available parking spot in a specified TARDIS area.

Parameters:

area - the TARDIS area to look in.

Returns:

the next free Location in an area

getExileArea

public java.lang.String getExileArea(org.bukkit.entity.Player p)

Gets the TARDIS area a player is exiled to.

Parameters:

p - a player to check.

Returns:

the area the player has been exiled to