net.risingworld.api.worldelements

Class World3DText

java.lang.Object

net.risingworld.api.worldelements.WorldElement

net.risingworld.api.worldelements.World3DText

public class World3DText
extends WorldElement

A 3D text in the game world.

Constructor Summary

Constructors

Constructor and Description
World3DText(java.lang.String text) Creates a new World3DText element with the provided text.

Method Summary

Modifier and Type	Method and Description
int	getBackgroundColor() Gets the background color of this element.
Font	getFont() Gets the current font of this label.
int	getFontColor() Gets the font color.
int	getFontsize() Gets the font size of this text.
java.lang.String	getText() Gets the text.
boolean	isAlwaysVisible() Gets whether this element is always visible (i.e. visible through walls etc) or not.
boolean	isBillboard() Gets whether this element always faces to the player or not.
void	setAlwaysVisible(boolean set) Determines if the element should be always visible (i.e. visible through walls etc) or not.
void	setBackgroundColor(float r, float g, float b, float a) Sets the background color (RGBA) of this element.
void	setBackgroundColor(int backgroundColor) Sets the background color (RGBA) of this element.
void	setBillboard(boolean set) If set to true, the text will always face towars the player (acting like a "sprite").
void	setFont(Font font) Sets the font for this label.
void	setFontColor(float r, float g, float b, float a) Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).
void	setFontColor(int color) Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).
void	setFontsize(int size) Sets the font size of the text.
void	setText(java.lang.String text) Sets the text.

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

World3DText

public World3DText(java.lang.String text)

Creates a new World3DText element with the provided text.

Parameters:

text - the text.

Method Detail

setText

public void setText(java.lang.String text)

Sets the text.

Parameters:

text - the new text.

getText

public java.lang.String getText()

Gets the text.

Returns:

the text.

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.

setBillboard

public void setBillboard(boolean set)

If set to true, the text will always face towars the player (acting like a "sprite"). Otherwise it has a fixed orientation (can be changed with WorldElement.setRotation(net.risingworld.api.utils.Quaternion)

Parameters:

set - set to true if you want this element facing always to the player.

setFont

public void setFont(Font font)

Sets the font for this label.

Parameters:

font - the new font.

Example: Create a label and set a handdrawn font

1	GuiLabel txt = new GuiLabel("Rising World", 100, 400, false);
2	txt.setFont(Font.Handdrawn);

getFont

public Font getFont()

Gets the current font of this label.

Returns:

the current font.

isBillboard

public boolean isBillboard()

Gets whether this element always faces to the player or not.

Returns:

true if the element always faces towards the player, false if not.

setFontsize

public void setFontsize(int size)

Sets the font size of the text.

Parameters:

size - the new size.

getFontsize

public int getFontsize()

Gets the font size of this text.

Returns:

the font size.

setFontColor

public void setFontColor(int color)

Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).

Parameters:

color - the new int RGBA color value.

setFontColor

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

Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).

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 font invisible, 1 fully opaque.

getFontColor

public int getFontColor()

Gets the font color.

Returns:

the font color as an RGBA int.

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Sets the background color (RGBA) of this element.

Parameters:

backgroundColor - the new background color as an RGBA int value.

setBackgroundColor

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

Sets the background 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 background invisible, 1 fully opaque.

getBackgroundColor

public int getBackgroundColor()

Gets the background color of this element.

Returns:

an int value representing the RGBA color value.