Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_ContentBrowser_ScenarioSubMenuBase Interface Reference
Inheritance diagram for SCR_ContentBrowser_ScenarioSubMenuBase:
[legend]

Public Member Functions

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 ()
 
ScriptInvokerBool GetOnLineFavorite ()
 
- Public Member Functions inherited from SCR_SubMenuBase
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuUpdate (float tDelta)
 
void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
void OnTabShow ()
 
void OnTabHide ()
 
void OnTabRemove ()
 
void OnTabChange ()
 
bool GetShown ()
 
int GetIndex ()
 
ScriptInvokerVoid GetOnRequestCloseMenu ()
 
ScriptInvokerInt2 GetOnRequestTabChange ()
 
- Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
Widget GetRootWidget ()
 
bool IsVisible ()
 

Protected Member Functions

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)
 
void Play (MissionWorkshopItem scenario)
 
void Continue (MissionWorkshopItem scenario)
 
void Restart (MissionWorkshopItem scenario)
 
void OnRestartConfirmed ()
 
void Join (MissionWorkshopItem scenario)
 
void Host (MissionWorkshopItem scenario)
 
void SetFavorite (MissionWorkshopItem scenario)
 
bool CreateLines (array< MissionWorkshopItem > scenarios, Widget parent)
 
void InitWidgets ()
 
void InitWorkshopApi ()
 
void UpdateSidePanel ()
 
void UpdateNavigationButtons (bool visible=true)
 
SCR_ContentBrowser_ScenarioLineComponent GetSelectedLine ()
 
SCR_ContentBrowser_ScenarioLineComponent GetLineUnderCursor ()
 
MissionWorkshopItem GetSelectedScenario ()
 
- Protected Member Functions inherited from SCR_SubMenuBase
void ShowNavigationButtons (bool show)
 
void FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show)
 
void SetNavigationButtonVisibile (SCR_InputButtonComponent button, bool show, bool animate=false)
 
SCR_InputButtonComponent CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true)
 
void RequestCloseMenu ()
 
void RequestTabChange (int newTabIndex)
 

Protected Attributes

ResourceName m_sLinesLayout
 
ref array< SCR_ContentBrowser_ScenarioLineComponentm_aScenarioLines = {}
 
SCR_ContentBrowser_ScenarioLineComponent m_SelectedLine
 
SCR_ContentBrowser_ScenarioLineComponent m_LastSelectedLine
 
MissionWorkshopItem m_SelectedScenario
 
ref SCR_MissionHeader m_Header
 
SCR_ScenarioDetailsPanelComponent m_ScenarioDetailsPanel
 
EInputDeviceType m_eLastInputType
 
bool m_bWasLineSelected
 
SCR_ContentBrowser_ScenarioLineComponent m_ClickedLine
 
SCR_MenuActionsComponent m_ActionsComponent
 
SCR_InputButtonComponent m_NavFavorite
 
ref array< SCR_InputButtonComponentm_aRightFooterButtons = {}
 
ref ScriptInvokerBool m_OnLineFavorite
 
bool m_bIsListeningForCommStatus
 
WorkshopApi m_WorkshopApi
 
- Protected Attributes inherited from SCR_SubMenuBase
ResourceName m_sNavigationButtonLayout
 
SCR_DynamicFooterComponent m_DynamicFooter
 
ref array< SCR_InputButtonComponentm_aNavigationButtons = {}
 
ref map< SCR_InputButtonComponent, bool > m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()
 
Widget m_wMenuRoot
 
int m_iIndex
 
bool m_bShown
 
bool m_bFocused
 
ref ScriptInvokerVoid m_OnRequestCloseMenu
 
ref ScriptInvokerInt2 m_OnRequestTabChange
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
 Base method for component lookup through the widget library.
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Member Function Documentation

◆ Continue()

void SCR_ContentBrowser_ScenarioSubMenuBase.Continue ( MissionWorkshopItem  scenario)
protected

◆ CreateLines()

bool SCR_ContentBrowser_ScenarioSubMenuBase.CreateLines ( array< MissionWorkshopItem >  scenarios,
Widget  parent 
)
protected

◆ GetLineUnderCursor()

SCR_ContentBrowser_ScenarioLineComponent SCR_ContentBrowser_ScenarioSubMenuBase.GetLineUnderCursor ( )
protected

◆ GetOnLineFavorite()

ScriptInvokerBool SCR_ContentBrowser_ScenarioSubMenuBase.GetOnLineFavorite ( )

◆ GetSelectedLine()

SCR_ContentBrowser_ScenarioLineComponent SCR_ContentBrowser_ScenarioSubMenuBase.GetSelectedLine ( )
protected

◆ GetSelectedScenario()

MissionWorkshopItem SCR_ContentBrowser_ScenarioSubMenuBase.GetSelectedScenario ( )
protected

◆ HandlerAttached()

override void SCR_ContentBrowser_ScenarioSubMenuBase.HandlerAttached ( Widget  w)

◆ Host()

void SCR_ContentBrowser_ScenarioSubMenuBase.Host ( MissionWorkshopItem  scenario)
protected

◆ InitWidgets()

void SCR_ContentBrowser_ScenarioSubMenuBase.InitWidgets ( )
protected

◆ InitWorkshopApi()

void SCR_ContentBrowser_ScenarioSubMenuBase.InitWorkshopApi ( )
protected

◆ Join()

void SCR_ContentBrowser_ScenarioSubMenuBase.Join ( MissionWorkshopItem  scenario)
protected

◆ OnActionTriggered()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnActionTriggered ( string  action,
float  multiplier 
)
protected

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

◆ OnCommStatusCheckFinished()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnCommStatusCheckFinished ( SCR_ECommStatus  status,
float  responseTime,
float  lastSuccessTime,
float  lastFailTime 
)
protected

◆ OnConfirmationDialogButtonPressed()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnConfirmationDialogButtonPressed ( SCR_ScenarioConfirmationDialogUi  dialog,
string  tag 
)
protected

◆ OnFavouriteButton()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnFavouriteButton ( )
protected

◆ OnInteractionButtonPressed()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnInteractionButtonPressed ( string  action)
protected

◆ OnLineClick()

void SCR_ContentBrowser_ScenarioSubMenuBase.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

Implemented in SCR_ContentBrowserDetails_OverviewSubMenu.

◆ OnLineClickInteraction()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineClickInteraction ( float  multiplier)
protected

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

◆ OnLineDoubleClick()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineDoubleClick ( SCR_ContentBrowser_ScenarioLineComponent  lineComp)
protected

◆ OnLineFavorite()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineFavorite ( SCR_BrowserListMenuEntryComponent  entry,
bool  favorite 
)
protected

◆ OnLineFocus()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineFocus ( SCR_ScriptedWidgetComponent  entry)
protected

◆ OnLineFocusLost()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineFocusLost ( SCR_ScriptedWidgetComponent  entry)
protected

◆ OnLineMouseClick()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineMouseClick ( SCR_ScriptedWidgetComponent  button)
protected

◆ OnLineMouseEnter()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnLineMouseEnter ( SCR_ScriptedWidgetComponent  entry)
protected

◆ OnMenuFocusGained()

override void SCR_ContentBrowser_ScenarioSubMenuBase.OnMenuFocusGained ( )

◆ OnMenuShow()

override void SCR_ContentBrowser_ScenarioSubMenuBase.OnMenuShow ( )

Implements SCR_SubMenuBase.

◆ OnMenuUpdate()

override void SCR_ContentBrowser_ScenarioSubMenuBase.OnMenuUpdate ( float  tDelta)

Update selected scenario

Update buttons

Implements SCR_SubMenuBase.

◆ OnPlayInteraction()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnPlayInteraction ( MissionWorkshopItem  scenario)
protected

◆ OnRestartConfirmed()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnRestartConfirmed ( )
protected

◆ OnScenarioStateChanged()

void SCR_ContentBrowser_ScenarioSubMenuBase.OnScenarioStateChanged ( SCR_ContentBrowser_ScenarioLineComponent  comp)
protected

Called from scenario line component when scenario state changes.

Implemented in SCR_ContentBrowserDetails_OverviewSubMenu, and SCR_ContentBrowser_ScenarioSubMenu.

◆ OnTabCreate()

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

◆ OnTabHide()

override void SCR_ContentBrowser_ScenarioSubMenuBase.OnTabHide ( )

◆ OnTabShow()

override void SCR_ContentBrowser_ScenarioSubMenuBase.OnTabShow ( )

◆ Play()

void SCR_ContentBrowser_ScenarioSubMenuBase.Play ( MissionWorkshopItem  scenario)
protected

◆ Restart()

void SCR_ContentBrowser_ScenarioSubMenuBase.Restart ( MissionWorkshopItem  scenario)
protected

◆ SetFavorite()

void SCR_ContentBrowser_ScenarioSubMenuBase.SetFavorite ( MissionWorkshopItem  scenario)
protected

◆ SwitchOnButton()

void SCR_ContentBrowser_ScenarioSubMenuBase.SwitchOnButton ( string  tag,
MissionWorkshopItem  scenario 
)
protected

◆ UpdateNavigationButtons()

void SCR_ContentBrowser_ScenarioSubMenuBase.UpdateNavigationButtons ( bool  visible = true)
protected

◆ UpdateSidePanel()

void SCR_ContentBrowser_ScenarioSubMenuBase.UpdateSidePanel ( )
protected

Member Data Documentation

◆ m_ActionsComponent

SCR_MenuActionsComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_ActionsComponent
protected

◆ m_aRightFooterButtons

ref array<SCR_InputButtonComponent> SCR_ContentBrowser_ScenarioSubMenuBase.m_aRightFooterButtons = {}
protected

◆ m_aScenarioLines

ref array<SCR_ContentBrowser_ScenarioLineComponent> SCR_ContentBrowser_ScenarioSubMenuBase.m_aScenarioLines = {}
protected

◆ m_bIsListeningForCommStatus

bool SCR_ContentBrowser_ScenarioSubMenuBase.m_bIsListeningForCommStatus
protected

◆ m_bWasLineSelected

bool SCR_ContentBrowser_ScenarioSubMenuBase.m_bWasLineSelected
protected

◆ m_ClickedLine

SCR_ContentBrowser_ScenarioLineComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_ClickedLine
protected

◆ m_eLastInputType

EInputDeviceType SCR_ContentBrowser_ScenarioSubMenuBase.m_eLastInputType
protected

◆ m_Header

ref SCR_MissionHeader SCR_ContentBrowser_ScenarioSubMenuBase.m_Header
protected

◆ m_LastSelectedLine

SCR_ContentBrowser_ScenarioLineComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_LastSelectedLine
protected

◆ m_NavFavorite

SCR_InputButtonComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_NavFavorite
protected

◆ m_OnLineFavorite

ref ScriptInvokerBool SCR_ContentBrowser_ScenarioSubMenuBase.m_OnLineFavorite
protected

◆ m_ScenarioDetailsPanel

SCR_ScenarioDetailsPanelComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_ScenarioDetailsPanel
protected

◆ m_SelectedLine

SCR_ContentBrowser_ScenarioLineComponent SCR_ContentBrowser_ScenarioSubMenuBase.m_SelectedLine
protected

◆ m_SelectedScenario

MissionWorkshopItem SCR_ContentBrowser_ScenarioSubMenuBase.m_SelectedScenario
protected

◆ m_sLinesLayout

ResourceName SCR_ContentBrowser_ScenarioSubMenuBase.m_sLinesLayout
protected

◆ m_WorkshopApi

WorkshopApi SCR_ContentBrowser_ScenarioSubMenuBase.m_WorkshopApi
protected

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