SCR_CoreMenuHeaderButtonComponent Interface Reference

Helper component for core menu header button prefabs. More...

Inheritance diagram for SCR_CoreMenuHeaderButtonComponent:

Public Member Functions
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
string	m_sIconName
bool	m_bShowCount
string	m_sLabel
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Attributes
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

Static Protected Attributes
const string	BUTTON = "CoreMenuHeaderButton"
const string	COUNT_ICON_FRAME = "CountIconFrame"
const string	COUNT_TEXT = "CountText"
const string	ICON = "Icon"
const string	LABEL = "ButtonLabel"

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.

Detailed Description

Helper component for core menu header button prefabs.

Member Function Documentation

GetButton()

SCR_ModularButtonComponent SCR_CoreMenuHeaderButtonComponent.GetButton

(

)

Returns

GetLabelText()

string SCR_CoreMenuHeaderButtonComponent.GetLabelText

(

)

Returns

HandlerAttached()

override void SCR_CoreMenuHeaderButtonComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_ConnectionStateButtonComponent.

SetCountText()

void SCR_CoreMenuHeaderButtonComponent.SetCountText

(

string

text

)

Parameters

[in]

text

SetCountVisible()

void SCR_CoreMenuHeaderButtonComponent.SetCountVisible

(

bool

visible

)

Parameters

[in]

visible

SetIcon()

void SCR_CoreMenuHeaderButtonComponent.SetIcon

(

string

name

)

Parameters

[in]

name

SetLabelText()

void SCR_CoreMenuHeaderButtonComponent.SetLabelText

(

string

text

)

Parameters

[in]

text

SetVisible()

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

Parameters

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

Implemented in SCR_ConnectionStateButtonComponent.

Member Data Documentation

BUTTON

const string SCR_CoreMenuHeaderButtonComponent.BUTTON = "CoreMenuHeaderButton"

staticprotected

COUNT_ICON_FRAME

const string SCR_CoreMenuHeaderButtonComponent.COUNT_ICON_FRAME = "CountIconFrame"

staticprotected

COUNT_TEXT

const string SCR_CoreMenuHeaderButtonComponent.COUNT_TEXT = "CountText"

staticprotected

ICON

const string SCR_CoreMenuHeaderButtonComponent.ICON = "Icon"

staticprotected

LABEL

const string SCR_CoreMenuHeaderButtonComponent.LABEL = "ButtonLabel"

staticprotected

m_bShowCount

bool SCR_CoreMenuHeaderButtonComponent.m_bShowCount

m_ButtonComponent

SCR_ModularButtonComponent SCR_CoreMenuHeaderButtonComponent.m_ButtonComponent

protected

m_sIconName

string SCR_CoreMenuHeaderButtonComponent.m_sIconName

m_sLabel

string SCR_CoreMenuHeaderButtonComponent.m_sLabel

m_wButtonWidget

Widget SCR_CoreMenuHeaderButtonComponent.m_wButtonWidget

protected

m_wCountIconFrame

Widget SCR_CoreMenuHeaderButtonComponent.m_wCountIconFrame

protected

m_wCountText

TextWidget SCR_CoreMenuHeaderButtonComponent.m_wCountText

protected

m_wIcon

ImageWidget SCR_CoreMenuHeaderButtonComponent.m_wIcon

protected

m_wLabel

TextWidget SCR_CoreMenuHeaderButtonComponent.m_wLabel

protected

---

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

• Game/UI/Components/MainMenu/SCR_CoreMenuHeaderButtonComponent.c