SCR_SettingsSubMenuBase Interface Reference

Inheritance diagram for SCR_SettingsSubMenuBase:

Public Member Functions
override void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
override void	OnTabHide ()
override void	OnTabShow ()
Public Member Functions inherited from SCR_SubMenuBase
void	OnMenuFocusGained ()
void	OnMenuFocusLost ()
void	OnMenuShow ()
void	OnMenuHide ()
void	OnMenuUpdate (float tDelta)
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	LoadSettings (bool forceLoadSettings=false, bool addEntryChangedEventHandler=true)
void	OnMenuItemChanged (SCR_SettingsBindingBase binding)
void	HideMenuItem (string widgetName)
Protected Member Functions inherited from SCR_SubMenuBase
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
ref array< ref SCR_SettingsBindingBase >	m_aSettingsBindings = {}
ScrollLayoutWidget	m_wScroll
bool	m_bLoadingSettings
Protected Attributes inherited from SCR_SubMenuBase
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

HideMenuItem()

void SCR_SettingsSubMenuBase.HideMenuItem ( string widgetName )

protected

LoadSettings()

void SCR_SettingsSubMenuBase.LoadSettings ( bool forceLoadSettings = false, bool addEntryChangedEventHandler = true )

protected

OnMenuItemChanged()

void SCR_SettingsSubMenuBase.OnMenuItemChanged ( SCR_SettingsBindingBase binding )

protected

Implemented in SCR_VideoSettingsSubMenu.

OnTabCreate()

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

Implements SCR_SubMenuBase.

Implemented in SCR_AudioSettingsSubMenu, SCR_ControllerPresetsSettingsSubmenu, SCR_EditorSettingsSubMenu, SCR_GameplaySettingsSubMenu, SCR_InterfaceSettingsSubMenu, SCR_KeybindSetting, SCR_VideoSettingsConsoleSubMenu, and SCR_VideoSettingsSubMenu.

OnTabHide()

override void SCR_SettingsSubMenuBase.OnTabHide

(

)

Implements SCR_SubMenuBase.

Implemented in SCR_ControllerPresetsSettingsSubmenu, SCR_GameplaySettingsSubMenu, and SCR_KeybindSetting.

OnTabShow()

override void SCR_SettingsSubMenuBase.OnTabShow

(

)

Implements SCR_SubMenuBase.

Implemented in SCR_KeybindSetting.

Member Data Documentation

m_aSettingsBindings

ref array<ref SCR_SettingsBindingBase> SCR_SettingsSubMenuBase.m_aSettingsBindings = {}

protected

m_bLoadingSettings

bool SCR_SettingsSubMenuBase.m_bLoadingSettings

protected

m_wScroll

ScrollLayoutWidget SCR_SettingsSubMenuBase.m_wScroll

protected

---

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

• Game/UI/Menu/SettingsMenu/SCR_SettingsSubMenuBase.c