me.eccentric_nz.TARDIS.utility

Class TARDISWorldGuardUtils

java.lang.Object

me.eccentric_nz.TARDIS.utility.TARDISWorldGuardUtils

public class TARDISWorldGuardUtils
extends java.lang.Object

Before a TARDIS becomes fully functional, it must be primed with the biological imprint of a Time Lord, normally done by simply having a Time Lord operate the TARDIS for the first time.

Constructor Summary

Constructors

Constructor and Description
TARDISWorldGuardUtils(TARDIS plugin) Checks if WorldGuard is on the server.

Method Summary

Modifier and Type	Method and Description
void	addMemberToRegion(org.bukkit.World w, java.lang.String owner, java.lang.String a) Adds a player to a region's membership.
void	addRechargerProtection(org.bukkit.entity.Player p, java.lang.String name, org.bukkit.Location one, org.bukkit.Location two) Adds a WorldGuard protected region to recharger location.
void	addRendererProtection(java.lang.String name, org.bukkit.Location one, org.bukkit.Location two) Adds a WorldGuard protected region to exterior renderer room.
void	addWGProtection(org.bukkit.entity.Player p, org.bukkit.Location one, org.bukkit.Location two) Adds a WorldGuard protected region to the inner TARDIS location.
void	addWGProtection(java.lang.String p, TARDISTIPSData data, org.bukkit.World w) Adds a WorldGuard protected region for a TIPS slot.
boolean	canBreakBlock(org.bukkit.entity.Player p, org.bukkit.block.Block b) Checks whether a block can be broken
boolean	canBuild(org.bukkit.entity.Player p, org.bukkit.Location l) Checks if a player can build (a Police Box) at this location.
boolean	canLand(org.bukkit.entity.Player p, org.bukkit.Location l) Checks if a player can land (a Police Box) at this location.
com.sk89q.worldguard.protection.regions.ProtectedRegion	getRegion(java.lang.String world, java.lang.String p) Gets a TARDIS WorldGuard region.
java.util.List<java.lang.String>	getRegions(org.bukkit.World w) Gets a List of all TARDIS regions in a world where the build flag is set.
java.util.List<java.lang.String>	getTARDISRegions(org.bukkit.World w) Gets a List of all TARDIS regions in a world.
boolean	mobsCanSpawnAtLocation(org.bukkit.Location l) Checks whether there is a protected region at a location and if so whether mobs can spawn.
void	removeAllMembersFromRegion(org.bukkit.World w, java.lang.String owner) Removes all members from a region's membership.
void	removeMemberFromRegion(org.bukkit.World w, java.lang.String owner, java.lang.String a) Removes a player from a region's membership.
void	removeRechargerRegion(java.lang.String name) Removes the WorldGuard region when the recharger is removed.
void	removeRegion(org.bukkit.Location l) Removes the WorldGuard region when the TARDIS is deleted.
void	removeRegion(org.bukkit.World w, java.lang.String p) Removes the WorldGuard region when the TARDIS is deleted.
void	removeRoomRegion(org.bukkit.World w, java.lang.String p, java.lang.String r) Removes the exterior rendering room region when the room is jettisoned or the TARDIS is deleted.
void	setEntryExitFlags(java.lang.String world, java.lang.String owner, boolean allow) Sets the entry and exit flags for a region.
void	sponge(org.bukkit.block.Block b, boolean clear) Sets a block with the properties of a sponge
void	updateRegionForClaim(org.bukkit.Location location, java.util.UUID uuid) Updates the TARDIS WorldGuard region when the TARDIS has been claimed by a new player.
void	updateRegionForNameChange(org.bukkit.World w, java.lang.String o, java.util.UUID uuid, java.lang.String which) Updates the TARDIS WorldGuard region when the player name has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TARDISWorldGuardUtils

public TARDISWorldGuardUtils(TARDIS plugin)

Checks if WorldGuard is on the server.

Parameters:

plugin - an instance of the TARDIS plugin

Method Detail

canBuild

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

Checks if a player can build (a Police Box) at this location.

Parameters:

p - the player to check

l - the location to check

Returns:

true of false depending on whether the player has permission to build at this location

canLand

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

Checks if a player can land (a Police Box) at this location.

Parameters:

p - the player to check

l - the location to check

Returns:

true of false depending on whether the player has permission to land at this location

addWGProtection

public void addWGProtection(org.bukkit.entity.Player p,
                            org.bukkit.Location one,
                            org.bukkit.Location two)

Adds a WorldGuard protected region to the inner TARDIS location. This stops other players and mobs from griefing the TARDIS :)

Parameters:

p - the player to assign as the owner of the region

one - a start location of a cuboid region

two - an end location of a cuboid region

addWGProtection

public void addWGProtection(java.lang.String p,
                            TARDISTIPSData data,
                            org.bukkit.World w)

Adds a WorldGuard protected region for a TIPS slot. This stops other players and mobs from griefing the TARDIS :)

Parameters:

p - the player to assign as the owner of the region

data - a TIPS Data container

w - the world we are creating the region in

addRechargerProtection

public void addRechargerProtection(org.bukkit.entity.Player p,
                                   java.lang.String name,
                                   org.bukkit.Location one,
                                   org.bukkit.Location two)

Adds a WorldGuard protected region to recharger location. A 3x3 block area is protected.

Parameters:

p - the player to assign as the owner of the region

name - the name of the recharger

one - a start location of a cuboid region

two - an end location of a cuboid region

addRendererProtection

public void addRendererProtection(java.lang.String name,
                                  org.bukkit.Location one,
                                  org.bukkit.Location two)

Adds a WorldGuard protected region to exterior renderer room.

Parameters:

name - the name of the recharger

one - a start location of a cuboid region

two - an end location of a cuboid region

removeRegion

public void removeRegion(org.bukkit.World w,
                         java.lang.String p)

Removes the WorldGuard region when the TARDIS is deleted.

Parameters:

w - the world the region is located in

p - the player's name

removeRegion

public void removeRegion(org.bukkit.Location l)

Removes the WorldGuard region when the TARDIS is deleted.

Parameters:

l - the TARDIS interior location

removeRechargerRegion

public void removeRechargerRegion(java.lang.String name)

Removes the WorldGuard region when the recharger is removed.

Parameters:

name - the name of the recharger to remove

removeRoomRegion

public void removeRoomRegion(org.bukkit.World w,
                             java.lang.String p,
                             java.lang.String r)

Removes the exterior rendering room region when the room is jettisoned or the TARDIS is deleted.

Parameters:

w - the world the region is located in

p - the player's name

r - the room region to remove

addMemberToRegion

public void addMemberToRegion(org.bukkit.World w,
                              java.lang.String owner,
                              java.lang.String a)

Adds a player to a region's membership.

Parameters:

w - the world the region is located in

owner - the player whose region it is

a - the player to add

removeMemberFromRegion

public void removeMemberFromRegion(org.bukkit.World w,
                                   java.lang.String owner,
                                   java.lang.String a)

Removes a player from a region's membership.

Parameters:

w - the world the region is located in

owner - the player whose region it is

a - the player to add

removeAllMembersFromRegion

public void removeAllMembersFromRegion(org.bukkit.World w,
                                       java.lang.String owner)

Removes all members from a region's membership.

Parameters:

w - the world the region is located in

owner - the player whose region it is

updateRegionForNameChange

public void updateRegionForNameChange(org.bukkit.World w,
                                      java.lang.String o,
                                      java.util.UUID uuid,
                                      java.lang.String which)

Updates the TARDIS WorldGuard region when the player name has changed.

Parameters:

w - the world the region is located in

o - the owner's name

uuid - the UUID of the player

which - the region type to update

updateRegionForClaim

public void updateRegionForClaim(org.bukkit.Location location,
                                 java.util.UUID uuid)

Updates the TARDIS WorldGuard region when the TARDIS has been claimed by a new player.

Parameters:

location - the TARDIS interior location

uuid - the UUID of the player

sponge

public void sponge(org.bukkit.block.Block b,
                   boolean clear)

Sets a block with the properties of a sponge

Parameters:

b - the sponge block

clear - whether to set the sponge area or remove it

canBreakBlock

public boolean canBreakBlock(org.bukkit.entity.Player p,
                             org.bukkit.block.Block b)

Checks whether a block can be broken

Parameters:

p - the player trying to break the block

b - the block

Returns:

whether the block can be broken

getRegion

public com.sk89q.worldguard.protection.regions.ProtectedRegion getRegion(java.lang.String world,
                                                                         java.lang.String p)

Gets a TARDIS WorldGuard region.

Parameters:

world - the world the region is in

p - the Time Lord whose region it is

Returns:

the protected region

getRegions

public java.util.List<java.lang.String> getRegions(org.bukkit.World w)

Gets a List of all TARDIS regions in a world where the build flag is set.

Parameters:

w - the world to get the regions for

Returns:

a list of TARDIS region names for this world

getTARDISRegions

public java.util.List<java.lang.String> getTARDISRegions(org.bukkit.World w)

Gets a List of all TARDIS regions in a world.

Parameters:

w - the world to get the regions for

Returns:

a list of TARDIS region names for this world

mobsCanSpawnAtLocation

public boolean mobsCanSpawnAtLocation(org.bukkit.Location l)

Checks whether there is a protected region at a location and if so whether mobs can spawn.

Parameters:

l - the location to check

Returns:

true if mobs can spawn, otherwise false

setEntryExitFlags

public void setEntryExitFlags(java.lang.String world,
                              java.lang.String owner,
                              boolean allow)

Sets the entry and exit flags for a region.

Parameters:

world - the world in which the region is located

owner - the player who owns the region

allow - whether the flag state should be set to allow or deny