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

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

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

Public Member Functions

 HighScoreChangedMessage (GameItem gameItem, int newHighScore, int oldHighScore)
 
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 NewHighScore
 
readonly int OldHighScore
 
- 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 high score of a gameitem changes (assuming no overrides are in place).

Constructor & Destructor Documentation

GameFramework.GameStructure.GameItems.Messages.HighScoreChangedMessage.HighScoreChangedMessage ( GameItem  gameItem,
int  newHighScore,
int  oldHighScore 
)

Member Function Documentation

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

Return a representation of the message

Returns

Member Data Documentation

readonly GameItem GameFramework.GameStructure.GameItems.Messages.HighScoreChangedMessage.GameItem
readonly int GameFramework.GameStructure.GameItems.Messages.HighScoreChangedMessage.NewHighScore
readonly int GameFramework.GameStructure.GameItems.Messages.HighScoreChangedMessage.OldHighScore

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