TEXT.md

Text

A string of text that can be rendered on screen.

---

Constructor

new Text(scene, config);

Arguments

• scene — Scene The scene this Object is a part of.
• config — Object The Text's config object.
  • config.x — number This Text object's x-coordinate.
  • config.y — number This Text object's y-coordinate.
  • config.maxWidth — number The maximum width of the Text. Defaults to Renderer.width.
  • config.value — string The text to display. (use "\n" for newlines)
  • config.wrap — boolean Whether to wrap the text if it overflows the screen.
  • config.color — string Optional text color.
  • config.backgroundColor — string Optional background color.
  • config.fontWeight — string Optional font weight.

---

Properties

value

The string value of the text object.

renderable

Get the PixelMesh renderable representation of the text.