Game Framework
GameFramework.GameStructure.Players.Components.ShowLives Class Reference

Show the number of lives that the referenced Player has. More...

Inheritance diagram for GameFramework.GameStructure.Players.Components.ShowLives:
GameFramework.UI.Other.Components.AbstractClasses.ShowValueAnimatedMessaging< int, LivesChangedMessage >

Public Member Functions

override void Start ()
 Cache player reference and call base class. More...
 
override int GetValueFromMessage (LivesChangedMessage message)
 Return the number of lives the player has. More...
 
- Public Member Functions inherited from GameFramework.UI.Other.Components.AbstractClasses.ShowValueAnimatedMessaging< int, LivesChangedMessage >
override void Start ()
 Custom initialisation. More...
 
override void OnDestroy ()
 
override bool RunMethod (TM message)
 This is the method that you should implement that will be called when a message is received. Call base.Update() if you override this! More...
 
void ProcessQueuedMessages ()
 Check if we are ready to display new messages from the queue and if so then display them as needed. More...
 
void UpdateDisplay ()
 Update the display with the next value that is in the queue More...
 
void UpdateCompleted ()
 Flag that the update is complete and try processing any other pending items. More...
 
abstract T GetValueFromMessage (TM message)
 Implement this to return the latest value of the item that you are trying to display. Note message can be null if this is during initial setup in which case you should return a default of initial value. More...
 

Additional Inherited Members

- Public Attributes inherited from GameFramework.UI.Other.Components.AbstractClasses.ShowValueAnimatedMessaging< int, LivesChangedMessage >
UnityEngine.UI.Text Text
 
string LocalisationKey
 
Animator Animator
 
UpdateModeType UpdateMode
 

Detailed Description

Show the number of lives that the referenced Player has.

Member Function Documentation

override int GameFramework.GameStructure.Players.Components.ShowLives.GetValueFromMessage ( LivesChangedMessage  message)

Return the number of lives the player has.

Returns
override void GameFramework.GameStructure.Players.Components.ShowLives.Start ( )

Cache player reference and call base class.


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