SuperTuxKart
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CreateServerScreen Class Reference

Handles the main menu. More...

#include <create_server_screen.hpp>

Inheritance diagram for CreateServerScreen:
Inheritance graph
[legend]

Public Member Functions

virtual void onUpdate (float delta) OVERRIDE
 Called once per framce to check if the server creation request has finished.
 
virtual void loadedFromFile () OVERRIDE
 implement callback from parent class GUIEngine::Screen
 
virtual void beforeAddingWidget () 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 init () OVERRIDE
 implement callback from parent class GUIEngine::Screen
 
virtual void tearDown () OVERRIDE
 implement 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 MusicInformationgetMusic () const
 
virtual MusicInformationgetInGameMenuMusic () 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
 
WidgetgetWidget (const char *name)
 This function returns a widget by name if that widget is found.
 
WidgetgetWidget (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.
 
WidgetgetFirstWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the first widget found in within_vector.
 
WidgetgetLastWidget (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
 

Private Member Functions

void createServer ()
 In case of WAN it adds the server to the list of servers.
 
void updateMoreOption (int game_mode)
 

Private Attributes

int m_prev_mode
 
int m_prev_value
 
bool m_supports_ai
 
GUIEngine::TextBoxWidgetm_name_widget
 
GUIEngine::SpinnerWidgetm_max_players_widget
 
GUIEngine::SpinnerWidgetm_more_options_spinner
 
GUIEngine::LabelWidgetm_more_options_text
 
GUIEngine::LabelWidgetm_info_widget
 
GUIEngine::RibbonWidgetm_game_mode_widget
 
GUIEngine::RibbonWidgetm_options_widget
 
GUIEngine::IconButtonWidgetm_create_widget
 
GUIEngine::IconButtonWidgetm_cancel_widget
 
GUIEngine::IconButtonWidgetm_back_widget
 

Friends

class GUIEngine::ScreenSingleton< CreateServerScreen >
 

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 WidgetgetWidget (const char *name, PtrVector< Widget > *within_vector)
 This function returns a widget by name if that widget is found in within_vector.
 
static WidgetgetWidget (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< CreateServerScreen >
static CreateServerScreengetInstance ()
 
- 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
 
Widgetm_first_widget
 AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g.
 
Widgetm_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< CreateServerScreen >
static CreateServerScreensingleton
 

Detailed Description

Handles the main menu.

Member Function Documentation

◆ beforeAddingWidget()

void CreateServerScreen::beforeAddingWidget ( )
virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ createServer()

void CreateServerScreen::createServer ( )
private

In case of WAN it adds the server to the list of servers.

In case of LAN networking, it registers this game server with the stk server.

◆ eventCallback()

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

implement callback from parent class GUIEngine::Screen

Event callback which starts the server creation process.

Implements GUIEngine::Screen.

◆ init()

void CreateServerScreen::init ( )
virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ loadedFromFile()

void CreateServerScreen::loadedFromFile ( )
virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

◆ onUpdate()

void CreateServerScreen::onUpdate ( float  delta)
virtual

Called once per framce to check if the server creation request has finished.

If so, if pushes the server creation sceen.

Reimplemented from GUIEngine::Screen.

◆ tearDown()

void CreateServerScreen::tearDown ( )
virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.


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