TopDown Engine  v3.6
MoreMountains.TopDownEngine.GUIManager Class Reference

Handles all GUI effects and changes More...

Inheritance diagram for MoreMountains.TopDownEngine.GUIManager:
MoreMountains.Tools.MMSingleton< GUIManager > MoreMountains.TopDownEngine.MultiplayerGUIManager

Public Member Functions

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 SetPauseScreen (bool state)
 Sets the pause screen on or off. More...
 
virtual void SetDeathScreen (bool state)
 Sets the death screen on or off. More...
 
virtual void SetDashBar (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 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 UpdateDashBars (float currentFuel, float minFuel, float maxFuel, string playerID)
 Updates the dash bars. 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...
 

Public Attributes

Canvas MainCanvas
 the main canvas More...
 
GameObject HUD
 the game object that contains the heads up display (avatar, health, points...) More...
 
MMProgressBar[] HealthBars
 the health bars to update More...
 
MMRadialProgressBar[] DashBars
 the dash bars to update More...
 
AmmoDisplay[] AmmoDisplays
 the panels and bars used to display current weapon ammo More...
 
GameObject PauseScreen
 the pause screen game object More...
 
GameObject DeathScreen
 the death screen 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...
 
string PointsTextPattern = "000000"
 the pattern to apply to format the display of points More...
 

Protected Member Functions

override void Awake ()
 Initialization More...
 
virtual void Initialization ()
 
virtual void Start ()
 Initialization More...
 
- Protected Member Functions inherited from MoreMountains.Tools.MMSingleton< GUIManager >
virtual void InitializeSingleton ()
 Initializes the singleton. More...
 

Static Protected Member Functions

static void InitializeStatics ()
 Statics initialization to support enter play modes More...
 

Protected Attributes

float _initialJoystickAlpha
 
float _initialButtonsAlpha
 
bool _initialized = false
 

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 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

Handles all GUI effects and changes

Member Function Documentation

◆ Awake()

override void MoreMountains.TopDownEngine.GUIManager.Awake ( )
protectedvirtual

Initialization

Reimplemented from MoreMountains.Tools.MMSingleton< GUIManager >.

◆ Initialization()

virtual void MoreMountains.TopDownEngine.GUIManager.Initialization ( )
protectedvirtual

◆ InitializeStatics()

static void MoreMountains.TopDownEngine.GUIManager.InitializeStatics ( )
staticprotected

Statics initialization to support enter play modes

◆ RefreshPoints()

virtual void MoreMountains.TopDownEngine.GUIManager.RefreshPoints ( )
virtual

Sets the text to the game manager's points.

◆ SetAmmoDisplays()

virtual void MoreMountains.TopDownEngine.GUIManager.SetAmmoDisplays ( bool  state,
string  playerID,
int  ammoDisplayID 
)
virtual

Sets the ammo displays active or not

Parameters
stateIf set to true state.
playerIDPlayer I.

◆ SetAvatarActive()

virtual void MoreMountains.TopDownEngine.GUIManager.SetAvatarActive ( bool  state)
virtual

Sets the avatar active or inactive

Parameters
stateIf set to true turns the HUD active, turns it off otherwise.

◆ SetDashBar()

virtual void MoreMountains.TopDownEngine.GUIManager.SetDashBar ( bool  state,
string  playerID 
)
virtual

Sets the jetpackbar active or not.

Parameters
stateIf set to true, sets the pause.

◆ SetDeathScreen()

virtual void MoreMountains.TopDownEngine.GUIManager.SetDeathScreen ( bool  state)
virtual

Sets the death screen on or off.

Parameters
stateIf set to true, sets the pause.

◆ SetHUDActive()

virtual void MoreMountains.TopDownEngine.GUIManager.SetHUDActive ( bool  state)
virtual

Sets the HUD active or inactive

Parameters
stateIf set to true turns the HUD active, turns it off otherwise.

◆ SetMobileControlsActive()

virtual void MoreMountains.TopDownEngine.GUIManager.SetMobileControlsActive ( bool  state,
InputManager.MovementControls  movementControl = InputManager.MovementControls.Joystick 
)
virtual

Called by the input manager, this method turns controls visible or not depending on what's been chosen

Parameters
stateIf set to true state.
movementControlMovement control.

◆ SetPauseScreen()

virtual void MoreMountains.TopDownEngine.GUIManager.SetPauseScreen ( bool  state)
virtual

Sets the pause screen on or off.

Parameters
stateIf set to true, sets the pause.

◆ Start()

virtual void MoreMountains.TopDownEngine.GUIManager.Start ( )
protectedvirtual

Initialization

◆ UpdateAmmoDisplays()

virtual void MoreMountains.TopDownEngine.GUIManager.UpdateAmmoDisplays ( bool  magazineBased,
int  totalAmmo,
int  maxAmmo,
int  ammoInMagazine,
int  magazineSize,
string  playerID,
int  ammoDisplayID,
bool  displayTotal 
)
virtual

Updates the (optional) ammo displays.

Parameters
magazineBasedIf set to true magazine based.
totalAmmoTotal ammo.
maxAmmoMax ammo.
ammoInMagazineAmmo in magazine.
magazineSizeMagazine size.
playerIDPlayer I.
displayTotalIf set to true display total.

◆ UpdateDashBars()

virtual void MoreMountains.TopDownEngine.GUIManager.UpdateDashBars ( float  currentFuel,
float  minFuel,
float  maxFuel,
string  playerID 
)
virtual

Updates the dash bars.

Parameters
currentFuelCurrent fuel.
minFuelMinimum fuel.
maxFuelMax fuel.
playerIDPlayer I.

◆ UpdateHealthBar()

virtual void MoreMountains.TopDownEngine.GUIManager.UpdateHealthBar ( float  currentHealth,
float  minHealth,
float  maxHealth,
string  playerID 
)
virtual

Updates the health bar.

Parameters
currentHealthCurrent health.
minHealthMinimum health.
maxHealthMax health.
playerIDPlayer I.

Member Data Documentation

◆ _initialButtonsAlpha

float MoreMountains.TopDownEngine.GUIManager._initialButtonsAlpha
protected

◆ _initialized

bool MoreMountains.TopDownEngine.GUIManager._initialized = false
protected

◆ _initialJoystickAlpha

float MoreMountains.TopDownEngine.GUIManager._initialJoystickAlpha
protected

◆ AmmoDisplays

AmmoDisplay [] MoreMountains.TopDownEngine.GUIManager.AmmoDisplays

the panels and bars used to display current weapon ammo

◆ Arrows

CanvasGroup MoreMountains.TopDownEngine.GUIManager.Arrows

The mobile arrows.

◆ Buttons

CanvasGroup MoreMountains.TopDownEngine.GUIManager.Buttons

The mobile buttons.

◆ DashBars

MMRadialProgressBar [] MoreMountains.TopDownEngine.GUIManager.DashBars

the dash bars to update

◆ DeathScreen

GameObject MoreMountains.TopDownEngine.GUIManager.DeathScreen

the death screen

◆ HealthBars

MMProgressBar [] MoreMountains.TopDownEngine.GUIManager.HealthBars

the health bars to update

◆ HUD

GameObject MoreMountains.TopDownEngine.GUIManager.HUD

the game object that contains the heads up display (avatar, health, points...)

◆ Joystick

CanvasGroup MoreMountains.TopDownEngine.GUIManager.Joystick

The mobile movement joystick.

◆ MainCanvas

Canvas MoreMountains.TopDownEngine.GUIManager.MainCanvas

the main canvas

◆ PauseScreen

GameObject MoreMountains.TopDownEngine.GUIManager.PauseScreen

the pause screen game object

◆ PointsText

Text MoreMountains.TopDownEngine.GUIManager.PointsText

the points counter

◆ PointsTextPattern

string MoreMountains.TopDownEngine.GUIManager.PointsTextPattern = "000000"

the pattern to apply to format the display of points


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