SCR_ConfigurableDialogUi Interface Reference

Inheritance diagram for SCR_ConfigurableDialogUi:

Public Member Functions
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_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)

Public Attributes
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
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"

Protected Member Functions
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.

Static Protected Member Functions
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.

Protected Attributes
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 SCR_ConfigurableDialogUi	m_CurrentDialog

Member Function Documentation

BindButtonCancel()

void SCR_ConfigurableDialogUi.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)

Cache

BindButtonConfirm()

void SCR_ConfigurableDialogUi.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)

Cache

BindButtonGeneric()

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

Cache

Close()

void SCR_ConfigurableDialogUi.Close

(

)

Implemented in SCR_FailedModsDownloadDialog, and SCR_NotEnoughStorageDialog.

CreateButton()

SCR_InputButtonComponent SCR_ConfigurableDialogUi.CreateButton ( SCR_ConfigurableDialogUiButtonPreset  buttonPreset )

protected

Handle padding

Implemented in SCR_ScenarioConfirmationDialogUi.

CreateByPreset()

static SCR_ConfigurableDialogUi SCR_ConfigurableDialogUi.CreateByPreset ( SCR_ConfigurableDialogUiPreset  preset, SCR_ConfigurableDialogUi  customDialogObj = null  )

staticprotected

CreateFromPreset()

static SCR_ConfigurableDialogUi SCR_ConfigurableDialogUi.CreateFromPreset ( ResourceName  presetsResourceName, string  tag, SCR_ConfigurableDialogUi  customDialogObj = null  )

static

Creates a dialog from preset.

FindButton()

SCR_InputButtonComponent SCR_ConfigurableDialogUi.FindButton

(

string

tag

)

Returns a button with given tag.

GetButtonTag()

string SCR_ConfigurableDialogUi.GetButtonTag

(

SCR_InputButtonComponent

button

)

Returns a button's tag.

GetContentLayoutRoot()

Widget SCR_ConfigurableDialogUi.GetContentLayoutRoot

(

)

Returns the root of the content layout.

GetContentWidget()

static Widget SCR_ConfigurableDialogUi.GetContentWidget ( Widget  baseWidget )

staticprotected

Returns the container in which to place the content layout. Container must be called ContentLayoutContainer.

GetCurrentDialog()

static SCR_ConfigurableDialogUi SCR_ConfigurableDialogUi.GetCurrentDialog ( )

static

GetCurrentDialogTag()

static string SCR_ConfigurableDialogUi.GetCurrentDialogTag ( )

static

GetDialogBaseOverlay()

OverlayWidget SCR_ConfigurableDialogUi.GetDialogBaseOverlay

(

)

Returns the base dialog overlay (the rectangle covered by the background). Useful for dialog wide darkening (e.g. by SCR_LoadingOverlay)

Implemented in SCR_LoginDialogConsoleUI.

GetDialogPreset()

SCR_ConfigurableDialogUiPreset SCR_ConfigurableDialogUi.GetDialogPreset

(

)

GetMessageStr()

string SCR_ConfigurableDialogUi.GetMessageStr

(

)

GetMessageWidget()

TextWidget SCR_ConfigurableDialogUi.GetMessageWidget

(

)

GetRootWidget()

Widget SCR_ConfigurableDialogUi.GetRootWidget

(

)

Init()

void SCR_ConfigurableDialogUi.Init ( Widget  root, SCR_ConfigurableDialogUiPreset  preset, MenuBase  proxyMenu  )

protected

Implemented in SCR_CreateNewSaveDialog, SCR_EditorSaveDialog, SCR_PublishSaveDialog, SCR_ServerDetailsDialog, and SCR_ServerConfigSaveDialog.

InitAttributedVariables()

void SCR_ConfigurableDialogUi.InitAttributedVariables ( )

protected

Verifies that all attributed variables are set up.

When we create this object with 'new' keyword, the game doesn't assign default values to attributed variables.

InitWidgets()

void SCR_ConfigurableDialogUi.InitWidgets ( )

protected

Implemented in SCR_EditboxDialogUi, and SCR_ServerDetailsDialog.

Internal_Close()

void SCR_ConfigurableDialogUi.Internal_Close ( )

protected

IsPresetValid()

static bool SCR_ConfigurableDialogUi.IsPresetValid ( ResourceName  presetsResourceName, string  tag  )

static

OnButtonPressed()

void SCR_ConfigurableDialogUi.OnButtonPressed ( SCR_InputButtonComponent  button )

protected

Implemented in SCR_ScenarioConfirmationDialogUi.

OnCancel()

void SCR_ConfigurableDialogUi.OnCancel ( )

protected

Implemented in SCR_EditorSaveDialog, SCR_PublishSaveDialog, AddonsToolsUI, SCR_DisableDependentAddonsDialog, and SCR_ServerFullDialog.

OnConfirm()

void SCR_ConfigurableDialogUi.OnConfirm ( )

protected

Implemented in SCR_NewSessionDialog, SCR_CreateNewSaveDialog, SCR_EditorSaveDialog, SCR_PublishSaveDialog, SCR_RewindDialog, SCR_ExitGameDialog, SCR_ExitGameWhileDownloadingDialog, SCR_StartScenarioWhileDownloadingDialog, SCR_HostScenarioWhileDownloadingDialog, SCR_WorkshopDialogCopyToClipboard, SCR_DisableDependentAddonsDialog, SCR_DeleteAddonDependentAddonsDetected, SCR_CancelDownloadConfirmationDialog, SCR_CancelMyReportDialog, SCR_DeleteAddonDialog, SCR_DeleteAddonsListDialog, SCR_DownloadConfirmationDialog, SCR_ReportedAddonsDialog, SCR_BlockedPlayerPresentDialog, SCR_Login2FADialogUI, SCR_LoginDialogUI, MultiplayerDialogUI, SCR_LoginProcessDialogUI, SCR_PlayerProfileDialogUI, and SCR_ServerFullDialog.

OnMenuClose()

void SCR_ConfigurableDialogUi.OnMenuClose

(

)

Implemented in AddonsToolsUI, SCR_ModDetailsAdditionalInfoDialog, SCR_ScenarioConfirmationDialogUi, SCR_TabDialog, SCR_DownloadManager_Dialog, SCR_Login2FADialogUI, SCR_BlockedUsersDialogUI, SCR_LoginProcessDialogUI, SCR_AccountLockedDialogUi, SCR_ServicesStatusDialogUI, SCR_ServerFullDialog, and SCR_SimpleKeybindDialogUI.

OnMenuFocusGained()

void SCR_ConfigurableDialogUi.OnMenuFocusGained

(

)

Implemented in SCR_TabDialog.

OnMenuFocusLost()

void SCR_ConfigurableDialogUi.OnMenuFocusLost

(

)

Implemented in SCR_TabDialog.

OnMenuHide()

void SCR_ConfigurableDialogUi.OnMenuHide

(

)

Implemented in SCR_TabDialog.

OnMenuOpen()

void SCR_ConfigurableDialogUi.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset )

protected

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

Here you can perform custom initialization.

Implemented in AddonsToolsUI, SCR_AddonListDialog, SCR_BannedAddonsDetectedDialog, SCR_CancelDownloadConfirmationDialog, SCR_CancelMyReportDialog, SCR_DownloadConfirmationDialog, SCR_DownloadFailDialog, SCR_ModDetailsAdditionalInfoDialog, SCR_ReportedAddonsDialog, SCR_ServerJoinDownloadsConfirmationDialog, SCR_SimpleEntryListDialog, SCR_GMSaveDialog, SCR_ScenarioConfirmationDialogUi, SCR_EditboxDialogUi, SCR_ReportPlayerDialog, SCR_TabDialog, SCR_DownloadManager_Dialog, SCR_Login2FADialogUI, SCR_LoginDialogUI, SCR_LoginDialogConsoleUI, MultiplayerDialogUI, SCR_BlockedUsersDialogUI, SCR_LoginProcessDialogUI, SCR_AccountLockedDialogUi, SCR_ServicesStatusDialogUI, SCR_ServerDetailsDialog, SCR_ServerFullDialog, ServerHostingUI, SCR_AdvancedKeybindDialogUI, and SCR_SimpleKeybindDialogUI.

OnMenuShow()

void SCR_ConfigurableDialogUi.OnMenuShow

(

)

Implemented in SCR_TabDialog.

OnMenuUpdate()

void SCR_ConfigurableDialogUi.OnMenuUpdate

(

float

tDelta

)

Implemented in SCR_TabDialog, SCR_DownloadManager_Dialog, and SCR_SimpleKeybindDialogUI.

SetIconColor()

void SCR_ConfigurableDialogUi.SetIconColor

(

Color

color

)

Set title icons with custom image.

SetMessage()

void SCR_ConfigurableDialogUi.SetMessage

(

string

text

)

SetMessageColor()

void SCR_ConfigurableDialogUi.SetMessageColor

(

Color

color

)

SetStyle()

void SCR_ConfigurableDialogUi.SetStyle

(

EConfigurableDialogStyle

type

)

Sets colors based on style.

SetTitle()

void SCR_ConfigurableDialogUi.SetTitle

(

string

text

)

SetTitleIcon()

void SCR_ConfigurableDialogUi.SetTitleIcon	(	ResourceName	image,
		string	imageName
	)

Set title icons with custom image.

Member Data Documentation

BUTTON_CANCEL

const string SCR_ConfigurableDialogUi.BUTTON_CANCEL = "cancel"

static

BUTTON_CONFIRM

const string SCR_ConfigurableDialogUi.BUTTON_CONFIRM = "confirm"

static

m_aButtonComponents

ref map<string, SCR_InputButtonComponent> SCR_ConfigurableDialogUi.m_aButtonComponents = new map<string, SCR_InputButtonComponent>

protected

m_bIsClosing

bool SCR_ConfigurableDialogUi.m_bIsClosing

protected

m_CurrentDialog

SCR_ConfigurableDialogUi SCR_ConfigurableDialogUi.m_CurrentDialog

staticprotected

m_DialogPreset

ref SCR_ConfigurableDialogUiPreset SCR_ConfigurableDialogUi.m_DialogPreset

protected

m_DynamicFooter

SCR_DynamicFooterComponent SCR_ConfigurableDialogUi.m_DynamicFooter

protected

m_fFadeInTime

float SCR_ConfigurableDialogUi.m_fFadeInTime

protected

m_OnButtonPressed

ref ScriptInvoker SCR_ConfigurableDialogUi.m_OnButtonPressed = new ScriptInvoker()

m_OnCancel

ref ScriptInvoker SCR_ConfigurableDialogUi.m_OnCancel = new ScriptInvoker()

m_OnClose

ref ScriptInvoker SCR_ConfigurableDialogUi.m_OnClose = new ScriptInvoker()

m_OnCloseStart

ref ScriptInvoker SCR_ConfigurableDialogUi.m_OnCloseStart = new ScriptInvoker()

m_OnConfirm

ref ScriptInvoker SCR_ConfigurableDialogUi.m_OnConfirm = new ScriptInvoker()

m_ProxyMenu

MenuBase SCR_ConfigurableDialogUi.m_ProxyMenu

protected

m_sLastPressedButtonTag

string SCR_ConfigurableDialogUi.m_sLastPressedButtonTag

protected

m_sNavigationButtonLayout

ResourceName SCR_ConfigurableDialogUi.m_sNavigationButtonLayout

protected

m_sWidgetNameButtonsCenter

string SCR_ConfigurableDialogUi.m_sWidgetNameButtonsCenter

protected

m_sWidgetNameButtonsLeft

string SCR_ConfigurableDialogUi.m_sWidgetNameButtonsLeft

protected

m_sWidgetNameButtonsRight

string SCR_ConfigurableDialogUi.m_sWidgetNameButtonsRight

protected

m_wContentVerticalLayout

VerticalLayoutWidget SCR_ConfigurableDialogUi.m_wContentVerticalLayout

protected

m_wDialogBase

OverlayWidget SCR_ConfigurableDialogUi.m_wDialogBase

protected

m_wImgTitleIcon

ImageWidget SCR_ConfigurableDialogUi.m_wImgTitleIcon

protected

m_wImgTopLine

ImageWidget SCR_ConfigurableDialogUi.m_wImgTopLine

protected

m_wMessage

TextWidget SCR_ConfigurableDialogUi.m_wMessage

protected

m_wRoot

Widget SCR_ConfigurableDialogUi.m_wRoot

protected

m_wTitle

TextWidget SCR_ConfigurableDialogUi.m_wTitle

protected

NAVIGATION_BUTTON_LAYOUT

const ResourceName SCR_ConfigurableDialogUi.NAVIGATION_BUTTON_LAYOUT = "{87037226B1A2064B}UI/layouts/WidgetLibrary/Buttons/WLib_NavigationButtonSuperSmall.layout"

static

---

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

• Game/UI/Menu/SCR_ConfigurableDialogUI.c