SCR_SubMenuBase Interface Reference

Inheritance diagram for SCR_SubMenuBase:

Public Member Functions
void	OnMenuFocusGained ()
void	OnMenuFocusLost ()
void	OnMenuShow ()
void	OnMenuHide ()
void	OnMenuUpdate (float tDelta)
void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
void	OnTabShow ()
void	OnTabHide ()
void	OnTabRemove ()
void	OnTabChange ()
bool	GetShown ()
int	GetIndex ()
ScriptInvokerVoid	GetOnRequestCloseMenu ()
ScriptInvokerInt2	GetOnRequestTabChange ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	ShowNavigationButtons (bool show)
void	FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show)
void	SetNavigationButtonVisibile (SCR_InputButtonComponent button, bool show, bool animate=false)
SCR_InputButtonComponent	CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true)
void	RequestCloseMenu ()
void	RequestTabChange (int newTabIndex)

Protected Attributes
ResourceName	m_sNavigationButtonLayout
SCR_DynamicFooterComponent	m_DynamicFooter
ref array< SCR_InputButtonComponent >	m_aNavigationButtons = {}
ref map< SCR_InputButtonComponent, bool >	m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()
Widget	m_wMenuRoot
int	m_iIndex
bool	m_bShown
bool	m_bFocused
ref ScriptInvokerVoid	m_OnRequestCloseMenu
ref ScriptInvokerInt2	m_OnRequestTabChange
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

CreateNavigationButton()

SCR_InputButtonComponent SCR_SubMenuBase.CreateNavigationButton ( string actionName, string label, bool rightFooter = false, bool show = true )

protected

FlagNavigationButtonVisibility()

void SCR_SubMenuBase.FlagNavigationButtonVisibility ( SCR_InputButtonComponent button, bool show )

protected

GetIndex()

int SCR_SubMenuBase.GetIndex

(

)

GetOnRequestCloseMenu()

ScriptInvokerVoid SCR_SubMenuBase.GetOnRequestCloseMenu

(

)

GetOnRequestTabChange()

ScriptInvokerInt2 SCR_SubMenuBase.GetOnRequestTabChange

(

)

GetShown()

bool SCR_SubMenuBase.GetShown

(

)

OnMenuFocusGained()

void SCR_SubMenuBase.OnMenuFocusGained

(

)

Implemented in SCR_AddonsPresetsSubMenuComponent, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_ContentBrowserDetails_OverviewSubMenu, SCR_DownloadManagerListComponent, SCR_KeybindSetting, and SCR_WorkshopListAddonsSubmenu.

OnMenuFocusLost()

void SCR_SubMenuBase.OnMenuFocusLost

(

)

Implemented in SCR_KeybindSetting.

OnMenuHide()

void SCR_SubMenuBase.OnMenuHide

(

)

OnMenuShow()

void SCR_SubMenuBase.OnMenuShow

(

)

Implemented in SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_KeybindSetting, and SCR_WorkshopListAddonsSubmenu.

OnMenuUpdate()

void SCR_SubMenuBase.OnMenuUpdate

(

float

tDelta

)

Implemented in SCR_CareerProfileOverviewUI, SCR_CommunitySubMenu, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_GroupSubMenuPlayerlist, and SCR_KeybindSetting.

OnTabChange()

void SCR_SubMenuBase.OnTabChange

(

)

OnTabCreate()

void SCR_SubMenuBase.OnTabCreate	(	Widget	menuRoot,
		ResourceName	buttonsLayout,
		int	index )

Implemented in SCR_AddonsPresetsSubMenuComponent, SCR_AudioSettingsSubMenu, SCR_CareerProfileOverviewUI, SCR_CommunitySubMenu, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_ContentBrowserDetails_OverviewSubMenu, SCR_ContentBrowserDetails_SaveOverviewSubMenu, SCR_ControllerPresetsSettingsSubmenu, SCR_DownloadManagerListComponent, SCR_EditorSettingsSubMenu, SCR_GameplaySettingsSubMenu, SCR_GroupSubMenu, SCR_GroupSubMenuPlayerlist, SCR_InterfaceSettingsSubMenu, SCR_KeybindSetting, SCR_NewsSubMenu, SCR_ServerHostingModSubMenu, SCR_ServerHostingSettingsSubMenu, SCR_SettingsSubMenuBase, SCR_VideoSettingsConsoleSubMenu, SCR_VideoSettingsSubMenu, and SCR_WorkshopListAddonsSubmenu.

OnTabHide()

void SCR_SubMenuBase.OnTabHide

(

)

Implemented in SCR_CommunitySubMenu, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_ContentBrowserDetails_OverviewSubMenu, SCR_ControllerPresetsSettingsSubmenu, SCR_GameplaySettingsSubMenu, SCR_GroupSubMenu, SCR_GroupSubMenuPlayerlist, SCR_KeybindSetting, SCR_NewsSubMenu, SCR_ServerHostingModSubMenu, SCR_ServerHostingSettingsSubMenu, SCR_SettingsSubMenuBase, and SCR_WorkshopListAddonsSubmenu.

OnTabRemove()

void SCR_SubMenuBase.OnTabRemove

(

)

Implemented in SCR_CommunitySubMenu, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowserDetails_OverviewSubMenu, SCR_GroupSubMenuPlayerlist, SCR_NewsSubMenu, SCR_RequestToJoinSubmenu, and SCR_WorkshopListAddonsSubmenu.

OnTabShow()

void SCR_SubMenuBase.OnTabShow

(

)

Implemented in SCR_AddonsExportSubMenuComponent, SCR_AddonsPresetsSubMenuComponent, SCR_ContentBrowser_AddonsSubMenu, SCR_ContentBrowser_ScenarioSubMenu, SCR_ContentBrowser_ScenarioSubMenuBase, SCR_ContentBrowserDetails_OverviewSubMenu, SCR_DownloadManagerListComponent, SCR_GroupSubMenu, SCR_GroupSubMenuPlayerlist, SCR_KeybindSetting, SCR_NewsSubMenu, SCR_RequestToJoinSubmenu, SCR_ServerHostingModSubMenu, SCR_ServerHostingSettingsSubMenu, SCR_SettingsSubMenuBase, and SCR_WorkshopListAddonsSubmenu.

RequestCloseMenu()

void SCR_SubMenuBase.RequestCloseMenu ( )

protected

RequestTabChange()

void SCR_SubMenuBase.RequestTabChange ( int newTabIndex )

protected

SetNavigationButtonVisibile()

void SCR_SubMenuBase.SetNavigationButtonVisibile ( SCR_InputButtonComponent button, bool show, bool animate = false )

protected

ShowNavigationButtons()

void SCR_SubMenuBase.ShowNavigationButtons ( bool show )

protected

Implemented in SCR_ServerHostingModSubMenu.

Member Data Documentation

m_aNavigationButtons

ref array<SCR_InputButtonComponent> SCR_SubMenuBase.m_aNavigationButtons = {}

protected

m_aNavigationButtonsVisibilityFlags

ref map<SCR_InputButtonComponent, bool> SCR_SubMenuBase.m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()

protected

m_bFocused

bool SCR_SubMenuBase.m_bFocused

protected

m_bShown

bool SCR_SubMenuBase.m_bShown

protected

m_DynamicFooter

SCR_DynamicFooterComponent SCR_SubMenuBase.m_DynamicFooter

protected

m_iIndex

int SCR_SubMenuBase.m_iIndex

protected

m_OnRequestCloseMenu

ref ScriptInvokerVoid SCR_SubMenuBase.m_OnRequestCloseMenu

protected

m_OnRequestTabChange

ref ScriptInvokerInt2 SCR_SubMenuBase.m_OnRequestTabChange

protected

m_sNavigationButtonLayout

ResourceName SCR_SubMenuBase.m_sNavigationButtonLayout

protected

m_wMenuRoot

Widget SCR_SubMenuBase.m_wMenuRoot

protected

---

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

• Game/UI/Menu/SubMenu/SCR_SubMenuBase.c