Screen shown at the end of a Grand Prix. More...
#include <grand_prix_lose.hpp>
Inheritance diagram for GrandPrixLose:
Public Member Functions | |
| void | init () OVERRIDE |
| Callback invoked when entering this menu (after the widgets have been added). More... | |
| void | loadedFromFile () OVERRIDE |
| Callback invoked when loading this menu. More... | |
| void | onCutsceneEnd () OVERRIDE |
| void | onUpdate (float dt) OVERRIDE |
| optional callback you can override to be notified at every frame. | |
| void | setKarts (std::vector< std::pair< std::string, float > > ident) |
| set which karts lost this GP | |
| MusicInformation * | getInGameMenuMusic () const OVERRIDE |
 Public Member Functions inherited from GrandPrixCutscene | |
| GrandPrixCutscene (const char *filename) | |
| Public Member Functions inherited from GUIEngine::CutsceneScreen | |
| CutsceneScreen (const char *name) | |
| Public Member Functions inherited from GUIEngine::Screen | |
| Screen (bool pause_race=true) | |
| Creates a dummy incomplete object; only use to override behaviour in sub-class. | |
| Screen (const char *filename, bool pause_race=true) | |
| Creates a screen populated by the widgets described in a STK GUI file. More... | |
| bool | operator== (const char *filename) const |
| void | loadFromFile () |
| loads this Screen from the file passed to the constructor | |
| bool | isLoaded () const |
| void | addWidgets () |
| Adds the IrrLicht widgets corresponding to this screen to the IGUIEnvironment. | |
| void | calculateLayout () |
| Called after all widgets have been added. More... | |
| void | manualAddWidget (Widget *w) |
| Can be used for custom purposes for which the load-screen-from-XML code won't make it. | |
| void | manualRemoveWidget (Widget *w) |
| Can be used for custom purposes for which the load-screen-from-XML code won't make it. | |
| void | setUpdateInBackground (bool value) |
| When set to true it updates the screen even if modal dialog is opened. | |
| bool | getUpdateInBackground () |
| const std::string & | getName () const |
| virtual void | unload () |
| Next time this menu needs to be shown, don't use cached values, re-calculate everything. More... | |
| bool | needs3D () |
| Will be called to determine if the 3D scene must be rendered when at this screen. | |
| void | setNeeds3D (bool needs3D) |
| Invoke this method for screens that use a 3D scene as background. More... | |
| virtual void | unloaded () |
| Callback invoked when this screen is being unloaded. More... | |
| virtual void | beforeAddingWidget () |
| Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added) | |
| void | push () |
| Displays this screen bu pushing it onto the stack of screen in the state manager. | |
| virtual void | onDraw (float dt) |
| optional callback you can override to be notified at every frame. | |
| virtual void | onResize () |
| optional callback you can override to be notified at every resize. | |
| virtual MusicInformation * | getMusic () const |
| virtual int | getWidth () |
| virtual int | getHeight () |
| virtual EventPropagation | filterActions (PlayerAction action, int deviceID, const unsigned int value, Input::InputType type, int playerId) |
| Override this if you need to be notified of player actions in subclasses. | |
| virtual void | onDisabledItemClicked (const std::string &item) |
| Callback you can use if you want to know when the user pressed on a disabled ribbon item. More... | |
| virtual void | filterInput (Input::InputType type, int deviceID, int btnID, int axisDir, int value) |
| Override this if you need to be notified of raw input in subclasses. | |
| virtual void | onDialogClose () |
| Callback that gets called when a dialog is closed. More... | |
| virtual void | onFocusChanged (Widget *previous, Widget *focus, int playerID) |
| Callback called when focus changes. | |
| Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer | |
| Widget * | getWidget (const char *name) |
| This function returns a widget by name if that widget is found. More... | |
| Widget * | getWidget (const int id) |
| This function returns a widget by irrlicht ID if that widget is found. More... | |
| template<typename T > | |
| T * | getWidget (const char *name) |
| This function searches and returns a widget by name, cast as specified type, if that widget is found and the type is correct. More... | |
| Widget * | getFirstWidget (PtrVector< Widget > *within_vector=NULL) |
| This function returns the first widget found in within_vector. More... | |
| Widget * | getLastWidget (PtrVector< Widget > *within_vector=NULL) |
| This function returns the last widget found in within_vector. More... | |
| void | elementsWereDeleted (PtrVector< Widget > *within_vector=NULL) |
| This function is called when screen is removed. More... | |
| bool | isMyChild (Widget *widget) const |
| This function checks if a widget is a child of the container. More... | |
| virtual bool | enableScreenPadding () const |
Private Attributes | |
| float | m_global_time |
| Global evolution of time. | |
| TrackObject * | m_kart_node [4] |
| std::vector< KartModel * > | m_all_kart_models |
| A copy of the kart model for each kart used. | |
| int | m_phase |
| float | m_kart_x |
| float | m_kart_y |
| float | m_kart_z |
Friends | |
| class | GUIEngine::ScreenSingleton< GrandPrixLose > |
Additional Inherited Members | |
| Static Public Member Functions inherited from GUIEngine::Screen | |
| static void | parseScreenFileDiv (irr::io::IXMLReader *xml, PtrVector< Widget > &append_to, irr::gui::IGUIElement *parent=NULL) |
| Loads a GUI screen from its XML file. More... | |
| Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer | |
| static Widget * | getWidget (const char *name, PtrVector< Widget > *within_vector) |
| This function returns a widget by name if that widget is found in within_vector. More... | |
| static Widget * | getWidget (const int id, PtrVector< Widget > *within_vector) |
| This function returns a widget by irrlicht ID if that widget is found. More... | |
| Static Public Member Functions inherited from GUIEngine::ScreenSingleton< GrandPrixLose > | |
| static GrandPrixLose * | getInstance () |
| Protected Member Functions inherited from GrandPrixCutscene | |
| void | saveGPButton () |
| A Button to save the GP if it was a random GP. | |
| void | setNewGPWithName (const irr::core::stringw &name) |
| Creates a new GP with the same content as the current and saves it The GP that the race_manager provides can't be used because we need some functions and settings that the GP manager only gives us through createNewGP(). | |
| void | eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE |
| will be called everytime something happens. More... | |
| bool | onEscapePressed () OVERRIDE |
| Called when escape is pressed. More... | |
| void | tearDown () OVERRIDE |
| Callback invoked before leaving this menu. More... | |
| Protected Member Functions inherited from GUIEngine::AbstractTopLevelContainer | |
| void | addWidgetsRecursively (PtrVector< Widget > &widgets, Widget *parent=NULL) |
| This function adds a list of widgets recursively, effectively creating the hierarchy of widgets. More... | |
| void | resizeWidgetsRecursively (PtrVector< Widget > &widgets) |
| This function invokes resize() of each widgets and its children. More... | |
| Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer | |
| PtrVector< Widget, HOLD > | m_widgets |
| the widgets in this screen | |
| Widget * | m_first_widget |
| AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g. More... | |
| Widget * | m_last_widget |
| AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g. More... | |
| Static Protected Attributes inherited from GUIEngine::ScreenSingleton< GrandPrixLose > | |
| static GrandPrixLose * | singleton |
Detailed Description
Screen shown at the end of a Grand Prix.
Member Function Documentation
◆ getInGameMenuMusic()
|
virtual |
- Returns
- which music to play at this screen, if accessed in "in-game-menu" mode
Reimplemented from GUIEngine::Screen.
◆ init()
|
virtual |
Callback invoked when entering this menu (after the widgets have been added).
Initialisation before the object is displayed.
- Note
- The same instance of your object may be entered/left more than once, so make sure that one instance of your object can be used several times if the same screen is visited several times.
If necessary this function will pause the race if it is running (i.e. world exists). While only some of the screen can be shown during the race (via the in-game menu you can get the options screen and the help screens only). This is used by the RaceResultGUI to leave the race running (for the end animation) while the results are being shown.
Reimplemented from GUIEngine::Screen.
◆ loadedFromFile()
|
virtual |
Callback invoked when loading this menu.
- Precondition
- Children widgets of this menu have been created by the time this callback is invoked.
- Note
- This method is not called everytime the screen is shown. Screen::init is. Use this method for persistent setup code (namely, that deals with setting up children widget objects and needs not be done everytime we visit the screen).
- A Screen object instance may be unloaded then loaded back. This method might thus be called more than once in the lifetime of a Screen object, however there will always be an 'unload' event in-between calls to this method.
Implements GUIEngine::Screen.
The documentation for this class was generated from the following files:
- states_screens/grand_prix_lose.hpp
- states_screens/grand_prix_lose.cpp
