Handles all GUI effects and changes. More...

Inheritance diagram for MoreMountains.TopDownEngine.GUIManager:

Public Member Functions
virtual void	SetHUDActive (bool state)
	Sets the HUD active or inactive.
virtual void	SetAvatarActive (bool state)
	Sets the avatar active or inactive.
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.
virtual void	SetPauseScreen (bool state)
	Sets the pause screen on or off.
virtual void	SetDeathScreen (bool state)
	Sets the death screen on or off.
virtual void	SetDashBar (bool state, string playerID)
	Sets the jetpackbar active or not.
virtual void	SetAmmoDisplays (bool state, string playerID, int ammoDisplayID)
	Sets the ammo displays active or not.
virtual void	RefreshPoints ()
	Sets the text to the game manager's points.
virtual void	UpdateHealthBar (float currentHealth, float minHealth, float maxHealth, string playerID)
	Updates the health bar.
virtual void	UpdateDashBars (float currentFuel, float minFuel, float maxFuel, string playerID)
	Updates the dash bars.
virtual void	UpdateAmmoDisplays (bool magazineBased, int totalAmmo, int maxAmmo, int ammoInMagazine, int magazineSize, string playerID, int ammoDisplayID, bool displayTotal)
	Updates the (optional) ammo displays.

Public Attributes
Canvas	MainCanvas
	the main canvas
GameObject	HUD
	the game object that contains the heads up display (avatar, health, points...)
MMProgressBar[]	HealthBars
	the health bars to update
MMProgressBar[]	DashBars
	the dash bars to update
AmmoDisplay[]	AmmoDisplays
	the panels and bars used to display current weapon ammo
GameObject	PauseScreen
	the pause screen game object
GameObject	DeathScreen
	the death screen
CanvasGroup	Buttons
	The mobile buttons.
CanvasGroup	Arrows
	The mobile arrows.
CanvasGroup	Joystick
	The mobile movement joystick.
Text	PointsText
	the points counter
string	PointsTextPattern = "000000"
	the pattern to apply to format the display of points

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

Static Protected Member Functions
static void	InitializeStatics ()
	Statics initialization to support enter play modes.

Protected Attributes
float	_initialJoystickAlpha
float	_initialButtonsAlpha
bool	_initialized = false

Additional Inherited Members
Static Public Member Functions inherited from MoreMountains.Tools.MMSingleton< T >
static T	TryGetInstance ()
Static Protected Attributes inherited from MoreMountains.Tools.MMSingleton< T >
static T	_instance
Properties inherited from MoreMountains.Tools.MMSingleton< T >
static bool	HasInstance `[get]`
static T	Current `[get]`
static T	Instance `[get]`
	Singleton design pattern.

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

◆ Initialization()

virtual void MoreMountains.TopDownEngine.GUIManager.Initialization ( )

protectedvirtual

◆ InitializeStatics()

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

state	If set to `true` state.
playerID	Player I.

◆ SetAvatarActive()

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

virtual

Sets the avatar active or inactive.

Parameters

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

state If set to true, sets the pause.

◆ SetDeathScreen()

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

virtual

Sets the death screen on or off.

Parameters

state If set to true, sets the pause.

◆ SetHUDActive()

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

virtual

Sets the HUD active or inactive.

Parameters

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

state	If set to `true` state.
movementControl	Movement control.

◆ SetPauseScreen()

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

virtual

Sets the pause screen on or off.

Parameters

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

magazineBased	If set to `true` magazine based.
totalAmmo	Total ammo.
maxAmmo	Max ammo.
ammoInMagazine	Ammo in magazine.
magazineSize	Magazine size.
playerID	Player I.
displayTotal	If 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

currentFuel	Current fuel.
minFuel	Minimum fuel.
maxFuel	Max fuel.
playerID	Player I.

◆ UpdateHealthBar()

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

virtual

Updates the health bar.

Parameters

currentHealth	Current health.
minHealth	Minimum health.
maxHealth	Max health.
playerID	Player 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

MMProgressBar [] 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:

H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Managers/GUIManager.cs

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ Initialization()

◆ InitializeStatics()

◆ RefreshPoints()

◆ SetAmmoDisplays()

◆ SetAvatarActive()

◆ SetDashBar()

◆ SetDeathScreen()

◆ SetHUDActive()

◆ SetMobileControlsActive()

◆ SetPauseScreen()

◆ Start()

◆ UpdateAmmoDisplays()

◆ UpdateDashBars()

◆ UpdateHealthBar()

Member Data Documentation

◆ _initialButtonsAlpha

◆ _initialized

◆ _initialJoystickAlpha

◆ AmmoDisplays

◆ Arrows

◆ Buttons

◆ DashBars

◆ DeathScreen

◆ HealthBars

◆ HUD

◆ Joystick

◆ MainCanvas

◆ PauseScreen

◆ PointsText

◆ PointsTextPattern