dMessage_c Class Reference

#include <game/bases/d_message.hpp>

Description

Helper class for managing message resources.

Definition at line 8 of file d_message.hpp.

Public Member Functions
	dMessage_c ()
	Constructs a new dMessage_c instance.
	~dMessage_c ()
	Destroys the dMessage_c instance.

Static Public Member Functions
static bool	create (EGG::Heap *heap)
	Loads the message resource file from disk and initializes it.
static wchar_t *	getMsg (ulong messageGroup, ulong messageID)
	Gets a message from the group number and ID.
static MsgRes_c *	getMesRes ()
	Gets the MsgRes_c instance used.
static void	numToString (int num, wchar_t *dst, size_t writeLimit, int digitCount, int suppressLeadingZero)
	Writes num into dst with digitCount decimal digits, replacing suppressed leading zeros with spaces. At most writeLimit characters are written, followed by a null terminator.
static void	numToFullWidth (int num, wchar_t *dst, size_t writeLimit, int digitCount, int suppressLeadingZero)
	Same as ::numToString, but uses full-width characters.
static void	changetoFullSize (wchar_t *str)
	Converts regular ASCII characters in str to full-width characters.

Public Attributes
dDvd::loader_c	mLoader
	The loader for loading the message resource file from disk.
void *	mpFileData
	The raw message resource file data.
MsgRes_c *	mpMsgRes
	The message resource instance used to retrieve messages.

Private Member Functions
void	buildMsgRes (EGG::Heap *heap)
	Creates a new MsgRes_c instance from the loaded message resource file.

Constructor & Destructor Documentation

dMessage_c()

dMessage_c::dMessage_c

(

)

Constructs a new dMessage_c instance.

Definition at line 8 of file d_message.cpp.

~dMessage_c()

dMessage_c::~dMessage_c

(

)

Destroys the dMessage_c instance.

Definition at line 10 of file d_message.cpp.

Member Function Documentation

buildMsgRes()

void dMessage_c::buildMsgRes ( EGG::Heap * heap )

private

Creates a new MsgRes_c instance from the loaded message resource file.

Definition at line 33 of file d_message.cpp.

create()

bool dMessage_c::create ( EGG::Heap * heap )

static

Loads the message resource file from disk and initializes it.

Definition at line 14 of file d_message.cpp.

getMsg()

wchar_t * dMessage_c::getMsg ( ulong messageGroup, ulong messageID )

static

Gets a message from the group number and ID.

Definition at line 37 of file d_message.cpp.

getMesRes()

MsgRes_c * dMessage_c::getMesRes ( )

static

Gets the MsgRes_c instance used.

Definition at line 41 of file d_message.cpp.

numToString()

void dMessage_c::numToString ( int num, wchar_t * dst, size_t writeLimit, int digitCount, int suppressLeadingZero )

static

Writes num into dst with digitCount decimal digits, replacing suppressed leading zeros with spaces. At most writeLimit characters are written, followed by a null terminator.

Parameters

num	The number to convert.
dst	The destination buffer.
writeLimit	The maximum number of characters to write.
digitCount	The number of digits to write.
suppressLeadingZero	Whether to suppress leading zeros (1) or not (0).

Definition at line 45 of file d_message.cpp.

numToFullWidth()

void dMessage_c::numToFullWidth ( int num, wchar_t * dst, size_t writeLimit, int digitCount, int suppressLeadingZero )

static

Same as ::numToString, but uses full-width characters.

Definition at line 75 of file d_message.cpp.

changetoFullSize()

void dMessage_c::changetoFullSize ( wchar_t * str )

static

Converts regular ASCII characters in str to full-width characters.

Definition at line 80 of file d_message.cpp.

Member Data Documentation

mLoader

dDvd::loader_c dMessage_c::mLoader

The loader for loading the message resource file from disk.

Definition at line 41 of file d_message.hpp.

mpFileData

void* dMessage_c::mpFileData

The raw message resource file data.

Definition at line 42 of file d_message.hpp.

mpMsgRes

MsgRes_c* dMessage_c::mpMsgRes

The message resource instance used to retrieve messages.

Definition at line 43 of file d_message.hpp.