Emergency 20 Dokumentation  4.2.0
em5::IngameHud Class Reference

EMERGENCY 5 in-game HUD. More...

#include <IngameHud.h>

Inheritance diagram for em5::IngameHud:

Public Member Functions

 IngameHud ()
 Default constructor. More...
 
 ~IngameHud ()
 Destructor. More...
 
void loadGui ()
 Load the default EMERGENCY 5 in-game HUD. More...
 
void destroyGui ()
 Destroy the EMERGENCY 5 in-game HUD. More...
 
void showGui ()
 Show the default EMERGENCY 5 in-game HUD; not every GUI will be hidden, used for win/failed. More...
 
void hideGui ()
 Hide the default EMERGENCY 5 in-game HUD; not every GUI will be hidden, used for win/failed. More...
 
bool isAnyEndscreenVisible ()
 If any end screen visible this method returns true. More...
 
ChatWindowgetChatWindow () const
 Return the chat window instance. More...
 
MessageWindowgetMessageWindow () const
 Return the message window instance. More...
 
WarblerFeedWindowgetWarblerFeedWindow () const
 Return the warbler feed window instance. More...
 
WarblerFeedWindowgetOrCreateWarblerFeedWindow ()
 
SupervisorWindowgetSupervisorWindow () const
 Return the supervisor window instance. More...
 
MiniMapWindowgetMiniMapWindow () const
 Return the mini-map window instance. More...
 
UnitOverviewWindowgetUnitOverviewWindow () const
 Return the unit overview window instance. More...
 
SEKDroneScanWindowgetSEKDroneScanWindow () const
 Return the SEK drone scan window instance. More...
 
BaseHudLayergetBaseHudLayer () const
 Return the base HUD layer. More...
 
FullscreenVideoWindowgetFullscreenVideoWindow () const
 Return the fullscreen video window instance. More...
 
DebugSelectionInfoWindowgetDebugSelectionInfoWindow ()
 Return the commando box instance. More...
 
DebugEquipmentBoxgetDebugEquipmentBox ()
 Return the equipment box instance. More...
 
DebugOrderBoxgetDebugOrderBox ()
 Return the order box instance. More...
 
DebugLogBoxgetDebugLogBox ()
 Return the debug log box instance. More...
 
DebugEventBoxgetDebugEventBox ()
 Return the event box instance. More...
 
DebugEventDetailBoxgetDebugEventDetailBox ()
 Return the event detail box instance. More...
 
DebugGuiWindowgetDebugGuiWindow ()
 
DebugTriggerWindowgetDebugTriggerWindow ()
 Return the debug trigger window instance. Here we can place functions we need to test specific functionalities. More...
 
DebugUpgradeBoxgetDebugUpgradeBox ()
 Return the debug upgrade box instance. Here we can place functions we need to test specific functionalities. More...
 
DebugWeatherBoxgetDebugWeatherBox ()
 Return the debug weather box instance. Here we can place functions we need to test specific functionalities. More...
 
IngameEventFailedWindowgetIngameEventFailedWindow ()
 Return the ingame event failed window instance. More...
 
IngameMainMenuWindowgetIngameMainMenuWindow ()
 Return the ingame main menu window instance. More...
 
FreeplayFailedWindowgetFreeplayFailedWindow ()
 Return the freeplay failed window instance. More...
 
IngameFreeplayEndWindowgetIngameFreeplayEndWindow ()
 Return the freeplay end window instance. More...
 
IngameMainEventFailedWindowgetIngameMainEventFailedWindow ()
 Return the IngameMainEventFailedWindow instance. More...
 
IngameMainEventSuccessWindowgetIngameMainEventSuccessWindow ()
 Return the IngameMainEventSuccessWindow instance. More...
 
IngamePromotionWindowgetIngamePromotionWindow ()
 Return the IngamePromotionWindow instance. More...
 
IngameOnlineHighscoreWindowgetIngameOnlineHighscoreWindow ()
 Return the online highscore window instance. More...
 
AchievementUnlockedWindowgetAchievementUnlockedWindow ()
 Return the achievement unlocked window instance. More...
 
MultiplayerScoreOverviewgetMultiplayerScoreOverview ()
 Return the multiplayer score overview window instance. More...
 
AiNavigationDebugBoxgetAiNavigationDebugBox ()
 Return the AI navigation debug box instance. More...
 
AiPerceptionDebugBoxgetAiPerceptionDebugBox ()
 Return the AI perception debug box instance. More...
 
AiReactionDebugBoxgetAiReactionDebugBox ()
 Return the AI reaction debug box instance. More...
 
ObjectiveWindowgetObjectiveWindow ()
 Return the objective window instance. More...
 
VehicleOrderBargetVehicleOrderBar () const
 Return the vehicle order bar window instance. More...
 
VehicleSelectionWindowgetVehicleSelectionWindow () const
 Return the vehicle selection window instance. More...
 
VehicleOrderWindowgetVehicleOrderWindow () const
 Return the vehicle order window instance. More...
 
IngameHighscoreDatasourcegetIngameHighscoreDatasource () const
 Return the datasource of the campaign score. More...
 
IngameMultiplayerCOOPEndWindowgetIngameMultiplayerCOOPEndWindow ()
 Return the IngameMultiplayerCOOPEndWindow instance. More...
 
IngameMultiplayerPvPEndWindowgetIngameMultiplayerPvPEndWindow ()
 Return the IngameMultiplayerCOOPEndWindow instance. More...
 
MultiplayerPlayerLeftMessagegetMultiplayerPlayerLeftMessage ()
 Return the MultiplayerPlayerLeftMessage instance. More...
 
MultiplayerVoteWindowgetMultiplayerVoteWindow ()
 Return the MultiplayerVoteWindow instance. More...
 
MultiplayerVoteFailedWindowgetMultiplayerVoteFailedWindow ()
 Return the MultiplayerVoteFailedWindow instance. More...
 
HqExtendedMessagegetHqExtendedMessage ()
 Return the HqExtendedMessage instance. More...
 
CommandWindowgetCommandWindow ()
 Return the command window instance. More...
 
HelpWindowgetHelpWindow ()
 Return the help window instance. More...
 
void manageSelectionWindows ()
 Manage which selection window to display. More...
 
void hideAllSelectionWindows ()
 Hide all selection windows. More...
 
BuyUpgradeWindowgetBuyUpgradeWindow ()
 Return the buy and upgrade menu window instance. More...
 
MenuBargetMenuBar () const
 Return the menu bar instance. More...
 
BuyUpgradeDataSourcegetBuyUpgradeDataSouce () const
 Return the buy-/upgrade datasource. More...
 
StatusOverlayWindowManagergetStatusOverlayWindowManager ()
 
BuildingOverlayWindowManagergetBuildingOverlayWindowManager ()
 
CommandTargetManagergetCommandTargetManager ()
 
BuildingClippingManagergetBuildingClippingManager ()
 
SelectionWindowCommandablegetSelectionWindowCommandable ()
 
SelectionWindowVehiclegetSelectionWindowVehicle ()
 
SelectionWindowMultigetSelectionWindowMulti ()
 

Detailed Description

EMERGENCY 5 in-game HUD.

Constructor & Destructor Documentation

em5::IngameHud::IngameHud ( )

Default constructor.

em5::IngameHud::~IngameHud ( )

Destructor.

Note
  • Not virtual by intent

Member Function Documentation

void em5::IngameHud::destroyGui ( )

Destroy the EMERGENCY 5 in-game HUD.

AchievementUnlockedWindow& em5::IngameHud::getAchievementUnlockedWindow ( )

Return the achievement unlocked window instance.

Returns
Reference to the online achievement unlocked window instance, do not destroy the instance
AiNavigationDebugBox& em5::IngameHud::getAiNavigationDebugBox ( )

Return the AI navigation debug box instance.

Returns
Reference to the AI navigation debug box, do not destroy the instance
AiPerceptionDebugBox& em5::IngameHud::getAiPerceptionDebugBox ( )

Return the AI perception debug box instance.

Returns
Reference to the AI perception debug box, do not destroy the instance
AiReactionDebugBox& em5::IngameHud::getAiReactionDebugBox ( )

Return the AI reaction debug box instance.

Returns
Reference to the AI reaction debug box, do not destroy the instance
BaseHudLayer & em5::IngameHud::getBaseHudLayer ( ) const
inline

Return the base HUD layer.

Returns
Reference to the base HUD layer, do not destroy the instance
BuildingClippingManager& em5::IngameHud::getBuildingClippingManager ( )
BuildingOverlayWindowManager& em5::IngameHud::getBuildingOverlayWindowManager ( )
BuyUpgradeDataSource & em5::IngameHud::getBuyUpgradeDataSouce ( ) const
inline

Return the buy-/upgrade datasource.

Returns
Reference to the Buy Upgrade datasource, do not destroy the instance
BuyUpgradeWindow& em5::IngameHud::getBuyUpgradeWindow ( )

Return the buy and upgrade menu window instance.

Returns
Reference to the buy upgrade menu window, do not destroy the instance
ChatWindow & em5::IngameHud::getChatWindow ( ) const
inline

Return the chat window instance.

Returns
Reference to the chat window instance, do not destroy the instance
CommandTargetManager& em5::IngameHud::getCommandTargetManager ( )
CommandWindow& em5::IngameHud::getCommandWindow ( )

Return the command window instance.

Returns
Reference to the command window, do not destroy the instance
DebugEquipmentBox& em5::IngameHud::getDebugEquipmentBox ( )

Return the equipment box instance.

Returns
Reference to the equipment box instance, do not destroy the instance
DebugEventBox& em5::IngameHud::getDebugEventBox ( )

Return the event box instance.

Returns
Reference to the event box instance, do not destroy the instance
DebugEventDetailBox& em5::IngameHud::getDebugEventDetailBox ( )

Return the event detail box instance.

Returns
Reference to the event box detail instance, do not destroy the instance
DebugGuiWindow& em5::IngameHud::getDebugGuiWindow ( )
DebugLogBox& em5::IngameHud::getDebugLogBox ( )

Return the debug log box instance.

Returns
Reference to the debug log box instance, do not destroy the instance
DebugOrderBox& em5::IngameHud::getDebugOrderBox ( )

Return the order box instance.

Returns
Reference to the order box instance, do not destroy the instance
DebugSelectionInfoWindow& em5::IngameHud::getDebugSelectionInfoWindow ( )

Return the commando box instance.

Returns
Reference to the commando box instance, do not destroy the instance
DebugTriggerWindow& em5::IngameHud::getDebugTriggerWindow ( )

Return the debug trigger window instance. Here we can place functions we need to test specific functionalities.

Returns
Reference to the debug trigger window instance, do not destroy the instance
DebugUpgradeBox& em5::IngameHud::getDebugUpgradeBox ( )

Return the debug upgrade box instance. Here we can place functions we need to test specific functionalities.

Returns
Reference to the debug upgrade box instance, do not destroy the instance
DebugWeatherBox& em5::IngameHud::getDebugWeatherBox ( )

Return the debug weather box instance. Here we can place functions we need to test specific functionalities.

Returns
Reference to the debug weather box instance, do not destroy the instance
FreeplayFailedWindow& em5::IngameHud::getFreeplayFailedWindow ( )

Return the freeplay failed window instance.

Returns
Reference to the freeplay failed window instance, do not destroy the instance
FullscreenVideoWindow & em5::IngameHud::getFullscreenVideoWindow ( ) const
inline

Return the fullscreen video window instance.

Returns
Reference to the video window instance, do not destroy the instance
HelpWindow& em5::IngameHud::getHelpWindow ( )

Return the help window instance.

Returns
Reference to the help window, do not destroy the instance
HqExtendedMessage& em5::IngameHud::getHqExtendedMessage ( )

Return the HqExtendedMessage instance.

Returns
Reference to the HqExtendedMessage instance, do not destroy the instance
IngameEventFailedWindow& em5::IngameHud::getIngameEventFailedWindow ( )

Return the ingame event failed window instance.

Returns
Reference to the ingame event failed window instance, do not destroy the instance
IngameFreeplayEndWindow& em5::IngameHud::getIngameFreeplayEndWindow ( )

Return the freeplay end window instance.

Returns
Reference to the freeplay end window instance, do not destroy the instance
IngameHighscoreDatasource & em5::IngameHud::getIngameHighscoreDatasource ( ) const
inline

Return the datasource of the campaign score.

Returns
Reference to the load campaign window data source instance, do not destroy the instance
IngameMainEventFailedWindow& em5::IngameHud::getIngameMainEventFailedWindow ( )

Return the IngameMainEventFailedWindow instance.

Returns
Reference to the IngameMainEventFailedWindow instance, do not destroy the instance
IngameMainEventSuccessWindow& em5::IngameHud::getIngameMainEventSuccessWindow ( )

Return the IngameMainEventSuccessWindow instance.

Returns
Reference to the IngameMainEventSuccessWindow instance, do not destroy the instance
IngameMainMenuWindow& em5::IngameHud::getIngameMainMenuWindow ( )

Return the ingame main menu window instance.

Returns
Reference to the ingame main menu window instance, do not destroy the instance
IngameMultiplayerCOOPEndWindow& em5::IngameHud::getIngameMultiplayerCOOPEndWindow ( )

Return the IngameMultiplayerCOOPEndWindow instance.

Returns
Reference to the IngameMultiplayerCOOPEndWindow instance, do not destroy the instance
IngameMultiplayerPvPEndWindow& em5::IngameHud::getIngameMultiplayerPvPEndWindow ( )

Return the IngameMultiplayerCOOPEndWindow instance.

Returns
Reference to the IngameMultiplayerCOOPEndWindow instance, do not destroy the instance
IngameOnlineHighscoreWindow& em5::IngameHud::getIngameOnlineHighscoreWindow ( )

Return the online highscore window instance.

Returns
Reference to the online highscore window instance, do not destroy the instance
IngamePromotionWindow& em5::IngameHud::getIngamePromotionWindow ( )

Return the IngamePromotionWindow instance.

Returns
Reference to the IngamePromotionWindow instance, do not destroy the instance
MenuBar * em5::IngameHud::getMenuBar ( ) const
inline

Return the menu bar instance.

Returns
Pointer to the menu bar, do not destroy the instance
MessageWindow * em5::IngameHud::getMessageWindow ( ) const
inline

Return the message window instance.

Returns
Pointer to the message window instance, may be a null pointer, do not destroy the instance
MiniMapWindow * em5::IngameHud::getMiniMapWindow ( ) const
inline

Return the mini-map window instance.

Returns
Pointer to the mini-map window instance, may be null pointer, do not destroy the instance
MultiplayerPlayerLeftMessage& em5::IngameHud::getMultiplayerPlayerLeftMessage ( )

Return the MultiplayerPlayerLeftMessage instance.

Returns
Reference to the MultiplayerPlayerLeftMessage instance, do not destroy the instance
MultiplayerScoreOverview& em5::IngameHud::getMultiplayerScoreOverview ( )

Return the multiplayer score overview window instance.

Returns
Reference to the online multiplayer score overview window instance, do not destroy the instance
MultiplayerVoteFailedWindow& em5::IngameHud::getMultiplayerVoteFailedWindow ( )

Return the MultiplayerVoteFailedWindow instance.

Returns
Reference to the MultiplayerVoteFailedWindow instance, do not destroy the instance
MultiplayerVoteWindow& em5::IngameHud::getMultiplayerVoteWindow ( )

Return the MultiplayerVoteWindow instance.

Returns
Reference to the MultiplayerVoteWindow instance, do not destroy the instance
ObjectiveWindow& em5::IngameHud::getObjectiveWindow ( )

Return the objective window instance.

Returns
Reference to the objective window, do not destroy the instance
WarblerFeedWindow& em5::IngameHud::getOrCreateWarblerFeedWindow ( )
SEKDroneScanWindow & em5::IngameHud::getSEKDroneScanWindow ( ) const
inline

Return the SEK drone scan window instance.

Returns
Reference to the SEK drone scan window instance, do not destroy the instance
SelectionWindowCommandable& em5::IngameHud::getSelectionWindowCommandable ( )
SelectionWindowMulti& em5::IngameHud::getSelectionWindowMulti ( )
SelectionWindowVehicle& em5::IngameHud::getSelectionWindowVehicle ( )
StatusOverlayWindowManager& em5::IngameHud::getStatusOverlayWindowManager ( )
SupervisorWindow & em5::IngameHud::getSupervisorWindow ( ) const
inline

Return the supervisor window instance.

Returns
Reference to the supervisor window instance, do not destroy the instance
UnitOverviewWindow & em5::IngameHud::getUnitOverviewWindow ( ) const
inline

Return the unit overview window instance.

Returns
Pointer to the unit overview window instance, do not destroy the instance
VehicleOrderBar * em5::IngameHud::getVehicleOrderBar ( ) const
inline

Return the vehicle order bar window instance.

Returns
Pointer to the vehicle order bar window, may be a null pointer, do not destroy the instance
VehicleOrderWindow & em5::IngameHud::getVehicleOrderWindow ( ) const
inline

Return the vehicle order window instance.

Returns
Reference to the vehicle order window, do not destroy the instance
VehicleSelectionWindow & em5::IngameHud::getVehicleSelectionWindow ( ) const
inline

Return the vehicle selection window instance.

Returns
Reference to the vehicle selection window, do not destroy the instance
WarblerFeedWindow * em5::IngameHud::getWarblerFeedWindow ( ) const
inline

Return the warbler feed window instance.

Returns
Pointer to the warbler feed window instance, may be a null pointer, do not destroy the instance
void em5::IngameHud::hideAllSelectionWindows ( )

Hide all selection windows.

void em5::IngameHud::hideGui ( )

Hide the default EMERGENCY 5 in-game HUD; not every GUI will be hidden, used for win/failed.

bool em5::IngameHud::isAnyEndscreenVisible ( )

If any end screen visible this method returns true.

void em5::IngameHud::loadGui ( )

Load the default EMERGENCY 5 in-game HUD.

void em5::IngameHud::manageSelectionWindows ( )

Manage which selection window to display.

Note
We have many different selection windows, so it makes sense to have a helper that decides which window to display
void em5::IngameHud::showGui ( )

Show the default EMERGENCY 5 in-game HUD; not every GUI will be hidden, used for win/failed.


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