gyurix.spigotutils

Class CuboidArea

java.lang.Object

gyurix.spigotutils.Area

gyurix.spigotutils.CuboidArea

All Implemented Interfaces:

ConfigSerialization.StringSerializable, java.lang.Cloneable

public class CuboidArea
extends Area
implements ConfigSerialization.StringSerializable, java.lang.Cloneable

Class representing a CuboidArea, with a first and second block location and with or without world parameter

Field Summary

Fields

Modifier and Type	Field and Description
BlockLocation	pos1 The first position of this CuboidArea, containing the minX, minY and minZ coordinates
BlockLocation	pos2 The second position of this CuboidArea, containing the maxX, maxY and maxZ coordinates

Fields inherited from class gyurix.spigotutils.Area

world

Constructor Summary

Constructors

Constructor and Description
CuboidArea() Constructs a new not properly set up CuboidArea
CuboidArea(BlockLocation pos1, BlockLocation pos2)
CuboidArea(LocationData pos1, LocationData pos2)
CuboidArea(java.lang.String in) Constructs a new CuboidArea from the given String
CuboidArea(java.lang.String world, BlockLocation pos1, BlockLocation pos2)

Method Summary

Modifier and Type	Method and Description
CuboidArea	add(int x, int y, int z)
CuboidArea	clone() Makes a clone of the CuboidArea by keeping all of it's properties
CuboidArea	cloneFixed() Makes a clone of this CuboidArea and fixes it's pos1 and pos2 using the @see fix method
boolean	contains(org.bukkit.block.Block loc)
boolean	contains(BlockLocation loc)
boolean	contains(int x, int z)
boolean	contains(org.bukkit.Location loc)
boolean	contains(LocationData loc)
void	fix() Fix the min and max points for ensuring that the pos1 contains the minX, minY and minZ, while the pos2 contains the maxX, maxY and maxZ and they does not contain these informations oppositely
java.util.List<org.bukkit.block.Block>	getBlocks(org.bukkit.World w)
LocationData	getCenter()
java.util.List<org.bukkit.block.Block>	getOutlineBlocks(org.bukkit.World w)
boolean	isBorder(int x, int z)
boolean	isDefined()
org.bukkit.Location	randomLoc()
org.bukkit.Location	randomLoc(org.bukkit.World w)
static void	resetOutlineBlock(org.bukkit.block.Block block, org.bukkit.entity.Player plr)
int	size()
CuboidArea	subtract(int x, int y, int z)
java.lang.String	toString()
UnlimitedYArea	toUnlimitedYArea() Converts this CuboidArea to an @see UnlimitedYArea

Methods inherited from class gyurix.spigotutils.Area

getBlocks, getOutlineBlocks, resetOutlineWithBlock, showOutlineWithBlock

Methods inherited from class java.lang.Object

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

Field Detail

pos1

public BlockLocation pos1

The first position of this CuboidArea, containing the minX, minY and minZ coordinates

pos2

public BlockLocation pos2

The second position of this CuboidArea, containing the maxX, maxY and maxZ coordinates

Constructor Detail

CuboidArea

public CuboidArea()

Constructs a new not properly set up CuboidArea

CuboidArea

public CuboidArea(java.lang.String in)

Constructs a new CuboidArea from the given String

Parameters:

in - - The String from which the CuboidArea should be constructed Accepted input String formats: world minX minY minZ maxX maxY maxZ world minX minY minZ maxX maxY maxZ

CuboidArea

public CuboidArea(java.lang.String world,
                  BlockLocation pos1,
                  BlockLocation pos2)

CuboidArea

public CuboidArea(LocationData pos1,
                  LocationData pos2)

CuboidArea

public CuboidArea(BlockLocation pos1,
                  BlockLocation pos2)

Method Detail

resetOutlineBlock

public static void resetOutlineBlock(org.bukkit.block.Block block,
                                     org.bukkit.entity.Player plr)

add

public CuboidArea add(int x,
                      int y,
                      int z)

clone

public CuboidArea clone()

Makes a clone of the CuboidArea by keeping all of it's properties

Overrides:

clone in class java.lang.Object

Returns:

The cloned version of this CuboidArea

toString

public java.lang.String toString()

Specified by:

toString in interface ConfigSerialization.StringSerializable

Overrides:

toString in class java.lang.Object

cloneFixed

public CuboidArea cloneFixed()

Makes a clone of this CuboidArea and fixes it's pos1 and pos2 using the @see fix method

Returns:

The cloned and fixed version of this CuboidArea

contains

public boolean contains(org.bukkit.Location loc)

contains

public boolean contains(org.bukkit.block.Block loc)

contains

public boolean contains(LocationData loc)

contains

public boolean contains(BlockLocation loc)

contains

public boolean contains(int x,
                        int z)

fix

public void fix()

Fix the min and max points for ensuring that the pos1 contains the minX, minY and minZ, while the pos2 contains the maxX, maxY and maxZ and they does not contain these informations oppositely

getBlocks

public java.util.List<org.bukkit.block.Block> getBlocks(org.bukkit.World w)

Specified by:

getBlocks in class Area

getCenter

public LocationData getCenter()

getOutlineBlocks

public java.util.List<org.bukkit.block.Block> getOutlineBlocks(org.bukkit.World w)

Specified by:

getOutlineBlocks in class Area

isBorder

public boolean isBorder(int x,
                        int z)

isDefined

public boolean isDefined()

randomLoc

public org.bukkit.Location randomLoc(org.bukkit.World w)

randomLoc

public org.bukkit.Location randomLoc()

size

public int size()

subtract

public CuboidArea subtract(int x,
                           int y,
                           int z)

toUnlimitedYArea

public UnlimitedYArea toUnlimitedYArea()

Converts this CuboidArea to an @see UnlimitedYArea

Returns:

The conversion result