SCR_MultipleStatesButtonComponent Interface Reference

Multiple states button. More...

Inheritance diagram for SCR_MultipleStatesButtonComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	Init ()
override bool	OnClick (Widget w, int x, int y, int button)
void	ChangeState (int state)
void	StartProgress ()
void	SetProgress (int progress)
void	FinishProgress ()
int	GetSelectedItem ()
void	SetProgressText (string text)
void	SetHintVisible (bool show)
void	EnableButton (bool bEnable)
bool	IsButtonEnabled ()
override bool	OnMouseButtonDown (Widget w, int x, int y, int button)
override bool	OnMouseButtonUp (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
string	GetCurrentContent ()
Public Member Functions inherited from SCR_ButtonBaseComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
bool	IsToggled ()
void	SetToggleable (bool togglable)
bool	GetToggleable ()
void	ShowBorder (bool show, bool animate=true)
bool	IsBorderShown ()
void	SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
	Alternate way of setting button background colors through script.
void	ColorizeBackground (bool animate=true)
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
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 ()

Static Public Member Functions
static SCR_MultipleStatesButtonComponent	GetMultipleStatesButtonComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.
Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent	GetButtonBase (string name, Widget parent, bool searchAllChildren=true)
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
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
ref ScriptInvoker	m_OnStateChange = new ScriptInvoker
ref ScriptInvoker	m_OnHover = new ScriptInvoker
ref ScriptInvoker	m_OnHoverLeave = new ScriptInvoker
Public Attributes inherited from SCR_ButtonBaseComponent
bool	m_bCanBeToggled
bool	m_bUseColorization
ref Color	m_BackgroundDefault
ref Color	m_BackgroundHovered
ref Color	m_BackgroundSelected
ref Color	m_BackgroundSelectedHovered
ref Color	m_BackgroundClicked
bool	m_bShowBorderOnFocus
bool	m_bShowBackgroundOnFocus
bool	m_bNoBorderAnimation
bool	m_bNoBackgroundAnimation
bool	m_bShowBorderOnHover
Widget	m_wBackground
Widget	m_wBorder
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker< Widget >	m_OnFocus = new ScriptInvoker<Widget>()
ref ScriptInvoker< Widget >	m_OnFocusLost = new ScriptInvoker<Widget>()
ref ScriptInvoker	m_OnShowBorder = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
override void	OnMenuSelect ()
Protected Member Functions inherited from SCR_ButtonBaseComponent
void	OnMenuSelect ()
void	MenuSelectBase ()
void	FindParentMenu ()
	Finds the parent menu of this component.
bool	IsParentMenuFocused ()
	Returns true if parent menu is focused, or if there is no parent menu.
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Protected Attributes
ref array< ref MultipleStateButtonState >	m_aStates
ResourceName	m_wIconSetTexture
int	m_iStateSelected
bool	m_bEnabled = true
string	m_sHintAction
TextWidget	m_ContentText
TextWidget	m_ProgressText
ImageWidget	m_Progress
ImageWidget	m_wIcon
RichTextWidget	m_wActionHint
Protected Attributes inherited from SCR_ButtonBaseComponent
bool	m_bIsToggled
MenuBase	m_ParentMenu
SCR_SubMenuBase	m_ParentSubMenu
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Detailed Description

Multiple states button.

Works with WLib_ButtonMultipleStates widget prefab.

Member Function Documentation

ChangeState()

void SCR_MultipleStatesButtonComponent.ChangeState

(

int

state

)

EnableButton()

void SCR_MultipleStatesButtonComponent.EnableButton

(

bool

bEnable

)

FinishProgress()

void SCR_MultipleStatesButtonComponent.FinishProgress

(

)

GetCurrentContent()

string SCR_MultipleStatesButtonComponent.GetCurrentContent

(

)

GetMultipleStatesButtonComponent()

static SCR_MultipleStatesButtonComponent SCR_MultipleStatesButtonComponent.GetMultipleStatesButtonComponent ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

GetSelectedItem()

int SCR_MultipleStatesButtonComponent.GetSelectedItem

(

)

HandlerAttached()

override void SCR_MultipleStatesButtonComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonBaseComponent.

Init()

void SCR_MultipleStatesButtonComponent.Init

(

)

IsButtonEnabled()

bool SCR_MultipleStatesButtonComponent.IsButtonEnabled

(

)

OnClick()

override bool SCR_MultipleStatesButtonComponent.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

Implements SCR_ButtonBaseComponent.

OnFocus()

override bool SCR_MultipleStatesButtonComponent.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ButtonBaseComponent.

OnFocusLost()

override bool SCR_MultipleStatesButtonComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ButtonBaseComponent.

OnMenuSelect()

override void SCR_MultipleStatesButtonComponent.OnMenuSelect ( )

protected

Implements SCR_ButtonBaseComponent.

OnMouseButtonDown()

override bool SCR_MultipleStatesButtonComponent.OnMouseButtonDown	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseButtonUp()

override bool SCR_MultipleStatesButtonComponent.OnMouseButtonUp	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseEnter()

override bool SCR_MultipleStatesButtonComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ButtonBaseComponent.

OnMouseLeave()

override bool SCR_MultipleStatesButtonComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y
	)

Implements SCR_ButtonBaseComponent.

SetHintVisible()

void SCR_MultipleStatesButtonComponent.SetHintVisible

(

bool

show

)

SetProgress()

void SCR_MultipleStatesButtonComponent.SetProgress

(

int

progress

)

SetProgressText()

void SCR_MultipleStatesButtonComponent.SetProgressText

(

string

text

)

StartProgress()

void SCR_MultipleStatesButtonComponent.StartProgress

(

)

Member Data Documentation

m_aStates

ref array<ref MultipleStateButtonState> SCR_MultipleStatesButtonComponent.m_aStates

protected

m_bEnabled

bool SCR_MultipleStatesButtonComponent.m_bEnabled = true

protected

m_ContentText

TextWidget SCR_MultipleStatesButtonComponent.m_ContentText

protected

m_iStateSelected

int SCR_MultipleStatesButtonComponent.m_iStateSelected

protected

m_OnHover

ref ScriptInvoker SCR_MultipleStatesButtonComponent.m_OnHover = new ScriptInvoker

m_OnHoverLeave

ref ScriptInvoker SCR_MultipleStatesButtonComponent.m_OnHoverLeave = new ScriptInvoker

m_OnStateChange

ref ScriptInvoker SCR_MultipleStatesButtonComponent.m_OnStateChange = new ScriptInvoker

m_Progress

ImageWidget SCR_MultipleStatesButtonComponent.m_Progress

protected

m_ProgressText

TextWidget SCR_MultipleStatesButtonComponent.m_ProgressText

protected

m_sHintAction

string SCR_MultipleStatesButtonComponent.m_sHintAction

protected

m_wActionHint

RichTextWidget SCR_MultipleStatesButtonComponent.m_wActionHint

protected

m_wIcon

ImageWidget SCR_MultipleStatesButtonComponent.m_wIcon

protected

m_wIconSetTexture

ResourceName SCR_MultipleStatesButtonComponent.m_wIconSetTexture

protected

---

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

• Game/UI/Components/WidgetLibrary/SCR_MultipleStatesButtonComponent.c