Emergency 20 Dokumentation  4.2.0
em5::IngameEventFailedWindow Class Reference

Window to show when an event fails that the player is required to solve. More...

#include <IngameEventFailedWindow.h>

Inheritance diagram for em5::IngameEventFailedWindow:
qsf::GuiDocument em5::IngameMainEventFailedWindow

Public Member Functions

 IngameEventFailedWindow (qsf::GuiContext &guiContext)
 
virtual ~IngameEventFailedWindow ()
 
void stopGameSimulation ()
 
void setFailedText (const std::string &eventName, const std::string &failedReason)
 
virtual void processEvent (const std::string &eventKey, Rocket::Core::Event &event) override
 
- Public Member Functions inherited from qsf::GuiDocument
 GuiDocument (GuiContext &guiContext)
 Constructor. More...
 
 GuiDocument (GuiContext &guiContext, Rocket::Core::ElementDocument &rocketCoreElementDocument)
 Constructor. More...
 
virtual ~GuiDocument ()
 Destructor. More...
 
GuiContextgetGuiContext () const
 Return the document's owning GUI context. More...
 
Rocket::Core::ElementDocument * getRocketCoreElementDocument () const
 Return the document's libRocket document. More...
 
bool loadByFilename (const std::string &filename)
 Load the document from an RML file. More...
 
void unload ()
 Use this method if you want to change a documents .rml file at runtime. More...
 
void show ()
 Show the document. More...
 
void showFocused ()
 Show the document focused. More...
 
void showModal ()
 Show the document modal. More...
 
void hide ()
 Hide the document. More...
 
bool isVisible () const
 Check if the document is currently visible. More...
 
void setVisible (bool visible)
 Show/hide the document. More...
 
void pullToFront ()
 Pull the document to the front. More...
 
Rocket::Core::Element * findElementById (const std::string &elementId) const
 Find an element inside the document by its case-sensitive ID. More...
 
void registerNewButton (const std::string &buttonId, const std::string &event, const std::string &eventKey)
 Register a new button. More...
 
virtual void toggleVisibility ()
 Toggle visibility. More...
 
virtual void processViewportDimensionsChanged (int width, int height)
 

Protected Member Functions

virtual void triggerRepeatEvent ()
 
void setPlayerControl (bool playerControl) const
 
- Protected Member Functions inherited from qsf::GuiDocument
void createEmptyDocument ()
 

Additional Inherited Members

- Static Public Member Functions inherited from qsf::GuiDocument
static Rocket::Core::EventListener * createEventListener (const std::string &eventKey)
 Create an event listener. More...
 
static GuiDocumentgetGuiDocumentByRocketCoreElement (Rocket::Core::Element *element)
 Return a QSF GUI document instance by using a given libRocket element instance. More...
 

Detailed Description

Window to show when an event fails that the player is required to solve.

Remarks
Currently used for EM2016 campaign's mini events.

Constructor & Destructor Documentation

em5::IngameEventFailedWindow::IngameEventFailedWindow ( qsf::GuiContext guiContext)
explicit
virtual em5::IngameEventFailedWindow::~IngameEventFailedWindow ( )
virtual

Member Function Documentation

virtual void em5::IngameEventFailedWindow::processEvent ( const std::string &  eventKey,
Rocket::Core::Event &  event 
)
overridevirtual

Reimplemented from qsf::GuiDocument.

Reimplemented in em5::IngameMainEventFailedWindow.

void em5::IngameEventFailedWindow::setFailedText ( const std::string &  eventName,
const std::string &  failedReason 
)
void em5::IngameEventFailedWindow::setPlayerControl ( bool  playerControl) const
protected
void em5::IngameEventFailedWindow::stopGameSimulation ( )
virtual void em5::IngameEventFailedWindow::triggerRepeatEvent ( )
protectedvirtual

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