Role selection menu for setting up player faction, group and loadout. More...

Inheritance diagram for SCR_RoleSelectionMenu:

Protected Member Functions
override void	OnMenuOpen ()
override void	OnMenuOpened ()
override void	OnMenuUpdate (float tDelta)
override void	OnMenuFocusGained ()
override void	OnMenuFocusLost ()
void	FindRequestHandlers ()
	Find request handlers based on the layout configuration.
void	HookEvents ()
	Initialize event listeners.
void	UpdateElapsedTime ()
	Update elapsed time.
void	InitMapPlain ()
	Initialize empty map in the background.
void	OnMouseLeft ()
void	ShowFactionPlayerList (Faction faction=null, bool show=true)
void	ShowLoadoutList ()
	Shows the loadout selector on the right side of role selection screen.
void	ShowGroupPlayerList ()
	Shows the Player List selector on the right side of role selection screen.
void	UpdatePlayerCount ()
	Updates the session's player count.
bool	CanContinue ()
	Check if role selection screen can be closed.
bool	CanOpenGroupMenu ()
	Check if group menu can be opened.
void	OpenGroupMenu ()
void	OnPlayerFactionRequest (SCR_PlayerFactionAffiliationComponent component, int factionIndex)
void	OnPlayerFactionResponse (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
	Callback when player receives a response to afaction request.
void	OnPlayerGroupJoined (SCR_AIGroup group, int pid=-1)
	Callback when a player joins a group.
void	OnLocalGroupJoined (SCR_AIGroup group)
	Callback when local player joins a group.
void	OnPlayerLoadoutRequest (SCR_PlayerLoadoutComponent component, int loadoutIndex)
void	OnPlayerLoadoutResponse (SCR_PlayerLoadoutComponent component, int loadoutIndex, bool response)
	Callback when local player receives a response to a loadout request.
void	OnChatToggle ()
void	OnPauseMenu ()
override void	OnMenuClose ()
void	OnPlayerEntryFocused (int id)
void	OnPlayerEntryFocusLost (Widget w)
void	OnViewProfile ()
void	UpdateViewProfileButton (bool forceHidden=false)

Static Protected Member Functions
static SCR_RoleSelectionMenu	OpenRoleSelectionMenu ()
static void	CloseRoleSelectionMenu ()
	Close role selection menu.
static SCR_RoleSelectionMenu	GetRoleSelectionMenu ()

Detailed Description

Role selection menu for setting up player faction, group and loadout.

Definition at line 2 of file SCR_RoleSelectionMenu.c.

Member Function Documentation

◆ CanContinue()

bool SCR_RoleSelectionMenu::CanContinue ( )

inlineprotected

Check if role selection screen can be closed.

Definition at line 303 of file SCR_RoleSelectionMenu.c.

◆ CanOpenGroupMenu()

bool SCR_RoleSelectionMenu::CanOpenGroupMenu ( )

inlineprotected

Check if group menu can be opened.

Definition at line 319 of file SCR_RoleSelectionMenu.c.

◆ CloseRoleSelectionMenu()

void SCR_RoleSelectionMenu::CloseRoleSelectionMenu ( )

inlinestaticprotected

Close role selection menu.

Definition at line 532 of file SCR_RoleSelectionMenu.c.

◆ FindRequestHandlers()

void SCR_RoleSelectionMenu::FindRequestHandlers ( )

inlineprotected

Find request handlers based on the layout configuration.

Definition at line 177 of file SCR_RoleSelectionMenu.c.

◆ GetRoleSelectionMenu()

SCR_RoleSelectionMenu SCR_RoleSelectionMenu::GetRoleSelectionMenu ( )

inlinestaticprotected

Get opened role selection menu.

Returns: the menu instance

Definition at line 542 of file SCR_RoleSelectionMenu.c.

◆ HookEvents()

void SCR_RoleSelectionMenu::HookEvents ( )

inlineprotected

Initialize event listeners.

Definition at line 186 of file SCR_RoleSelectionMenu.c.

◆ InitMapPlain()

void SCR_RoleSelectionMenu::InitMapPlain ( )

inlineprotected

Initialize empty map in the background.

Definition at line 224 of file SCR_RoleSelectionMenu.c.

◆ OnChatToggle()

void SCR_RoleSelectionMenu::OnChatToggle ( )

inlineprotected

Definition at line 446 of file SCR_RoleSelectionMenu.c.

◆ OnLocalGroupJoined()

void SCR_RoleSelectionMenu::OnLocalGroupJoined ( SCR_AIGroup group )

inlineprotected

Callback when local player joins a group.

Definition at line 408 of file SCR_RoleSelectionMenu.c.

◆ OnMenuClose()

override void SCR_RoleSelectionMenu::OnMenuClose ( )

inlineprotected

Definition at line 477 of file SCR_RoleSelectionMenu.c.

◆ OnMenuFocusGained()

override void SCR_RoleSelectionMenu::OnMenuFocusGained ( )

inlineprotected

Definition at line 156 of file SCR_RoleSelectionMenu.c.

◆ OnMenuFocusLost()

override void SCR_RoleSelectionMenu::OnMenuFocusLost ( )

inlineprotected

Definition at line 168 of file SCR_RoleSelectionMenu.c.

◆ OnMenuOpen()

override void SCR_RoleSelectionMenu::OnMenuOpen ( )

inlineprotected

Definition at line 33 of file SCR_RoleSelectionMenu.c.

◆ OnMenuOpened()

override void SCR_RoleSelectionMenu::OnMenuOpened ( )

inlineprotected

Definition at line 126 of file SCR_RoleSelectionMenu.c.

◆ OnMenuUpdate()

override void SCR_RoleSelectionMenu::OnMenuUpdate ( float tDelta )

inlineprotected

Definition at line 141 of file SCR_RoleSelectionMenu.c.

◆ OnMouseLeft()

void SCR_RoleSelectionMenu::OnMouseLeft ( )

inlineprotected

Determine which widget should be shown on the right side of the role selection SplashScreen when user hovers their mouse cursor off a button on the left side of the screen.

Definition at line 233 of file SCR_RoleSelectionMenu.c.

◆ OnPauseMenu()

void SCR_RoleSelectionMenu::OnPauseMenu ( )

inlineprotected

Definition at line 462 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerEntryFocused()

void SCR_RoleSelectionMenu::OnPlayerEntryFocused ( int id )

inlineprotected

Definition at line 490 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerEntryFocusLost()

void SCR_RoleSelectionMenu::OnPlayerEntryFocusLost ( Widget w )

inlineprotected

Definition at line 497 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerFactionRequest()

void SCR_RoleSelectionMenu::OnPlayerFactionRequest	(	SCR_PlayerFactionAffiliationComponent	component,
		int	factionIndex )

inlineprotected

Definition at line 335 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerFactionResponse()

void SCR_RoleSelectionMenu::OnPlayerFactionResponse	(	SCR_PlayerFactionAffiliationComponent	component,
		int	factionIndex,
		bool	response )

inlineprotected

Callback when player receives a response to afaction request.

Definition at line 341 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerGroupJoined()

void SCR_RoleSelectionMenu::OnPlayerGroupJoined	(	SCR_AIGroup	group,
		int	pid = -1 )

inlineprotected

Callback when a player joins a group.

Definition at line 390 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerLoadoutRequest()

void SCR_RoleSelectionMenu::OnPlayerLoadoutRequest	(	SCR_PlayerLoadoutComponent	component,
		int	loadoutIndex )

inlineprotected

Definition at line 426 of file SCR_RoleSelectionMenu.c.

◆ OnPlayerLoadoutResponse()

void SCR_RoleSelectionMenu::OnPlayerLoadoutResponse	(	SCR_PlayerLoadoutComponent	component,
		int	loadoutIndex,
		bool	response )

inlineprotected

Callback when local player receives a response to a loadout request.

Definition at line 432 of file SCR_RoleSelectionMenu.c.

◆ OnViewProfile()

void SCR_RoleSelectionMenu::OnViewProfile ( )

inlineprotected

Definition at line 503 of file SCR_RoleSelectionMenu.c.

◆ OpenGroupMenu()

void SCR_RoleSelectionMenu::OpenGroupMenu ( )

inlineprotected

Definition at line 325 of file SCR_RoleSelectionMenu.c.

◆ OpenRoleSelectionMenu()

SCR_RoleSelectionMenu SCR_RoleSelectionMenu::OpenRoleSelectionMenu ( )

inlinestaticprotected

Open role selection menu.

Returns: the menu instance

Definition at line 522 of file SCR_RoleSelectionMenu.c.

◆ ShowFactionPlayerList()

void SCR_RoleSelectionMenu::ShowFactionPlayerList	(	Faction	faction = null,
		bool	show = true )

inlineprotected

Show player list for a faction if the faction valid.

Parameters

[in]	faction	Faction that the playerlist should be set to
[in]	show	If false, hide the list instead of showing

Definition at line 252 of file SCR_RoleSelectionMenu.c.

◆ ShowGroupPlayerList()

void SCR_RoleSelectionMenu::ShowGroupPlayerList ( )

inlineprotected

Shows the Player List selector on the right side of role selection screen.

Definition at line 283 of file SCR_RoleSelectionMenu.c.

◆ ShowLoadoutList()

void SCR_RoleSelectionMenu::ShowLoadoutList ( )

inlineprotected

Shows the loadout selector on the right side of role selection screen.

Definition at line 265 of file SCR_RoleSelectionMenu.c.

◆ UpdateElapsedTime()

void SCR_RoleSelectionMenu::UpdateElapsedTime ( )

inlineprotected

Update elapsed time.

Definition at line 211 of file SCR_RoleSelectionMenu.c.

◆ UpdatePlayerCount()

void SCR_RoleSelectionMenu::UpdatePlayerCount ( )

inlineprotected

Updates the session's player count.

Definition at line 293 of file SCR_RoleSelectionMenu.c.

◆ UpdateViewProfileButton()

void SCR_RoleSelectionMenu::UpdateViewProfileButton ( bool forceHidden = false )

inlineprotected

Definition at line 509 of file SCR_RoleSelectionMenu.c.

Member Data Documentation

◆ m_ContinueButton

SCR_InputButtonComponent SCR_RoleSelectionMenu::m_ContinueButton

protected

Definition at line 18 of file SCR_RoleSelectionMenu.c.

◆ m_FactionManager

SCR_FactionManager SCR_RoleSelectionMenu::m_FactionManager

protected

Definition at line 10 of file SCR_RoleSelectionMenu.c.

◆ m_FactionPlayerList

SCR_FactionPlayerList SCR_RoleSelectionMenu::m_FactionPlayerList

protected

Definition at line 11 of file SCR_RoleSelectionMenu.c.

◆ m_FactionRequestUIHandler

SCR_FactionRequestUIComponent SCR_RoleSelectionMenu::m_FactionRequestUIHandler

protected

Definition at line 6 of file SCR_RoleSelectionMenu.c.

◆ m_fTimer

float SCR_RoleSelectionMenu::m_fTimer = 0

protected

Definition at line 28 of file SCR_RoleSelectionMenu.c.

◆ m_GameMode

SCR_BaseGameMode SCR_RoleSelectionMenu::m_GameMode

protected

Definition at line 14 of file SCR_RoleSelectionMenu.c.

◆ m_GroupOpenButton

SCR_InputButtonComponent SCR_RoleSelectionMenu::m_GroupOpenButton

protected

Definition at line 19 of file SCR_RoleSelectionMenu.c.

◆ m_GroupPlayerList

SCR_GroupPlayerList SCR_RoleSelectionMenu::m_GroupPlayerList

protected

Definition at line 12 of file SCR_RoleSelectionMenu.c.

◆ m_GroupRequestUIHandler

SCR_GroupRequestUIComponent SCR_RoleSelectionMenu::m_GroupRequestUIHandler

protected

Definition at line 8 of file SCR_RoleSelectionMenu.c.

◆ m_iLastFocusedEntryPlayerId

int SCR_RoleSelectionMenu::m_iLastFocusedEntryPlayerId

protected

Definition at line 30 of file SCR_RoleSelectionMenu.c.

◆ m_iMaxPlayerCount

int SCR_RoleSelectionMenu::m_iMaxPlayerCount

protected

Definition at line 27 of file SCR_RoleSelectionMenu.c.

◆ m_LoadoutRequestUIHandler

SCR_LoadoutRequestUIComponent SCR_RoleSelectionMenu::m_LoadoutRequestUIHandler

protected

Definition at line 7 of file SCR_RoleSelectionMenu.c.

◆ m_MenuHandler

SCR_DeployMenuHandler SCR_RoleSelectionMenu::m_MenuHandler

protected

Definition at line 4 of file SCR_RoleSelectionMenu.c.

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_RoleSelectionMenu::m_PlyFactionAffilComp

protected

Definition at line 15 of file SCR_RoleSelectionMenu.c.

◆ m_PlyLoadoutComp

SCR_PlayerLoadoutComponent SCR_RoleSelectionMenu::m_PlyLoadoutComp

protected

Definition at line 16 of file SCR_RoleSelectionMenu.c.

◆ m_ViewProfileButton

SCR_InputButtonComponent SCR_RoleSelectionMenu::m_ViewProfileButton

protected

Definition at line 20 of file SCR_RoleSelectionMenu.c.

◆ m_wPersistentFaction

Widget SCR_RoleSelectionMenu::m_wPersistentFaction

protected

Definition at line 22 of file SCR_RoleSelectionMenu.c.

◆ m_wPlayerCount

TextWidget SCR_RoleSelectionMenu::m_wPlayerCount

protected

Definition at line 24 of file SCR_RoleSelectionMenu.c.

◆ m_wScenarioTimeElapsed

TextWidget SCR_RoleSelectionMenu::m_wScenarioTimeElapsed

protected

Definition at line 23 of file SCR_RoleSelectionMenu.c.

◆ m_wServerName

TextWidget SCR_RoleSelectionMenu::m_wServerName

protected

Definition at line 25 of file SCR_RoleSelectionMenu.c.

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

scripts/Game/UI/Menu/DeployMenu/SCR_RoleSelectionMenu.c

Protected Attributes
SCR_DeployMenuHandler	m_MenuHandler
SCR_FactionRequestUIComponent	m_FactionRequestUIHandler
SCR_LoadoutRequestUIComponent	m_LoadoutRequestUIHandler
SCR_GroupRequestUIComponent	m_GroupRequestUIHandler
SCR_FactionManager	m_FactionManager
SCR_FactionPlayerList	m_FactionPlayerList
SCR_GroupPlayerList	m_GroupPlayerList
SCR_BaseGameMode	m_GameMode
SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp
SCR_PlayerLoadoutComponent	m_PlyLoadoutComp
SCR_InputButtonComponent	m_ContinueButton
SCR_InputButtonComponent	m_GroupOpenButton
SCR_InputButtonComponent	m_ViewProfileButton
Widget	m_wPersistentFaction
TextWidget	m_wScenarioTimeElapsed
TextWidget	m_wPlayerCount
TextWidget	m_wServerName
int	m_iMaxPlayerCount
float	m_fTimer = 0
int	m_iLastFocusedEntryPlayerId

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ CanContinue()

◆ CanOpenGroupMenu()

◆ CloseRoleSelectionMenu()

◆ FindRequestHandlers()

◆ GetRoleSelectionMenu()

◆ HookEvents()

◆ InitMapPlain()

◆ OnChatToggle()

◆ OnLocalGroupJoined()

◆ OnMenuClose()

◆ OnMenuFocusGained()

◆ OnMenuFocusLost()

◆ OnMenuOpen()

◆ OnMenuOpened()

◆ OnMenuUpdate()

◆ OnMouseLeft()

◆ OnPauseMenu()

◆ OnPlayerEntryFocused()

◆ OnPlayerEntryFocusLost()

◆ OnPlayerFactionRequest()

◆ OnPlayerFactionResponse()

◆ OnPlayerGroupJoined()

◆ OnPlayerLoadoutRequest()

◆ OnPlayerLoadoutResponse()

◆ OnViewProfile()

◆ OpenGroupMenu()

◆ OpenRoleSelectionMenu()

◆ ShowFactionPlayerList()

◆ ShowGroupPlayerList()

◆ ShowLoadoutList()

◆ UpdateElapsedTime()

◆ UpdatePlayerCount()

◆ UpdateViewProfileButton()

Member Data Documentation

◆ m_ContinueButton

◆ m_FactionManager

◆ m_FactionPlayerList

◆ m_FactionRequestUIHandler

◆ m_fTimer

◆ m_GameMode

◆ m_GroupOpenButton

◆ m_GroupPlayerList

◆ m_GroupRequestUIHandler

◆ m_iLastFocusedEntryPlayerId

◆ m_iMaxPlayerCount

◆ m_LoadoutRequestUIHandler

◆ m_MenuHandler

◆ m_PlyFactionAffilComp

◆ m_PlyLoadoutComp

◆ m_ViewProfileButton

◆ m_wPersistentFaction

◆ m_wPlayerCount

◆ m_wScenarioTimeElapsed

◆ m_wServerName