Game Framework
GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage Class Reference

A message that is generated when the level high score changes. More...

Inheritance diagram for GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage:

Public Member Functions

 LevelHighScoreChangedMessage (Level level, 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 Level Level
 The Level that this update relates to More...
readonly int NewHighScore
 The levels new high score More...
readonly int OldHighScore
 The levels old high score More...
- 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 level high score changes.

Constructor & Destructor Documentation

GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage.LevelHighScoreChangedMessage ( Level  level,
int  newHighScore,
int  oldHighScore 

Member Function Documentation

override string GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage.ToString ( )

Return a representation of the message


Member Data Documentation

readonly Level GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage.Level

The Level that this update relates to

readonly int GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage.NewHighScore

The levels new high score

readonly int GameFramework.GameStructure.Levels.Messages.LevelHighScoreChangedMessage.OldHighScore

The levels old high score

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