AGS Manual

`TextWindowGUI` functions and properties

This struct extends the GUI struct, so it has all functions and properties from GUI, in addition to the properties below.

Compatibility: TextWindowGUI is supported by AGS 3.5.0 and later versions.

`TextWindowGUI.LeftGraphic`

import readonly attribute int TextWindowGUI.LeftGraphic

Gets the sprite number used for this TextWindow's left border.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.TopLeftGraphic`

import readonly attribute int TextWindowGUI.TopLeftGraphic

Gets the sprite number used for this TextWindow's top-left corner.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.TopGraphic`

import readonly attribute int TextWindowGUI.TopGraphic

Gets the sprite number used for this TextWindow's top border.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.TopRightGraphic`

import readonly attribute int TextWindowGUI.TopRightGraphic

Gets the sprite number used for this TextWindow's top-right corner.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.RightGraphic`

import readonly attribute int TextWindowGUI.RightGraphic

Gets the sprite number used for this TextWindow's right border.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.BottomRightGraphic`

import readonly attribute int TextWindowGUI.BottomRightGraphic

Gets the sprite number used for this TextWindow's bottom-right corner.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.BottomGraphic`

import readonly attribute int TextWindowGUI.BottomGraphic

Gets the sprite number used for this TextWindow's bottom border.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.BottomLeftGraphic`

import readonly attribute int TextWindowGUI.BottomLeftGraphic

Gets the sprite number used for this TextWindow's bottom-left corner.

Compatibility: supported by AGS 3.6.3 and later versions.

`TextWindowGUI.TextColor`

int TextWindowGUI.TextColor

Gets/sets the text color to be used when rendering text on this TextWindowGUI.

Example:

// a custom MySay function with character-specific text color;
// (assuming that gTextGui is assigned as a speech GUI)
function MySay(this Character*, const string message) {
    gTextGui.AsTextWindow.TextColor = this.SpeechColor;
    this.Say(message);
}

above function adjusts gTextGui's text color before calling a standard Character.Say function. It assumes that gTextGui was assigned as a default textwindow for the character speech. Such custom function may then be used as:

cEgo.MySay("My text has my colors!");

`TextWindowGUI.TextPadding`

int TextWindowGUI.TextPadding

Gets/sets the amount of padding, in pixels, surrounding the text in the TextWindow.