Component for core menu header button that shows connection state based on comm test, but also needs to show a warning for low bandwidth Uses the parent's icon & label attributes for Low Bandwidth state and considers it the default, as it is outside of the comm test results. More...

Inheritance diagram for SCR_ConnectionStateButtonComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

override void	SetVisible (bool visible, bool animate=false, float rate=UIConstants.FADE_RATE_FAST)

Public Member Functions inherited from SCR_CoreMenuHeaderButtonComponent
override void	HandlerAttached (Widget w)

void	SetIcon (string name)

void	SetCountText (string text)

void	SetCountVisible (bool visible)

void	SetLabelText (string text)

string	GetLabelText ()

void	SetVisible (bool visible, bool animate=false, float rate=UIConstants.FADE_RATE_FAST)

SCR_ModularButtonComponent	GetButton ()

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 ()

Public Attributes
EAnimationCurve	m_eSpinnerAnimationCurve

Public Attributes inherited from SCR_CoreMenuHeaderButtonComponent
string	m_sIconName

bool	m_bShowCount

string	m_sLabel

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	OnMenuEnabled (ChimeraMenuBase menu)

void	OnMenuDisabled (ChimeraMenuBase menu)

void	ClearInvokers ()

void	OnCommStatusUpdated (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)

void	OnCommStatusCheckStart ()

void	OnAutomaticRefresh ()

void	UpdateStatus (SCR_ECommStatus status)

bool	AreServicesUnavailable ()

bool	CheckLowBandwidth ()

void	UpdateWidgets (SCR_ECommStatus status, bool lowBandwidth=false)

void	AnimateSpinner ()

bool	ShowSpinner ()

SCR_ConnectionStateButtonComponent_StatusPreset	GetStatusPreset (SCR_ECommStatus status)

void	SetIconColor (Color color)

void	OnButtonClicked ()

void	OnButtonFocused ()

void	OnButtonFocusLost ()

void	OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)

void	UpdateTooltip ()

Protected Attributes
ref SCR_BackendServiceDisplayPresets	m_ServicesPresets

ref array< ref SCR_ConnectionStateButtonComponent_StatusPreset >	m_aStatuses

ref Color	m_LowBandwidthColor

bool	m_bShowLowBandwidthLabel

string	m_sTooltipTag

float	m_fSpinnerSpeed

bool	m_bIsListeningForCommCheckEvent

ref array< string >	m_aUnavailableServices = {}

SCR_ConnectionStateButtonComponent_StatusPreset	m_CurrentStatusPreset

SCR_ScriptedWidgetTooltip	m_Tooltip

ImageWidget	m_wConnectingSpinner

WidgetAnimationImageRotation	m_SpinnerAnimation

Protected Attributes inherited from SCR_CoreMenuHeaderButtonComponent
Widget	m_wButtonWidget

SCR_ModularButtonComponent	m_ButtonComponent

ImageWidget	m_wIcon

Widget	m_wCountIconFrame

TextWidget	m_wCountText

TextWidget	m_wLabel

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.

Static Protected Attributes inherited from SCR_CoreMenuHeaderButtonComponent
const string	BUTTON = "CoreMenuHeaderButton"

const string	COUNT_ICON_FRAME = "CountIconFrame"

const string	COUNT_TEXT = "CountText"

const string	ICON = "Icon"

const string	LABEL = "ButtonLabel"

Detailed Description

Component for core menu header button that shows connection state based on comm test, but also needs to show a warning for low bandwidth Uses the parent's icon & label attributes for Low Bandwidth state and considers it the default, as it is outside of the comm test results.

Member Function Documentation

◆ AnimateSpinner()

void SCR_ConnectionStateButtonComponent.AnimateSpinner ( )

protected

◆ AreServicesUnavailable()

bool SCR_ConnectionStateButtonComponent.AreServicesUnavailable ( )

protected

◆ CheckLowBandwidth()

bool SCR_ConnectionStateButtonComponent.CheckLowBandwidth ( )

protected

◆ ClearInvokers()

void SCR_ConnectionStateButtonComponent.ClearInvokers ( )

protected

◆ GetStatusPreset()

SCR_ConnectionStateButtonComponent_StatusPreset SCR_ConnectionStateButtonComponent.GetStatusPreset ( SCR_ECommStatus status )

protected

◆ HandlerAttached()

override void SCR_ConnectionStateButtonComponent.HandlerAttached ( Widget w )

Implements SCR_CoreMenuHeaderButtonComponent.

◆ HandlerDeattached()

override void SCR_ConnectionStateButtonComponent.HandlerDeattached ( Widget w )

◆ OnAutomaticRefresh()

void SCR_ConnectionStateButtonComponent.OnAutomaticRefresh ( )

protected

◆ OnButtonClicked()

void SCR_ConnectionStateButtonComponent.OnButtonClicked ( )

protected

◆ OnButtonFocused()

void SCR_ConnectionStateButtonComponent.OnButtonFocused ( )

protected

◆ OnButtonFocusLost()

void SCR_ConnectionStateButtonComponent.OnButtonFocusLost ( )

protected

◆ OnCommStatusCheckStart()

void SCR_ConnectionStateButtonComponent.OnCommStatusCheckStart ( )

protected

◆ OnCommStatusUpdated()

void SCR_ConnectionStateButtonComponent.OnCommStatusUpdated	(	SCR_ECommStatus	status,
		float	responseTime,
		float	lastSuccessTime,
		float	lastFailTime
	)

protected

◆ OnMenuDisabled()

void SCR_ConnectionStateButtonComponent.OnMenuDisabled ( ChimeraMenuBase menu )

protected

◆ OnMenuEnabled()

void SCR_ConnectionStateButtonComponent.OnMenuEnabled ( ChimeraMenuBase menu )

protected

◆ OnTooltipShow()

void SCR_ConnectionStateButtonComponent.OnTooltipShow ( SCR_ScriptedWidgetTooltip tooltip )

protected

◆ SetIconColor()

void SCR_ConnectionStateButtonComponent.SetIconColor ( Color color )

protected

◆ SetVisible()

override void SCR_ConnectionStateButtonComponent.SetVisible	(	bool	visible,
		bool	animate = `false`,
		float	rate = `UIConstants::FADE_RATE_FAST`
	)

Parameters

[in]	visible
[in]	animate
[in]	rate

Implements SCR_CoreMenuHeaderButtonComponent.

◆ ShowSpinner()

bool SCR_ConnectionStateButtonComponent.ShowSpinner ( )

protected

◆ UpdateStatus()

void SCR_ConnectionStateButtonComponent.UpdateStatus ( SCR_ECommStatus status )

protected

◆ UpdateTooltip()

void SCR_ConnectionStateButtonComponent.UpdateTooltip ( )

protected

◆ UpdateWidgets()

void SCR_ConnectionStateButtonComponent.UpdateWidgets	(	SCR_ECommStatus	status,
		bool	lowBandwidth = `false`
	)

protected

Member Data Documentation

◆ m_aStatuses

ref array<ref SCR_ConnectionStateButtonComponent_StatusPreset> SCR_ConnectionStateButtonComponent.m_aStatuses

protected

◆ m_aUnavailableServices

ref array<string> SCR_ConnectionStateButtonComponent.m_aUnavailableServices = {}

protected

◆ m_bIsListeningForCommCheckEvent

bool SCR_ConnectionStateButtonComponent.m_bIsListeningForCommCheckEvent

protected

◆ m_bShowLowBandwidthLabel

bool SCR_ConnectionStateButtonComponent.m_bShowLowBandwidthLabel

protected

◆ m_CurrentStatusPreset

SCR_ConnectionStateButtonComponent_StatusPreset SCR_ConnectionStateButtonComponent.m_CurrentStatusPreset

protected

◆ m_eSpinnerAnimationCurve

EAnimationCurve SCR_ConnectionStateButtonComponent.m_eSpinnerAnimationCurve

◆ m_fSpinnerSpeed

float SCR_ConnectionStateButtonComponent.m_fSpinnerSpeed

protected

◆ m_LowBandwidthColor

ref Color SCR_ConnectionStateButtonComponent.m_LowBandwidthColor

protected

◆ m_ServicesPresets

ref SCR_BackendServiceDisplayPresets SCR_ConnectionStateButtonComponent.m_ServicesPresets

protected

◆ m_SpinnerAnimation

WidgetAnimationImageRotation SCR_ConnectionStateButtonComponent.m_SpinnerAnimation

protected

◆ m_sTooltipTag

string SCR_ConnectionStateButtonComponent.m_sTooltipTag

protected

◆ m_Tooltip

SCR_ScriptedWidgetTooltip SCR_ConnectionStateButtonComponent.m_Tooltip

protected

◆ m_wConnectingSpinner

ImageWidget SCR_ConnectionStateButtonComponent.m_wConnectingSpinner

protected

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

Game/UI/Components/MainMenu/SCR_ConnectionStateButtonComponent.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AnimateSpinner()

◆ AreServicesUnavailable()

◆ CheckLowBandwidth()

◆ ClearInvokers()

◆ GetStatusPreset()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ OnAutomaticRefresh()

◆ OnButtonClicked()

◆ OnButtonFocused()

◆ OnButtonFocusLost()

◆ OnCommStatusCheckStart()

◆ OnCommStatusUpdated()

◆ OnMenuDisabled()

◆ OnMenuEnabled()

◆ OnTooltipShow()

◆ SetIconColor()

◆ SetVisible()

◆ ShowSpinner()

◆ UpdateStatus()

◆ UpdateTooltip()

◆ UpdateWidgets()

Member Data Documentation

◆ m_aStatuses

◆ m_aUnavailableServices

◆ m_bIsListeningForCommCheckEvent

◆ m_bShowLowBandwidthLabel

◆ m_CurrentStatusPreset

◆ m_eSpinnerAnimationCurve

◆ m_fSpinnerSpeed

◆ m_LowBandwidthColor

◆ m_ServicesPresets

◆ m_SpinnerAnimation

◆ m_sTooltipTag

◆ m_Tooltip

◆ m_wConnectingSpinner