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

A message that is generated when the health of the player has is changed. More...

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

Public Member Functions

 HealthChangedMessage (float newHealth, float oldHealth)
 
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 float NewHealth
 The Players new health More...
 
readonly float OldHealth
 The Players old health 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 health of the player has is changed.

Constructor & Destructor Documentation

GameFramework.GameStructure.Players.Messages.HealthChangedMessage.HealthChangedMessage ( float  newHealth,
float  oldHealth 
)

Member Function Documentation

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

Return a representation of the message

Returns

Member Data Documentation

readonly float GameFramework.GameStructure.Players.Messages.HealthChangedMessage.NewHealth

The Players new health

readonly float GameFramework.GameStructure.Players.Messages.HealthChangedMessage.OldHealth

The Players old health


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