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

Public Member Functions

override void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
override void OnTabShow ()
 
override void OnTabHide ()
 
override void OnMenuFocusGained ()
 
override void InitWidgets ()
 
override void UpdateNavigationButtons (bool visible=true)
 
override void Play (MissionWorkshopItem scenario)
 
override void Continue (MissionWorkshopItem scenario)
 
override void OnRestartConfirmed ()
 
override void OnScenarioStateChanged (SCR_ContentBrowser_ScenarioLineComponent comp)
 Called from scenario line component when scenario state changes.
 
void SetPanelsMode (bool showEmptyPanel, string messagePresetTag=string.Empty)
 
array< MissionWorkshopItem > SearchScenarios (array< MissionWorkshopItem > scenarios, string searchStr)
 
- Public Member Functions inherited from SCR_ContentBrowser_ScenarioSubMenuBase
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 ()
 

Public Attributes

EScenarioSubMenuMode m_eMode
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Protected Member Functions

override bool CreateLines (array< MissionWorkshopItem > scenarios, Widget parent)
 Be able to create various lines type - saves.
 
override Widget CreateLine (ResourceName layout, Widget parent, MissionWorkshopItem scenario)
 
void UpdateScenarioList (bool setNewFocus)
 Requests missions from API and shows them in the list.
 
bool ScenarioEmptyMessage (array< MissionWorkshopItem > mission, string messageTag)
 
void ScenarioList_ClearMissionEntries ()
 
void ScenarioList_CreateMissionEntries (array< MissionWorkshopItem > scenarios, bool setNewFocus)
 Creates lines for missions in the scroll view.
 
void OnSearchConfirm (SCR_EditBoxComponent comp, string newValue)
 Called when user confirms the value in the seacrh string.
 
void OnSortingHeaderChange (SCR_SortHeaderComponent sortHeader)
 Called when sorting header changes.
 
- Protected Member Functions inherited from SCR_ContentBrowser_ScenarioSubMenuBase
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)
 
Widget CreateLine (ResourceName layout, Widget parent, MissionWorkshopItem scenario)
 
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)
 

Static Protected Member Functions

static bool SearchStringLocalized (string str, string searchStrLower)
 

Protected Attributes

ResourceName m_sSaveLineLayout
 
ref SCR_ContentBrowser_ScenarioSubMenuWidgets m_Widgets = new SCR_ContentBrowser_ScenarioSubMenuWidgets
 
int m_iEntriesTotal
 
int m_iEntriesCurrent
 
- Protected Attributes inherited from SCR_ContentBrowser_ScenarioSubMenuBase
ResourceName m_sLinesLayout
 
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
 
- Protected Attributes inherited from SCR_SubMenuBase
ResourceName m_sNavigationButtonLayout
 
SCR_DynamicFooterComponent m_DynamicFooter
 
ref array< SCR_InputButtonComponent > m_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
 

Static Protected Attributes

const int RECENTLY_PLAYED_MAX_ENTRIES = 10
 
const string MESSAGE_TAG_NOTHING_FOUND = "nothing_found"
 
const string MESSAGE_TAG_NOTHING_FOUND_2 = "nothing_found2"
 
const string MESSAGE_TAG_NOTHING_FAVOURITE = "nothing_favourite"
 
const string MESSAGE_TAG_NOTHING_FAVOURITE_2 ="nothing_favourite2"
 
const string MESSAGE_TAG_NOTHING_RECENT = "nothing_recent"
 
const string MESSAGE_TAG_NOTHING_RECENT_2 = "nothing_recent2"
 
const string MESSAGE_TAG_NO_SAVE = "no_save"
 
const string MESSAGE_TAG_NO_SAVE_FOUND = "no_save_found"
 

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.
 

Member Function Documentation

◆ Continue()

override void SCR_ContentBrowser_ScenarioSubMenu.Continue ( MissionWorkshopItem  scenario)

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ CreateLine()

override Widget SCR_ContentBrowser_ScenarioSubMenu.CreateLine ( ResourceName  layout,
Widget  parent,
MissionWorkshopItem  scenario 
)
protected

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ CreateLines()

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

Be able to create various lines type - saves.

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ InitWidgets()

override void SCR_ContentBrowser_ScenarioSubMenu.InitWidgets ( )

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnMenuFocusGained()

override void SCR_ContentBrowser_ScenarioSubMenu.OnMenuFocusGained ( )

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnRestartConfirmed()

override void SCR_ContentBrowser_ScenarioSubMenu.OnRestartConfirmed ( )

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnScenarioStateChanged()

override void SCR_ContentBrowser_ScenarioSubMenu.OnScenarioStateChanged ( SCR_ContentBrowser_ScenarioLineComponent  comp)

Called from scenario line component when scenario state changes.

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnSearchConfirm()

void SCR_ContentBrowser_ScenarioSubMenu.OnSearchConfirm ( SCR_EditBoxComponent  comp,
string  newValue 
)
protected

Called when user confirms the value in the seacrh string.

◆ OnSortingHeaderChange()

void SCR_ContentBrowser_ScenarioSubMenu.OnSortingHeaderChange ( SCR_SortHeaderComponent  sortHeader)
protected

Called when sorting header changes.

◆ OnTabCreate()

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

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnTabHide()

override void SCR_ContentBrowser_ScenarioSubMenu.OnTabHide ( )

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ OnTabShow()

override void SCR_ContentBrowser_ScenarioSubMenu.OnTabShow ( )

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ Play()

override void SCR_ContentBrowser_ScenarioSubMenu.Play ( MissionWorkshopItem  scenario)

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ ScenarioEmptyMessage()

bool SCR_ContentBrowser_ScenarioSubMenu.ScenarioEmptyMessage ( array< MissionWorkshopItem >  mission,
string  messageTag 
)
protected

◆ ScenarioList_ClearMissionEntries()

void SCR_ContentBrowser_ScenarioSubMenu.ScenarioList_ClearMissionEntries ( )
protected

◆ ScenarioList_CreateMissionEntries()

void SCR_ContentBrowser_ScenarioSubMenu.ScenarioList_CreateMissionEntries ( array< MissionWorkshopItem >  scenarios,
bool  setNewFocus 
)
protected

Creates lines for missions in the scroll view.

◆ SearchScenarios()

array< MissionWorkshopItem > SCR_ContentBrowser_ScenarioSubMenu.SearchScenarios ( array< MissionWorkshopItem >  scenarios,
string  searchStr 
)

◆ SearchStringLocalized()

static bool SCR_ContentBrowser_ScenarioSubMenu.SearchStringLocalized ( string  str,
string  searchStrLower 
)
staticprotected

◆ SetPanelsMode()

void SCR_ContentBrowser_ScenarioSubMenu.SetPanelsMode ( bool  showEmptyPanel,
string  messagePresetTag = string::Empty 
)

◆ UpdateNavigationButtons()

override void SCR_ContentBrowser_ScenarioSubMenu.UpdateNavigationButtons ( bool  visible = true)

Implements SCR_ContentBrowser_ScenarioSubMenuBase.

◆ UpdateScenarioList()

void SCR_ContentBrowser_ScenarioSubMenu.UpdateScenarioList ( bool  setNewFocus)
protected

Requests missions from API and shows them in the list.

Member Data Documentation

◆ m_eMode

EScenarioSubMenuMode SCR_ContentBrowser_ScenarioSubMenu.m_eMode

◆ m_iEntriesCurrent

int SCR_ContentBrowser_ScenarioSubMenu.m_iEntriesCurrent
protected

◆ m_iEntriesTotal

int SCR_ContentBrowser_ScenarioSubMenu.m_iEntriesTotal
protected

◆ m_sSaveLineLayout

ResourceName SCR_ContentBrowser_ScenarioSubMenu.m_sSaveLineLayout
protected

◆ m_Widgets

ref SCR_ContentBrowser_ScenarioSubMenuWidgets SCR_ContentBrowser_ScenarioSubMenu.m_Widgets = new SCR_ContentBrowser_ScenarioSubMenuWidgets
protected

◆ MESSAGE_TAG_NO_SAVE

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NO_SAVE = "no_save"
staticprotected

◆ MESSAGE_TAG_NO_SAVE_FOUND

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NO_SAVE_FOUND = "no_save_found"
staticprotected

◆ MESSAGE_TAG_NOTHING_FAVOURITE

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_FAVOURITE = "nothing_favourite"
staticprotected

◆ MESSAGE_TAG_NOTHING_FAVOURITE_2

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_FAVOURITE_2 ="nothing_favourite2"
staticprotected

◆ MESSAGE_TAG_NOTHING_FOUND

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_FOUND = "nothing_found"
staticprotected

◆ MESSAGE_TAG_NOTHING_FOUND_2

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_FOUND_2 = "nothing_found2"
staticprotected

◆ MESSAGE_TAG_NOTHING_RECENT

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_RECENT = "nothing_recent"
staticprotected

◆ MESSAGE_TAG_NOTHING_RECENT_2

const string SCR_ContentBrowser_ScenarioSubMenu.MESSAGE_TAG_NOTHING_RECENT_2 = "nothing_recent2"
staticprotected

◆ RECENTLY_PLAYED_MAX_ENTRIES

const int SCR_ContentBrowser_ScenarioSubMenu.RECENTLY_PLAYED_MAX_ENTRIES = 10
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6