Class TextRenderer

The TextRenderer component allows to render text using font families, colors, and other configuration options.

Example

  textRenderer.layer: "default";
  textRenderer.text: "Hello world!";
  textRenderer.font: "Arial";
  textRenderer.fontSize: 16;
  textRenderer.width: 160;
  textRenderer.height: 16;
  textRenderer.color: "#000000";
  textRenderer.offset: new Vector2();
  textRenderer.lineSeparation: 0;
  textRenderer.letterSpacing: 0;
  textRenderer.charRanges: [32, 126, 161, 255];
  textRenderer.smooth: false;
  textRenderer.rotation: 0;
  textRenderer.opacity: 1;
  textRenderer.orientation: TextOrientation.RightDown;
  textRenderer.bitmapMargin: new Vector2();
  textRenderer.bitmapSpacing: new Vector2();

Constructors

constructor

Properties

bitmapMargin bitmapSpacing charRanges color font fontSize height layer letterSpacing lineSeparation offset opacity orientation rotation smooth text width

Constructors

constructor

Properties

bitmapMargin

bitmapMargin: Vector2 = ...

Margin in pixels to correct badly sliced characters.

bitmapSpacing

bitmapSpacing: Vector2 = ...

Spacing in pixels to correct badly sliced characters.

charRanges

charRanges: number[] = ...

Range of characters covered by the component defined in number pairs. The default value is [32, 126, 161, 255], this means that the component will render characters from 32 to 126 and from 161 to 255.

color

color: string = "#000000"

The text color

font

font: string | FontFace = "Arial"

The font family to use

fontSize

fontSize: number = 16

The size of the font in pixels.

height

height: number = 16

The height of the invisible box where the text is rendered

layer

layer: string = defaultRenderLayer

The render layer

letterSpacing

letterSpacing: number = 0

The space between chars in pixels

lineSeparation

lineSeparation: number = 0

The separation between lines in pixels

offset

offset: Vector2 = ...

X-axis and Y-axis offset

opacity

opacity: number = 1

Change the opacity between 1 and 0

orientation

orientation: TextOrientation = TextOrientation.Center

Direction in which the text will be rendered.

rotation

rotation: number = 0

Text rotation in radians

smooth

smooth: boolean = false

Smoothing pixels (not recommended for bitmap fonts)

text

text: string = "Hello World!"

The text to render

width

width: number = 160

The width of the invisible box where the text is rendered

Settings

Member Visibility

On This Page

Constructors
Properties