Final Reforger button. More...

Inheritance diagram for SCR_ButtonSplitComponent:

Public Member Functions
void	SetColorizeFocusLost (bool colorize)

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

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

void	InsertWidgetCells (array< string > cellNames)

void	SetupInnerButton (string widgetName)
	Find and setup focusing on root for every inner widget.

void	ColorizeCellPart (string partName, Color c, float speed, float prevent, int id)
	Set color of one specific cell.

void	PreventContentColoringOn (int iCellId, bool bPrevent)

Color	GetColorContent ()

Public Member Functions inherited from SCR_ButtonComponent
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 ()

Protected Member Functions
override void	HandlerAttached (Widget w)

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

void	OnInnerButtonFocus (Widget w)
	Focus button root.

void	ColorizeCellPart (string partName, Color c, float speed, float prevent)
	Set color of every cell.

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 Widget >	m_aWidgetCells = new array<ref Widget>()

ref array< bool >	m_aPreventContentChange = new array<bool>

ref array< SCR_ButtonComponent >	m_aInnerButtons = new array<SCR_ButtonComponent>

Color	m_cColorContent

ref Widget	m_wHoverWidget

int	m_iButtonPaddingLeft

int	m_iButtonPaddingTop

int	m_iButtonPaddingRigh

int	m_iButtonPaddingBottom

bool	m_bColorizeFocusLost = true

Protected Attributes inherited from SCR_ButtonComponent
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 Member Functions inherited from SCR_ButtonComponent
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 inherited from SCR_ButtonComponent
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

Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001

static const float	START_ANIMATION_PERIOD = 250

Detailed Description

Final Reforger button.

Supported states: Disaled, hovered, focused, clicked - each with own visualization Works with WLib_Button widget prefab

Member Function Documentation

◆ ColorizeCellPart() [1/2]

void SCR_ButtonSplitComponent.ColorizeCellPart	(	string	partName,
		Color	c,
		float	speed,
		float	prevent
	)

protected

Set color of every cell.

◆ ColorizeCellPart() [2/2]

void SCR_ButtonSplitComponent.ColorizeCellPart	(	string	partName,
		Color	c,
		float	speed,
		float	prevent,
		int	id
	)

Set color of one specific cell.

◆ ColorizeWidgets()

override void SCR_ButtonSplitComponent.ColorizeWidgets	(	Color	colorBackground,
		Color	colorContent,
		float	speed = `-1`
	)

protected

Implements SCR_ButtonComponent.

◆ GetColorContent()

Color SCR_ButtonSplitComponent.GetColorContent ( )

◆ HandlerAttached()

override void SCR_ButtonSplitComponent.HandlerAttached ( Widget w )

protected

Implements SCR_ButtonComponent.

◆ InsertWidgetCells()

void SCR_ButtonSplitComponent.InsertWidgetCells ( array< string > cellNames )

◆ OnInnerButtonFocus()

void SCR_ButtonSplitComponent.OnInnerButtonFocus ( Widget w )

protected

Focus button root.

◆ OnMouseEnter()

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

Implements SCR_ButtonComponent.

◆ OnMouseLeave()

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

Implements SCR_ButtonComponent.

◆ PreventContentColoringOn()

void SCR_ButtonSplitComponent.PreventContentColoringOn	(	int	iCellId,
		bool	bPrevent
	)

◆ SetColorizeFocusLost()

void SCR_ButtonSplitComponent.SetColorizeFocusLost ( bool colorize )

◆ SetupInnerButton()

void SCR_ButtonSplitComponent.SetupInnerButton ( string widgetName )

Find and setup focusing on root for every inner widget.

Member Data Documentation

◆ m_aInnerButtons

ref array<SCR_ButtonComponent> SCR_ButtonSplitComponent.m_aInnerButtons = new array<SCR_ButtonComponent>

protected

◆ m_aPreventContentChange

ref array<bool> SCR_ButtonSplitComponent.m_aPreventContentChange = new array<bool>

protected

◆ m_aWidgetCells

ref array<ref Widget> SCR_ButtonSplitComponent.m_aWidgetCells = new array<ref Widget>()

protected

◆ m_bColorizeFocusLost

bool SCR_ButtonSplitComponent.m_bColorizeFocusLost = true

protected

◆ m_cColorContent

Color SCR_ButtonSplitComponent.m_cColorContent

protected

◆ m_iButtonPaddingBottom

int SCR_ButtonSplitComponent.m_iButtonPaddingBottom

protected

◆ m_iButtonPaddingLeft

int SCR_ButtonSplitComponent.m_iButtonPaddingLeft

protected

◆ m_iButtonPaddingRigh

int SCR_ButtonSplitComponent.m_iButtonPaddingRigh

protected

◆ m_iButtonPaddingTop

int SCR_ButtonSplitComponent.m_iButtonPaddingTop

protected

◆ m_wHoverWidget

ref Widget SCR_ButtonSplitComponent.m_wHoverWidget

protected

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

Game/UI/Components/WidgetLibrary/SCR_ButtonSplitComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ColorizeCellPart() [1/2]

◆ ColorizeCellPart() [2/2]

◆ ColorizeWidgets()

◆ GetColorContent()

◆ HandlerAttached()

◆ InsertWidgetCells()

◆ OnInnerButtonFocus()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ PreventContentColoringOn()

◆ SetColorizeFocusLost()

◆ SetupInnerButton()

Member Data Documentation

◆ m_aInnerButtons

◆ m_aPreventContentChange

◆ m_aWidgetCells

◆ m_bColorizeFocusLost

◆ m_cColorContent

◆ m_iButtonPaddingBottom

◆ m_iButtonPaddingLeft

◆ m_iButtonPaddingRigh

◆ m_iButtonPaddingTop

◆ m_wHoverWidget