LytTextBox_c Class Reference

#include <game/bases/d_lyttextBox.hpp>

Inheritance diagram for LytTextBox_c:

Description

A text box class with BMG message support.

Definition at line 6 of file d_lyttextBox.hpp.

Public Member Functions
void	setMessage (MsgRes_c *bmg, ulong messageGroup, ulong messageID, long placeholderCount,...)
	Sets the message to display in the text box.
void	setText (const wchar_t *text, long placeholderCount,...)
	Sets the text to display in the text box.
void	ExtensionUserDataSetup ()
	Checks for extension user data in the layout.

Private Member Functions
void	setMessage (MsgRes_c *bmg, ulong messageGroup, ulong messageID, long placeholderCount, va_list *vargs)
	Sets the message to display in the text box with a va_list.
void	setText (const wchar_t *text, long placeholderCount, va_list *vargs, MsgRes_c *bmg)
	Sets the text to display in the text box with a va_list.

Member Function Documentation

setMessage() [1/2]

void LytTextBox_c::setMessage	(	MsgRes_c *	bmg,
		ulong	messageGroup,
		ulong	messageID,
		long	placeholderCount,
			... )

Sets the message to display in the text box.

Parameters

bmg	The BMG resource.
messageID	The ID of the message to display.
messageGroup	The group of the message to display.
placeholderCount	The number of placeholders in the message.
...	Values for placeholders in the message.

Definition at line 7 of file d_lyttextbox.cpp.

setText() [1/2]

void LytTextBox_c::setText	(	const wchar_t *	text,
		long	placeholderCount,
			... )

Sets the text to display in the text box.

Parameters

text	The text to display.
placeholderCount	The number of placeholders in the message.
...	Values for placeholders in the text.

Definition at line 77 of file d_lyttextbox.cpp.

ExtensionUserDataSetup()

void LytTextBox_c::ExtensionUserDataSetup

(

)

Checks for extension user data in the layout.

Definition at line 18 of file d_lyttextbox.cpp.

setMessage() [2/2]

void LytTextBox_c::setMessage ( MsgRes_c * bmg, ulong messageGroup, ulong messageID, long placeholderCount, va_list * vargs )

private

Sets the message to display in the text box with a va_list.

Parameters

bmg	The BMG resource.
messageID	The ID of the message to display.
messageGroup	The group of the message to display.
placeholderCount	The number of placeholders in the message.
vargs	A va_list of values for placeholders in the message.

Definition at line 26 of file d_lyttextbox.cpp.

setText() [2/2]

void LytTextBox_c::setText ( const wchar_t * text, long placeholderCount, va_list * vargs, MsgRes_c * bmg )

private

Sets the text to display in the text box with a va_list.

Parameters

text	The text to display.
placeholderCount	The number of placeholders in the text.
vargs	A va_list of values for placeholders in the text.
bmg	The BMG resource.

Definition at line 84 of file d_lyttextbox.cpp.