CMessage<Message> Classes

Overview

Note

There are lots of Message classes that are similar in definition. Rather than document each one individually, there are all referenced here collectively instead. CMessage<Message> classes handle specific Messages, where <Message> is a placeholder for the Message name.

Note

Please see the CMessage Structures section for a Message structure used by a specific Message class.

Tip

See Notes for details of the Message classes, that the class methods documented here apply to. See Specific CMessage<Message> Classes for classes that share the same methods as the others listed, but have additional class methods as well.

Methods

Name*

Description

CMessage<Message>::GetCommType

Returns the message communication type

CMessage<Message>::GetMsgSubType

Returns the message sub-type

CMessage<Message>::GetMsgType

Returns the message type

CMessage<Message>::MarshalMessage

Marshal the CMessage object

CMessage<Message>::Run

Execution of the message

CMessage<Message>::UnmarshalMessage

Unmarshal the CMessage object

* <Message> is a placeholder for the game Message name

CMessage<Message>::GetCommType

Returns the message communication type

virtual short CMessage<Message>::GetCommType();

Return Value

Returns short

Remarks

CMessage<Message>::GetMsgSubType

Returns the message sub-type

virtual unsigned char CMessage<Message>::GetMsgSubType();

Return Value

Returns unsigned char

Remarks

CMessage<Message>::GetMsgType

Returns the message type

virtual unsigned char CMessage<Message>::GetMsgType();

Return Value

Returns unsigned char

Remarks

CMessage<Message>::MarshalMessage

Transforming the memory representation of the CMessage<Message> object to a data format suitable for storage or transmission

virtual void CMessage<Message>::MarshalMessage(
   unsigned char** pData,
   unsigned long* dwSize);

Parameters

  • unsigned char** pData - pointer to a pointer to data

  • unsigned long* dwSize - pointer to a dword variable that contains the size of data pointed to by pData

Remarks

CMessage<Message>::Run

Execution of the message

virtual void CMessage<Message>::Run();

Remarks

CMessage<Message>::UnmarshalMessage

Transforming a representation of the CMessage<Message> object that was used for storage or transmission to a representation of the object that is executable

virtual int CMessage<Message>::UnmarshalMessage(
   unsigned char\* pData,
   unsigned long dwSize);

Parameters

  • unsigned char* pData - pointer to data

  • unsigned long dwSize - size of data

Return Value

Returns int

Remarks

Notes

Note

CMessage<Message> used in the documentation above is a placeholder for the actual class name, as listed below.

The following class names apply to the documented class methods above as the share the same basic methods for each class:

Specific CMessage<Message> Classes

Note

The following class names also apply to the above documentation, but also contain additional class methods. They are listed here as well for completeness as they share the same basic class methods, but they are documented individually as well due to the additional class methods they contain - see the specific class for details.