messagedata#

Tutorials#

• String Control Codes

Variables#

Functions#

Enumerations#

enum MessageFlag: 🔗 Source

Used with messagedata::Flags[].

MessageFlag MSGFLAG_WRAP = 0

If the text wraps around the bounding box

MessageFlag MSGFLAG_CONT = 1

If the message is the continuation of a previous one

MessageFlag MSGFLAG_CENTER = 2

Reserved

MessageFlag MSGFLAG_RIGHT = 3

Reserved

MessageFlag MSGFLAG_FULLTILE = 4

If the background tile should be treated as the UL of a tile block,

MessageFlag MSGFLAG_TRANS_BG = 5

If the background should be translucent

MessageFlag MSGFLAG_TRANS_FG = 6

If the text should be translucent

Variable descriptions#

int Next 🔗 Source

The ‘next’ message, which will be automatically displayed when this message finishes.

int Tile 🔗 Source

The tile used for the background.

int CSet 🔗 Source

The CSet to draw the background in.

int Font 🔗 Source

value Font

The font to display the message in.

int X 🔗 Source

The X position of the message box.

int Y 🔗 Source

The Y position of the message box.

int Width 🔗 Source

The width of the message box, in pixels.

int Height 🔗 Source

The height of the message box, in pixels.

int Sound 🔗 Source

The SFX to play when a new character is drawn (including spaces).

int ListPosition 🔗 Source

The list position of the messagedata as it is displayed in ZQ.

int VSpace 🔗 Source

The spacing between lines/characters, in pixels.

int HSpace 🔗 Source

The spacing between lines/characters, in pixels.

bool[] Flags 🔗 Source

int[] Margins 🔗 Source

The margins, in pixels, from each edge of the text box.

Valid indices: DIR_UP, DIR_DOWN, DIR_LEFT, DIR_RIGHT

int PortraitTile 🔗 Source

The upper-left corner tile of the portrait. If set to 0, no portrait will be displayed.

int PortraitCSet 🔗 Source

The CSet to draw the portrait in

int PortraitX 🔗 Source

The X/Y position of the portrait.

int PortraitY 🔗 Source

The X/Y position of the portrait.

int PortraitTileWidth 🔗 Source

The tile width/height of the portrait. Max 16 and 14 respectively. If either is 0, no portrait will be displayed.

int PortraitTileHeight 🔗 Source

The tile width/height of the portrait. Max 16 and 14 respectively. If either is 0, no portrait will be displayed.

const int TextHeight 🔗 Source

Returns the height, in pixels, of the message text - not including line wrap / breaks.

const int TextWidth 🔗 Source

Returns the width, in pixels, of the message text - not including line wrap / breaks.

const int Length 🔗 Source

The length, in characters, of the message.

bool Transparent 🔗 Source

int Flag 🔗 Source

Function descriptions#

void Get(char32[] str) 🔗 Source

Loads the message into the provided string buffer.

void Set(char32[] str) 🔗 Source

Sets the message to the provided string.

int TextHeight() 🔗 Source

Returns the width/height, in pixels, of the message text - not including line wrap / breaks.

int TextWidth() 🔗 Source

Returns the width/height, in pixels, of the message text - not including line wrap / breaks.