SCR_WelcomeScreenMenu Interface Reference

Class that handles Welcome screen menu. More...

Inheritance diagram for SCR_WelcomeScreenMenu:

Public 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 ()
override void	OnMenuFocusGained ()
	Adds action listeners when menu is focused.
override void	OnMenuFocusLost ()
	Removes action listeners when menu loses focus.
void	OpenWelcomeScreenMenu ()
	Opens Welcome screen menu.
void	CloseWelcomeScreenMenu ()
	Closes Welcome screen menu.
override void	OnMenuUpdate (float tDelta)
	Refreshes chat and elapsed time.
Public Member Functions inherited from SCR_DeployMenuBase
override void	OnMenuHide ()
void	MuteSounds (bool mute=true)
Public Member Functions inherited from ChimeraMenuBase
override void	OnMenuInit ()
override void	OnMenuShow ()

Protected Member Functions
void	InitMap ()
	Initializes map in the menu background.
void	OpenPauseMenu ()
	Opens pause menu.
void	OnChatToggle ()
	Toggles chat panel.
void	UpdateElapsedTime ()
	Updates elapsed time.
void	UpdatePlayerCount (int playerID)
	Updates player count.
Protected Member Functions inherited from SCR_DeployMenuBase
void	OpenPlayerList ()
void	OnEditorLimitedChanged (bool limited)
	If limited, don't show the game master switch button.

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
Protected Attributes inherited from SCR_DeployMenuBase
SCR_InputButtonComponent	m_PauseButton
SCR_InputButtonComponent	m_GameMasterButton
SCR_InputButtonComponent	m_ChatButton
SCR_ChatPanel	m_ChatPanel
SCR_MapEntity	m_MapEntity
Protected Attributes inherited from ChimeraMenuBase
bool	m_bTextEditActive = false

Additional Inherited Members
Static Public Member Functions inherited from SCR_DeployMenuBase
static OnDeployMenuOpenInvoker	SGetOnMenuOpen ()
Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase	CurrentChimeraMenu ()
static ChimeraMenuBase	GetOwnerMenu (Widget w)
	Returns parent menu of a widget.
Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker	m_OnTextEditContextChange = new ScriptInvoker
ref ScriptInvoker	m_OnUpdate = new ScriptInvoker
Static Protected Attributes inherited from SCR_DeployMenuBase
static ref OnDeployMenuOpenInvoker	s_OnMenuOpen
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

Detailed Description

Class that handles Welcome screen menu.

Member Function Documentation

CloseWelcomeScreenMenu()

void SCR_WelcomeScreenMenu.CloseWelcomeScreenMenu

(

)

Closes Welcome screen menu.

InitMap()

void SCR_WelcomeScreenMenu.InitMap ( )

protected

Initializes map in the menu background.

OnChatToggle()

void SCR_WelcomeScreenMenu.OnChatToggle ( )

protected

Toggles chat panel.

OnMenuClose()

override void SCR_WelcomeScreenMenu.OnMenuClose

(

)

Implements SCR_DeployMenuBase.

OnMenuFocusGained()

override void SCR_WelcomeScreenMenu.OnMenuFocusGained

(

)

Adds action listeners when menu is focused.

Implements ChimeraMenuBase.

OnMenuFocusLost()

override void SCR_WelcomeScreenMenu.OnMenuFocusLost

(

)

Removes action listeners when menu loses focus.

Implements ChimeraMenuBase.

OnMenuOpen()

override void SCR_WelcomeScreenMenu.OnMenuOpen

(

)

Initializes necessary parts of menu upon opening it.

Implements SCR_DeployMenuBase.

Implemented in SCR_DebriefingScreenMenu.

OnMenuOpened()

override void SCR_WelcomeScreenMenu.OnMenuOpened

(

)

Mutes sounds once the menu is opened.

Implements SCR_DeployMenuBase.

OnMenuUpdate()

override void SCR_WelcomeScreenMenu.OnMenuUpdate

(

float

tDelta

)

Refreshes chat and elapsed time.

Implements ChimeraMenuBase.

OpenPauseMenu()

void SCR_WelcomeScreenMenu.OpenPauseMenu ( )

protected

Opens pause menu.

Implemented in SCR_DebriefingScreenMenu.

OpenWelcomeScreenMenu()

void SCR_WelcomeScreenMenu.OpenWelcomeScreenMenu

(

)

Opens Welcome screen menu.

UpdateElapsedTime()

void SCR_WelcomeScreenMenu.UpdateElapsedTime ( )

protected

Updates elapsed time.

UpdatePlayerCount()

void SCR_WelcomeScreenMenu.UpdatePlayerCount ( int playerID )

protected

Updates player count.

Member Data Documentation

m_fTimeSlice

float SCR_WelcomeScreenMenu.m_fTimeSlice

protected

m_GameMode

SCR_BaseGameMode SCR_WelcomeScreenMenu.m_GameMode

protected

m_iMaxPlayerCount

int SCR_WelcomeScreenMenu.m_iMaxPlayerCount

protected

m_MapConfig

ref MapConfiguration SCR_WelcomeScreenMenu.m_MapConfig = new MapConfiguration()

protected

m_PlayerManager

PlayerManager SCR_WelcomeScreenMenu.m_PlayerManager

protected

m_sTimeElapsed

string SCR_WelcomeScreenMenu.m_sTimeElapsed

protected

m_wPlayerCount

RichTextWidget SCR_WelcomeScreenMenu.m_wPlayerCount

protected

m_wScenarioTimeElapsed

RichTextWidget SCR_WelcomeScreenMenu.m_wScenarioTimeElapsed

protected

---

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

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