SCR_ServerJoinDownloadsConfirmationDialog Interface Reference

Dialog to cancel downloads during to server joining. More...

Inheritance diagram for SCR_ServerJoinDownloadsConfirmationDialog:

Public Member Functions
override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.
void	Setup (array< ref SCR_WorkshopItemActionDownload > actions)
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 SCR_ServerJoinDownloadsConfirmationDialog	Create (array< ref SCR_WorkshopItemActionDownload > actions, SCR_EJoinDownloadsConfirmationDialogType type)
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	UpdateRetryButton ()
void	RetryActions ()
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
Widget	m_ListWrapper
ref array< ref SCR_WorkshopItemActionDownload >	m_aActions = {}
SCR_InputButtonComponent	m_Retry
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_InputButtonComponent >	m_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
static const string	TAG_ALL = "server_download_all_cancel"
static const string	TAG_REQUIRED = "server_download_required"
static const string	TAG_UNRELATED = "server_download_unrelated_cancel"
const ResourceName	DOWNLOAD_LINE_LAYOUT = "{1C5D2CC10D7A1BC3}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManager_AddonDownloadLineNonInteractive.layout"
const string	BUTTON_RETRY = "Retry"
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.

Detailed Description

Dialog to cancel downloads during to server joining.

Member Function Documentation

Create()

static SCR_ServerJoinDownloadsConfirmationDialog SCR_ServerJoinDownloadsConfirmationDialog.Create ( array< ref SCR_WorkshopItemActionDownload >  actions, SCR_EJoinDownloadsConfirmationDialogType  type  )

static

OnMenuOpen()

override void SCR_ServerJoinDownloadsConfirmationDialog.OnMenuOpen

(

SCR_ConfigurableDialogUiPreset

preset

)

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

Here you can perform custom initialization.

Implements SCR_ConfigurableDialogUi.

RetryActions()

void SCR_ServerJoinDownloadsConfirmationDialog.RetryActions ( )

protected

Setup()

void SCR_ServerJoinDownloadsConfirmationDialog.Setup

(

array< ref SCR_WorkshopItemActionDownload >

actions

)

UpdateRetryButton()

void SCR_ServerJoinDownloadsConfirmationDialog.UpdateRetryButton ( )

protected

Member Data Documentation

BUTTON_RETRY

const string SCR_ServerJoinDownloadsConfirmationDialog.BUTTON_RETRY = "Retry"

staticprotected

DOWNLOAD_LINE_LAYOUT

const ResourceName SCR_ServerJoinDownloadsConfirmationDialog.DOWNLOAD_LINE_LAYOUT = "{1C5D2CC10D7A1BC3}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManager_AddonDownloadLineNonInteractive.layout"

staticprotected

m_aActions

ref array<ref SCR_WorkshopItemActionDownload> SCR_ServerJoinDownloadsConfirmationDialog.m_aActions = {}

protected

m_ListWrapper

Widget SCR_ServerJoinDownloadsConfirmationDialog.m_ListWrapper

protected

m_Retry

SCR_InputButtonComponent SCR_ServerJoinDownloadsConfirmationDialog.m_Retry

protected

TAG_ALL

const string SCR_ServerJoinDownloadsConfirmationDialog.TAG_ALL = "server_download_all_cancel"

staticprotected

TAG_REQUIRED

const string SCR_ServerJoinDownloadsConfirmationDialog.TAG_REQUIRED = "server_download_required"

staticprotected

TAG_UNRELATED

const string SCR_ServerJoinDownloadsConfirmationDialog.TAG_UNRELATED = "server_download_unrelated_cancel"

staticprotected

---

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

• Game/UI/Menu/ContentBrowser/Common/Dialogs/SCR_ServerJoinDownloadsConfirmationDialog.c