net.risingworld.api.worldelements

Class WorldArea

java.lang.Object

net.risingworld.api.worldelements.WorldElement

net.risingworld.api.worldelements.WorldArea

public class WorldArea
extends WorldElement

A world area in the game world. It's used to "visualize" an Area.

Example #1: Create area and display it for the player

1	//Create a new area
2	Area area = new Area(-5, -5, -5, 5, 5, 5);
3
4	//Create a new WorldArea (it visualizes the "Area" object)
5	WorldArea wa = new WorldArea(area);
6
7	//Set transparent red color (RGBA)
8	wa.setColor(0xFF000055);
9
10	//We don't want the area to be always visible (set to true by default)
11	wa.setAlwaysVisible(false);
12
13	//Add the world element to the player (so it becomes visible for this player)
14	player.addWorldElement(wa);

Example #2: WorldAreas can be "abused" to change the sky color (by using an infinite area)

1	//Create WorldArea and provide an infinite Area (see static variable in Area class)
2	WorldArea worldArea = new WorldArea(Area.INFINITE);
3
4	//Disable frame
5	worldArea.setFrameVisible(false);
6
7	//Set it to not being always visible
8	worldArea.setAlwaysVisible(false);
9
10	//Choose a proper color. It's recommendable to use a transparent color.
11	//In our example, we use a transparent orange color (#FFAA2299)
12	worldArea.setColor(0xFFAA2299);
13
14	//Add the world element to the player (so it becomes visible for this player)
15	worldArea.addWorldElement(worldArea);

Constructor Summary

Constructors

Constructor and Description
WorldArea(Area area) Creates a new WorldArea element which represents an actual Area.

Method Summary

Modifier and Type	Method and Description
Area	getArea() Gets the underlying Area.
int	getColor() Gets the color of this element.
int	getFrameColor() Gets the color of the frame.
boolean	isAlwaysVisible() Gets whether this element is always visible (i.e. visible through walls etc) or not.
boolean	isFrameVisible()
void	setAlwaysVisible(boolean set) Determines if the element should be always visible (i.e. visible through walls etc) or not.
void	setArea(Area area) Sets the underlying Area.
void	setColor(float r, float g, float b, float a) Sets the color (RGBA) of this element.
void	setColor(int color) Sets the color (RGBA) of this element.
void	setFrameColor(float r, float g, float b, float a) Sets the color (RGBA) of the frame.
void	setFrameColor(int color) Sets the color (RGBA) of the frame.
void	setFrameVisible(boolean set)
void	updateCoordinates() Updates this element.

Methods inherited from class net.risingworld.api.worldelements.WorldElement

deleteAttribute, destroy, getAttribute, getID, getPosition, getRotation, getVisibleRange, hasAttribute, moveTo, moveTo, refresh, setAttribute, setPosition, setPosition, setRotation, setRotation, setVisibleRange

Methods inherited from class java.lang.Object

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

Constructor Detail

WorldArea

public WorldArea(Area area)

Creates a new WorldArea element which represents an actual Area. Can be used to visaulize an Area.
Note that changes to the Area (i.e. if you change its coordinates) requires you to update this WorldArea accordingly.

Parameters:

area - the Area you want to represent.

Method Detail

setArea

public void setArea(Area area)

Sets the underlying Area.

Parameters:

area - the new area.

updateCoordinates

public void updateCoordinates()

Updates this element. Call this method if the area coordinates have been changed. Does the same as setArea(getArea());

getArea

public Area getArea()

Gets the underlying Area.

Returns:

the area.

setAlwaysVisible

public void setAlwaysVisible(boolean set)

Determines if the element should be always visible (i.e. visible through walls etc) or not.

Parameters:

set - set to true to make this element always visible.

isAlwaysVisible

public boolean isAlwaysVisible()

Gets whether this element is always visible (i.e. visible through walls etc) or not.

Returns:

true if this element is always visible, false if not.

setFrameVisible

public void setFrameVisible(boolean set)

isFrameVisible

public boolean isFrameVisible()

setColor

public void setColor(int color)

Sets the color (RGBA) of this element.

Parameters:

color - the new color as an RGBA int value.

setColor

public void setColor(float r,
                     float g,
                     float b,
                     float a)

Sets the color (RGBA) of this element.

Parameters:

r - the red color value (0-1)

g - the green color value (0-1)

b - the blue color value (0-1)

a - the alpha value (0-1), 0 makes the element invisible, 1 fully opaque.

getColor

public int getColor()

Gets the color of this element.

Returns:

an int value representing the RGBA color value.

setFrameColor

public void setFrameColor(int color)

Sets the color (RGBA) of the frame.

Parameters:

color - the new frame color as an RGBA int value.

setFrameColor

public void setFrameColor(float r,
                          float g,
                          float b,
                          float a)

Sets the color (RGBA) of the frame.

Parameters:

r - the red color value (0-1)

g - the green color value (0-1)

b - the blue color value (0-1)

a - the alpha value (0-1), 0 makes the frame invisible, 1 fully opaque.

getFrameColor

public int getFrameColor()

Gets the color of the frame.

Returns:

an int value representing the RGBA color value.