API Docs for:
Show:

Object_Message Class

Module: ui

A message object to display game messages on screen.

Methods

restore

(
  • data
)

Restores the object from a data-bundle.

Parameters:

  • data Object
    • The data-bundle.

toDataBundle

() Object

Serializes the object into a data-bundle.

Returns:

Object:

The data-bundle.

Properties

animator

gs.Component_Animator

The UI object's animator-component to execute different kind of animations like move, rotate, etc. on it.

behavior

vn.Component_MessageBehavior

The UI object's component to add message-specific behavior.

font

gs.Font

The font used for the message text.

messages

Object

All message paragraphs

settings

ui.MessageSettings

Message specific settings such as auto-erase, wait-at-end, etc.

srcRect

gs.Rect

The UI object's source rectangle on screen.

textRenderer

gs.Component_MessageTextRenderer

The text-renderer used to render the message text.