SCR_WelcomeScreenMenu Class Reference

Class that handles Welcome screen menu. More...

Inheritance diagram for SCR_WelcomeScreenMenu:

Protected Member Functions
override void	OnMenuOpen ()
	Initializes necessary parts of menu upon opening it.
override void	OnMenuOpened ()
	Mutes sounds once the menu is opened.
override void	OnMenuClose ()
void	InitMap ()
	Initializes map in the menu background.
override void	OnMenuFocusGained ()
	Adds action listeners when menu is focused.
override void	OnMenuFocusLost ()
	Removes action listeners when menu loses focus.
void	OpenPauseMenu ()
	Opens pause menu.
void	OpenWelcomeScreenMenu ()
	Opens Welcome screen menu.
void	CloseWelcomeScreenMenu ()
	Closes Welcome screen menu.
override void	OnMenuUpdate (float tDelta)
	Refreshes chat and elapsed time.
void	OnChatToggle ()
	Toggles chat panel.
void	UpdateElapsedTime ()
	Updates elapsed time.
void	UpdatePlayerCount (int playerID)
	Updates player count.

Protected Attributes
SCR_BaseGameMode	m_GameMode
PlayerManager	m_PlayerManager
RichTextWidget	m_wPlayerCount
RichTextWidget	m_wScenarioTimeElapsed
ref MapConfiguration	m_MapConfig = new MapConfiguration()
string	m_sTimeElapsed
float	m_fTimeSlice
int	m_iMaxPlayerCount

Detailed Description

Class that handles Welcome screen menu.

Definition at line 3 of file SCR_WelcomeScreenMenu.c.

Member Function Documentation

CloseWelcomeScreenMenu()

void SCR_WelcomeScreenMenu::CloseWelcomeScreenMenu ( )

inlineprotected

Closes Welcome screen menu.

Definition at line 164 of file SCR_WelcomeScreenMenu.c.

InitMap()

void SCR_WelcomeScreenMenu::InitMap ( )

inlineprotected

Initializes map in the menu background.

Definition at line 111 of file SCR_WelcomeScreenMenu.c.

OnChatToggle()

void SCR_WelcomeScreenMenu::OnChatToggle ( )

inlineprotected

Toggles chat panel.

Definition at line 193 of file SCR_WelcomeScreenMenu.c.

OnMenuClose()

override void SCR_WelcomeScreenMenu::OnMenuClose ( )

inlineprotected

Definition at line 98 of file SCR_WelcomeScreenMenu.c.

OnMenuFocusGained()

override void SCR_WelcomeScreenMenu::OnMenuFocusGained ( )

inlineprotected

Adds action listeners when menu is focused.

Definition at line 121 of file SCR_WelcomeScreenMenu.c.

OnMenuFocusLost()

override void SCR_WelcomeScreenMenu::OnMenuFocusLost ( )

inlineprotected

Removes action listeners when menu loses focus.

Definition at line 134 of file SCR_WelcomeScreenMenu.c.

OnMenuOpen()

override void SCR_WelcomeScreenMenu::OnMenuOpen ( )

inlineprotected

Initializes necessary parts of menu upon opening it.

Definition at line 16 of file SCR_WelcomeScreenMenu.c.

OnMenuOpened()

override void SCR_WelcomeScreenMenu::OnMenuOpened ( )

inlineprotected

Mutes sounds once the menu is opened.

Definition at line 87 of file SCR_WelcomeScreenMenu.c.

OnMenuUpdate()

override void SCR_WelcomeScreenMenu::OnMenuUpdate ( float tDelta )

inlineprotected

Refreshes chat and elapsed time.

Definition at line 176 of file SCR_WelcomeScreenMenu.c.

OpenPauseMenu()

void SCR_WelcomeScreenMenu::OpenPauseMenu ( )

inlineprotected

Opens pause menu.

Definition at line 143 of file SCR_WelcomeScreenMenu.c.

OpenWelcomeScreenMenu()

void SCR_WelcomeScreenMenu::OpenWelcomeScreenMenu ( )

inlineprotected

Opens Welcome screen menu.

Definition at line 157 of file SCR_WelcomeScreenMenu.c.

UpdateElapsedTime()

void SCR_WelcomeScreenMenu::UpdateElapsedTime ( )

inlineprotected

Updates elapsed time.

Definition at line 215 of file SCR_WelcomeScreenMenu.c.

UpdatePlayerCount()

void SCR_WelcomeScreenMenu::UpdatePlayerCount ( int playerID )

inlineprotected

Updates player count.

Definition at line 225 of file SCR_WelcomeScreenMenu.c.

Member Data Documentation

m_fTimeSlice

float SCR_WelcomeScreenMenu::m_fTimeSlice

protected

Definition at line 11 of file SCR_WelcomeScreenMenu.c.

m_GameMode

SCR_BaseGameMode SCR_WelcomeScreenMenu::m_GameMode

protected

Definition at line 5 of file SCR_WelcomeScreenMenu.c.

m_iMaxPlayerCount

int SCR_WelcomeScreenMenu::m_iMaxPlayerCount

protected

Definition at line 12 of file SCR_WelcomeScreenMenu.c.

m_MapConfig

ref MapConfiguration SCR_WelcomeScreenMenu::m_MapConfig = new MapConfiguration()

protected

Definition at line 9 of file SCR_WelcomeScreenMenu.c.

m_PlayerManager

PlayerManager SCR_WelcomeScreenMenu::m_PlayerManager

protected

Definition at line 6 of file SCR_WelcomeScreenMenu.c.

m_sTimeElapsed

string SCR_WelcomeScreenMenu::m_sTimeElapsed

protected

Definition at line 10 of file SCR_WelcomeScreenMenu.c.

m_wPlayerCount

RichTextWidget SCR_WelcomeScreenMenu::m_wPlayerCount

protected

Definition at line 7 of file SCR_WelcomeScreenMenu.c.

m_wScenarioTimeElapsed

RichTextWidget SCR_WelcomeScreenMenu::m_wScenarioTimeElapsed

protected

Definition at line 8 of file SCR_WelcomeScreenMenu.c.

---

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

• scripts/Game/UI/Menu/DeployMenu/SCR_WelcomeScreenMenu.c