TEXTINPUT.md

TextInput

A text input that can be rendered on screen.

---

Constructor

new TextInput(scene, config);

Arguments

• scene — Scene The scene this Object is a part of.
• config — Object The TextInput's config object.
  • x — number This TextInput object's x-coordinate.
  • y — number This TextInput object's y-coordinate.
  • maxWidth — number The maximum width of the TextInput.
  • value — string The text to display. (use "\n" for newlines)
  • color — string Optional text color.
  • activeColor — string Optional text color for active character.
  • backgroundColor — string Optional background color.
  • backgroundColorActive — string Optional background color for active key.
  • fontWeight — string Optional font weight.
  • autoFocus — boolean Automatically focus on element once it is instantiated.
  • onChange — function Callback that runs when the input's value changes.
  • onKeyDown — function Callback that runs when the input receives a keypress.
  • onFocus — function Callback that runs when focus on this input is gained.
  • onBlur — function Callback that runs when focus on this input is lost.
  • maxLength — number An optional maximum input length.

---

Properties

caret

The current position of the caret.

renderable

The renderable PixelMesh representation of the TextInput, including text color, background color, and caret behavior.