Inheritance diagram for SCR_ScenarioConfirmationDialogUi:

[legend]

Public Member Functions
void	SCR_ScenarioConfirmationDialogUi (MissionWorkshopItem scenario, ScriptInvokerBool onFavoritesResponse=null)

override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	OVERRIDES.

override void	OnMenuClose ()

override void	OnButtonPressed (SCR_InputButtonComponent button)

override SCR_InputButtonComponent	CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)

MissionWorkshopItem	GetScenario ()
	PUBLIC.

ScriptInvokerMissionWorkshopItem	GetOnFavorite ()

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 ()

Public Attributes
MissionWorkshopItem	m_Scenario

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()

Protected Member Functions
void	OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)
	PROTECTED.

void	OnFavoritesButton ()

void	UpdateFavoriteWidgets (bool isFavorite)

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
SCR_InputButtonComponent	m_Favorite

SCR_InputButtonComponent	m_Host

SCR_InputButtonComponent	m_FindServers

ref array< SCR_InputButtonComponent >	m_aRightFooterButtons = {}

SCR_ModularButtonComponent	m_FavoriteStarButton

bool	m_bHandleFavoriting = true
	If true, the dialog itself will set the scenario favorite state, otherwise it will live it to the menu or handler class.

ref ScriptInvokerMissionWorkshopItem	m_OnFavorite

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

Additional Inherited Members
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)

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.

Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi	m_CurrentDialog

Constructor & Destructor Documentation

◆ SCR_ScenarioConfirmationDialogUi()

void SCR_ScenarioConfirmationDialogUi.SCR_ScenarioConfirmationDialogUi	(	MissionWorkshopItem	scenario,
		ScriptInvokerBool	onFavoritesResponse = `null`
	)

Member Function Documentation

◆ CreateButton()

override SCR_InputButtonComponent SCR_ScenarioConfirmationDialogUi.CreateButton ( SCR_ConfigurableDialogUiButtonPreset buttonPreset )

Implements SCR_ConfigurableDialogUi.

◆ GetOnFavorite()

ScriptInvokerMissionWorkshopItem SCR_ScenarioConfirmationDialogUi.GetOnFavorite ( )

◆ GetScenario()

MissionWorkshopItem SCR_ScenarioConfirmationDialogUi.GetScenario ( )

PUBLIC.

◆ OnButtonPressed()

override void SCR_ScenarioConfirmationDialogUi.OnButtonPressed ( SCR_InputButtonComponent button )

Implements SCR_ConfigurableDialogUi.

◆ OnCommStatusCheckFinished()

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

protected

PROTECTED.

◆ OnFavoritesButton()

void SCR_ScenarioConfirmationDialogUi.OnFavoritesButton ( )

protected

◆ OnMenuClose()

override void SCR_ScenarioConfirmationDialogUi.OnMenuClose ( )

Implements SCR_ConfigurableDialogUi.

◆ OnMenuOpen()

override void SCR_ScenarioConfirmationDialogUi.OnMenuOpen ( SCR_ConfigurableDialogUiPreset preset )

OVERRIDES.

Update visuals

Content layout

Type and player count

Source addon

Footer Buttons

Star button

Favorites widgets update

Implements SCR_ConfigurableDialogUi.

Implemented in SCR_GMSaveDialog.

◆ UpdateFavoriteWidgets()

void SCR_ScenarioConfirmationDialogUi.UpdateFavoriteWidgets ( bool isFavorite )

protected

Member Data Documentation

◆ m_aRightFooterButtons

ref array<SCR_InputButtonComponent> SCR_ScenarioConfirmationDialogUi.m_aRightFooterButtons = {}

protected

◆ m_bHandleFavoriting

bool SCR_ScenarioConfirmationDialogUi.m_bHandleFavoriting = true

protected

If true, the dialog itself will set the scenario favorite state, otherwise it will live it to the menu or handler class.

◆ m_Favorite

SCR_InputButtonComponent SCR_ScenarioConfirmationDialogUi.m_Favorite

protected

◆ m_FavoriteStarButton

SCR_ModularButtonComponent SCR_ScenarioConfirmationDialogUi.m_FavoriteStarButton

protected

◆ m_FindServers

SCR_InputButtonComponent SCR_ScenarioConfirmationDialogUi.m_FindServers

protected

◆ m_Host

SCR_InputButtonComponent SCR_ScenarioConfirmationDialogUi.m_Host

protected

◆ m_OnFavorite

ref ScriptInvokerMissionWorkshopItem SCR_ScenarioConfirmationDialogUi.m_OnFavorite

protected

◆ m_Scenario

MissionWorkshopItem SCR_ScenarioConfirmationDialogUi.m_Scenario

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

Game/UI/Menu/ContentBrowser/ScenarioMenu/SCR_ScenarioDialogs.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SCR_ScenarioConfirmationDialogUi()

Member Function Documentation

◆ CreateButton()

◆ GetOnFavorite()

◆ GetScenario()

◆ OnButtonPressed()

◆ OnCommStatusCheckFinished()

◆ OnFavoritesButton()

◆ OnMenuClose()

◆ OnMenuOpen()

◆ UpdateFavoriteWidgets()

Member Data Documentation

◆ m_aRightFooterButtons

◆ m_bHandleFavoriting

◆ m_Favorite

◆ m_FavoriteStarButton

◆ m_FindServers

◆ m_Host

◆ m_OnFavorite

◆ m_Scenario