Game Framework
GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage Class Reference

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

Inheritance diagram for GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage:
GameFramework.Messaging.BaseMessage

Public Member Functions

 PlayerHighScoreChangedMessage (Player player, 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 Player Player
 The Player that this update relates to More...
 
readonly int NewHighScore
 The Players new high score More...
 
readonly int OldHighScore
 The Players new 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 players high score changes.

Constructor & Destructor Documentation

GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage.PlayerHighScoreChangedMessage ( Player  player,
int  newHighScore,
int  oldHighScore 
)

Member Function Documentation

override string GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage.ToString ( )

Return a representation of the message

Returns

Member Data Documentation

readonly int GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage.NewHighScore

The Players new high score

readonly int GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage.OldHighScore

The Players new high score

readonly Player GameFramework.GameStructure.Players.Messages.PlayerHighScoreChangedMessage.Player

The Player that this update relates to


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