SCR_ButtonComponent Interface Reference

Deprecated button component. Still used in many prefabs, so it works, it's just stripped of most of the functionality. More...

Inheritance diagram for SCR_ButtonComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
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	ColorizeWidgets (Color colorBackground, Color colorContent, float speed=-1)
void	SetHorizontalAlign (LayoutHorizontalAlign horizontalAlign)
void	SetContent (string text)
void	SetContentFromUIInfo (SCR_UIInfo info)
string	GetContent ()
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_ButtonComponent	GetButtonComponent (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_OnHover = new ScriptInvoker()
ref ScriptInvoker< Widget >	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 Attributes
LocalizedString	m_sContent
Widget	m_wOverlay
Widget	m_wContent
ref Color	COLOR_BACKGROUND_DEFAULT = UIColors.BACKGROUND_DEFAULT
ref Color	COLOR_BACKGROUND_HOVERED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_BACKGROUND_FOCUSED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_BACKGROUND_CLICKED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_CONTENT_DEFAULT = Color.White
ref Color	COLOR_CONTENT_HOVERED = Color.White
ref Color	COLOR_CONTENT_FOCUSED = Color.White
ref Color	COLOR_CONTENT_CLICKED = Color.White
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
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)

Detailed Description

Deprecated button component. Still used in many prefabs, so it works, it's just stripped of most of the functionality.

Member Function Documentation

ColorizeWidgets()

void SCR_ButtonComponent.ColorizeWidgets	(	Color	colorBackground,
		Color	colorContent,
		float	speed = -1
	)

Implemented in SCR_ButtonSplitComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

GetButtonComponent()

static SCR_ButtonComponent SCR_ButtonComponent.GetButtonComponent ( 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

GetContent()

string SCR_ButtonComponent.GetContent

(

)

HandlerAttached()

override void SCR_ButtonComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ModdedScenarioComponent, SCR_ButtonSplitComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnFocus()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ModdedScenarioComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnFocusLost()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnMouseEnter()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ButtonSplitComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnMouseLeave()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ButtonSplitComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

SetContent()

void SCR_ButtonComponent.SetContent

(

string

text

)

SetContentFromUIInfo()

void SCR_ButtonComponent.SetContentFromUIInfo

(

SCR_UIInfo

info

)

SetHorizontalAlign()

void SCR_ButtonComponent.SetHorizontalAlign

(

LayoutHorizontalAlign

horizontalAlign

)

Member Data Documentation

COLOR_BACKGROUND_CLICKED

ref Color SCR_ButtonComponent.COLOR_BACKGROUND_CLICKED = UIColors.BACKGROUND_HOVERED

protected

COLOR_BACKGROUND_DEFAULT

ref Color SCR_ButtonComponent.COLOR_BACKGROUND_DEFAULT = UIColors.BACKGROUND_DEFAULT

protected

COLOR_BACKGROUND_FOCUSED

ref Color SCR_ButtonComponent.COLOR_BACKGROUND_FOCUSED = UIColors.BACKGROUND_HOVERED

protected

COLOR_BACKGROUND_HOVERED

ref Color SCR_ButtonComponent.COLOR_BACKGROUND_HOVERED = UIColors.BACKGROUND_HOVERED

protected

COLOR_CONTENT_CLICKED

ref Color SCR_ButtonComponent.COLOR_CONTENT_CLICKED = Color.White

protected

COLOR_CONTENT_DEFAULT

ref Color SCR_ButtonComponent.COLOR_CONTENT_DEFAULT = Color.White

protected

COLOR_CONTENT_FOCUSED

ref Color SCR_ButtonComponent.COLOR_CONTENT_FOCUSED = Color.White

protected

COLOR_CONTENT_HOVERED

ref Color SCR_ButtonComponent.COLOR_CONTENT_HOVERED = Color.White

protected

m_OnHover

ref ScriptInvoker SCR_ButtonComponent.m_OnHover = new ScriptInvoker()

m_OnHoverLeave

ref ScriptInvoker<Widget> SCR_ButtonComponent.m_OnHoverLeave = new ScriptInvoker()

m_sContent

LocalizedString SCR_ButtonComponent.m_sContent

protected

m_wContent

Widget SCR_ButtonComponent.m_wContent

protected

m_wOverlay

Widget SCR_ButtonComponent.m_wOverlay

protected

---

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

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