eu.wauz.wauzcore.system

Class WauzRegion

java.lang.Object

eu.wauz.wauzcore.system.WauzRegion

public class WauzRegion
extends java.lang.Object

A region, generated from a region config file.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<WauzRegion>	children All regions inside this region.
private java.awt.geom.Ellipse2D	ellipse The ellipse, that represents the region.
private static java.lang.String	FLAG_BUILD The flag to allow building in a region.
private static java.lang.String	FLAG_PROTECTED The flag to prevent changes in a region.
private static java.lang.String	FLAG_PVP The flag to enable pvp in a region.
private java.util.List<java.lang.String>	flags The flags of this region.
private static java.util.List<WauzRegion>	masterRegions A list of all top level regions.
private java.lang.String	music The music that plays to players inside the region.
private WauzRegion	parent The region, this region is inside.
private java.awt.Polygon	polygon The polygon, that represents the region.
private static int	regionCount The number of all constructed regions.
private java.lang.String	regionKey The configuration key of this region.
private java.lang.String	subtitle The subtitle that is shown when entering the region.
private byte	temperature The base temperature of the region.
private java.lang.String	title The title that is shown when entering the region.
private java.lang.String	type The type of this region a text.
private java.lang.String	world The name of the world, that represents the region.

Constructor Summary

Constructors

Constructor and Description
WauzRegion(WauzRegion parent, java.lang.String regionKey) Constructs a region, based on the region file in the /WauzCore folder.

Method Summary

Modifier and Type	Method and Description
static boolean	disallowBlockChange(org.bukkit.block.Block block)
static boolean	disallowBuild(org.bukkit.block.Block block)
static boolean	disallowPvP(org.bukkit.entity.Entity attacker, org.bukkit.entity.Entity attacked)
void	enter(org.bukkit.entity.Player player) Called when a player enters the region.
java.util.List<WauzRegion>	getChildren()
java.awt.geom.Ellipse2D	getEllipse()
java.util.List<java.lang.String>	getFlags()
static WauzRegion	getNewRegion(org.bukkit.Location location) Finds out the region of a location, if the current region is unknown.
private static WauzRegion	getNewRegion(org.bukkit.Location location, WauzRegion region, boolean knownToBeInRegion) Finds out the region of a location, if the current region is known.
WauzRegion	getParent()
java.awt.Polygon	getPolygon()
java.lang.String	getRegionKey()
java.lang.String	getSubtitle()
byte	getTemperature()
java.lang.String	getTitle()
java.lang.String	getType()
java.lang.String	getWorld()
static void	init() Initializes all master regions and their sub regions.
private static boolean	insideEllipseRegion(org.bukkit.Location location, java.awt.geom.Ellipse2D ellipse)
private static boolean	insidePolygonRegion(org.bukkit.Location location, java.awt.Polygon polygon)
private static boolean	insideRegion(org.bukkit.Location location, WauzRegion region)
private static boolean	insideWorldRegion(org.bukkit.Location location, java.lang.String world)
static boolean	isCombatZone(org.bukkit.Location location)
static void	regionCheck(org.bukkit.entity.Player player) Checks if a player region is still valid and determines the new region, if not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

masterRegions

private static java.util.List<WauzRegion> masterRegions

A list of all top level regions.

regionCount

private static int regionCount

The number of all constructed regions.

FLAG_BUILD

private static final java.lang.String FLAG_BUILD

The flag to allow building in a region.

See Also:

Constant Field Values

FLAG_PROTECTED

private static final java.lang.String FLAG_PROTECTED

The flag to prevent changes in a region.

See Also:

Constant Field Values

FLAG_PVP

private static final java.lang.String FLAG_PVP

The flag to enable pvp in a region.

See Also:

Constant Field Values

parent

private WauzRegion parent

The region, this region is inside.

children

private java.util.List<WauzRegion> children

All regions inside this region.

regionKey

private java.lang.String regionKey

The configuration key of this region.

type

private java.lang.String type

The type of this region a text.

world

private java.lang.String world

The name of the world, that represents the region.

polygon

private java.awt.Polygon polygon

The polygon, that represents the region.

ellipse

private java.awt.geom.Ellipse2D ellipse

The ellipse, that represents the region.

title

private java.lang.String title

The title that is shown when entering the region.

subtitle

private java.lang.String subtitle

The subtitle that is shown when entering the region.

music

private java.lang.String music

The music that plays to players inside the region.

temperature

private byte temperature

The base temperature of the region.

flags

private java.util.List<java.lang.String> flags

The flags of this region.

Constructor Detail

WauzRegion

public WauzRegion(WauzRegion parent,
                  java.lang.String regionKey)

Constructs a region, based on the region file in the /WauzCore folder.

Parameters:

parent - The region, this region is inside.

regionKey - The configuration key of this region.

Method Detail

init

public static void init()

Initializes all master regions and their sub regions.

regionCheck

public static void regionCheck(org.bukkit.entity.Player player)

Checks if a player region is still valid and determines the new region, if not. Also handles region entering and changes the music, if the region has changed.

Parameters:

player - The player whose region should be updated.

See Also:

getNewRegion(Location), getNewRegion(Location, WauzRegion, boolean), enter(Player), WauzNoteBlockPlayer.play(Player)

disallowBuild

public static boolean disallowBuild(org.bukkit.block.Block block)

Parameters:

block - The affected block.

Returns:

If the block cannot be broken / built on.

disallowBlockChange

public static boolean disallowBlockChange(org.bukkit.block.Block block)

Parameters:

block - The affected block.

Returns:

If the block cannot be changed.

disallowPvP

public static boolean disallowPvP(org.bukkit.entity.Entity attacker,
                                  org.bukkit.entity.Entity attacked)

Parameters:

attacker - The entity that is attacking.

attacked - The entity that gets attacked.

Returns:

If the entities cannot hurt each other.

isCombatZone

public static boolean isCombatZone(org.bukkit.Location location)

Parameters:

location - The affected location.

Returns:

If players can hurt each other in this location.

getNewRegion

public static WauzRegion getNewRegion(org.bukkit.Location location)

Finds out the region of a location, if the current region is unknown.

Parameters:

location - The location to check.

Returns:

The recursively determined region of the location.

getNewRegion

private static WauzRegion getNewRegion(org.bukkit.Location location,
                                       WauzRegion region,
                                       boolean knownToBeInRegion)

Finds out the region of a location, if the current region is known.

Parameters:

location - The location to check.

region - The current region.

knownToBeInRegion - If it should not be checked if the current region is still valid.

Returns:

The recursively determined region of the location.

insideRegion

private static boolean insideRegion(org.bukkit.Location location,
                                    WauzRegion region)

Parameters:

location - The location to check.

region - The region to check.

Returns:

If the location is inside the region.

insideWorldRegion

private static boolean insideWorldRegion(org.bukkit.Location location,
                                         java.lang.String world)

Parameters:

location - The location to check.

world - The name of the world, that represents the region.

Returns:

If the location is inside the region.

insidePolygonRegion

private static boolean insidePolygonRegion(org.bukkit.Location location,
                                           java.awt.Polygon polygon)

Parameters:

location - The location to check.

polygon - The polygon, that represents the region.

Returns:

If the location is inside the region.

insideEllipseRegion

private static boolean insideEllipseRegion(org.bukkit.Location location,
                                           java.awt.geom.Ellipse2D ellipse)

Parameters:

location - The location to check.

ellipse - The ellipse, that represents the region.

Returns:

If the location is inside the region.

enter

public void enter(org.bukkit.entity.Player player)

Called when a player enters the region. Shows the title and switches music, if possible.

Parameters:

player - The player that entered the region.

getParent

public WauzRegion getParent()

Returns:

The region, this region is inside.

getChildren

public java.util.List<WauzRegion> getChildren()

Returns:

All regions inside this region.

getRegionKey

public java.lang.String getRegionKey()

Returns:

The configuration key of this region.

getType

public java.lang.String getType()

Returns:

The type of this region a text.

getWorld

public java.lang.String getWorld()

Returns:

The name of the world, that represents the region.

getPolygon

public java.awt.Polygon getPolygon()

Returns:

The polygon, that represents the region.

getEllipse

public java.awt.geom.Ellipse2D getEllipse()

Returns:

The ellipse, that represents the region.

getTitle

public java.lang.String getTitle()

Returns:

The title that is shown when entering the region.

getSubtitle

public java.lang.String getSubtitle()

Returns:

The subtitle that is shown when entering the region.

getTemperature

public byte getTemperature()

Returns:

The base temperature of the region.

getFlags

public java.util.List<java.lang.String> getFlags()

Returns:

The flags of this region.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The region key as a readable string.