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

A message that is generated when the players Coins changes. More...

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

Public Member Functions

 PlayerCoinsChangedMessage (Player player, 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 Player Player
 The Player that this update relates to More...
 
readonly int NewCoins
 The Players new coin total More...
 
readonly int OldCoins
 The Players old coin total 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 Coins changes.

Constructor & Destructor Documentation

GameFramework.GameStructure.Players.Messages.PlayerCoinsChangedMessage.PlayerCoinsChangedMessage ( Player  player,
int  newCoins,
int  oldCoins 
)

Member Function Documentation

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

Return a representation of the message

Returns

Member Data Documentation

readonly int GameFramework.GameStructure.Players.Messages.PlayerCoinsChangedMessage.NewCoins

The Players new coin total

readonly int GameFramework.GameStructure.Players.Messages.PlayerCoinsChangedMessage.OldCoins

The Players old coin total

readonly Player GameFramework.GameStructure.Players.Messages.PlayerCoinsChangedMessage.Player

The Player that this update relates to


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