messagedata

For accessing and editing message strings. Load with Game->LoadMessageData().

Variables

int	Next
int	Tile
int	CSet
int	Font
int	X
int	Y
int	Width
int	Height
int	Sound
int	ListPosition
int	VSpace
int	HSpace
bool[]	Flags
int[]	Margins
int	PortraitTile
int	PortraitCSet
int	PortraitX
int	PortraitY
int	PortraitTileWidth
int	PortraitTileHeight
const int	TextHeight
const int	TextWidth
const int	Length
bool	Transparent deprecated
int	Flag deprecated

Functions

void	Get(char32[] str)
void	Set(char32[] str)
int	TextHeight() deprecated
int	TextWidth() deprecated

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

The font to display the message in. Use the FONT_ constants for this value.

---

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

A set of flags for the messagedata.

---

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

Warning

Deprecated! Unused! Does nothing!

---

int Flag 🔗 Source

Warning

Deprecated! Use Flags[] instead!

---

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.

Warning

Deprecated! Use TextHeight instead!

---

int TextWidth() 🔗 Source

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

Warning

Deprecated! Use TextWidth instead!