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

Public Member Functions

override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
override void OnMenuClose ()
 
override void OnMenuUpdate (float tDelta)
 
void SCR_DownloadManager_Dialog ()
 
void ~SCR_DownloadManager_Dialog ()
 
- Public Member Functions inherited from SCR_TabDialog
override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuClose ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
- Public Member Functions inherited from SCR_ConfigurableDialogUi
Widget GetRootWidget ()
 
OverlayWidget GetDialogBaseOverlay ()
 Returns the base dialog overlay (the rectangle covered by the background). Useful for dialog wide darkening (e.g. by SCR_LoadingOverlay)
 
Widget GetContentLayoutRoot ()
 Returns the root of the content layout.
 
SCR_ConfigurableDialogUiPreset GetDialogPreset ()
 
void Close ()
 
void SetTitle (string text)
 
void SetMessage (string text)
 
void SetMessageColor (Color color)
 
TextWidget GetMessageWidget ()
 
string GetMessageStr ()
 
void SetTitleIcon (ResourceName image, string imageName)
 Set title icons with custom image.
 
void SetIconColor (Color color)
 Set title icons with custom image.
 
void SetStyle (EConfigurableDialogStyle type)
 Sets colors based on style.
 
void BindButtonConfirm (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnConfirm (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonCancel (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnCancel (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonGeneric (SCR_InputButtonComponent button, string tag=string.Empty)
 Allows to register a custom button to call OnButtonPressed (i.e. one not in the conf files but placed by hand in the layout). An empty tag will result in the widget's name being used instead.
 
SCR_InputButtonComponent FindButton (string tag)
 Returns a button with given tag.
 
string GetButtonTag (SCR_InputButtonComponent button)
 Returns a button's tag.
 
void OnMenuUpdate (float tDelta)
 
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuClose ()
 

Static Public Member Functions

static bool IsOpened ()
 
static SCR_DownloadManager_Dialog Create ()
 
- Static Public Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateFromPreset (ResourceName presetsResourceName, string tag, SCR_ConfigurableDialogUi customDialogObj=null)
 Creates a dialog from preset.
 
static SCR_ConfigurableDialogUi GetCurrentDialog ()
 
static string GetCurrentDialogTag ()
 
static bool IsPresetValid (ResourceName presetsResourceName, string tag)
 

Protected Member Functions

void UpdateProgressWidgets ()
 
void UpdateDownloadingSpeedWidget (bool display, bool showFallback)
 
void InitList ()
 
SCR_WorkshopItemActionDownload GetSelectedAction ()
 
void OnNewDownload (SCR_WorkshopItem item, SCR_WorkshopItemActionDownload action)
 
void OnNewActionActivate (SCR_WorkshopItemActionDownload action)
 
void OnDownloadComplete (SCR_WorkshopItemActionDownload action)
 
void OnDownloadFailed (SCR_WorkshopItemActionDownload action, int reason)
 Call when download are not running Move view to failed downlaods and show dialog with listed downloads.
 
void ShowFailedModsDialog (SCR_WorkshopItemActionDownload action, int reason)
 
void OnFullStorageError (SCR_WorkshopItemActionDownload action, float size)
 Call on full addons storage reached to display storage limit reached error.
 
void CreateStoraLimitError ()
 
void OnStorageLimitDialogClosed ()
 
void OnDownloadFailDialogClose ()
 
void OnDownloadCanceled (SCR_WorkshopItemActionDownload action)
 
void OnBackButton ()
 
void OnPauseAllButton ()
 
void OnPauseButton ()
 
void OnCancelButton ()
 
void OnAutoenableButton ()
 
- Protected Member Functions inherited from SCR_ConfigurableDialogUi
void OnConfirm ()
 
void OnCancel ()
 
void OnButtonPressed (SCR_InputButtonComponent button)
 
void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
void Init (Widget root, SCR_ConfigurableDialogUiPreset preset, MenuBase proxyMenu)
 
void InitWidgets ()
 
SCR_InputButtonComponent CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)
 
void Internal_Close ()
 
void InitAttributedVariables ()
 Verifies that all attributed variables are set up.
 

Protected Attributes

ref SCR_DownloadManagerDialogWidgets m_Widgets = new SCR_DownloadManagerDialogWidgets()
 
SCR_ConfigurableDialogUi m_DownloadFailDialog
 
SCR_MessageDialogContent m_DownloadFailDialogContent
 
SCR_NotEnoughStorageDialog m_StorageLimitDialog
 
float m_fStorageLimitErrorSize = 0
 
ref SCR_DownloadManagerListComponent m_ActiveDownloads
 
ref SCR_DownloadManagerListComponent m_HistoryDownloads
 
- Protected Attributes inherited from SCR_TabDialog
SCR_SuperMenuComponent m_SuperMenuComponent
 
- Protected Attributes inherited from SCR_ConfigurableDialogUi
float m_fFadeInTime
 
ResourceName m_sNavigationButtonLayout
 
string m_sWidgetNameButtonsLeft
 
string m_sWidgetNameButtonsRight
 
string m_sWidgetNameButtonsCenter
 
ImageWidget m_wImgTopLine
 
ImageWidget m_wImgTitleIcon
 
TextWidget m_wTitle
 
TextWidget m_wMessage
 
VerticalLayoutWidget m_wContentVerticalLayout
 
ref map< string, SCR_InputButtonComponentm_aButtonComponents = new map<string, SCR_InputButtonComponent>
 
Widget m_wRoot
 
OverlayWidget m_wDialogBase
 
SCR_DynamicFooterComponent m_DynamicFooter
 
MenuBase m_ProxyMenu
 
ref SCR_ConfigurableDialogUiPreset m_DialogPreset
 
string m_sLastPressedButtonTag
 
bool m_bIsClosing
 

Static Protected Attributes

const string STATE_DOWNLOADING = "#AR-Workshop_TabName_Downloaded"
 
const string STATE_ALL_PAUSE = "#AR-DownloadManager_State_AllDownloadsPaused"
 
const string STATE_NO_ACTIVE_DOWNLOADS = "#AR-DownloadManager_State_NoActiveDownloads"
 
const string STR_AFFECTED_MODS = "#AR-Workshop_FailedModsDownload"
 
const ResourceName DOWNLOAD_LINE_LAYOUT = "{FB196DBC0ABA6AE4}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManagerEntry.layout"
 
const string DOWNLOAD_SUMMARY_FORMAT = "%1 / %2"
 
const string DOWNLOAD_SUMMARY_COLORED_FORMAT = "<color rgba=%1>%2</color>"
 
const string FAILED_ADDON_FORMAT = "- %1 \n"
 
const string FAILED_ADDON_LIST_DIALOG = "failed_dialogs_list"
 
static bool m_bOpened = false
 
- Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi m_CurrentDialog
 

Additional Inherited Members

- Public Attributes inherited from SCR_ConfigurableDialogUi
ref ScriptInvoker m_OnConfirm = new ScriptInvoker()
 
ref ScriptInvoker m_OnCancel = new ScriptInvoker()
 
ref ScriptInvoker m_OnClose = new ScriptInvoker()
 
ref ScriptInvoker m_OnCloseStart = new ScriptInvoker()
 
ref ScriptInvoker m_OnButtonPressed = new ScriptInvoker()
 
- Static Public Attributes inherited from SCR_ConfigurableDialogUi
static const ResourceName NAVIGATION_BUTTON_LAYOUT = "{87037226B1A2064B}UI/layouts/WidgetLibrary/Buttons/WLib_NavigationButtonSuperSmall.layout"
 
static const string BUTTON_CONFIRM = "confirm"
 
static const string BUTTON_CANCEL = "cancel"
 
- Static Protected Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateByPreset (SCR_ConfigurableDialogUiPreset preset, SCR_ConfigurableDialogUi customDialogObj=null)
 
static Widget GetContentWidget (Widget baseWidget)
 Returns the container in which to place the content layout. Container must be called ContentLayoutContainer.
 

Constructor & Destructor Documentation

◆ SCR_DownloadManager_Dialog()

void SCR_DownloadManager_Dialog.SCR_DownloadManager_Dialog ( )

◆ ~SCR_DownloadManager_Dialog()

void SCR_DownloadManager_Dialog.~SCR_DownloadManager_Dialog ( )

Member Function Documentation

◆ Create()

static SCR_DownloadManager_Dialog SCR_DownloadManager_Dialog.Create ( )
static

◆ CreateStoraLimitError()

void SCR_DownloadManager_Dialog.CreateStoraLimitError ( )
protected

◆ GetSelectedAction()

SCR_WorkshopItemActionDownload SCR_DownloadManager_Dialog.GetSelectedAction ( )
protected

◆ InitList()

void SCR_DownloadManager_Dialog.InitList ( )
protected

◆ IsOpened()

static bool SCR_DownloadManager_Dialog.IsOpened ( )
static

◆ OnAutoenableButton()

void SCR_DownloadManager_Dialog.OnAutoenableButton ( )
protected

◆ OnBackButton()

void SCR_DownloadManager_Dialog.OnBackButton ( )
protected

◆ OnCancelButton()

void SCR_DownloadManager_Dialog.OnCancelButton ( )
protected

◆ OnDownloadCanceled()

void SCR_DownloadManager_Dialog.OnDownloadCanceled ( SCR_WorkshopItemActionDownload  action)
protected

◆ OnDownloadComplete()

void SCR_DownloadManager_Dialog.OnDownloadComplete ( SCR_WorkshopItemActionDownload  action)
protected

◆ OnDownloadFailDialogClose()

void SCR_DownloadManager_Dialog.OnDownloadFailDialogClose ( )
protected

◆ OnDownloadFailed()

void SCR_DownloadManager_Dialog.OnDownloadFailed ( SCR_WorkshopItemActionDownload  action,
int  reason 
)
protected

Call when download are not running Move view to failed downlaods and show dialog with listed downloads.

◆ OnFullStorageError()

void SCR_DownloadManager_Dialog.OnFullStorageError ( SCR_WorkshopItemActionDownload  action,
float  size 
)
protected

Call on full addons storage reached to display storage limit reached error.

◆ OnMenuClose()

override void SCR_DownloadManager_Dialog.OnMenuClose ( )

Implements SCR_TabDialog.

◆ OnMenuOpen()

override void SCR_DownloadManager_Dialog.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset)

Called last of all, after all the initialization of main element done.

Here you can perform custom initialization.

Implements SCR_TabDialog.

◆ OnMenuUpdate()

override void SCR_DownloadManager_Dialog.OnMenuUpdate ( float  tDelta)

Implements SCR_TabDialog.

◆ OnNewActionActivate()

void SCR_DownloadManager_Dialog.OnNewActionActivate ( SCR_WorkshopItemActionDownload  action)
protected

◆ OnNewDownload()

void SCR_DownloadManager_Dialog.OnNewDownload ( SCR_WorkshopItem  item,
SCR_WorkshopItemActionDownload  action 
)
protected

◆ OnPauseAllButton()

void SCR_DownloadManager_Dialog.OnPauseAllButton ( )
protected

◆ OnPauseButton()

void SCR_DownloadManager_Dialog.OnPauseButton ( )
protected

◆ OnStorageLimitDialogClosed()

void SCR_DownloadManager_Dialog.OnStorageLimitDialogClosed ( )
protected

◆ ShowFailedModsDialog()

void SCR_DownloadManager_Dialog.ShowFailedModsDialog ( SCR_WorkshopItemActionDownload  action,
int  reason 
)
protected

◆ UpdateDownloadingSpeedWidget()

void SCR_DownloadManager_Dialog.UpdateDownloadingSpeedWidget ( bool  display,
bool  showFallback 
)
protected

◆ UpdateProgressWidgets()

void SCR_DownloadManager_Dialog.UpdateProgressWidgets ( )
protected

Member Data Documentation

◆ DOWNLOAD_LINE_LAYOUT

const ResourceName SCR_DownloadManager_Dialog.DOWNLOAD_LINE_LAYOUT = "{FB196DBC0ABA6AE4}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManagerEntry.layout"
staticprotected

◆ DOWNLOAD_SUMMARY_COLORED_FORMAT

const string SCR_DownloadManager_Dialog.DOWNLOAD_SUMMARY_COLORED_FORMAT = "<color rgba=%1>%2</color>"
staticprotected

◆ DOWNLOAD_SUMMARY_FORMAT

const string SCR_DownloadManager_Dialog.DOWNLOAD_SUMMARY_FORMAT = "%1 / %2"
staticprotected

◆ FAILED_ADDON_FORMAT

const string SCR_DownloadManager_Dialog.FAILED_ADDON_FORMAT = "- %1 \n"
staticprotected

◆ FAILED_ADDON_LIST_DIALOG

const string SCR_DownloadManager_Dialog.FAILED_ADDON_LIST_DIALOG = "failed_dialogs_list"
staticprotected

◆ m_ActiveDownloads

ref SCR_DownloadManagerListComponent SCR_DownloadManager_Dialog.m_ActiveDownloads
protected

◆ m_bOpened

bool SCR_DownloadManager_Dialog.m_bOpened = false
staticprotected

◆ m_DownloadFailDialog

SCR_ConfigurableDialogUi SCR_DownloadManager_Dialog.m_DownloadFailDialog
protected

◆ m_DownloadFailDialogContent

SCR_MessageDialogContent SCR_DownloadManager_Dialog.m_DownloadFailDialogContent
protected

◆ m_fStorageLimitErrorSize

float SCR_DownloadManager_Dialog.m_fStorageLimitErrorSize = 0
protected

◆ m_HistoryDownloads

ref SCR_DownloadManagerListComponent SCR_DownloadManager_Dialog.m_HistoryDownloads
protected

◆ m_StorageLimitDialog

SCR_NotEnoughStorageDialog SCR_DownloadManager_Dialog.m_StorageLimitDialog
protected

◆ m_Widgets

ref SCR_DownloadManagerDialogWidgets SCR_DownloadManager_Dialog.m_Widgets = new SCR_DownloadManagerDialogWidgets()
protected

◆ STATE_ALL_PAUSE

const string SCR_DownloadManager_Dialog.STATE_ALL_PAUSE = "#AR-DownloadManager_State_AllDownloadsPaused"
staticprotected

◆ STATE_DOWNLOADING

const string SCR_DownloadManager_Dialog.STATE_DOWNLOADING = "#AR-Workshop_TabName_Downloaded"
staticprotected

◆ STATE_NO_ACTIVE_DOWNLOADS

const string SCR_DownloadManager_Dialog.STATE_NO_ACTIVE_DOWNLOADS = "#AR-DownloadManager_State_NoActiveDownloads"
staticprotected

◆ STR_AFFECTED_MODS

const string SCR_DownloadManager_Dialog.STR_AFFECTED_MODS = "#AR-Workshop_FailedModsDownload"
staticprotected

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