Corgi Engine  v8.8
MoreMountains.CorgiEngine.RetroAdventureGUIManager Class Reference

This class handles the GUI in the action phases of the Retro Adventure levels More...

Inheritance diagram for MoreMountains.CorgiEngine.RetroAdventureGUIManager:
MoreMountains.CorgiEngine.GUIManager MoreMountains.Tools.MMEventListener< CorgiEngineEvent > MoreMountains.Tools.MMSingleton< GUIManager > MoreMountains.Tools.MMEventListener< LevelNameEvent > MoreMountains.Tools.MMEventListener< ControlsModeEvent >

Public Member Functions

virtual void LevelComplete ()
 When the level is complete we display our level complete splash and set its values More...
 
virtual void OnMMEvent (CorgiEngineEvent corgiEngineEvent)
 When grabbing a level complete event, we call our LevelComplete method More...
 
- Public Member Functions inherited from MoreMountains.CorgiEngine.GUIManager
virtual void SetHUDActive (bool state)
 Sets the HUD active or inactive More...
 
virtual void SetAvatarActive (bool state)
 Sets the avatar active or inactive More...
 
virtual void SetMobileControlsActive (bool state, InputManager.MovementControls movementControl=InputManager.MovementControls.Joystick)
 Called by the input manager, this method turns controls visible or not depending on what's been chosen More...
 
virtual void SetPause (bool state)
 Sets the pause. More...
 
virtual void SetJetpackBar (bool state, string playerID)
 Sets the jetpackbar active or not. More...
 
virtual void SetAmmoDisplays (bool state, string playerID, int ammoDisplayID)
 Sets the ammo displays active or not More...
 
virtual void SetTimeSplash (bool state)
 Sets the time splash. More...
 
virtual void RefreshPoints ()
 Sets the text to the game manager's points. More...
 
virtual void UpdateHealthBar (float currentHealth, float minHealth, float maxHealth, string playerID)
 Updates the health bar. More...
 
virtual void UpdateJetpackBar (float currentFuel, float minFuel, float maxFuel, string playerID)
 Updates the jetpack bar. More...
 
virtual void UpdateAmmoDisplays (bool magazineBased, int totalAmmo, int maxAmmo, int ammoInMagazine, int magazineSize, string playerID, int ammoDisplayID, bool displayTotal)
 Updates the (optional) ammo displays. More...
 
virtual void SetLevelName (string name)
 Sets the level name in the HUD More...
 
virtual void OnMMEvent (LevelNameEvent levelNameEvent)
 When we catch a level name event, we change our level's name in the GUI More...
 
virtual void OnMMEvent (ControlsModeEvent controlsModeEvent)
 
- Public Member Functions inherited from MoreMountains.Tools.MMEventListener< LevelNameEvent >
void OnMMEvent (T eventType)
 
- Public Member Functions inherited from MoreMountains.Tools.MMEventListener< ControlsModeEvent >
void OnMMEvent (T eventType)
 
- Public Member Functions inherited from MoreMountains.Tools.MMEventListener< CorgiEngineEvent >
void OnMMEvent (T eventType)
 

Public Attributes

Text StarDisplayText
 the text used to display collected stars number More...
 
GameObject LevelCompleteSplash
 the splash to display when the level is complete More...
 
GameObject LevelCompleteSplashFocus
 the object to give focus to when the complete splash gets displayed More...
 
GameObject Inventories
 the GUI inventory displays More...
 
Image[] Stars
 the representation of the collected stars More...
 
Color StarOnColor
 the color to display a collected star with More...
 
Color StarOffColor
 the color to display a not collected star with More...
 
- Public Attributes inherited from MoreMountains.CorgiEngine.GUIManager
GameObject HUD
 the game object that contains the heads up display (avatar, health, points...) More...
 
MMProgressBar[] HealthBars
 the jetpack bar More...
 
MMProgressBar[] JetPackBars
 the jetpack bar More...
 
AmmoDisplay[] AmmoDisplays
 the panels and bars used to display current weapon ammo More...
 
GameObject PauseScreen
 the pause screen game object More...
 
GameObject TimeSplash
 the time splash gameobject More...
 
CanvasGroup Buttons
 The mobile buttons. More...
 
CanvasGroup Arrows
 The mobile arrows. More...
 
CanvasGroup Joystick
 The mobile movement joystick. More...
 
Text PointsText
 the points counter More...
 
Text LevelText
 the level display More...
 
string PointsPattern = "000000"
 the pattern to apply when displaying the score More...
 

Protected Member Functions

virtual void Update ()
 On Update we update our star text More...
 
virtual void UpdateStars ()
 Every frame we update our star text with the current version More...
 
override void OnEnable ()
 On enable, we start listening to events More...
 
override void OnDisable ()
 On disable, we stop listening to events More...
 
- Protected Member Functions inherited from MoreMountains.CorgiEngine.GUIManager
override void Awake ()
 Initialization More...
 
virtual void Start ()
 Initialization More...
 
- Protected Member Functions inherited from MoreMountains.Tools.MMSingleton< GUIManager >
virtual void InitializeSingleton ()
 Initializes the singleton. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MoreMountains.Tools.MMSingleton< GUIManager >
static T TryGetInstance ()
 
- Static Public Attributes inherited from MoreMountains.Tools.MMSingleton< GUIManager >
static bool HasInstance
 
static T Current
 
- Static Protected Member Functions inherited from MoreMountains.CorgiEngine.GUIManager
static void InitializeStatics ()
 Statics initialization to support enter play modes More...
 
- Protected Attributes inherited from MoreMountains.CorgiEngine.GUIManager
float _initialJoystickAlpha
 
float _initialArrowsAlpha
 
float _initialButtonsAlpha
 
- Static Protected Attributes inherited from MoreMountains.Tools.MMSingleton< GUIManager >
static T _instance
 
- Properties inherited from MoreMountains.Tools.MMSingleton< GUIManager >
static T Instance [get]
 Singleton design pattern More...
 

Detailed Description

This class handles the GUI in the action phases of the Retro Adventure levels

Member Function Documentation

◆ LevelComplete()

virtual void MoreMountains.CorgiEngine.RetroAdventureGUIManager.LevelComplete ( )
virtual

When the level is complete we display our level complete splash and set its values

◆ OnDisable()

override void MoreMountains.CorgiEngine.RetroAdventureGUIManager.OnDisable ( )
protectedvirtual

On disable, we stop listening to events

Reimplemented from MoreMountains.CorgiEngine.GUIManager.

◆ OnEnable()

override void MoreMountains.CorgiEngine.RetroAdventureGUIManager.OnEnable ( )
protectedvirtual

On enable, we start listening to events

Reimplemented from MoreMountains.CorgiEngine.GUIManager.

◆ OnMMEvent()

virtual void MoreMountains.CorgiEngine.RetroAdventureGUIManager.OnMMEvent ( CorgiEngineEvent  corgiEngineEvent)
virtual

When grabbing a level complete event, we call our LevelComplete method

Parameters
corgiEngineEventCorgi engine event.

◆ Update()

virtual void MoreMountains.CorgiEngine.RetroAdventureGUIManager.Update ( )
protectedvirtual

On Update we update our star text

◆ UpdateStars()

virtual void MoreMountains.CorgiEngine.RetroAdventureGUIManager.UpdateStars ( )
protectedvirtual

Every frame we update our star text with the current version

Member Data Documentation

◆ Inventories

GameObject MoreMountains.CorgiEngine.RetroAdventureGUIManager.Inventories

the GUI inventory displays

◆ LevelCompleteSplash

GameObject MoreMountains.CorgiEngine.RetroAdventureGUIManager.LevelCompleteSplash

the splash to display when the level is complete

◆ LevelCompleteSplashFocus

GameObject MoreMountains.CorgiEngine.RetroAdventureGUIManager.LevelCompleteSplashFocus

the object to give focus to when the complete splash gets displayed

◆ StarDisplayText

Text MoreMountains.CorgiEngine.RetroAdventureGUIManager.StarDisplayText

the text used to display collected stars number

◆ StarOffColor

Color MoreMountains.CorgiEngine.RetroAdventureGUIManager.StarOffColor

the color to display a not collected star with

◆ StarOnColor

Color MoreMountains.CorgiEngine.RetroAdventureGUIManager.StarOnColor

the color to display a collected star with

◆ Stars

Image [] MoreMountains.CorgiEngine.RetroAdventureGUIManager.Stars

the representation of the collected stars


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