Inheritance diagram for SCR_PlayMenu:

Protected Member Functions
override void	OnMenuOpen ()
override void	OnMenuClose ()
override void	OnMenuHide ()
override void	OnMenuShow ()
override void	OnMenuFocusGained ()
void	SetupSectionTiles (SCR_PlayMenuComponent section, array< ref SCR_PlayMenuEntry > entries)
void	CreateMenuEntries (out array< ref SCR_PlayMenuEntry > entries, array< MissionWorkshopItem > scenarios, EPlayMenuContentType type)
void	GetScenarios (out array< MissionWorkshopItem > scenarios, EPlayMenuContentType type)
void	GetRecentScenarios (out array< MissionWorkshopItem > scenarios)
void	OnActionTriggered (string action, float multiplier)
	Input Events.
void	OnInteractionButtonPressed (string action)
void	OnConfirmationDialogButtonPressed (SCR_ScenarioConfirmationDialogUi dialog, string tag)
void	SwitchOnButton (string tag, MissionWorkshopItem scenario)
void	OnTileClickInteraction (float multiplier)
void	OnClickInteraction (MissionWorkshopItem scenario)
void	OnDoubleClickInteraction (MissionWorkshopItem scenario)
void	OnTileMouseClick (SCR_ScriptedWidgetComponent tile)
void	OnPlayInteraction (MissionWorkshopItem scenario)
void	OnBack ()
void	OnScenarios ()
void	Play (MissionWorkshopItem scenario)
void	Continue (MissionWorkshopItem scenario)
void	Restart (MissionWorkshopItem scenario)
void	OnRestartConfirmed ()
void	Host (MissionWorkshopItem scenario)
void	Join (MissionWorkshopItem scenario)
void	OnTileFocused (SCR_PlayMenuTileComponent tile)
void	OnTileFocusLost (SCR_PlayMenuTileComponent tile)
void	UpdateNavigationButtons (bool show=true)
void	PlayCurrentScenario ()
void	FindCurrentScenarioServers ()
void	HostCurrentScenario ()
void	OnPlayTutorial ()
SCR_PlayMenuTileComponent	GetSelectedTile ()
SCR_PlayMenuTileComponent	GetTileUnderCursor ()
MissionWorkshopItem	GetSelectedScenario ()
void	OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)

Protected Attributes
ResourceName	m_sConfig = "{6409EA8EA4BFF7E6}Configs/PlayMenu/PlayMenuEntries.conf"
ref Resource	m_Config
BaseContainer	m_ConfigEntries
const string	TYPE_FEATURED = "m_aFeaturedScenarios"
const string	TYPE_RECOMMENDED = "m_aRecommendedScenarios"
SCR_PlayMenuComponent	m_Featured
SCR_PlayMenuComponent	m_Recommended
SCR_PlayMenuComponent	m_Recent
ref array< MissionWorkshopItem >	m_aScenariosFeatured = {}
ref array< MissionWorkshopItem >	m_aScenariosRecommended = {}
ref array< MissionWorkshopItem >	m_aScenariosRecent = {}
ref array< ref SCR_PlayMenuEntry >	m_aEntriesFeatured = {}
ref array< ref SCR_PlayMenuEntry >	m_aEntriesRecommended = {}
ref array< ref SCR_PlayMenuEntry >	m_aEntriesRecent = {}
ref MissionWorkshopItem	m_ItemTutorial
WorkshopApi	m_WorkshopAPI
SCR_PlayMenuTileComponent	m_CurrentTile
Widget	m_wRoot
bool	m_bTutorialPlayed
bool	m_bShowPlayTutorialDialog
int	m_iPlayTutorialShowCount
int	m_iPlayTutorialShowMax
const int	THRESHOLD_RECENTLY_PLAYED = 3600 * 24 * 30
ref array< SCR_InputButtonComponent >	m_aRightFooterButtons = {}
SCR_PlayMenuTileComponent	m_ClickedTile
MissionWorkshopItem	m_SelectedScenario
SCR_MenuActionsComponent	m_ActionsComponent

Detailed Description

Definition at line 20 of file SCR_PlayMenu.c.

Member Function Documentation

◆ Continue()

void SCR_PlayMenu::Continue ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 455 of file SCR_PlayMenu.c.

◆ CreateMenuEntries()

void SCR_PlayMenu::CreateMenuEntries	(	out array< ref SCR_PlayMenuEntry >	entries,
		array< MissionWorkshopItem >	scenarios,
		EPlayMenuContentType	type )

inlineprotected

Definition at line 231 of file SCR_PlayMenu.c.

◆ FindCurrentScenarioServers()

void SCR_PlayMenu::FindCurrentScenarioServers ( )

inlineprotected

Definition at line 541 of file SCR_PlayMenu.c.

◆ GetRecentScenarios()

void SCR_PlayMenu::GetRecentScenarios ( out array< MissionWorkshopItem > scenarios )

inlineprotected

Definition at line 265 of file SCR_PlayMenu.c.

◆ GetScenarios()

void SCR_PlayMenu::GetScenarios	(	out array< MissionWorkshopItem >	scenarios,
		EPlayMenuContentType	type )

inlineprotected

Definition at line 240 of file SCR_PlayMenu.c.

◆ GetSelectedScenario()

MissionWorkshopItem SCR_PlayMenu::GetSelectedScenario ( )

inlineprotected

Definition at line 597 of file SCR_PlayMenu.c.

◆ GetSelectedTile()

SCR_PlayMenuTileComponent SCR_PlayMenu::GetSelectedTile ( )

inlineprotected

Definition at line 568 of file SCR_PlayMenu.c.

◆ GetTileUnderCursor()

SCR_PlayMenuTileComponent SCR_PlayMenu::GetTileUnderCursor ( )

inlineprotected

Definition at line 586 of file SCR_PlayMenu.c.

◆ Host()

void SCR_PlayMenu::Host ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 481 of file SCR_PlayMenu.c.

◆ HostCurrentScenario()

void SCR_PlayMenu::HostCurrentScenario ( )

inlineprotected

Definition at line 548 of file SCR_PlayMenu.c.

◆ Join()

void SCR_PlayMenu::Join ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 494 of file SCR_PlayMenu.c.

◆ OnActionTriggered()

void SCR_PlayMenu::OnActionTriggered	(	string	action,
		float	multiplier )

inlineprotected

Input Events.

TODO: set which input modes should trigger the actions in the component itself

Definition at line 293 of file SCR_PlayMenu.c.

◆ OnBack()

void SCR_PlayMenu::OnBack ( )

inlineprotected

Definition at line 405 of file SCR_PlayMenu.c.

◆ OnClickInteraction()

void SCR_PlayMenu::OnClickInteraction ( MissionWorkshopItem scenario )

inlineprotected

Confirmation Dialog

Bind dialog delegates

Definition at line 366 of file SCR_PlayMenu.c.

◆ OnCommStatusCheckFinished()

void SCR_PlayMenu::OnCommStatusCheckFinished	(	SCR_ECommStatus	status,
		float	responseTime,
		float	lastSuccessTime,
		float	lastFailTime )

inlineprotected

Definition at line 608 of file SCR_PlayMenu.c.

◆ OnConfirmationDialogButtonPressed()

void SCR_PlayMenu::OnConfirmationDialogButtonPressed	(	SCR_ScenarioConfirmationDialogUi	dialog,
		string	tag )

inlineprotected

Definition at line 317 of file SCR_PlayMenu.c.

◆ OnDoubleClickInteraction()

void SCR_PlayMenu::OnDoubleClickInteraction ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 381 of file SCR_PlayMenu.c.

◆ OnInteractionButtonPressed()

void SCR_PlayMenu::OnInteractionButtonPressed ( string action )

inlineprotected

Definition at line 311 of file SCR_PlayMenu.c.

◆ OnMenuClose()

override void SCR_PlayMenu::OnMenuClose ( )

inlineprotected

Definition at line 153 of file SCR_PlayMenu.c.

◆ OnMenuFocusGained()

override void SCR_PlayMenu::OnMenuFocusGained ( )

inlineprotected

Definition at line 180 of file SCR_PlayMenu.c.

◆ OnMenuHide()

override void SCR_PlayMenu::OnMenuHide ( )

inlineprotected

Definition at line 161 of file SCR_PlayMenu.c.

◆ OnMenuOpen()

override void SCR_PlayMenu::OnMenuOpen ( )

inlineprotected

Inputs Buttons

Listeners

Definition at line 61 of file SCR_PlayMenu.c.

◆ OnMenuShow()

override void SCR_PlayMenu::OnMenuShow ( )

inlineprotected

Definition at line 169 of file SCR_PlayMenu.c.

◆ OnPlayInteraction()

void SCR_PlayMenu::OnPlayInteraction ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 398 of file SCR_PlayMenu.c.

◆ OnPlayTutorial()

void SCR_PlayMenu::OnPlayTutorial ( )

inlineprotected

Definition at line 562 of file SCR_PlayMenu.c.

◆ OnRestartConfirmed()

void SCR_PlayMenu::OnRestartConfirmed ( )

inlineprotected

Definition at line 474 of file SCR_PlayMenu.c.

◆ OnScenarios()

void SCR_PlayMenu::OnScenarios ( )

inlineprotected

Definition at line 411 of file SCR_PlayMenu.c.

◆ OnTileClickInteraction()

void SCR_PlayMenu::OnTileClickInteraction ( float multiplier )

inlineprotected

multiplier value in the action is used to differentiate between single and double click

Definition at line 344 of file SCR_PlayMenu.c.

◆ OnTileFocused()

void SCR_PlayMenu::OnTileFocused ( SCR_PlayMenuTileComponent tile )

inlineprotected

Definition at line 507 of file SCR_PlayMenu.c.

◆ OnTileFocusLost()

void SCR_PlayMenu::OnTileFocusLost ( SCR_PlayMenuTileComponent tile )

inlineprotected

Definition at line 517 of file SCR_PlayMenu.c.

◆ OnTileMouseClick()

void SCR_PlayMenu::OnTileMouseClick ( SCR_ScriptedWidgetComponent tile )

inlineprotected

Definition at line 391 of file SCR_PlayMenu.c.

◆ Play()

void SCR_PlayMenu::Play ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 419 of file SCR_PlayMenu.c.

◆ PlayCurrentScenario()

void SCR_PlayMenu::PlayCurrentScenario ( )

inlineprotected

Definition at line 535 of file SCR_PlayMenu.c.

◆ Restart()

void SCR_PlayMenu::Restart ( MissionWorkshopItem scenario )

inlineprotected

Definition at line 462 of file SCR_PlayMenu.c.

◆ SetupSectionTiles()

void SCR_PlayMenu::SetupSectionTiles	(	SCR_PlayMenuComponent	section,
		array< ref SCR_PlayMenuEntry >	entries )

inlineprotected

Definition at line 202 of file SCR_PlayMenu.c.

◆ SwitchOnButton()

void SCR_PlayMenu::SwitchOnButton	(	string	tag,
		MissionWorkshopItem	scenario )

inlineprotected

Definition at line 326 of file SCR_PlayMenu.c.

◆ UpdateNavigationButtons()

void SCR_PlayMenu::UpdateNavigationButtons ( bool show = true )

inlineprotected

Definition at line 525 of file SCR_PlayMenu.c.

Member Data Documentation

◆ m_ActionsComponent

SCR_MenuActionsComponent SCR_PlayMenu::m_ActionsComponent

protected

Definition at line 58 of file SCR_PlayMenu.c.

◆ m_aEntriesFeatured

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu::m_aEntriesFeatured = {}

protected

Definition at line 37 of file SCR_PlayMenu.c.

◆ m_aEntriesRecent

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu::m_aEntriesRecent = {}

protected

Definition at line 39 of file SCR_PlayMenu.c.

◆ m_aEntriesRecommended

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu::m_aEntriesRecommended = {}

protected

Definition at line 38 of file SCR_PlayMenu.c.

◆ m_aRightFooterButtons

ref array<SCR_InputButtonComponent> SCR_PlayMenu::m_aRightFooterButtons = {}

protected

Definition at line 52 of file SCR_PlayMenu.c.

◆ m_aScenariosFeatured

ref array<MissionWorkshopItem> SCR_PlayMenu::m_aScenariosFeatured = {}

protected

Definition at line 33 of file SCR_PlayMenu.c.

◆ m_aScenariosRecent

ref array<MissionWorkshopItem> SCR_PlayMenu::m_aScenariosRecent = {}

protected

Definition at line 35 of file SCR_PlayMenu.c.

◆ m_aScenariosRecommended

ref array<MissionWorkshopItem> SCR_PlayMenu::m_aScenariosRecommended = {}

protected

Definition at line 34 of file SCR_PlayMenu.c.

◆ m_bShowPlayTutorialDialog

bool SCR_PlayMenu::m_bShowPlayTutorialDialog

protected

Definition at line 46 of file SCR_PlayMenu.c.

◆ m_bTutorialPlayed

bool SCR_PlayMenu::m_bTutorialPlayed

protected

Definition at line 45 of file SCR_PlayMenu.c.

◆ m_ClickedTile

SCR_PlayMenuTileComponent SCR_PlayMenu::m_ClickedTile

protected

Definition at line 54 of file SCR_PlayMenu.c.

◆ m_Config

ref Resource SCR_PlayMenu::m_Config

protected

Definition at line 23 of file SCR_PlayMenu.c.

◆ m_ConfigEntries

BaseContainer SCR_PlayMenu::m_ConfigEntries

protected

Definition at line 24 of file SCR_PlayMenu.c.

◆ m_CurrentTile

SCR_PlayMenuTileComponent SCR_PlayMenu::m_CurrentTile

protected

Definition at line 43 of file SCR_PlayMenu.c.

◆ m_Featured

SCR_PlayMenuComponent SCR_PlayMenu::m_Featured

protected

Definition at line 29 of file SCR_PlayMenu.c.

◆ m_iPlayTutorialShowCount

int SCR_PlayMenu::m_iPlayTutorialShowCount

protected

Definition at line 47 of file SCR_PlayMenu.c.

◆ m_iPlayTutorialShowMax

int SCR_PlayMenu::m_iPlayTutorialShowMax

protected

Definition at line 48 of file SCR_PlayMenu.c.

◆ m_ItemTutorial

ref MissionWorkshopItem SCR_PlayMenu::m_ItemTutorial

protected

Definition at line 41 of file SCR_PlayMenu.c.

◆ m_Recent

SCR_PlayMenuComponent SCR_PlayMenu::m_Recent

protected

Definition at line 31 of file SCR_PlayMenu.c.

◆ m_Recommended

SCR_PlayMenuComponent SCR_PlayMenu::m_Recommended

protected

Definition at line 30 of file SCR_PlayMenu.c.

◆ m_sConfig

ResourceName SCR_PlayMenu::m_sConfig = "{6409EA8EA4BFF7E6}Configs/PlayMenu/PlayMenuEntries.conf"

protected

Definition at line 22 of file SCR_PlayMenu.c.

◆ m_SelectedScenario

MissionWorkshopItem SCR_PlayMenu::m_SelectedScenario

protected

Definition at line 56 of file SCR_PlayMenu.c.

◆ m_WorkshopAPI

WorkshopApi SCR_PlayMenu::m_WorkshopAPI

protected

Definition at line 42 of file SCR_PlayMenu.c.

◆ m_wRoot

Widget SCR_PlayMenu::m_wRoot

protected

Definition at line 44 of file SCR_PlayMenu.c.

◆ THRESHOLD_RECENTLY_PLAYED

const int SCR_PlayMenu::THRESHOLD_RECENTLY_PLAYED = 3600 * 24 * 30

protected

Definition at line 50 of file SCR_PlayMenu.c.

◆ TYPE_FEATURED

const string SCR_PlayMenu::TYPE_FEATURED = "m_aFeaturedScenarios"

protected

Definition at line 26 of file SCR_PlayMenu.c.

◆ TYPE_RECOMMENDED

const string SCR_PlayMenu::TYPE_RECOMMENDED = "m_aRecommendedScenarios"

protected

Definition at line 27 of file SCR_PlayMenu.c.

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

scripts/Game/UI/Menu/PlayMenu/SCR_PlayMenu.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Continue()

◆ CreateMenuEntries()

◆ FindCurrentScenarioServers()

◆ GetRecentScenarios()

◆ GetScenarios()

◆ GetSelectedScenario()

◆ GetSelectedTile()

◆ GetTileUnderCursor()

◆ Host()

◆ HostCurrentScenario()

◆ Join()

◆ OnActionTriggered()

◆ OnBack()

◆ OnClickInteraction()

◆ OnCommStatusCheckFinished()

◆ OnConfirmationDialogButtonPressed()

◆ OnDoubleClickInteraction()

◆ OnInteractionButtonPressed()

◆ OnMenuClose()

◆ OnMenuFocusGained()

◆ OnMenuHide()

◆ OnMenuOpen()

◆ OnMenuShow()

◆ OnPlayInteraction()

◆ OnPlayTutorial()

◆ OnRestartConfirmed()

◆ OnScenarios()

◆ OnTileClickInteraction()

◆ OnTileFocused()

◆ OnTileFocusLost()

◆ OnTileMouseClick()

◆ Play()

◆ PlayCurrentScenario()

◆ Restart()

◆ SetupSectionTiles()

◆ SwitchOnButton()

◆ UpdateNavigationButtons()

Member Data Documentation

◆ m_ActionsComponent

◆ m_aEntriesFeatured

◆ m_aEntriesRecent

◆ m_aEntriesRecommended

◆ m_aRightFooterButtons

◆ m_aScenariosFeatured

◆ m_aScenariosRecent

◆ m_aScenariosRecommended

◆ m_bShowPlayTutorialDialog

◆ m_bTutorialPlayed

◆ m_ClickedTile

◆ m_Config

◆ m_ConfigEntries

◆ m_CurrentTile

◆ m_Featured

◆ m_iPlayTutorialShowCount

◆ m_iPlayTutorialShowMax

◆ m_ItemTutorial

◆ m_Recent

◆ m_Recommended

◆ m_sConfig

◆ m_SelectedScenario

◆ m_WorkshopAPI

◆ m_wRoot

◆ THRESHOLD_RECENTLY_PLAYED

◆ TYPE_FEATURED

◆ TYPE_RECOMMENDED