SCR_BlockedUsersDialogUI Interface Reference

Inheritance diagram for SCR_BlockedUsersDialogUI:

Public Member Functions
override void	OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
	Called last of all, after all the initialization of main element done.
void	ListBlockedUsers ()
void	OnBlockedListUpdated (bool success)
override void	OnMenuClose ()
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
Widget	m_wCurrentSelectedEntry
SCR_InputButtonComponent	m_UnblockButton
ref map< Widget, BlockListItem >	m_mUserList = new map<Widget, BlockListItem>()
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	OnEntryFocused (SCR_ModularButtonComponent modularButton)
void	OnUserUnblock ()
void	OnViewGamecard ()
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_wUserListWidget
SCR_InputButtonComponent	m_GamecardButton
SocialComponent	m_SocialComponent
ref SCR_BlocklistUnblockCallback	m_BlocklistCallback
ref array< Widget >	m_aUserList = {}
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 ResourceName	ENTRY_WIDGET_NAME = "{3B2D99949BCE0542}UI/layouts/Menus/Dialogs/BlockedUsersEntry.layout"
const string	ENTRY_SCROLL_LIST = "Users"
const string	UNLOCK_BUTTON = "unblock"
const string	VIEW_GAMECARD_BUTTON = "viewGamecard"
const string PLATFORM_ int	m_iMaxBlockedUserAmount = 10
Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi	m_CurrentDialog

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.

Member Function Documentation

ListBlockedUsers()

void SCR_BlockedUsersDialogUI.ListBlockedUsers

(

)

OnBlockedListUpdated()

void SCR_BlockedUsersDialogUI.OnBlockedListUpdated

(

bool

success

)

OnEntryFocused()

void SCR_BlockedUsersDialogUI.OnEntryFocused ( SCR_ModularButtonComponent  modularButton )

protected

OnMenuClose()

override void SCR_BlockedUsersDialogUI.OnMenuClose

(

)

Implements SCR_ConfigurableDialogUi.

OnMenuOpen()

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

OnUserUnblock()

void SCR_BlockedUsersDialogUI.OnUserUnblock ( )

protected

OnViewGamecard()

void SCR_BlockedUsersDialogUI.OnViewGamecard ( )

protected

Member Data Documentation

ENTRY_SCROLL_LIST

const string SCR_BlockedUsersDialogUI.ENTRY_SCROLL_LIST = "Users"

staticprotected

ENTRY_WIDGET_NAME

const ResourceName SCR_BlockedUsersDialogUI.ENTRY_WIDGET_NAME = "{3B2D99949BCE0542}UI/layouts/Menus/Dialogs/BlockedUsersEntry.layout"

staticprotected

m_aUserList

ref array<Widget> SCR_BlockedUsersDialogUI.m_aUserList = {}

protected

m_BlocklistCallback

ref SCR_BlocklistUnblockCallback SCR_BlockedUsersDialogUI.m_BlocklistCallback

protected

m_GamecardButton

SCR_InputButtonComponent SCR_BlockedUsersDialogUI.m_GamecardButton

protected

m_iMaxBlockedUserAmount

const string PLATFORM_ int SCR_BlockedUsersDialogUI.m_iMaxBlockedUserAmount = 10

staticprotected

m_mUserList

ref map<Widget, BlockListItem> SCR_BlockedUsersDialogUI.m_mUserList = new map<Widget, BlockListItem>()

m_SocialComponent

SocialComponent SCR_BlockedUsersDialogUI.m_SocialComponent

protected

m_UnblockButton

SCR_InputButtonComponent SCR_BlockedUsersDialogUI.m_UnblockButton

m_wCurrentSelectedEntry

Widget SCR_BlockedUsersDialogUI.m_wCurrentSelectedEntry

m_wUserListWidget

Widget SCR_BlockedUsersDialogUI.m_wUserListWidget

protected

UNLOCK_BUTTON

const string SCR_BlockedUsersDialogUI.UNLOCK_BUTTON = "unblock"

staticprotected

VIEW_GAMECARD_BUTTON

const string SCR_BlockedUsersDialogUI.VIEW_GAMECARD_BUTTON = "viewGamecard"

staticprotected

---

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

• Game/UI/Menu/SCR_BlockedUsersDialogUI.c