ServerHostingUI Interface Reference

Inheritance diagram for ServerHostingUI:

Public Member Functions
override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.
void	SaveConfig ()
void	SelectScenario (notnull MissionWorkshopItem scenario)
	Select scenario in scenario selection dropdown.
void	SelectDefaultScenario ()
	Select scenario in scenario selection dropdown.
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 SCR_DSConfig	GetTemporaryConfig ()
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
bool	VerifyAndStoreConfig ()
	Verify and store all info into config - return true if all config properties are valid.
void	OnOverrideConfirm (SCR_ConfigurableDialogUi dialog)
void	OnHostServerClick ()
void	OnSaveTemplateClick ()
void	DisplaySaveDialog ()
	Show dialog with file name settings and confirmation.
void	OnSaveDialogConfirm (SCR_ConfigurableDialogUi dialog)
void	OnWorkshopOpenActivate ()
void	AllMenuClosed ()
	Callback for when all additional menu are closed and top menu is main menu.
void	OnSubMenuChangePort (string port)
	Call when sub menu change port setting to propagete unified port on multiple places.
void	OnScenarioSelected (MissionWorkshopItem scenario)
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_DSConfig	m_DSConfig = new SCR_DSConfig()
ref SCR_ServerConfigListComponent	m_ConfigList
ref SCR_ServerHostingSettingsSubMenu	m_ConfigListSubMenu
ref SCR_ServerHostingModSubMenu	m_ConfigMods
ref SCR_ServerConfigAdvancedComponent	m_AdvancedSettings
ref SCR_ServerHostingSettingsSubMenu	m_AdvancedSubMenu
string	m_iUnifiedPort
string	m_sFileName
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_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
const string	JSON_POSTFIX = ".json"
const string	DIALOG_OVERRIDE = "#AR-ServerHosting_OverrideWarning"
const string	DIALOG_SAVED = "#AR-ServerHosting_SaveSuccessful"
const string	COLOR_TAG = "<color rgba='%1'>"
const string	COLOR_TAG_END = "</color>"
static ref SCR_DSConfig	s_TemporaryConfig
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.

Member Function Documentation

AllMenuClosed()

void ServerHostingUI.AllMenuClosed ( )

protected

Callback for when all additional menu are closed and top menu is main menu.

DisplaySaveDialog()

void ServerHostingUI.DisplaySaveDialog ( )

protected

Show dialog with file name settings and confirmation.

GetTemporaryConfig()

static SCR_DSConfig ServerHostingUI.GetTemporaryConfig ( )

static

OnHostServerClick()

void ServerHostingUI.OnHostServerClick ( )

protected

OnMenuOpen()

override void ServerHostingUI.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.

OnOverrideConfirm()

void ServerHostingUI.OnOverrideConfirm ( SCR_ConfigurableDialogUi  dialog )

protected

OnSaveDialogConfirm()

void ServerHostingUI.OnSaveDialogConfirm ( SCR_ConfigurableDialogUi  dialog )

protected

OnSaveTemplateClick()

void ServerHostingUI.OnSaveTemplateClick ( )

protected

OnScenarioSelected()

void ServerHostingUI.OnScenarioSelected ( MissionWorkshopItem  scenario )

protected

OnSubMenuChangePort()

void ServerHostingUI.OnSubMenuChangePort ( string  port )

protected

Call when sub menu change port setting to propagete unified port on multiple places.

OnWorkshopOpenActivate()

void ServerHostingUI.OnWorkshopOpenActivate ( )

protected

SaveConfig()

void ServerHostingUI.SaveConfig

(

)

SelectDefaultScenario()

void ServerHostingUI.SelectDefaultScenario

(

)

Select scenario in scenario selection dropdown.

SelectScenario()

void ServerHostingUI.SelectScenario

(

notnull MissionWorkshopItem

scenario

)

Select scenario in scenario selection dropdown.

VerifyAndStoreConfig()

bool ServerHostingUI.VerifyAndStoreConfig ( )

protected

Verify and store all info into config - return true if all config properties are valid.

Member Data Documentation

COLOR_TAG

const string ServerHostingUI.COLOR_TAG = "<color rgba='%1'>"

staticprotected

COLOR_TAG_END

const string ServerHostingUI.COLOR_TAG_END = "</color>"

staticprotected

DIALOG_OVERRIDE

const string ServerHostingUI.DIALOG_OVERRIDE = "#AR-ServerHosting_OverrideWarning"

staticprotected

DIALOG_SAVED

const string ServerHostingUI.DIALOG_SAVED = "#AR-ServerHosting_SaveSuccessful"

staticprotected

JSON_POSTFIX

const string ServerHostingUI.JSON_POSTFIX = ".json"

staticprotected

m_AdvancedSettings

ref SCR_ServerConfigAdvancedComponent ServerHostingUI.m_AdvancedSettings

protected

m_AdvancedSubMenu

ref SCR_ServerHostingSettingsSubMenu ServerHostingUI.m_AdvancedSubMenu

protected

m_ConfigList

ref SCR_ServerConfigListComponent ServerHostingUI.m_ConfigList

protected

m_ConfigListSubMenu

ref SCR_ServerHostingSettingsSubMenu ServerHostingUI.m_ConfigListSubMenu

protected

m_ConfigMods

ref SCR_ServerHostingModSubMenu ServerHostingUI.m_ConfigMods

protected

m_DSConfig

ref SCR_DSConfig ServerHostingUI.m_DSConfig = new SCR_DSConfig()

protected

m_iUnifiedPort

string ServerHostingUI.m_iUnifiedPort

protected

m_sFileName

string ServerHostingUI.m_sFileName

protected

s_TemporaryConfig

ref SCR_DSConfig ServerHostingUI.s_TemporaryConfig

staticprotected

---

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

• Game/UI/Menu/ServerBrowser/ServerHosting/ServerHostingUI.c