net.risingworld.api.utils

Class Area

java.lang.Object

net.risingworld.api.utils.Area

public class Area
extends java.lang.Object

An Area describes an area in the game world. It has a start and end position, which are usually determined by block positions within a specific chunk (offset).

Field Summary

Fields

Modifier and Type	Field and Description
static Area	INFINITE An "infinite" area (more precisely, the largest possible area).

Constructor Summary

Constructors

Constructor and Description
Area() Creates an "empty" Area.
Area(Area area) Creates an Area with the same size as the provided Area.
Area(int minX, int minY, int minZ, int maxX, int maxY, int maxZ) Creates a new area from global min-/max-coordinates.
Area(int startcX, int startcY, int startcZ, int startbX, int startbY, int startbZ, int endcX, int endcY, int endcZ, int endbX, int endbY, int endbZ) Creates a new area.
Area(Vector3f globalStartPosition, Vector3f globalEndPosition) Creates a new area from global positions.
Area(Vector3i startChunk, Vector3i startBlock, Vector3i endChunk, Vector3i endBlock) Creates a new area.

Method Summary

Modifier and Type	Method and Description
void	deleteAttribute(java.lang.String key) Removes an attribute from this area.
boolean	equals(java.lang.Object o)
java.lang.Object	getAttribute(java.lang.String key) Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.
Vector3i	getEndBlockPosition()
Vector3i	getEndChunkPosition()
int	getID() Gets the internal unique id of this area (this id is only unique during runtime).
Vector3i	getStartBlockPosition()
Vector3i	getStartChunkPosition()
boolean	hasAttribute(java.lang.String key) Gets whether or not the provided attribute exists.
int	hashCode()
boolean	intersects(Area area) Checks whether or not the provided area intersects this area.
boolean	isPointInArea(float x, float y, float z) Gets whether or not the provided position is inside this area.
boolean	isPointInArea(int chunkx, int chunky, int chunkz, int blockx, int blocky, int blockz) Gets whether or not the provided position (chunkcoordinate + block position) is inside this area.
boolean	isPointInArea(Vector3f point) Gets whether or not the point is inside this area.
boolean	rearrange() Rearranges the values of this Area, i.e. the start position will be compared with the end position, and if the start position is less than the end position, the values will be swapped.
void	set(int minX, int minY, int minZ, int maxX, int maxY, int maxZ) Changes the area start and end positions.
void	set(int startcX, int startcY, int startcZ, int startbX, int startbY, int startbZ, int endcX, int endcY, int endcZ, int endbX, int endbY, int endbZ)
void	set(Vector3f globalStartPosition, Vector3f globalEndPosition) Changes start and end position of this area by getting the coordinates from global positions.
void	set(Vector3i startChunk, Vector3i startBlock, Vector3i endChunk, Vector3i endBlock) Changes the start and end positions of this area.
void	setAttribute(java.lang.String key, java.lang.Object value) Stores an attribute for this area.
java.lang.String	toString() Gets a String representation of this area.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INFINITE

public static final Area INFINITE

An "infinite" area (more precisely, the largest possible area). It covers the whole world.

Constructor Detail

Area

public Area()

Creates an "empty" Area.

Area

public Area(Area area)

Creates an Area with the same size as the provided Area.

Parameters:

area - the Area you want this Area to be adapted to.

Area

public Area(Vector3i startChunk,
            Vector3i startBlock,
            Vector3i endChunk,
            Vector3i endBlock)

Creates a new area.

Parameters:

startChunk - the start chunk offset.

startBlock - the start block position within the start chunk.

endChunk - the end chunk offset.

endBlock - the end block position within the end chunk.

Area

public Area(int startcX,
            int startcY,
            int startcZ,
            int startbX,
            int startbY,
            int startbZ,
            int endcX,
            int endcY,
            int endcZ,
            int endbX,
            int endbY,
            int endbZ)

Creates a new area.

Parameters:

startcX - the start chunk x offset.

startcY - the start chunk y offset.

startcZ - the start chunk z offset.

startbX - the start block x position within the start chunk.

startbY - the start block y position within the start chunk.

startbZ - the start block z position within the start chunk.

endcX - the end chunk x offset.

endcY - the end chunk y offset.

endcZ - the end chunk z offset.

endbX - the end block x position within the end chunk.

endbY - the end block y position within the end chunk.

endbZ - the end block z position within the end chunk.

Area

public Area(int minX,
            int minY,
            int minZ,
            int maxX,
            int maxY,
            int maxZ)

Creates a new area from global min-/max-coordinates.

Parameters:

minX - global start x position of the area.

minY - global start y position of the area.

minZ - global start z position of the area.

maxX - global end x position of the area.

maxY - global end y position of the area.

maxZ - global end z position of the area.

Area

public Area(Vector3f globalStartPosition,
            Vector3f globalEndPosition)

Creates a new area from global positions. Note that this may result in a loss of precision, since areas are always described by integer positions.

Parameters:

globalStartPosition - the global start position of the area.

globalEndPosition - the global end position of the area.

Method Detail

set

public void set(Vector3i startChunk,
                Vector3i startBlock,
                Vector3i endChunk,
                Vector3i endBlock)

Changes the start and end positions of this area.

Parameters:

startChunk - the new start chunk offset.

startBlock - the new start block position within the start chunk.

endChunk - the new end chunk offset.

endBlock - the new end block position within the end chunk.

set

public void set(int startcX,
                int startcY,
                int startcZ,
                int startbX,
                int startbY,
                int startbZ,
                int endcX,
                int endcY,
                int endcZ,
                int endbX,
                int endbY,
                int endbZ)

set

public void set(int minX,
                int minY,
                int minZ,
                int maxX,
                int maxY,
                int maxZ)

Changes the area start and end positions.

Parameters:

minX - the new global start x position of the area.

minY - the new global start y position of the area.

minZ - the new global start z position of the area.

maxX - the new global end x position of the area.

maxY - the new global end y position of the area.

maxZ - the new global end z position of the area.

set

public void set(Vector3f globalStartPosition,
                Vector3f globalEndPosition)

Changes start and end position of this area by getting the coordinates from global positions. Note that this may result in a loss of precision, since areas are always described by integer positions.

Parameters:

globalStartPosition - the new global start position of the area.

globalEndPosition - the new global end position of the area.

getStartChunkPosition

public Vector3i getStartChunkPosition()

getStartBlockPosition

public Vector3i getStartBlockPosition()

getEndChunkPosition

public Vector3i getEndChunkPosition()

getEndBlockPosition

public Vector3i getEndBlockPosition()

getID

public int getID()

Gets the internal unique id of this area (this id is only unique during runtime).

Returns:

the id of this area.

rearrange

public boolean rearrange()

Rearranges the values of this Area, i.e. the start position will be compared with the end position, and if the start position is less than the end position, the values will be swapped.
Note: This method is called automatically when a new area is created.

Returns:

true if the values have been rearranged, false if rearranging was not necessary.

isPointInArea

public boolean isPointInArea(Vector3f point)

Gets whether or not the point is inside this area.

Parameters:

point - a global world position (as a Vector3f)

Returns:

true if the point is inside this area, false if not.

isPointInArea

public boolean isPointInArea(int chunkx,
                             int chunky,
                             int chunkz,
                             int blockx,
                             int blocky,
                             int blockz)

Gets whether or not the provided position (chunkcoordinate + block position) is inside this area.

Parameters:

chunkx - the chunk x position of the point.

chunky - the chunk y position of the point.

chunkz - the chunk z position of the point.

blockx - the block x position of the point.

blocky - the block y position of the point.

blockz - the block z position of the point.

Returns:

true if the provided position is inside this area, false if not.

isPointInArea

public boolean isPointInArea(float x,
                             float y,
                             float z)

Gets whether or not the provided position is inside this area.

Parameters:

x - the global x world position.

y - the global y world position.

z - the global z world position.

Returns:

true if the position is inside this area, false if not.

intersects

public boolean intersects(Area area)

Checks whether or not the provided area intersects this area.

Parameters:

area - the area you want to check.

Returns:

true if there is an intersection between this area and the provided area, false if not.

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Stores an attribute for this area. You can store any type of object. Note that all attributes will be reset upon server restart.

Parameters:

key - the name of the attribute.

value - the value/object you want to store.

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.

Parameters:

key - the name of the attribute.

Returns:

the attribute that is stored for that key, or null of the key does not exists.

hasAttribute

public boolean hasAttribute(java.lang.String key)

Gets whether or not the provided attribute exists.

Parameters:

key - the name of the attribute.

Returns:

true if the attribute exists, false if not.

deleteAttribute

public void deleteAttribute(java.lang.String key)

Removes an attribute from this area. Does nothing if the attribute doesn't exist.

Parameters:

key - the name of the attribute you want to delete.

toString

public java.lang.String toString()

Gets a String representation of this area.

Overrides:

toString in class java.lang.Object

Returns:

a string representing the values of this area.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object