API Docs for:
Show:

Component_TextInput Class

Module: gs

The text-input component defines the logic for the text-input window of the default In-Game UI.

Methods

action_addLetter

(
  • sender
  • params
)

An action-method to add a single letter to the text.

Parameters:

  • sender gs.Object_Base

    The sender of the action.

  • params Object

    The params-object which needs a letter-property containing the letter to add.

action_removeLetter

(
  • sender
  • [params=null]
)

An action-method to clear the letter at the current cursor position.

Parameters:

  • sender gs.Object_Base

    The sender of the action.

  • [params=null] Object optional

    The params-object. Can be null.

setText

(
  • text
)

Puts the specified text into the UI label-objects to make it visible on screen.

Parameters:

  • text String

    The text to set.

Properties

cursor

Number protected

The cursor position. Points to the current letter.

letters

Number

The max. number of letters.

text

String

The current text.