SCR_InterfaceSettingsSubMenu Interface Reference

Inheritance diagram for SCR_InterfaceSettingsSubMenu:

Public Member Functions
override void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
void	OnSpinBoxChange (SCR_SpinBoxComponent spinBox, int currentItem)
void	OnMasterChange (SCR_SpinBoxComponent spinBox, int currentItem)
Public Member Functions inherited from SCR_SettingsSubMenuBase
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	SetupSpinboxes (string widgetName, string settingName)
	Get the correct Spinnerbox widget for the setting and set it's value based on the stored setting.
void	SetupMasterSwitch ()
void	ChangeMasterSwitchState ()
void	SetCustomState ()
Protected Member Functions inherited from SCR_SettingsSubMenuBase
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
BaseContainer	m_InterfaceSettings
SCR_SpinBoxComponent	m_SpinnerBoxComp
SCR_SpinBoxComponent	m_MasterSpinBoxComp
bool	m_bIsAllShown
bool	m_bIsCustom
ref array< ref SCR_SpinBoxComponent >	m_aAllSpinBoxes = {}
Protected Attributes inherited from SCR_SettingsSubMenuBase
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

Static Protected Attributes
const string	CHAT_SPINBOX_WIDGET_NAME = "Chat"
const string	NOTIFICATIONS_SPINBOX_WIDGET_NAME = "Notifications"
const string	VON_SPINBOX_WIDGET_NAME = "VoN"
const string	CONTROLHINTS_SPINBOX_WIDGET_NAME = "ControlHints"
const string	HINTS_SPINBOX_WIDGET_NAME = "Hints"
const string	NEARBYINTERACTION_SPINBOX_WIDGET_NAME = "NearbyInteractions"
const string	NAMETAGS_SPINBOX_WIDGET_NAME = "NameTags"
const string	FPS_SPINBOX_WIDGET_NAME = "FPS"
const string	SERVER_FPS_SPINBOX_WIDGET_NAME = "ServerFPS"
const string	PACKETLOSS_SPINBOX_WIDGET_NAME = "PacketLoss"
const string	LATENCY_SPINBOX_WIDGET_NAME = "Latency"
const string	GAMEVERSION_SPINBOX_WIDGET_NAME = "GameVersion"
const string	WEAPONINFO_SPINBOX_WIDGET_NAME = "WeaponInfo"
const string	VEHICLEINFO_SPINBOX_WIDGET_NAME = "VehicleInfo"
const string	MASTERSWITCH_SPINBOX_WIDGET_NAME = "MasterSwitch"
const string	SERVERNAME_SPINBOX_WIDGET_NAME = "ServerName"
const string	INTERACTION_HINT_SPINBOX_WIDGET_NAME = "InteractionHint"
const string	MASTER_SWITCH_HIDE_STATE_NAME = "#AR-Settings_Hide_All"
const string	MASTER_SWITCH_SHOW_STATE_NAME = "#AR-Settings_Show_All"
const string	MASTER_SWITCH_CUSTOM_STATE_NAME = "#AR-Settings_Interface_Custom"
const int	MASTER_SWITCH_CUSTOM_STATE_SPINBOX_INDEX = 2

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

ChangeMasterSwitchState()

void SCR_InterfaceSettingsSubMenu.ChangeMasterSwitchState ( )

protected

OnMasterChange()

void SCR_InterfaceSettingsSubMenu.OnMasterChange	(	SCR_SpinBoxComponent	spinBox,
		int	currentItem )

OnSpinBoxChange()

void SCR_InterfaceSettingsSubMenu.OnSpinBoxChange	(	SCR_SpinBoxComponent	spinBox,
		int	currentItem )

OnTabCreate()

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

Implements SCR_SettingsSubMenuBase.

SetCustomState()

void SCR_InterfaceSettingsSubMenu.SetCustomState ( )

protected

SetupMasterSwitch()

void SCR_InterfaceSettingsSubMenu.SetupMasterSwitch ( )

protected

SetupSpinboxes()

void SCR_InterfaceSettingsSubMenu.SetupSpinboxes ( string widgetName, string settingName )

protected

Get the correct Spinnerbox widget for the setting and set it's value based on the stored setting.

Parameters

[in]	name	of the Spinnerbox widget
[in]	variable	name of the setting from SCR_InterfaceSettings

Member Data Documentation

CHAT_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.CHAT_SPINBOX_WIDGET_NAME = "Chat"

staticprotected

CONTROLHINTS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.CONTROLHINTS_SPINBOX_WIDGET_NAME = "ControlHints"

staticprotected

FPS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.FPS_SPINBOX_WIDGET_NAME = "FPS"

staticprotected

GAMEVERSION_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.GAMEVERSION_SPINBOX_WIDGET_NAME = "GameVersion"

staticprotected

HINTS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.HINTS_SPINBOX_WIDGET_NAME = "Hints"

staticprotected

INTERACTION_HINT_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.INTERACTION_HINT_SPINBOX_WIDGET_NAME = "InteractionHint"

staticprotected

LATENCY_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.LATENCY_SPINBOX_WIDGET_NAME = "Latency"

staticprotected

m_aAllSpinBoxes

ref array<ref SCR_SpinBoxComponent> SCR_InterfaceSettingsSubMenu.m_aAllSpinBoxes = {}

protected

m_bIsAllShown

bool SCR_InterfaceSettingsSubMenu.m_bIsAllShown

protected

m_bIsCustom

bool SCR_InterfaceSettingsSubMenu.m_bIsCustom

protected

m_InterfaceSettings

BaseContainer SCR_InterfaceSettingsSubMenu.m_InterfaceSettings

protected

m_MasterSpinBoxComp

SCR_SpinBoxComponent SCR_InterfaceSettingsSubMenu.m_MasterSpinBoxComp

protected

m_SpinnerBoxComp

SCR_SpinBoxComponent SCR_InterfaceSettingsSubMenu.m_SpinnerBoxComp

protected

MASTER_SWITCH_CUSTOM_STATE_NAME

const string SCR_InterfaceSettingsSubMenu.MASTER_SWITCH_CUSTOM_STATE_NAME = "#AR-Settings_Interface_Custom"

staticprotected

MASTER_SWITCH_CUSTOM_STATE_SPINBOX_INDEX

const int SCR_InterfaceSettingsSubMenu.MASTER_SWITCH_CUSTOM_STATE_SPINBOX_INDEX = 2

staticprotected

MASTER_SWITCH_HIDE_STATE_NAME

const string SCR_InterfaceSettingsSubMenu.MASTER_SWITCH_HIDE_STATE_NAME = "#AR-Settings_Hide_All"

staticprotected

MASTER_SWITCH_SHOW_STATE_NAME

const string SCR_InterfaceSettingsSubMenu.MASTER_SWITCH_SHOW_STATE_NAME = "#AR-Settings_Show_All"

staticprotected

MASTERSWITCH_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.MASTERSWITCH_SPINBOX_WIDGET_NAME = "MasterSwitch"

staticprotected

NAMETAGS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.NAMETAGS_SPINBOX_WIDGET_NAME = "NameTags"

staticprotected

NEARBYINTERACTION_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.NEARBYINTERACTION_SPINBOX_WIDGET_NAME = "NearbyInteractions"

staticprotected

NOTIFICATIONS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.NOTIFICATIONS_SPINBOX_WIDGET_NAME = "Notifications"

staticprotected

PACKETLOSS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.PACKETLOSS_SPINBOX_WIDGET_NAME = "PacketLoss"

staticprotected

SERVER_FPS_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.SERVER_FPS_SPINBOX_WIDGET_NAME = "ServerFPS"

staticprotected

SERVERNAME_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.SERVERNAME_SPINBOX_WIDGET_NAME = "ServerName"

staticprotected

VEHICLEINFO_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.VEHICLEINFO_SPINBOX_WIDGET_NAME = "VehicleInfo"

staticprotected

VON_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.VON_SPINBOX_WIDGET_NAME = "VoN"

staticprotected

WEAPONINFO_SPINBOX_WIDGET_NAME

const string SCR_InterfaceSettingsSubMenu.WEAPONINFO_SPINBOX_WIDGET_NAME = "WeaponInfo"

staticprotected

---

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

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