C#Code
C#Code
Public Member Functions | Private Attributes
TheForum.GameCode.MessageSystems.GameMessage Class Reference
Inheritance diagram for TheForum.GameCode.MessageSystems.GameMessage:
Libraries.Messaging.BaseMessage Libraries.Messaging.BaseMessage

List of all members.

Public Member Functions

 GameMessage (object data, Libraries.StringType type)
object Clone ()
Libraries.StringType GetMessageType ()
object GetMessageData ()
 GameMessage (object data, Libraries.StringType type)
object Clone ()
Libraries.StringType GetMessageType ()
object GetMessageData ()

Private Attributes

object m_data
 Whatever the data type is, store it here.
Libraries.StringType m_type
 The string that represents the message.

Detailed Description

The message used to store a game related action that should occur. The datatype stored in the message should correspond to the message type. This is something that will need to be hard coded for each message type I want it to do. This is what tells the game what to do. So input events, etc go through this and the game gets notified. When the game goes to use the message, it has to cast the object based on the message type and use it appropriatly.


Constructor & Destructor Documentation

TheForum.GameCode.MessageSystems.GameMessage.GameMessage ( object  data,
Libraries.StringType  type 
)

Constructor.

data - Data to store in the message.
type - String that represents the message.
TheForum.GameCode.MessageSystems.GameMessage.GameMessage ( object  data,
Libraries.StringType  type 
)

Constructor.

data - Data to store in the message.
type - String that represents the message.

Member Function Documentation

object TheForum.GameCode.MessageSystems.GameMessage.Clone ( )

Clone the object.

Return:
Value is the clone.

object TheForum.GameCode.MessageSystems.GameMessage.Clone ( )

Clone the object.

Return:
Value is the clone.

object TheForum.GameCode.MessageSystems.GameMessage.GetMessageData ( )

Get the message data.

Return:
Value is the message data, null if no additional data was stored.

object TheForum.GameCode.MessageSystems.GameMessage.GetMessageData ( )

Get the message data.

Return:
Value is the message data, null if no additional data was stored.

Libraries.StringType TheForum.GameCode.MessageSystems.GameMessage.GetMessageType ( )

Get the message type associated with the message.

Return:
Value is the type.

Libraries.StringType TheForum.GameCode.MessageSystems.GameMessage.GetMessageType ( )

Get the message type associated with the message.

Return:
Value is the type.


Member Data Documentation

Whatever the data type is, store it here.

The string that represents the message.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties