Game Framework
GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage Class Reference

A message that is generated when the Coins of a gameitem changes (assuming no overrides are in place). More...

Inheritance diagram for GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage:
GameFramework.Messaging.BaseMessage

Public Member Functions

 CoinsChangedMessage (GameItem gameItem, int newCoins, int oldCoins)
 
override string ToString ()
 Return a representation of the message More...
 
- Public Member Functions inherited from GameFramework.Messaging.BaseMessage
 BaseMessage ()
 
void DontShowInEditorLog ()
 Hide this message so that it isn't displayed in the editor logs. (Editor only method) More...
 

Public Attributes

readonly GameItem GameItem
 
readonly int NewCoins
 
readonly int OldCoins
 
- Public Attributes inherited from GameFramework.Messaging.BaseMessage
string Name
 
SendModeType SendMode
 
bool DontShowInEditorLogInternal
 

Additional Inherited Members

- Public Types inherited from GameFramework.Messaging.BaseMessage
enum  SendModeType { SendModeType.SendToAll, SendModeType.SendToFirst }
 

Detailed Description

A message that is generated when the Coins of a gameitem changes (assuming no overrides are in place).

Constructor & Destructor Documentation

GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage.CoinsChangedMessage ( GameItem  gameItem,
int  newCoins,
int  oldCoins 
)

Member Function Documentation

override string GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage.ToString ( )

Return a representation of the message

Returns

Member Data Documentation

readonly GameItem GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage.GameItem
readonly int GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage.NewCoins
readonly int GameFramework.GameStructure.GameItems.Messages.CoinsChangedMessage.OldCoins

The documentation for this class was generated from the following file: