HighScoreSelection Class Reference

HighScoreSelection. More...

#include <high_score_selection.hpp>

Inheritance diagram for HighScoreSelection:

Public Member Functions
irr::gui::STKModifiedSpriteBank *	getIconBank ()
int	getUnknownKartIcon ()
void	refresh (bool forced_update=true, bool update_columns=false)
	Triggers a refresh of the high score list.
void	loadList ()
	Load the addons into the main list.
void	onDeleteHighscores ()
void	onClearHighscores ()
const RaceManager::MinorRaceModeType	getActiveMode ()
const bool	isActiveModeLinear ()
virtual void	loadedFromFile () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	beforeAddingWidget () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	onColumnClicked (int column_id, bool sort_desc, bool sort_default) OVERRIDE
	Change the sort order if a column was clicked.
virtual void	init () OVERRIDE
	Callback invoked when entering this menu (after the widgets have been added).
virtual void	tearDown () OVERRIDE
	Callback invoked before leaving this menu.
virtual void	unloaded () OVERRIDE
	Callback invoked when this screen is being unloaded.
virtual void	onConfirm () OVERRIDE
	Implement IConfirmDialogListener callback.
Public Member Functions inherited from GUIEngine::Screen
std::function< Screen *()>	getNewScreenPointer () const
	Save the function before GUIEngine::clearScreenCache, call it after to get the new screen instance pointer.
void	setScreenPointerFunction (const std::function< Screen *()> &f)
	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.
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.
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.
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.
virtual void	loadedFromFile ()=0
	Callback invoked when loading this menu.
virtual void	unloaded ()
	Callback invoked when this screen is being unloaded.
virtual void	beforeAddingWidget ()
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)
virtual void	init ()
	Callback invoked when entering this menu (after the widgets have been added).
void	push ()
	Displays this screen bu pushing it onto the stack of screen in the state manager.
virtual void	tearDown ()
	Callback invoked before leaving this menu.
virtual bool	onEscapePressed ()
	Called when escape is pressed.
virtual void	eventCallback (Widget *widget, const std::string &name, const int playerID)=0
	will be called everytime something happens.
virtual void	onUpdate (float dt)
	optional callback you can override to be notified at every frame.
virtual void	onDraw (float dt)
	optional callback you can override to be notified at every frame.
virtual MusicInformation *	getMusic () const
virtual MusicInformation *	getInGameMenuMusic () const
virtual int	getWidth ()
virtual int	getHeight ()
virtual bool	isResizable () const
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.
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.
virtual void	onFocusChanged (Widget *previous, Widget *focus, int playerID)
	Callback called when focus changes.
Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
virtual int	getWidth ()=0
virtual int	getHeight ()=0
Widget *	getWidget (const char *name)
	This function returns a widget by name if that widget is found.
Widget *	getWidget (const int id)
	This function returns a widget by irrlicht ID if that widget is found.
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.
Widget *	getFirstWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the first widget found in within_vector.
Widget *	getLastWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the last widget found in within_vector.
void	elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
	This function is called when screen is removed.
bool	isMyChild (Widget *widget) const
	This function checks if a widget is a child of the container.
virtual bool	enableScreenPadding () const
virtual void	onColumnClicked (int column_id, bool sort_desc, bool sort_default)=0
Public Member Functions inherited from MessageDialog::IConfirmDialogListener
virtual void	onConfirm ()
	Implement to be notified of dialog confirmed.
virtual void	onCancel ()
	Implement to be notified of dialog cancelled.
virtual void	onDialogUpdate (float dt)
	Optional callback.

Private Member Functions
	HighScoreSelection ()
	Constructor, which loads the stkgui file.
	~HighScoreSelection ()
	Destructor.
void	defaultSort ()
	Apply the default sorting to the high score list.

Private Attributes
GUIEngine::ListWidget *	m_high_scores_list_widget
GUIEngine::RibbonWidget *	m_mode_tabs
bool	m_active_mode_is_linear
bool	m_reverse_sort
RaceManager::MajorRaceModeType	m_major_mode
RaceManager::MinorRaceModeType	m_active_mode
int	m_selected_index
irr::gui::STKModifiedSpriteBank *	m_icon_bank
int	m_icon_unknown_kart
	Icon for unknown karts.
int	m_icon_lock
	Icon for locked replays.

Friends
class	GUIEngine::ScreenSingleton< HighScoreSelection >

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.
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.
static Widget *	getWidget (const int id, PtrVector< Widget > *within_vector)
	This function returns a widget by irrlicht ID if that widget is found.
Static Public Member Functions inherited from GUIEngine::ScreenSingleton< HighScoreSelection >
static HighScoreSelection *	getInstance ()
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.
Protected Attributes inherited from GUIEngine::Screen
bool	m_resizable
	True if this screen is resizable.
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.
Widget *	m_last_widget
	AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g.
Static Protected Attributes inherited from GUIEngine::ScreenSingleton< HighScoreSelection >
static HighScoreSelection *	singleton

Detailed Description

HighScoreSelection.

Member Function Documentation

beforeAddingWidget()

void HighScoreSelection::beforeAddingWidget ( )

virtual

implement callback from parent class GUIEngine::Screen

Clear the high score entry list, which will be reloaded.

Reimplemented from GUIEngine::Screen.

eventCallback()

void HighScoreSelection::eventCallback ( GUIEngine::Widget *  widget, const std::string &  name, const int  playerID  )

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

init()

void HighScoreSelection::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()

void HighScoreSelection::loadedFromFile ( )

virtual

implement callback from parent class GUIEngine::Screen

Set pointers to the various widgets.

Implements GUIEngine::Screen.

loadList()

void HighScoreSelection::loadList

(

)

Load the addons into the main list.

Loads the list of all high score entries.

The gui element will be updated.

onColumnClicked()

void HighScoreSelection::onColumnClicked ( int  column_id, bool  sort_desc, bool  sort_default  )

virtual

Change the sort order if a column was clicked.

Parameters

column_id

ID of the column that was clicked.

Implements GUIEngine::IListWidgetHeaderListener.

onConfirm()

void HighScoreSelection::onConfirm ( )

virtual

Implement IConfirmDialogListener callback.

Reimplemented from MessageDialog::IConfirmDialogListener.

tearDown()

void HighScoreSelection::tearDown ( )

virtual

Callback invoked before leaving this menu.

Prepares removal of this screen.

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 will unpause the race (so this means that if you have several consecutive screens while the race is running the race will be unpaused and paused when switching from one screen to the next.

Reimplemented from GUIEngine::Screen.

unloaded()

void HighScoreSelection::unloaded ( )

virtual

Callback invoked when this screen is being unloaded.

Override this method in children classes if you need to be notified of this.

Note

A Screen object instance may be unloaded then loaded back at will.

An unloaded Screen object does not have its children widgets anymore, it only retains its members (most importantly the path to its GUI file) so that it can be loaded back later.

Reimplemented from GUIEngine::Screen.

---

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

• states_screens/high_score_selection.hpp
• states_screens/high_score_selection.cpp