MainMenuUI Interface Reference

Inheritance diagram for MainMenuUI:

Public Member Functions
void	OnServicesStatus ()
override void	OnMenuClose ()
Public Member Functions inherited from ChimeraMenuBase
override void	OnMenuInit ()
override void	OnMenuUpdate (float tDelta)
override void	OnMenuShow ()
override void	OnMenuHide ()

Static Public Member Functions
static int	GetNewsEntries (out array< ref SCR_NewsEntry > entries=null)
static int	GetNotificationEntries (out array< ref SCR_NewsEntry > entries=null)
static int	GetUnreadNewsCount ()
static int	GetUnreadNotificationCount ()
Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase	CurrentChimeraMenu ()
static ChimeraMenuBase	GetOwnerMenu (Widget w)
	Returns parent menu of a widget.

Protected Member Functions
override void	OnMenuOpen ()
override void	OnMenuOpened ()
override void	OnMenuFocusLost ()
override void	OnMenuFocusGained ()
void	LoadTutorial (SCR_MainMenuConfiguration menuConfig, notnull Widget root, bool isContentDisabled=false)
void	LoadMenuTiles (SCR_MainMenuConfiguration menuConfig, notnull Widget root, bool isContentDisabled=false)
void	CreateTile (ResourceName mission, notnull Widget root, bool isRecommended=false, bool isContentDisabled=false)
void	PrepareTiles (bool isContentDisabled=false)
void	HandleEntry (string tileName, bool isContentDisabled)
void	OnBack ()
void	OnCredits ()
void	OnTileClick (notnull SCR_MenuTileComponent comp)
void	OnTileFocus (SCR_MenuTileComponent comp)
void	OnButtonSelect ()
void	OnFeedback ()
void	OnLogoClicked ()
void	RestoreFocus ()
void	CheckServicesStatusIfFocused ()
	Check Services Status only if the main menu is still focused (given the check is delayed by SERVICES_STATUS_CHECK_DELAY)

Static Protected Member Functions
static void	TryExitGame ()
	Shows exit game dialog, or some other dialog if something should prevent user from exiting the game through the main menu.

Protected Attributes
SCR_MenuTileComponent	m_FocusedTile
DialogUI	m_BannedDetectionDialog
ref array< string >	m_aBannedItems = {}
ref array< ref Widget >	m_aTiles = {}
bool	m_bFirstLoad
ref SCR_ScriptPlatformRequestCallback	m_CallbackGetPrivilege
Protected Attributes inherited from ChimeraMenuBase
bool	m_bTextEditActive = false

Static Protected Attributes
const ResourceName	TILES_LAYOUT = "{2D4191089E061C18}UI/layouts/Menus/PlayMenu/MainMenuTile_Vertical.layout"
const ResourceName	CONFIG = "{6DDC861718434B94}Configs/ContentBrowser/MainMenu/MainMenuEntries.conf"
const string	SCENARIO_LIST_WIDGET_NAME = "ScenariosHorizontalLayoutDeep"
static ref array< ref SCR_NewsEntry >	m_aNews = {}
static ref array< ref SCR_NewsEntry >	m_aNotifications = {}
static bool	s_bDidCheckNetwork
static const int	SERVICES_STATUS_CHECK_DELAY = 2000
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

Additional Inherited Members
Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker	m_OnTextEditContextChange = new ScriptInvoker
ref ScriptInvoker	m_OnUpdate = new ScriptInvoker

Member Function Documentation

CheckServicesStatusIfFocused()

void MainMenuUI.CheckServicesStatusIfFocused ( )

protected

Check Services Status only if the main menu is still focused (given the check is delayed by SERVICES_STATUS_CHECK_DELAY)

CreateTile()

void MainMenuUI.CreateTile ( ResourceName mission, notnull Widget root, bool isRecommended = false, bool isContentDisabled = false )

protected

Parameters

[in]	mission	resource name of mission
[in]	root	related widget
[in]	isRecommended
[in]	isContentDisabled	when true data is not loaded yet, content inaccessible

GetNewsEntries()

static int MainMenuUI.GetNewsEntries ( out array< ref SCR_NewsEntry > entries = null )

static

Parameters

[out]

entries

Returns

GetNotificationEntries()

static int MainMenuUI.GetNotificationEntries ( out array< ref SCR_NewsEntry > entries = null )

static

Parameters

[out]

entries

Returns

GetUnreadNewsCount()

static int MainMenuUI.GetUnreadNewsCount ( )

static

Returns

GetUnreadNotificationCount()

static int MainMenuUI.GetUnreadNotificationCount ( )

static

Returns

HandleEntry()

void MainMenuUI.HandleEntry ( string tileName, bool isContentDisabled )

protected

LoadMenuTiles()

void MainMenuUI.LoadMenuTiles ( SCR_MainMenuConfiguration menuConfig, notnull Widget root, bool isContentDisabled = false )

protected

LoadTutorial()

void MainMenuUI.LoadTutorial ( SCR_MainMenuConfiguration menuConfig, notnull Widget root, bool isContentDisabled = false )

protected

OnBack()

void MainMenuUI.OnBack ( )

protected

OnButtonSelect()

void MainMenuUI.OnButtonSelect ( )

protected

OnCredits()

void MainMenuUI.OnCredits ( )

protected

OnFeedback()

void MainMenuUI.OnFeedback ( )

protected

OnLogoClicked()

void MainMenuUI.OnLogoClicked ( )

protected

OnMenuClose()

override void MainMenuUI.OnMenuClose

(

)

Implements ChimeraMenuBase.

OnMenuFocusGained()

override void MainMenuUI.OnMenuFocusGained ( )

protected

Implements ChimeraMenuBase.

OnMenuFocusLost()

override void MainMenuUI.OnMenuFocusLost ( )

protected

Implements ChimeraMenuBase.

OnMenuOpen()

override void MainMenuUI.OnMenuOpen ( )

protected

Implements ChimeraMenuBase.

OnMenuOpened()

override void MainMenuUI.OnMenuOpened ( )

protected

Implements ChimeraMenuBase.

OnServicesStatus()

void MainMenuUI.OnServicesStatus

(

)

OnTileClick()

void MainMenuUI.OnTileClick ( notnull SCR_MenuTileComponent comp )

protected

OnTileFocus()

void MainMenuUI.OnTileFocus ( SCR_MenuTileComponent comp )

protected

PrepareTiles()

void MainMenuUI.PrepareTiles ( bool isContentDisabled = false )

protected

Parameters

[in]

isContentDisabled

when true data is not loaded yet, content inaccessible

RestoreFocus()

void MainMenuUI.RestoreFocus ( )

protected

Parameters

[out]

entries

Returns

TryExitGame()

static void MainMenuUI.TryExitGame ( )

staticprotected

Shows exit game dialog, or some other dialog if something should prevent user from exiting the game through the main menu.

Member Data Documentation

CONFIG

const ResourceName MainMenuUI.CONFIG = "{6DDC861718434B94}Configs/ContentBrowser/MainMenu/MainMenuEntries.conf"

staticprotected

m_aBannedItems

ref array<string> MainMenuUI.m_aBannedItems = {}

protected

m_aNews

ref array<ref SCR_NewsEntry> MainMenuUI.m_aNews = {}

staticprotected

m_aNotifications

ref array<ref SCR_NewsEntry> MainMenuUI.m_aNotifications = {}

staticprotected

m_aTiles

ref array<ref Widget> MainMenuUI.m_aTiles = {}

protected

m_BannedDetectionDialog

DialogUI MainMenuUI.m_BannedDetectionDialog

protected

m_bFirstLoad

bool MainMenuUI.m_bFirstLoad

protected

m_CallbackGetPrivilege

ref SCR_ScriptPlatformRequestCallback MainMenuUI.m_CallbackGetPrivilege

protected

m_FocusedTile

SCR_MenuTileComponent MainMenuUI.m_FocusedTile

protected

s_bDidCheckNetwork

bool MainMenuUI.s_bDidCheckNetwork

staticprotected

SCENARIO_LIST_WIDGET_NAME

const string MainMenuUI.SCENARIO_LIST_WIDGET_NAME = "ScenariosHorizontalLayoutDeep"

staticprotected

SERVICES_STATUS_CHECK_DELAY

const int MainMenuUI.SERVICES_STATUS_CHECK_DELAY = 2000

staticprotected

TILES_LAYOUT

const ResourceName MainMenuUI.TILES_LAYOUT = "{2D4191089E061C18}UI/layouts/Menus/PlayMenu/MainMenuTile_Vertical.layout"

staticprotected

---

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

• Game/UI/Menu/MainMenuUI.c