screen where players can choose their kart More...

#include <kart_selection.hpp>

Inheritance diagram for KartSelectionScreen:

[legend]

Public Member Functions
virtual void	loadedFromFile () OVERRIDE
	implement callback from parent class GUIEngine::Screen

void	setMultiplayer (bool multiplayer)

void	setFromOverworld (bool from_overworld)
	Set whether this screen is being visited from overworld or not.

void	setGoToOverworldNext ()

bool	joinPlayer (InputDevice device, PlayerProfile p)
	Called when a player hits 'fire'/'select' on his device to join the game.

virtual bool	playerQuit (StateManager::ActivePlayer *player)
	Called when a player hits 'rescue'/'cancel' on his device to leave the game.

virtual void	init () OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual void	beforeAddingWidget () OVERRIDE
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)

virtual void	tearDown () 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	onUpdate (float dt) OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual void	unloaded () OVERRIDE
	implement optional callback from parent class GUIEngine::Screen

virtual bool	onEscapePressed () OVERRIDE
	implement optional callback from parent class GUIEngine::Screen

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

Static Public Member Functions
static KartSelectionScreen *	getRunningInstance ()
	Returns the current instance.

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.

Protected Member Functions
	KartSelectionScreen (const char *filename)

virtual void	allPlayersDone ()
	Called when all players selected their kart.

void	renumberKarts ()
	Called when number/order of karts changed, so that all will keep an up-to-date ID.

bool	validateIdentChoices ()
	Checks identities chosen by players, making sure no duplicates are used.

bool	validateKartChoices ()
	Checks karts chosen by players, making sure no duplicates are used.

void	setKartsFromCurrentGroup ()
	Fill the ribbon with the karts from the currently selected group.

void	playerConfirm (const int playerID)

void	updateKartStats (uint8_t widget_id, const std::string &selection)

void	updateKartWidgetModel (int widget_id, const std::string &selection, const irr::core::stringw &selectionText, float kart_color)
	updates model of a kart widget, to have the good selection when the user validates

void	addMultiplayerMessage ()
	Adds a message to the screen which indicates that players must press fire to join.

void	removeMultiplayerMessage ()
	Remove the multiplayer message.

virtual bool	isIgnored (const std::string &ident) const

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
PtrVector< GUIEngine::PlayerKartWidget, REF >	m_kart_widgets
	Contains the custom widget shown for every player.

bool	m_multiplayer

bool	m_from_overworld
	Whether this screen is being visited from overworld or not.

bool	m_go_to_overworld_next

bool	m_must_delete_on_back
	To delete the screen if back is pressed.

bool	m_game_master_confirmed
	Stores whether any player confirmed their choice; then, some things are "frozen", for instance the selected kart group tab.

GUIEngine::PlayerKartWidget *	m_removed_widget

GUIEngine::BubbleWidget *	m_multiplayer_message
	Message shown in multiplayer mode.

FocusDispatcher *	m_dispatcher

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
static KartSelectionScreen *	m_instance_ptr = NULL
	Stores a pointer to the current selection screen.

Private Member Functions
PtrVector< const KartProperties, REF >	getUsableKarts (const std::string &selected_kart_group)

bool	useContinueButton () const

Friends
class	KartHoverListener

class	PlayerNameSpinner

class	FocusDispatcher

class	GUIEngine::ScreenSingleton< KartSelectionScreen >

class	GUIEngine::PlayerKartWidget

Detailed Description

screen where players can choose their kart

Member Function Documentation

◆ allPlayersDone()

void KartSelectionScreen::allPlayersDone ( )

protectedvirtual

Called when all players selected their kart.

Reimplemented in NetworkKartSelectionScreen.

◆ beforeAddingWidget()

void KartSelectionScreen::beforeAddingWidget ( )

virtual

Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)

Reimplemented from GUIEngine::Screen.

Reimplemented in NetworkKartSelectionScreen.

◆ eventCallback()

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

virtual

implement callback from parent class GUIEngine::Screen

Callback handling events from the kart selection menu.

Implements GUIEngine::Screen.

◆ init()

void KartSelectionScreen::init ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

Reimplemented in NetworkKartSelectionScreen.

◆ loadedFromFile()

void KartSelectionScreen::loadedFromFile ( )

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

◆ onEscapePressed()

bool KartSelectionScreen::onEscapePressed ( )

virtual

implement optional callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

Reimplemented in NetworkKartSelectionScreen.

◆ onUpdate()

void KartSelectionScreen::onUpdate ( float dt )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

Reimplemented in NetworkKartSelectionScreen.

◆ playerQuit()

bool KartSelectionScreen::playerQuit ( StateManager::ActivePlayer * player )

virtual

Called when a player hits 'rescue'/'cancel' on his device to leave the game.

Returns: true if event was handled succesfully

Reimplemented in NetworkKartSelectionScreen.

◆ tearDown()

void KartSelectionScreen::tearDown ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ unloaded()

void KartSelectionScreen::unloaded ( )

virtual

implement optional callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ validateIdentChoices()

bool KartSelectionScreen::validateIdentChoices ( )

protected

Checks identities chosen by players, making sure no duplicates are used.

Returns: Whether all choices are ok

◆ validateKartChoices()

bool KartSelectionScreen::validateKartChoices ( )

protected

Checks karts chosen by players, making sure no duplicates are used.

Returns: Whether all choices are ok

Member Data Documentation

◆ m_kart_widgets

PtrVector<GUIEngine::PlayerKartWidget, REF> KartSelectionScreen::m_kart_widgets

protected

Contains the custom widget shown for every player.

(ref only since we're adding them to a Screen, and the Screen will take ownership of these widgets)

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

states_screens/kart_selection.hpp
states_screens/kart_selection.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Function Documentation

◆ allPlayersDone()

◆ beforeAddingWidget()

◆ eventCallback()

◆ init()

◆ loadedFromFile()

◆ onEscapePressed()

◆ onUpdate()

◆ playerQuit()

◆ tearDown()

◆ unloaded()

◆ validateIdentChoices()

◆ validateKartChoices()

Member Data Documentation

◆ m_kart_widgets