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

List of all members.

Public Member Functions

 ItemMessage (object data, string type)
 ItemMessage (object data, string type, Microsoft.Xna.Framework.Point boardSlot)
int FindFlagInd (Libraries.StringType flag)
void AddFlag (Libraries.StringType flag)
object Clone ()
 ItemMessage (object data, string type)
object Clone ()

Public Attributes

object m_data
 Whatever the data type is, store it here.
Libraries.StringType m_type
 The string that represents the message.
Microsoft.Xna.Framework.Point m_boardSlot
 Slot on the board the was at. Only set if needed.

Protected Attributes

List< Libraries.StringTypem_flags
 Flags that the message has. Same as for events. Flags can be checked by the game to allow/prevent things from happening.

Detailed Description

The message used to store a item 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. 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.ItemMessage.ItemMessage ( object  data,
string  type 
)

Constructor.

data - Data to store in the message.
type - String that represents the message.
TheForum.GameCode.MessageSystems.ItemMessage.ItemMessage ( object  data,
string  type,
Microsoft.Xna.Framework.Point  boardSlot 
)

Constructor.

data - Data to store in the message.
type - String that represents the message.
boardSlot - Slot on the board the item is at.
TheForum.GameCode.MessageSystems.ItemMessage.ItemMessage ( object  data,
string  type 
)

Constructor.

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

Member Function Documentation

void TheForum.GameCode.MessageSystems.ItemMessage.AddFlag ( Libraries.StringType  flag)

Store a copy of the given flag. Multiples of the same flag can be stored.

flag - Flag to store.
object TheForum.GameCode.MessageSystems.ItemMessage.Clone ( )

Clone the object.

Return:
Value is the clone.

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

Clone the object.

Return:
Value is the clone.

int TheForum.GameCode.MessageSystems.ItemMessage.FindFlagInd ( Libraries.StringType  flag)

Find the first index of the given flag if it is stored.

flag - Flag to find.

Return:
Value is the index if found, -1 if not.

Member Data Documentation

Slot on the board the was at. Only set if needed.

Whatever the data type is, store it here.

Flags that the message has. Same as for events. Flags can be checked by the game to allow/prevent things from happening.

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