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

A message that is generated when the number of stars won changes for a level. More...

Inheritance diagram for GameFramework.GameStructure.Levels.Messages.StarsWonMessage:
GameFramework.Messaging.BaseMessage

Public Member Functions

 StarsWonMessage (Level level, int newStarsWon, int oldStarsWon)
 
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 NewStarsWon
 The old bitmask of stars won More...
 
readonly int OldStarsWon
 The new bitmask of stars won 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 number of stars won changes for a level.

Constructor & Destructor Documentation

GameFramework.GameStructure.Levels.Messages.StarsWonMessage.StarsWonMessage ( Level  level,
int  newStarsWon,
int  oldStarsWon 
)

Member Function Documentation

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

Return a representation of the message

Returns

Member Data Documentation

readonly Level GameFramework.GameStructure.Levels.Messages.StarsWonMessage.Level

The Level that this update relates to

readonly int GameFramework.GameStructure.Levels.Messages.StarsWonMessage.NewStarsWon

The old bitmask of stars won

readonly int GameFramework.GameStructure.Levels.Messages.StarsWonMessage.OldStarsWon

The new bitmask of stars won


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