SCR_ContentBrowser_ScenarioSubMenuBase.c File Reference

Go to the source code of this file.

Classes
class	SCR_ScenarioMenuLoadContext

Functions
class SCR_ScenarioMenuLoadContext	Attribute ("{FEFDB7917AB8310F}UI/layouts/Menus/ContentBrowser/ScenariosMenu/ContentBrowser_ScenarioLine.layout", UIWidgets.ResourceNamePicker, ".layout for the scenario lines", params:"layout")] protected ResourceName m_sLinesLayout
override void	HandlerAttached (Widget w)
override void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
override void	OnMenuUpdate (float tDelta)
override void	OnTabShow ()
override void	OnTabHide ()
override void	OnMenuFocusGained ()
override void	OnMenuShow ()
void	OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)
void	OnLineFocus (SCR_ScriptedWidgetComponent entry)
void	OnLineFocusLost (SCR_ScriptedWidgetComponent entry)
void	OnLineMouseEnter (SCR_ScriptedWidgetComponent entry)
void	OnLineMouseClick (SCR_ScriptedWidgetComponent button)
void	OnLineFavorite (SCR_BrowserListMenuEntryComponent entry, bool favorite)
void	OnScenarioStateChanged (SCR_ContentBrowser_ScenarioLineComponent comp)
	Called from scenario line component when scenario state changes.
void	OnActionTriggered (string action, float multiplier)
void	OnInteractionButtonPressed (string action)
void	OnConfirmationDialogButtonPressed (SCR_ScenarioConfirmationDialogUi dialog, string tag)
void	SwitchOnButton (string tag, MissionWorkshopItem scenario)
void	OnLineClickInteraction (float multiplier)
void	OnLineClick (SCR_ContentBrowser_ScenarioLineComponent lineComp)
void	OnLineDoubleClick (SCR_ContentBrowser_ScenarioLineComponent lineComp)
void	OnFavouriteButton ()
void	OnPlayInteraction (MissionWorkshopItem scenario)
bool	Play (MissionWorkshopItem scenario)
bool	Continue (MissionWorkshopItem scenario)
void	Restart (MissionWorkshopItem scenario)
void	OnRestartConfirmed ()
void	Join (MissionWorkshopItem scenario)
void	Host (MissionWorkshopItem scenario)
void	SetFavorite (MissionWorkshopItem scenario)
void	CreateLines (array< MissionWorkshopItem > scenarios, Widget parent)
Widget	CreateLine (ResourceName layout, Widget parent, MissionWorkshopItem scenario)
void	OnScenariosLoadFailed ()
void	InitWidgets ()
void	InitWorkshopApi ()
void	UpdateSidePanel ()
void	UpdateNavigationButtons (bool visible=true)
SCR_ContentBrowser_ScenarioLineComponent	GetSelectedLine ()
SCR_ContentBrowser_ScenarioLineComponent	GetLineUnderCursor ()
MissionWorkshopItem	GetSelectedScenario ()
ScriptInvokerBool	GetOnLineFavorite ()

Variables
ref array< MissionWorkshopItem >	m_aScenarios
Widget	m_wListRoot
ref array< SCR_ContentBrowser_ScenarioLineComponent >	m_aScenarioLines = {}
SCR_ContentBrowser_ScenarioLineComponent	m_SelectedLine
SCR_ContentBrowser_ScenarioLineComponent	m_LastSelectedLine
MissionWorkshopItem	m_SelectedScenario
ref SCR_MissionHeader	m_Header
SCR_ScenarioDetailsPanelComponent	m_ScenarioDetailsPanel
SCR_AddonDetailsPanelComponent	m_AddonDetailsPanel
EInputDeviceType	m_eLastInputType
bool	m_bWasLineSelected
SCR_ContentBrowser_ScenarioLineComponent	m_ClickedLine
SCR_MenuActionsComponent	m_ActionsComponent
SCR_InputButtonComponent	m_NavFavorite
ref array< SCR_InputButtonComponent >	m_aRightFooterButtons = {}
ref ScriptInvokerBool	m_OnLineFavorite
bool	m_bIsListeningForCommStatus
WorkshopApi	m_WorkshopApi

Function Documentation

Attribute()

class SCR_ScenarioMenuLoadContext Attribute	(	"{FEFDB7917AB8310F}UI/layouts/Menus/ContentBrowser/ScenariosMenu/ContentBrowser_ScenarioLine.layout"	,
		UIWidgets.	ResourceNamePicker,
		".layout for the scenario lines"	,
		params:"layout"	)

Continue()

bool Continue ( MissionWorkshopItem scenario )

protected

Definition at line 361 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

CreateLine()

Widget CreateLine ( ResourceName layout, Widget parent, MissionWorkshopItem scenario )

protected

Definition at line 440 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

CreateLines()

void CreateLines ( array< MissionWorkshopItem > scenarios, Widget parent )

protected

Definition at line 431 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

GetLineUnderCursor()

SCR_ContentBrowser_ScenarioLineComponent GetLineUnderCursor ( )

protected

Definition at line 542 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

GetOnLineFavorite()

ScriptInvokerBool GetOnLineFavorite ( )

protected

Definition at line 567 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

GetSelectedLine()

SCR_ContentBrowser_ScenarioLineComponent GetSelectedLine ( )

protected

Definition at line 524 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

GetSelectedScenario()

MissionWorkshopItem GetSelectedScenario ( )

protected

Definition at line 555 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

HandlerAttached()

override void HandlerAttached ( Widget w )

protected

Definition at line 45 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

Host()

void Host ( MissionWorkshopItem scenario )

protected

Definition at line 399 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

InitWidgets()

void InitWidgets ( )

protected

Definition at line 260 of file SCR_ContentBrowser_AddonsSubMenu.c.

InitWorkshopApi()

void InitWorkshopApi ( )

protected

Definition at line 470 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

Join()

void Join ( MissionWorkshopItem scenario )

protected

Definition at line 390 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnActionTriggered()

void OnActionTriggered ( string action, float multiplier )

protected

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

Definition at line 203 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnCommStatusCheckFinished()

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

protected

Definition at line 152 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnConfirmationDialogButtonPressed()

void OnConfirmationDialogButtonPressed ( SCR_ScenarioConfirmationDialogUi dialog, string tag )

protected

Definition at line 233 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnFavouriteButton()

void OnFavouriteButton ( )

protected

Definition at line 336 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnInteractionButtonPressed()

void OnInteractionButtonPressed ( string action )

protected

Definition at line 227 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineClick()

void OnLineClick ( SCR_ContentBrowser_ScenarioLineComponent lineComp )

protected

CONFIRMATION DIALOG

If using Mouse single click opens confirmation dialog, double click goes straight to the play interaction

Bind dialog delegates

If using Gamepad or Keyboard there's no confirmation dialog and single click starts the play interaction

Definition at line 276 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineClickInteraction()

void OnLineClickInteraction ( float multiplier )

protected

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

Definition at line 258 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineDoubleClick()

void OnLineDoubleClick ( SCR_ContentBrowser_ScenarioLineComponent lineComp )

protected

Definition at line 326 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineFavorite()

void OnLineFavorite ( SCR_BrowserListMenuEntryComponent entry, bool favorite )

protected

Definition at line 188 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineFocus()

void OnLineFocus ( SCR_ScriptedWidgetComponent entry )

protected

Definition at line 158 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineFocusLost()

void OnLineFocusLost ( SCR_ScriptedWidgetComponent entry )

protected

Definition at line 170 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineMouseClick()

void OnLineMouseClick ( SCR_ScriptedWidgetComponent button )

protected

Definition at line 182 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnLineMouseEnter()

void OnLineMouseEnter ( SCR_ScriptedWidgetComponent entry )

protected

OnMenuFocusGained()

override void OnMenuFocusGained ( )

protected

Definition at line 129 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnMenuShow()

override void OnMenuShow ( )

protected

Definition at line 142 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnMenuUpdate()

override void OnMenuUpdate ( float tDelta )

protected

Update selected scenario

Update buttons

Definition at line 77 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnPlayInteraction()

void OnPlayInteraction ( MissionWorkshopItem scenario )

protected

Definition at line 345 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnRestartConfirmed()

void OnRestartConfirmed ( )

protected

Definition at line 384 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnScenariosLoadFailed()

void OnScenariosLoadFailed ( )

protected

Definition at line 103 of file SCR_ContentBrowser_ScenarioSubMenu.c.

OnScenarioStateChanged()

void OnScenarioStateChanged ( SCR_ContentBrowser_ScenarioLineComponent comp )

protected

Called from scenario line component when scenario state changes.

Definition at line 195 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnTabCreate()

override void OnTabCreate ( Widget menuRoot, ResourceName buttonsLayout, int index )

protected

Definition at line 52 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnTabHide()

override void OnTabHide ( )

protected

Definition at line 118 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

OnTabShow()

override void OnTabShow ( )

protected

Definition at line 102 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

Play()

bool Play ( MissionWorkshopItem scenario )

protected

Definition at line 351 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

Restart()

void Restart ( MissionWorkshopItem scenario )

protected

Definition at line 371 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

SetFavorite()

void SetFavorite ( MissionWorkshopItem scenario )

protected

Definition at line 412 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

SwitchOnButton()

void SwitchOnButton ( string tag, MissionWorkshopItem scenario )

protected

Definition at line 242 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

UpdateNavigationButtons()

void UpdateNavigationButtons ( bool visible = true )

protected

Definition at line 510 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

UpdateSidePanel()

void UpdateSidePanel ( )

protected

Definition at line 478 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

Variable Documentation

m_ActionsComponent

SCR_MenuActionsComponent m_ActionsComponent

protected

Definition at line 32 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_AddonDetailsPanel

SCR_AddonDetailsPanelComponent m_AddonDetailsPanel

protected

Definition at line 25 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_aRightFooterButtons

ref array<SCR_InputButtonComponent> m_aRightFooterButtons = {}

protected

Definition at line 36 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_aScenarioLines

ref array<SCR_ContentBrowser_ScenarioLineComponent> m_aScenarioLines = {}

protected

Definition at line 16 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_aScenarios

ref array<MissionWorkshopItem> m_aScenarios

Definition at line 0 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_bIsListeningForCommStatus

bool m_bIsListeningForCommStatus

protected

Definition at line 41 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_bWasLineSelected

bool m_bWasLineSelected

protected

Definition at line 29 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_ClickedLine

SCR_ContentBrowser_ScenarioLineComponent m_ClickedLine

protected

Definition at line 30 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_eLastInputType

EInputDeviceType m_eLastInputType

protected

Definition at line 28 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_Header

ref SCR_MissionHeader m_Header

protected

Definition at line 22 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_LastSelectedLine

SCR_ContentBrowser_ScenarioLineComponent m_LastSelectedLine

protected

Definition at line 19 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_NavFavorite

SCR_InputButtonComponent m_NavFavorite

protected

Definition at line 35 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_OnLineFavorite

ref ScriptInvokerBool m_OnLineFavorite

protected

Definition at line 39 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_ScenarioDetailsPanel

SCR_ScenarioDetailsPanelComponent m_ScenarioDetailsPanel

protected

Definition at line 24 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_SelectedLine

SCR_ContentBrowser_ScenarioLineComponent m_SelectedLine

protected

Definition at line 18 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_SelectedScenario

MissionWorkshopItem m_SelectedScenario

protected

Definition at line 21 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_wListRoot

Widget m_wListRoot

Definition at line 1 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.

m_WorkshopApi

WorkshopApi m_WorkshopApi

protected

Definition at line 42 of file SCR_ContentBrowser_ScenarioSubMenuBase.c.