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

A message that is generated when the player changes. More...

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

Public Member Functions

 PlayerChangedMessage (Player newPlayer, Player oldPlayer)
 
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 NewPlayer
 The newly selected Player More...
 
readonly Player OldPlayer
 The previously selected Player 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 player changes.

Constructor & Destructor Documentation

GameFramework.GameStructure.Players.Messages.PlayerChangedMessage.PlayerChangedMessage ( Player  newPlayer,
Player  oldPlayer 
)

Member Function Documentation

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

Return a representation of the message

Returns

Member Data Documentation

readonly Player GameFramework.GameStructure.Players.Messages.PlayerChangedMessage.NewPlayer

The newly selected Player

readonly Player GameFramework.GameStructure.Players.Messages.PlayerChangedMessage.OldPlayer

The previously selected Player


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