SCR_CoreMenuHeaderButtonComponent Class Reference

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

Inheritance diagram for SCR_CoreMenuHeaderButtonComponent:

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

Protected Attributes
Widget	m_wButtonWidget
SCR_ModularButtonComponent	m_ButtonComponent
ImageWidget	m_wIcon
Widget	m_wCountIconFrame
TextWidget	m_wCountText
TextWidget	m_wLabel
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

Helper component for core menu header button prefabs.

Definition at line 2 of file SCR_CoreMenuHeaderButtonComponent.c.

Member Function Documentation

GetButton()

SCR_ModularButtonComponent SCR_CoreMenuHeaderButtonComponent::GetButton ( )

inlineprotected

Returns

Definition at line 130 of file SCR_CoreMenuHeaderButtonComponent.c.

GetLabelText()

string SCR_CoreMenuHeaderButtonComponent::GetLabelText ( )

inlineprotected

Returns

Definition at line 105 of file SCR_CoreMenuHeaderButtonComponent.c.

HandlerAttached()

override void SCR_CoreMenuHeaderButtonComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 30 of file SCR_CoreMenuHeaderButtonComponent.c.

SetCountText()

void SCR_CoreMenuHeaderButtonComponent::SetCountText ( string text )

inlineprotected

Parameters

[in]

text

Definition at line 72 of file SCR_CoreMenuHeaderButtonComponent.c.

SetCountVisible()

void SCR_CoreMenuHeaderButtonComponent::SetCountVisible ( bool visible )

inlineprotected

Parameters

[in]

visible

Definition at line 82 of file SCR_CoreMenuHeaderButtonComponent.c.

SetIcon()

void SCR_CoreMenuHeaderButtonComponent::SetIcon ( string name )

inlineprotected

Parameters

[in]

name

Definition at line 51 of file SCR_CoreMenuHeaderButtonComponent.c.

SetLabelText()

void SCR_CoreMenuHeaderButtonComponent::SetLabelText ( string text )

inlineprotected

Parameters

[in]

text

Definition at line 92 of file SCR_CoreMenuHeaderButtonComponent.c.

SetVisible()

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

inlineprotected

Parameters

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

Definition at line 117 of file SCR_CoreMenuHeaderButtonComponent.c.

Member Data Documentation

BUTTON

const string SCR_CoreMenuHeaderButtonComponent::BUTTON = "CoreMenuHeaderButton"

protected

Definition at line 23 of file SCR_CoreMenuHeaderButtonComponent.c.

COUNT_ICON_FRAME

const string SCR_CoreMenuHeaderButtonComponent::COUNT_ICON_FRAME = "CountIconFrame"

protected

Definition at line 24 of file SCR_CoreMenuHeaderButtonComponent.c.

COUNT_TEXT

const string SCR_CoreMenuHeaderButtonComponent::COUNT_TEXT = "CountText"

protected

Definition at line 25 of file SCR_CoreMenuHeaderButtonComponent.c.

ICON

const string SCR_CoreMenuHeaderButtonComponent::ICON = "Icon"

protected

Definition at line 26 of file SCR_CoreMenuHeaderButtonComponent.c.

LABEL

const string SCR_CoreMenuHeaderButtonComponent::LABEL = "ButtonLabel"

protected

Definition at line 27 of file SCR_CoreMenuHeaderButtonComponent.c.

m_ButtonComponent

SCR_ModularButtonComponent SCR_CoreMenuHeaderButtonComponent::m_ButtonComponent

protected

Definition at line 14 of file SCR_CoreMenuHeaderButtonComponent.c.

m_wButtonWidget

Widget SCR_CoreMenuHeaderButtonComponent::m_wButtonWidget

protected

Definition at line 13 of file SCR_CoreMenuHeaderButtonComponent.c.

m_wCountIconFrame

Widget SCR_CoreMenuHeaderButtonComponent::m_wCountIconFrame

protected

Definition at line 18 of file SCR_CoreMenuHeaderButtonComponent.c.

m_wCountText

TextWidget SCR_CoreMenuHeaderButtonComponent::m_wCountText

protected

Definition at line 19 of file SCR_CoreMenuHeaderButtonComponent.c.

m_wIcon

ImageWidget SCR_CoreMenuHeaderButtonComponent::m_wIcon

protected

Definition at line 16 of file SCR_CoreMenuHeaderButtonComponent.c.

m_wLabel

TextWidget SCR_CoreMenuHeaderButtonComponent::m_wLabel

protected

Definition at line 21 of file SCR_CoreMenuHeaderButtonComponent.c.

---

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

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