Text

java.lang.Object
- com.codingame.gameengine.module.entities.Entity<T>
- - com.codingame.gameengine.module.entities.Text

```
public class Text
extends Entity<T>
```
Represents a label on screen.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TextureBasedEntity.BlendMode
The list of supported PIXI blend modes and their associated constant.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TextureBasedEntity.BlendMode` The list of supported PIXI blend modes and their associated constant.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAnchorX()` Returns the X anchor of this `TextureBasedEntity` as a percentage of its width.
`double`	`getAnchorY()` Returns the Y anchor of this `TextureBasedEntity` as a percentage of its width.
`TextureBasedEntity.BlendMode`	`getBlendMode()` Returns the `BlendMode` this `TextureBasedEntity` is to be drawn with.
`int`	`getFillColor()` Returns the color of the fill of this `Text` as an RGB integer.
`java.lang.String`	`getFontFamily()` Returns the name of the font of this `Text` in px.
`int`	`getFontSize()` Returns the size of the font of this `Text` in px.
`int`	`getStrokeColor()` Returns the color of the stroke of this `Text` as an RGB integer.
`double`	`getStrokeThickness()` Returs the thickness of the stroke of this `Text` in pixels.
`java.lang.String`	`getText()` Returns the string this `Text` displays.
`int`	`getTint()` Returns the tint of this `TextureBasedEntity` as an RGB integer.
`T`	`setAnchor(double anchor)` Sets both the X and Y anchors of this `TextureBasedEntity` as a percentage of its width and height.
`T`	`setAnchorX(double anchorX)` Sets the X anchor of this `TextureBasedEntity` as a percentage of its width.
`T`	`setAnchorX(double anchorX, Curve curve)` Sets the X anchor of this `TextureBasedEntity` as a percentage of its width.
`T`	`setAnchorY(double anchorY)` Sets the Y anchor of this `TextureBasedEntity` as a percentage of its width.
`T`	`setAnchorY(double anchorY, Curve curve)` Sets the Y anchor of this `TextureBasedEntity` as a percentage of its width.
`T`	`setBlendMode(TextureBasedEntity.BlendMode blendMode)` Sets the blend mode for this `TextureBasedEntity`.
`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(java.lang.String fontFamily)` Sets the name of the font of this `Text`.
`Text`	`setFontSize(int fontSize)` Sets the size of the font of this `Text` in px.
`Text`	`setFontSize(int fontSize, Curve curve)` Sets the size of the font of this `Text` in px.
`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.
`Text`	`setText(java.lang.String text)` Sets the string for this `Text` to display.
`T`	`setTint(int color)` Sets the tint of this `TextureBasedEntity` as an RGB integer.
`T`	`setTint(int color, Curve curve)` Sets the tint of this `TextureBasedEntity` as an RGB integer.

Methods inherited from class com.codingame.gameengine.module.entities.Entity
getAlpha, getId, getRotation, getScaleX, getScaleY, getX, getY, getZIndex, isVisible, setAlpha, setAlpha, setRotation, setRotation, setScale, setScale, setScaleX, setScaleX, setScaleY, setScaleY, setVisible, setX, setX, setY, setY, setZIndex

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getText
```
public java.lang.String getText()
```
    Returns the string this Text displays.
    Default is "" (empty string).
    
    Returns:
    
    the string of this Text.
  - setText
```
public Text setText(java.lang.String text)
```
    Sets the string for this Text to display.
    
    Parameters:
    
    text - the string for this Text to display.
    
    Returns:
    
    this Text.
    
    Throws:
    
    java.lang.NullPointerException - if text is null.
  - 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.
    
    Parameters:
    
    strokeColor - the color for the stroke of this Text.
    
    Returns:
    
    this Text.
    
    Throws:
    
    java.lang.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.
    
    Parameters:
    
    strokeColor - the color for the stroke of this Text.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this Text.
    
    Throws:
    
    java.lang.IllegalArgumentException - if strokeColor is not a valid RGB integer.
  - getStrokeThickness
```
public double getStrokeThickness()
```
    Returs the thickness of the stroke of this Text in pixels.
    
    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
  - 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.
    
    Parameters:
    
    fillColor - the color for the fill of this Text.
    
    Returns:
    
    this Text.
    
    Throws:
    
    java.lang.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.
    
    Parameters:
    
    fillColor - the color for the fill of this Text.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this Text.
    
    Throws:
    
    java.lang.IllegalArgumentException - if fillColor is not a valid RGB integer.
  - getFontSize
```
public int getFontSize()
```
    Returns the size of the font of this Text in px.
    Default is 26.
    
    Returns:
    
    the size of the font of this Text.
  - setFontSize
```
public Text setFontSize(int fontSize)
```
    Sets the size of the font of this Text in px.
    
    Parameters:
    
    fontSize - the size for the font sof this Text.
    
    Returns:
    
    this Text.
  - setFontSize
```
public Text setFontSize(int fontSize,
                        Curve curve)
```
    Sets the size of the font of this Text in px.
    
    Parameters:
    
    fontSize - the size for the font sof this Text.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this Text.
  - getFontFamily
```
public java.lang.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(java.lang.String fontFamily)
```
    Sets the name of the font of this Text.
    Only fonts available to the browser can be displayed.
    
    Parameters:
    
    fontFamily - the size for the font sof this Text.
    
    Returns:
    
    this Text.
  - getBlendMode
```
public TextureBasedEntity.BlendMode getBlendMode()
```
    Returns the BlendMode this TextureBasedEntity is to be drawn with.
    
    Returns:
    
    the BlendMode this TextureBasedEntity is to be drawn with.
    
    See Also:
    
    PIXI BLEND_MODES
  - setBlendMode
```
public T setBlendMode(TextureBasedEntity.BlendMode blendMode)
```
    Sets the blend mode for this TextureBasedEntity.
    The possible values are found in BlendMode.
    
    Parameters:
    
    blendMode -
    
    Returns:
    
    this TextureBasedEntity.
    
    See Also:
    
    PIXI BLEND_MODES
  - setAnchor
```
public T setAnchor(double anchor)
```
    Sets both the X and Y anchors of this TextureBasedEntity as a percentage of its width and height.
    The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.
    
    Parameters:
    
    anchor - the percentage for both anchors of this TextureBasedEntity.
    
    Returns:
    
    this TextureBasedEntity.
  - getAnchorX
```
public double getAnchorX()
```
    Returns the X anchor of this TextureBasedEntity as a percentage of its width.
    Default is 0.
    
    Returns:
    
    the X anchor of this TextureBasedEntity as a percentage of its width.
  - setAnchorX
```
public T setAnchorX(double anchorX)
```
    Sets the X anchor of this TextureBasedEntity as a percentage of its width.
    The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.
    
    Parameters:
    
    anchorX - the X anchor for this TextureBasedEntity.
    
    Returns:
    
    this TextureBasedEntity.
  - setAnchorX
```
public T setAnchorX(double anchorX,
                    Curve curve)
```
    Sets the X anchor of this TextureBasedEntity as a percentage of its width.
    The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.
    
    Parameters:
    
    anchorX - the X anchor for this TextureBasedEntity.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this TextureBasedEntity.
  - getAnchorY
```
public double getAnchorY()
```
    Returns the Y anchor of this TextureBasedEntity as a percentage of its width.
    Default is 0.
    
    Returns:
    
    the Y anchor of this TextureBasedEntity as a percentage of its width.
  - setAnchorY
```
public T setAnchorY(double anchorY)
```
    Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
    The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.
    
    Parameters:
    
    anchorY - the Y anchor for this TextureBasedEntity.
    
    Returns:
    
    this TextureBasedEntity.
  - setAnchorY
```
public T setAnchorY(double anchorY,
                    Curve curve)
```
    Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
    The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.
    
    Parameters:
    
    anchorY - the Y anchor for this TextureBasedEntity.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this TextureBasedEntity.
  - setTint
```
public T setTint(int color)
```
    Sets the tint of this TextureBasedEntity as an RGB integer.
    
    Parameters:
    
    color - the tint of this TextureBasedEntity.
    
    Returns:
    
    this TextureBasedEntity.
    
    Throws:
    
    java.lang.IllegalArgumentException - if color is not a valid RGB integer.
  - setTint
```
public T setTint(int color,
                 Curve curve)
```
    Sets the tint of this TextureBasedEntity as an RGB integer.
    
    Parameters:
    
    color - the tint of this TextureBasedEntity.
    
    curve - the transition to animate between values of this property.
    
    Returns:
    
    this TextureBasedEntity.
    
    Throws:
    
    java.lang.IllegalArgumentException - if color is not a valid RGB integer.
  - getTint
```
public int getTint()
```
    Returns the tint of this TextureBasedEntity as an RGB integer.
    Default is 0xFFFFFF (white)
    
    Returns:
    
    the tint of this TextureBasedEntity.

Class Text

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getText

setText

getStrokeColor

setStrokeColor

setStrokeColor

getStrokeThickness

setStrokeThickness

setStrokeThickness

getFillColor

setFillColor

setFillColor

getFontSize

setFontSize

setFontSize

getFontFamily

setFontFamily

getBlendMode

setBlendMode

setAnchor

getAnchorX

setAnchorX

setAnchorX

getAnchorY

setAnchorY

setAnchorY

setTint

setTint

getTint