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

Public Member Functions

override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
override void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
override void OnTabShow ()
 
override void OnTabHide ()
 
override void ShowNavigationButtons (bool show)
 
void EnableModsFromDSConfig (notnull SCR_DSConfig config)
 Fill all entries with values from given DS config.
 
void SetScenario (MissionWorkshopItem scenario)
 
array< ref DSMod > SelectedModsList ()
 Get all selected mods from addon entries.
 
ScriptInvokerVoid GetEventOnWorkshopButtonActivate ()
 
ScriptInvokerVoid GetOnRequestDefaultScenario ()
 
- 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 UpdateWorkshopButton ()
 
void OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)
 
void FocusFirstEntry ()
 
void CreateAddonList ()
 Add all offline mods to selection.
 
void AddLineEntry (SCR_WorkshopItem item, int id)
 
int LastFocusedId (Widget line, bool enabled)
 
Widget ClosestAddonLine (int lineId, bool enabled)
 Return closest workshop item, first check down, then up if at the end of the list.
 
SCR_AddonLineDSConfigComponent FindLineByModId (string id)
 
void SetupDownloadingCallbacks ()
 Setup callbacks for all running downloads.
 
void ClearDownloadingCallbacks ()
 
void UpdateNavigationButtons (SCR_AddonLineDSConfigComponent line, bool forceDisabled=false)
 
void OnAddonEnabled (SCR_ScriptedWidgetComponent component)
 
void OnAddonDisabled (SCR_ScriptedWidgetComponent component)
 
void OnLineFocus (SCR_ScriptedWidgetComponent component)
 
void OnLineFocusLost (SCR_ScriptedWidgetComponent component)
 
void OnDownloadComplete (SCR_WorkshopItemAction action)
 
void OnRequiredAddonDisabled (SCR_ScriptedWidgetComponent component)
 
void EnableItems (bool enable, array< ref SCR_WorkshopItem > items, int indexToFocus=-1)
 Enable/disable multiple addons recursively. This does NOT actually enable/disable the addon, just changes it's state in relation to creating the server config.
 
void UpdateRequiredItems ()
 
void OnLineButtonUp (SCR_ScriptedWidgetComponent component)
 
void OnLineButtonDown (SCR_ScriptedWidgetComponent component)
 
void OnSortConfirm (SCR_ScriptedWidgetComponent component)
 
void OnEnableAllClicked ()
 
void OnDisableAllClicked ()
 
void OnOpenWorkshopButton ()
 
void OnNavEnableActivated (SCR_InputButtonComponent button, string action)
 
void SetLineEnabled (bool enabled)
 
void OnNavEnableAllActivated ()
 
void OnNavSelectSortActivate (SCR_InputButtonComponent button, string action)
 
void Sort (SCR_AddonLineDSConfigComponent line)
 
void StartSort (SCR_AddonLineDSConfigComponent line)
 
void ReleaseSort ()
 
void OnDownSort ()
 
void OnUpSort ()
 
void FocusLine (SCR_AddonLineDSConfigComponent line)
 
- 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_EntryLayout
 
ref SCR_ServerHostingModsWidgets m_Widgets = new SCR_ServerHostingModsWidgets()
 
ScrollLayoutWidget m_wDisableScroll
 
ScrollLayoutWidget m_wEnableScroll
 
ref array< ref Widget > m_aEnabled = {}
 
ref array< ref Widget > m_aDisabled = {}
 
SCR_InputButtonComponent m_NavWorkshop
 
SCR_InputButtonComponent m_NavEnable
 
SCR_InputButtonComponent m_NavEnableAll
 
SCR_InputButtonComponent m_NavSelectSort
 
SCR_InputButtonComponent m_NavChangeSortOrder
 
SCR_AddonLineDSConfigComponent m_FocusedLine
 
SCR_AddonLineDSConfigComponent m_OrderedLine
 
ref map< ref SCR_WorkshopItem, ref SCR_AddonLineDSConfigComponentm_ActiveAddons = new map<ref SCR_WorkshopItem, ref SCR_AddonLineDSConfigComponent>()
 
bool m_bIsSorting
 
MissionWorkshopItem m_SelectedScenario
 
ref ScriptInvokerVoid m_OnWorkshopButtonActivate
 
ref ScriptInvokerVoid m_OnRequestDefaultScenario
 
- 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
 

Static Protected Attributes

const string NAV_ENABLE_ALL = "#AR-ServerHosting_EnableAll"
 
const string NAV_DISABLE_ALL = "#AR-Workshop_DisableAll"
 
const string SORT_BTN_SORT_LABEL = "#AR-Editor_TooltipDetail_WaypointIndex_Name"
 
const string SORT_BTN_SORT_ACTION = "MenuFilter"
 
const string SORT_BTN_PLACE_LABEL = "#AR-Button_Confirm-UC"
 

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

◆ AddLineEntry()

void SCR_ServerHostingModSubMenu.AddLineEntry ( SCR_WorkshopItem  item,
int  id 
)
protected

◆ ClearDownloadingCallbacks()

void SCR_ServerHostingModSubMenu.ClearDownloadingCallbacks ( )
protected

◆ ClosestAddonLine()

Widget SCR_ServerHostingModSubMenu.ClosestAddonLine ( int  lineId,
bool  enabled 
)
protected

Return closest workshop item, first check down, then up if at the end of the list.

◆ CreateAddonList()

void SCR_ServerHostingModSubMenu.CreateAddonList ( )
protected

Add all offline mods to selection.

◆ EnableItems()

void SCR_ServerHostingModSubMenu.EnableItems ( bool  enable,
array< ref SCR_WorkshopItem items,
int  indexToFocus = -1 
)
protected

Enable/disable multiple addons recursively. This does NOT actually enable/disable the addon, just changes it's state in relation to creating the server config.

◆ EnableModsFromDSConfig()

void SCR_ServerHostingModSubMenu.EnableModsFromDSConfig ( notnull SCR_DSConfig  config)

Fill all entries with values from given DS config.

◆ FindLineByModId()

SCR_AddonLineDSConfigComponent SCR_ServerHostingModSubMenu.FindLineByModId ( string  id)
protected

◆ FocusFirstEntry()

void SCR_ServerHostingModSubMenu.FocusFirstEntry ( )
protected

◆ FocusLine()

void SCR_ServerHostingModSubMenu.FocusLine ( SCR_AddonLineDSConfigComponent  line)
protected

◆ GetEventOnWorkshopButtonActivate()

ScriptInvokerVoid SCR_ServerHostingModSubMenu.GetEventOnWorkshopButtonActivate ( )

◆ GetOnRequestDefaultScenario()

ScriptInvokerVoid SCR_ServerHostingModSubMenu.GetOnRequestDefaultScenario ( )

◆ HandlerAttached()

override void SCR_ServerHostingModSubMenu.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_ServerHostingModSubMenu.HandlerDeattached ( Widget  w)

◆ LastFocusedId()

int SCR_ServerHostingModSubMenu.LastFocusedId ( Widget  line,
bool  enabled 
)
protected

◆ OnAddonDisabled()

void SCR_ServerHostingModSubMenu.OnAddonDisabled ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnAddonEnabled()

void SCR_ServerHostingModSubMenu.OnAddonEnabled ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnCommStatusCheckFinished()

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

◆ OnDisableAllClicked()

void SCR_ServerHostingModSubMenu.OnDisableAllClicked ( )
protected

◆ OnDownloadComplete()

void SCR_ServerHostingModSubMenu.OnDownloadComplete ( SCR_WorkshopItemAction  action)
protected

◆ OnDownSort()

void SCR_ServerHostingModSubMenu.OnDownSort ( )
protected

◆ OnEnableAllClicked()

void SCR_ServerHostingModSubMenu.OnEnableAllClicked ( )
protected

◆ OnLineButtonDown()

void SCR_ServerHostingModSubMenu.OnLineButtonDown ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnLineButtonUp()

void SCR_ServerHostingModSubMenu.OnLineButtonUp ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnLineFocus()

void SCR_ServerHostingModSubMenu.OnLineFocus ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnLineFocusLost()

void SCR_ServerHostingModSubMenu.OnLineFocusLost ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnNavEnableActivated()

void SCR_ServerHostingModSubMenu.OnNavEnableActivated ( SCR_InputButtonComponent  button,
string  action 
)
protected

◆ OnNavEnableAllActivated()

void SCR_ServerHostingModSubMenu.OnNavEnableAllActivated ( )
protected

◆ OnNavSelectSortActivate()

void SCR_ServerHostingModSubMenu.OnNavSelectSortActivate ( SCR_InputButtonComponent  button,
string  action 
)
protected

◆ OnOpenWorkshopButton()

void SCR_ServerHostingModSubMenu.OnOpenWorkshopButton ( )
protected

◆ OnRequiredAddonDisabled()

void SCR_ServerHostingModSubMenu.OnRequiredAddonDisabled ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnSortConfirm()

void SCR_ServerHostingModSubMenu.OnSortConfirm ( SCR_ScriptedWidgetComponent  component)
protected

◆ OnTabCreate()

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

Implements SCR_SubMenuBase.

◆ OnTabHide()

override void SCR_ServerHostingModSubMenu.OnTabHide ( )

Implements SCR_SubMenuBase.

◆ OnTabShow()

override void SCR_ServerHostingModSubMenu.OnTabShow ( )

Implements SCR_SubMenuBase.

◆ OnUpSort()

void SCR_ServerHostingModSubMenu.OnUpSort ( )
protected

◆ ReleaseSort()

void SCR_ServerHostingModSubMenu.ReleaseSort ( )
protected

◆ SelectedModsList()

array< ref DSMod > SCR_ServerHostingModSubMenu.SelectedModsList ( )

Get all selected mods from addon entries.

◆ SetLineEnabled()

void SCR_ServerHostingModSubMenu.SetLineEnabled ( bool  enabled)
protected

◆ SetScenario()

void SCR_ServerHostingModSubMenu.SetScenario ( MissionWorkshopItem  scenario)

◆ SetupDownloadingCallbacks()

void SCR_ServerHostingModSubMenu.SetupDownloadingCallbacks ( )
protected

Setup callbacks for all running downloads.

◆ ShowNavigationButtons()

override void SCR_ServerHostingModSubMenu.ShowNavigationButtons ( bool  show)

Implements SCR_SubMenuBase.

◆ Sort()

void SCR_ServerHostingModSubMenu.Sort ( SCR_AddonLineDSConfigComponent  line)
protected

◆ StartSort()

void SCR_ServerHostingModSubMenu.StartSort ( SCR_AddonLineDSConfigComponent  line)
protected

◆ UpdateNavigationButtons()

void SCR_ServerHostingModSubMenu.UpdateNavigationButtons ( SCR_AddonLineDSConfigComponent  line,
bool  forceDisabled = false 
)
protected

◆ UpdateRequiredItems()

void SCR_ServerHostingModSubMenu.UpdateRequiredItems ( )
protected

◆ UpdateWorkshopButton()

void SCR_ServerHostingModSubMenu.UpdateWorkshopButton ( )
protected

Member Data Documentation

◆ m_ActiveAddons

ref map<ref SCR_WorkshopItem, ref SCR_AddonLineDSConfigComponent> SCR_ServerHostingModSubMenu.m_ActiveAddons = new map<ref SCR_WorkshopItem, ref SCR_AddonLineDSConfigComponent>()
protected

◆ m_aDisabled

ref array<ref Widget> SCR_ServerHostingModSubMenu.m_aDisabled = {}
protected

◆ m_aEnabled

ref array<ref Widget> SCR_ServerHostingModSubMenu.m_aEnabled = {}
protected

◆ m_bIsSorting

bool SCR_ServerHostingModSubMenu.m_bIsSorting
protected

◆ m_EntryLayout

ResourceName SCR_ServerHostingModSubMenu.m_EntryLayout
protected

◆ m_FocusedLine

SCR_AddonLineDSConfigComponent SCR_ServerHostingModSubMenu.m_FocusedLine
protected

◆ m_NavChangeSortOrder

SCR_InputButtonComponent SCR_ServerHostingModSubMenu.m_NavChangeSortOrder
protected

◆ m_NavEnable

SCR_InputButtonComponent SCR_ServerHostingModSubMenu.m_NavEnable
protected

◆ m_NavEnableAll

SCR_InputButtonComponent SCR_ServerHostingModSubMenu.m_NavEnableAll
protected

◆ m_NavSelectSort

SCR_InputButtonComponent SCR_ServerHostingModSubMenu.m_NavSelectSort
protected

◆ m_NavWorkshop

SCR_InputButtonComponent SCR_ServerHostingModSubMenu.m_NavWorkshop
protected

◆ m_OnRequestDefaultScenario

ref ScriptInvokerVoid SCR_ServerHostingModSubMenu.m_OnRequestDefaultScenario
protected

◆ m_OnWorkshopButtonActivate

ref ScriptInvokerVoid SCR_ServerHostingModSubMenu.m_OnWorkshopButtonActivate
protected

◆ m_OrderedLine

SCR_AddonLineDSConfigComponent SCR_ServerHostingModSubMenu.m_OrderedLine
protected

◆ m_SelectedScenario

MissionWorkshopItem SCR_ServerHostingModSubMenu.m_SelectedScenario
protected

◆ m_wDisableScroll

ScrollLayoutWidget SCR_ServerHostingModSubMenu.m_wDisableScroll
protected

◆ m_wEnableScroll

ScrollLayoutWidget SCR_ServerHostingModSubMenu.m_wEnableScroll
protected

◆ m_Widgets

ref SCR_ServerHostingModsWidgets SCR_ServerHostingModSubMenu.m_Widgets = new SCR_ServerHostingModsWidgets()
protected

◆ NAV_DISABLE_ALL

const string SCR_ServerHostingModSubMenu.NAV_DISABLE_ALL = "#AR-Workshop_DisableAll"
staticprotected

◆ NAV_ENABLE_ALL

const string SCR_ServerHostingModSubMenu.NAV_ENABLE_ALL = "#AR-ServerHosting_EnableAll"
staticprotected

◆ SORT_BTN_PLACE_LABEL

const string SCR_ServerHostingModSubMenu.SORT_BTN_PLACE_LABEL = "#AR-Button_Confirm-UC"
staticprotected

◆ SORT_BTN_SORT_ACTION

const string SCR_ServerHostingModSubMenu.SORT_BTN_SORT_ACTION = "MenuFilter"
staticprotected

◆ SORT_BTN_SORT_LABEL

const string SCR_ServerHostingModSubMenu.SORT_BTN_SORT_LABEL = "#AR-Editor_TooltipDetail_WaypointIndex_Name"
staticprotected

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