Package com.codingame.gameengine.module.entities

Class Text

java.lang.Object

com.codingame.gameengine.module.entities.Entity<T>

com.codingame.gameengine.module.entities.BlendableEntity<T>

com.codingame.gameengine.module.entities.TextureBasedEntity<T>

com.codingame.gameengine.module.entities.TextBasedEntity<Text>

com.codingame.gameengine.module.entities.Text

public class Text
extends TextBasedEntity<Text>

Represents a label on screen.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Text.FontWeight	The list of supported font weights.

Nested classes/interfaces inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

TextBasedEntity.TextAlign

Nested classes/interfaces inherited from class com.codingame.gameengine.module.entities.BlendableEntity

BlendableEntity.BlendMode

Field Summary

Fields inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

fontSize, maxWidth, text, textAlign

Method Summary

Modifier and Type	Method	Description
int	getFillColor()	Returns the color of the fill of this Text as an RGB integer.
String	getFontFamily()	Returns the name of the font of this Text in px.
Text.FontWeight	getFontWeight()	Returns the weight of the font of this Text.
int	getStrokeColor()	Returns the color of the stroke of this Text as an RGB integer.
double	getStrokeThickness()	Returns the thickness of the stroke of this Text in pixels.
Text	setFillColor(int fillColor)	Sets the color of the fill of this Text as an RGB integer.
Text	setFillColor(int fillColor, Curve curve)	Sets the color of the fill of this Text as an RGB integer.
Text	setFontFamily(String fontFamily)	Sets the name of the font of this Text.
Text	setFontWeight(Text.FontWeight weight)	Sets the weight of the font of this Text.
Text	setStrokeColor(int strokeColor)	Sets the color of the stroke of this Text as an RGB integer.
Text	setStrokeColor(int strokeColor, Curve curve)	Sets the color of the stroke of this Text as an RGB integer.
Text	setStrokeThickness(double strokeThickness)	Returns the thickness of the stroke of this Text in pixels.
Text	setStrokeThickness(double strokeThickness, Curve curve)	Returns the thickness of the stroke of this Text in pixels.

Methods inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

getFontSize, getMaxWidth, getText, getTextAlign, setFontSize, setFontSize, setMaxWidth, setText, setTextAlign

Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint

Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

getBlendMode, setBlendMode

Methods inherited from class com.codingame.gameengine.module.entities.Entity

getAlpha, getId, getMask, getParent, getRotation, getScaleX, getScaleY, getSkewX, getSkewY, getX, getY, getZIndex, isVisible, requireValidAlpha, requireValidColor, self, set, set, setAlpha, setAlpha, setMask, setMask, setRotation, setRotation, setScale, setScale, setScaleX, setScaleX, setScaleY, setScaleY, setSkewX, setSkewX, setSkewY, setSkewY, setVisible, setX, setX, setY, setY, setZIndex

Methods inherited from class java.lang.Object

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

Method Details

getStrokeColor

public int getStrokeColor()

Returns the color of the stroke of this Text as an RGB integer.

Default is 0 (black).

Returns:

the string of this Text.

setStrokeColor

public Text setStrokeColor(int strokeColor)

Sets the color of the stroke of this Text as an RGB integer.

Default is 0 (black).

Parameters:

strokeColor - the color for the stroke of this Text.

Returns:

this Text.

Throws:

IllegalArgumentException - if strokeColor is not a valid RGB integer.

setStrokeColor

public Text setStrokeColor(int strokeColor,
 Curve curve)

Sets the color of the stroke of this Text as an RGB integer.

Default is 0 (black).

Parameters:

strokeColor - the color for the stroke of this Text.

curve - the transition to animate between values of this property.

Returns:

this Text.

Throws:

IllegalArgumentException - if strokeColor is not a valid RGB integer.

getFontFamily

public String getFontFamily()

Returns the name of the font of this Text in px.

Default is "Lato".

Returns:

the size of the font of this Text.

setFontFamily

public Text setFontFamily(String fontFamily)

Sets the name of the font of this Text.

Only fonts available to the browser can be displayed.

Default is "Lato".

Parameters:

fontFamily - the size for the font of this Text.

Returns:

this Text.

getStrokeThickness

public double getStrokeThickness()

Returns the thickness of the stroke of this Text in pixels.

Default is 0 (no stroke).

Returns:

the thickness of the stroke of this Text

setStrokeThickness

public Text setStrokeThickness(double strokeThickness)

Returns the thickness of the stroke of this Text in pixels.

Default is 0 (no stroke).

Parameters:

strokeThickness - the thickness for the stroke of this Text.

Returns:

this Text

setStrokeThickness

public Text setStrokeThickness(double strokeThickness,
 Curve curve)

Returns the thickness of the stroke of this Text in pixels.

Default is 0 (no stroke).

Parameters:

strokeThickness - the thickness for the stroke of this Text.

curve - the transition to animate between values of this property.

Returns:

this Text

setFontWeight

public Text setFontWeight(Text.FontWeight weight)

Sets the weight of the font of this Text.

Default is NORMAL.

Parameters:

weight - the FontWeight of the Text.

Returns:

this Text.

getFontWeight

public Text.FontWeight getFontWeight()

Returns the weight of the font of this Text.

Default is NORMAL.

Returns:

the weight of the font of this Text.

getFillColor

public int getFillColor()

Returns the color of the fill of this Text as an RGB integer.

Default is 0 (black).

Returns:

the color of the fill of this Text

setFillColor

public Text setFillColor(int fillColor)

Sets the color of the fill of this Text as an RGB integer.

Default is 0 (black).

Parameters:

fillColor - the color for the fill of this Text.

Returns:

this Text.

Throws:

IllegalArgumentException - if fillColor is not a valid RGB integer.

setFillColor

public Text setFillColor(int fillColor,
 Curve curve)

Sets the color of the fill of this Text as an RGB integer.

Default is 0 (black).

Parameters:

fillColor - the color for the fill of this Text.

curve - the transition to animate between values of this property.

Returns:

this Text.

Throws:

IllegalArgumentException - if fillColor is not a valid RGB integer.