MultiplayerDialogUI Interface Reference

Inheritance diagram for MultiplayerDialogUI:

Public Member Functions
override void	OnConfirm ()
string	GetAddress ()
override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.
bool	IsAddressValid (string address)
void	CheckValidInput (SCR_EditBoxComponent comp, string text)
void	SetServerBrowserUI (ServerBrowserMenuUI serverBrowserUI)
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 Attributes
const string	WIDGET_EDIT_IP = "EditIP"
const string	WIDGET_EDIT_PORT = "EditPort"
const string	WIDGET_CHECK_NETWORK = "CheckboxNetwork"
const string	DEFAULT_ADDRESS = "127.0.0.1"
const string	DEFAULT_PORT = "2001"
const int	DIRECT_JOIN_CODE_LENGTH = 10
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"

Protected Member Functions
bool	IsJoinCodeValid (string text)
	Check it string is in join code format - 10 size, digits are check in editbox.
EDirectJoinFormats	IsInputValid (SCR_EditBoxComponent comp)
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_EditBoxComponent	m_EditIP
SCR_EditBoxComponent	m_EditPort
SCR_CheckboxComponent	m_CheckNetwork
ServerBrowserMenuUI	m_ServerBrowserUI
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)
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 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

Member Function Documentation

CheckValidInput()

void MultiplayerDialogUI.CheckValidInput	(	SCR_EditBoxComponent	comp,
		string	text
	)

GetAddress()

string MultiplayerDialogUI.GetAddress

(

)

IsAddressValid()

bool MultiplayerDialogUI.IsAddressValid

(

string

address

)

IsInputValid()

EDirectJoinFormats MultiplayerDialogUI.IsInputValid ( SCR_EditBoxComponent  comp )

protected

IsJoinCodeValid()

bool MultiplayerDialogUI.IsJoinCodeValid ( string  text )

protected

Check it string is in join code format - 10 size, digits are check in editbox.

OnConfirm()

override void MultiplayerDialogUI.OnConfirm

(

)

Implements SCR_ConfigurableDialogUi.

OnMenuOpen()

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

SetServerBrowserUI()

void MultiplayerDialogUI.SetServerBrowserUI

(

ServerBrowserMenuUI

serverBrowserUI

)

Member Data Documentation

DEFAULT_ADDRESS

const string MultiplayerDialogUI.DEFAULT_ADDRESS = "127.0.0.1"

static

DEFAULT_PORT

const string MultiplayerDialogUI.DEFAULT_PORT = "2001"

static

DIRECT_JOIN_CODE_LENGTH

const int MultiplayerDialogUI.DIRECT_JOIN_CODE_LENGTH = 10

static

m_CheckNetwork

SCR_CheckboxComponent MultiplayerDialogUI.m_CheckNetwork

protected

m_EditIP

SCR_EditBoxComponent MultiplayerDialogUI.m_EditIP

protected

m_EditPort

SCR_EditBoxComponent MultiplayerDialogUI.m_EditPort

protected

m_ServerBrowserUI

ServerBrowserMenuUI MultiplayerDialogUI.m_ServerBrowserUI

protected

WIDGET_CHECK_NETWORK

const string MultiplayerDialogUI.WIDGET_CHECK_NETWORK = "CheckboxNetwork"

static

WIDGET_EDIT_IP

const string MultiplayerDialogUI.WIDGET_EDIT_IP = "EditIP"

static

WIDGET_EDIT_PORT

const string MultiplayerDialogUI.WIDGET_EDIT_PORT = "EditPort"

static

---

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

• Game/UI/Menu/MultiplayerDialogUI.c