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

Inheritance diagram for SCR_RoleSelectionMenu:

Public Member Functions
override void	OnMenuOpen ()

override void	OnMenuOpened ()

override void	OnMenuUpdate (float tDelta)

override void	OnMenuFocusGained ()

override void	OnMenuFocusLost ()

override void	OnMenuClose ()

Public Member Functions inherited from SCR_DeployMenuBase
override void	OnMenuOpen ()

override void	OnMenuOpened ()

override void	OnMenuClose ()

override void	OnMenuHide ()

void	MuteSounds (bool mute=true)

Public Member Functions inherited from ChimeraMenuBase
override void	OnMenuInit ()

override void	OnMenuUpdate (float tDelta)

override void	OnMenuOpen ()

override void	OnMenuOpened ()

override void	OnMenuClose ()

override void	OnMenuFocusGained ()

override void	OnMenuFocusLost ()

override void	OnMenuShow ()

override void	OnMenuHide ()

Static Public Member Functions
static SCR_RoleSelectionMenu	OpenRoleSelectionMenu ()
	Open role selection menu.

static void	CloseRoleSelectionMenu ()
	Close role selection menu.

static SCR_RoleSelectionMenu	GetRoleSelectionMenu ()
	Get opened role selection menu.

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.

Protected Member Functions
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)
	Show player list for a faction.

void	ShowLoadoutList ()
	Shows the loadout 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 ()

void	OnPlayerEntryFocused (int id)

void	OnPlayerEntryFocusLost (Widget w)

void	OnViewProfile ()

void	UpdateViewProfileButton (bool forceHidden=false)

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_DeployMenuHandler	m_MenuHandler

SCR_FactionRequestUIComponent	m_FactionRequestUIHandler

SCR_LoadoutRequestUIComponent	m_LoadoutRequestUIHandler

SCR_GroupRequestUIComponent	m_GroupRequestUIHandler

SCR_FactionManager	m_FactionManager

SCR_FactionPlayerList	m_FactionPlayerList

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 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
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

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

Member Function Documentation

◆ CanContinue()

bool SCR_RoleSelectionMenu.CanContinue ( )

protected

Check if role selection screen can be closed.

◆ CanOpenGroupMenu()

bool SCR_RoleSelectionMenu.CanOpenGroupMenu ( )

protected

Check if group menu can be opened.

◆ CloseRoleSelectionMenu()

static void SCR_RoleSelectionMenu.CloseRoleSelectionMenu ( )

static

Close role selection menu.

◆ FindRequestHandlers()

void SCR_RoleSelectionMenu.FindRequestHandlers ( )

protected

Find request handlers based on the layout configuration.

◆ GetRoleSelectionMenu()

static SCR_RoleSelectionMenu SCR_RoleSelectionMenu.GetRoleSelectionMenu ( )

static

Get opened role selection menu.

Returns: the menu instance

◆ HookEvents()

void SCR_RoleSelectionMenu.HookEvents ( )

protected

Initialize event listeners.

◆ InitMapPlain()

void SCR_RoleSelectionMenu.InitMapPlain ( )

protected

Initialize empty map in the background.

◆ OnChatToggle()

void SCR_RoleSelectionMenu.OnChatToggle ( )

protected

◆ OnLocalGroupJoined()

void SCR_RoleSelectionMenu.OnLocalGroupJoined ( SCR_AIGroup group )

protected

Callback when local player joins a group.

◆ OnMenuClose()

override void SCR_RoleSelectionMenu.OnMenuClose ( )

Implements SCR_DeployMenuBase.

◆ OnMenuFocusGained()

override void SCR_RoleSelectionMenu.OnMenuFocusGained ( )

Implements ChimeraMenuBase.

◆ OnMenuFocusLost()

override void SCR_RoleSelectionMenu.OnMenuFocusLost ( )

Implements ChimeraMenuBase.

◆ OnMenuOpen()

override void SCR_RoleSelectionMenu.OnMenuOpen ( )

Implements SCR_DeployMenuBase.

◆ OnMenuOpened()

override void SCR_RoleSelectionMenu.OnMenuOpened ( )

Implements SCR_DeployMenuBase.

◆ OnMenuUpdate()

override void SCR_RoleSelectionMenu.OnMenuUpdate ( float tDelta )

Implements ChimeraMenuBase.

◆ OnMouseLeft()

void SCR_RoleSelectionMenu.OnMouseLeft ( )

protected

◆ OnPauseMenu()

void SCR_RoleSelectionMenu.OnPauseMenu ( )

protected

◆ OnPlayerEntryFocused()

void SCR_RoleSelectionMenu.OnPlayerEntryFocused ( int id )

protected

◆ OnPlayerEntryFocusLost()

void SCR_RoleSelectionMenu.OnPlayerEntryFocusLost ( Widget w )

protected

◆ OnPlayerFactionRequest()

void SCR_RoleSelectionMenu.OnPlayerFactionRequest	(	SCR_PlayerFactionAffiliationComponent	component,
		int	factionIndex
	)

protected

◆ OnPlayerFactionResponse()

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

protected

Callback when player receives a response to afaction request.

◆ OnPlayerGroupJoined()

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

protected

Callback when a player joins a group.

◆ OnPlayerLoadoutRequest()

void SCR_RoleSelectionMenu.OnPlayerLoadoutRequest	(	SCR_PlayerLoadoutComponent	component,
		int	loadoutIndex
	)

protected

◆ OnPlayerLoadoutResponse()

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

protected

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

◆ OnViewProfile()

void SCR_RoleSelectionMenu.OnViewProfile ( )

protected

◆ OpenGroupMenu()

void SCR_RoleSelectionMenu.OpenGroupMenu ( )

protected

◆ OpenRoleSelectionMenu()

static SCR_RoleSelectionMenu SCR_RoleSelectionMenu.OpenRoleSelectionMenu ( )

static

Open role selection menu.

Returns: the menu instance

◆ ShowFactionPlayerList()

void SCR_RoleSelectionMenu.ShowFactionPlayerList ( Faction faction = null )

protected

Show player list for a faction.

◆ ShowLoadoutList()

void SCR_RoleSelectionMenu.ShowLoadoutList ( )

protected

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

◆ UpdateElapsedTime()

void SCR_RoleSelectionMenu.UpdateElapsedTime ( )

protected

Update elapsed time.

◆ UpdatePlayerCount()

void SCR_RoleSelectionMenu.UpdatePlayerCount ( )

protected

Updates the session's player count.

◆ UpdateViewProfileButton()

void SCR_RoleSelectionMenu.UpdateViewProfileButton ( bool forceHidden = false )

protected

Member Data Documentation

◆ m_ContinueButton

SCR_InputButtonComponent SCR_RoleSelectionMenu.m_ContinueButton

protected

◆ m_FactionManager

SCR_FactionManager SCR_RoleSelectionMenu.m_FactionManager

protected

◆ m_FactionPlayerList

SCR_FactionPlayerList SCR_RoleSelectionMenu.m_FactionPlayerList

protected

◆ m_FactionRequestUIHandler

SCR_FactionRequestUIComponent SCR_RoleSelectionMenu.m_FactionRequestUIHandler

protected

◆ m_fTimer

float SCR_RoleSelectionMenu.m_fTimer = 0

protected

◆ m_GameMode

SCR_BaseGameMode SCR_RoleSelectionMenu.m_GameMode

protected

◆ m_GroupOpenButton

SCR_InputButtonComponent SCR_RoleSelectionMenu.m_GroupOpenButton

protected

◆ m_GroupRequestUIHandler

SCR_GroupRequestUIComponent SCR_RoleSelectionMenu.m_GroupRequestUIHandler

protected

◆ m_iLastFocusedEntryPlayerId

int SCR_RoleSelectionMenu.m_iLastFocusedEntryPlayerId

protected

◆ m_iMaxPlayerCount

int SCR_RoleSelectionMenu.m_iMaxPlayerCount

protected

◆ m_LoadoutRequestUIHandler

SCR_LoadoutRequestUIComponent SCR_RoleSelectionMenu.m_LoadoutRequestUIHandler

protected

◆ m_MenuHandler

SCR_DeployMenuHandler SCR_RoleSelectionMenu.m_MenuHandler

protected

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_RoleSelectionMenu.m_PlyFactionAffilComp

protected

◆ m_PlyLoadoutComp

SCR_PlayerLoadoutComponent SCR_RoleSelectionMenu.m_PlyLoadoutComp

protected

◆ m_ViewProfileButton

SCR_InputButtonComponent SCR_RoleSelectionMenu.m_ViewProfileButton

protected

◆ m_wPersistentFaction

Widget SCR_RoleSelectionMenu.m_wPersistentFaction

protected

◆ m_wPlayerCount

TextWidget SCR_RoleSelectionMenu.m_wPlayerCount

protected

◆ m_wScenarioTimeElapsed

TextWidget SCR_RoleSelectionMenu.m_wScenarioTimeElapsed

protected

◆ m_wServerName

TextWidget SCR_RoleSelectionMenu.m_wServerName

protected

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

Game/UI/Menu/DeployMenu/SCR_RoleSelectionMenu.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

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()

◆ ShowLoadoutList()

◆ UpdateElapsedTime()

◆ UpdatePlayerCount()

◆ UpdateViewProfileButton()

Member Data Documentation

◆ m_ContinueButton

◆ m_FactionManager

◆ m_FactionPlayerList

◆ m_FactionRequestUIHandler

◆ m_fTimer

◆ m_GameMode

◆ m_GroupOpenButton

◆ m_GroupRequestUIHandler

◆ m_iLastFocusedEntryPlayerId

◆ m_iMaxPlayerCount

◆ m_LoadoutRequestUIHandler

◆ m_MenuHandler

◆ m_PlyFactionAffilComp

◆ m_PlyLoadoutComp

◆ m_ViewProfileButton

◆ m_wPersistentFaction

◆ m_wPlayerCount

◆ m_wScenarioTimeElapsed

◆ m_wServerName