Inheritance diagram for SCR_DeployButtonBase:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

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

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

Widget	GetList ()

GridLayoutWidget	GetGridList ()

void	ExpandList ()

void	CollapseList ()

void	SetParentHandler (SCR_DeployRequestUIBaseComponent parent)

void	HideTooltip ()

void	Update (float dt)

void	Lock (bool loadingAnim=false)
	Lock the button (eg. during a request)

void	Unlock ()
	Unlock the button (eg. after receiving a request response)

void	SetSelected (bool selected)
	Visually set the button as selected.

void	SetFocused ()
	Set the button focused.

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

override void	SetEnabled (bool enabled, bool animate=true)

void	SetShouldUnlock (bool shouldUnlock)
	Marks if the buttons should be unlocked when calling the Unlock() method.

void	SetTooltipAvailable (bool available)
	Set if tooltip should be shown.

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

ImageWidget	GetImageWidget ()

void	SetImage (ResourceName texture, bool fromLocalStorage=false)

void	SetImage (ResourceName imageSet, string imageName)

string	GetImage (out string imageSet)

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
bool	ShouldUnlock ()
	Return true when the button should be unlocked when calling the Unlock() method.

bool	ShouldShowTooltip ()
	Get if tooltip should be shown.

void	OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)

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 Color	m_ColorSelected

ref Color	m_ColorWarning

string	m_sElements

Widget	m_wElements

string	m_sList

Widget	m_wList

string	m_sGridList

GridLayoutWidget	m_wGridList

string	m_sBackgroundHighlight

Widget	m_wBackgroundHighlight

SCR_DeployRequestUIBaseComponent	m_ParentHandler

ButtonWidget	m_wRootButton

Widget	m_wLoading

SCR_LoadingSpinner	m_Loading

SCR_ScriptedWidgetTooltip	m_ControlsTooltip

bool	m_bCanBeUnlocked = true

bool	m_bShowTooltip = true

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

Static Protected Attributes
static SCR_DeployButtonBase	s_ExpandedList

Additional Inherited Members
Static Public Member Functions inherited from SCR_ButtonImageComponent
static SCR_ButtonImageComponent	GetButtonImage (string name, Widget parent, bool searchAllChildren=true)

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_ButtonImageComponent
ResourceName	m_sTexture

string	m_sImageName

ImageWidget	m_wImage

ref ScriptInvoker< Widget >	m_OnMouseEnter = new ScriptInvoker()

ref ScriptInvoker< Widget >	m_OnMouseLeave = 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

Member Function Documentation

◆ CollapseList()

void SCR_DeployButtonBase.CollapseList ( )

◆ ExpandList()

void SCR_DeployButtonBase.ExpandList ( )

◆ GetGridList()

GridLayoutWidget SCR_DeployButtonBase.GetGridList ( )

◆ GetList()

Widget SCR_DeployButtonBase.GetList ( )

◆ HandlerAttached()

override void SCR_DeployButtonBase.HandlerAttached ( Widget w )

Implements SCR_ButtonImageComponent.

Implemented in SCR_FactionButton, SCR_GroupButton, and SCR_LoadoutButton.

◆ HandlerDeattached()

override void SCR_DeployButtonBase.HandlerDeattached ( Widget w )

Implemented in SCR_LoadoutButton.

◆ HideTooltip()

void SCR_DeployButtonBase.HideTooltip ( )

◆ Lock()

void SCR_DeployButtonBase.Lock ( bool loadingAnim = false )

Lock the button (eg. during a request)

◆ OnClick()

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

Implements SCR_ButtonBaseComponent.

◆ OnFocus()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_LoadoutButton.

◆ OnFocusLost()

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

Implements SCR_ButtonBaseComponent.

Implemented in SCR_LoadoutButton.

◆ OnTooltipShow()

void SCR_DeployButtonBase.OnTooltipShow ( SCR_ScriptedWidgetTooltip tooltip )

protected

◆ SetEnabled()

override void SCR_DeployButtonBase.SetEnabled	(	bool	enabled,
		bool	animate = `true`
	)

Implements SCR_WLibComponentBase.

◆ SetFocused()

void SCR_DeployButtonBase.SetFocused ( )

Set the button focused.

◆ SetParentHandler()

void SCR_DeployButtonBase.SetParentHandler ( SCR_DeployRequestUIBaseComponent parent )

◆ SetSelected()

void SCR_DeployButtonBase.SetSelected ( bool selected )

Visually set the button as selected.

Implemented in SCR_FactionButton, SCR_GroupButton, and SCR_LoadoutButton.

◆ SetShouldUnlock()

void SCR_DeployButtonBase.SetShouldUnlock ( bool shouldUnlock )

Marks if the buttons should be unlocked when calling the Unlock() method.

◆ SetTooltipAvailable()

void SCR_DeployButtonBase.SetTooltipAvailable ( bool available )

Set if tooltip should be shown.

◆ ShouldShowTooltip()

bool SCR_DeployButtonBase.ShouldShowTooltip ( )

protected

Get if tooltip should be shown.

◆ ShouldUnlock()

bool SCR_DeployButtonBase.ShouldUnlock ( )

protected

Return true when the button should be unlocked when calling the Unlock() method.

◆ Unlock()

void SCR_DeployButtonBase.Unlock ( )

Unlock the button (eg. after receiving a request response)

◆ Update()

void SCR_DeployButtonBase.Update ( float dt )

Member Data Documentation

◆ m_bCanBeUnlocked

bool SCR_DeployButtonBase.m_bCanBeUnlocked = true

protected

◆ m_bShowTooltip

bool SCR_DeployButtonBase.m_bShowTooltip = true

protected

◆ m_ColorSelected

ref Color SCR_DeployButtonBase.m_ColorSelected

protected

◆ m_ColorWarning

ref Color SCR_DeployButtonBase.m_ColorWarning

protected

◆ m_ControlsTooltip

SCR_ScriptedWidgetTooltip SCR_DeployButtonBase.m_ControlsTooltip

protected

◆ m_Loading

SCR_LoadingSpinner SCR_DeployButtonBase.m_Loading

protected

◆ m_ParentHandler

SCR_DeployRequestUIBaseComponent SCR_DeployButtonBase.m_ParentHandler

protected

◆ m_sBackgroundHighlight

string SCR_DeployButtonBase.m_sBackgroundHighlight

protected

◆ m_sElements

string SCR_DeployButtonBase.m_sElements

protected

◆ m_sGridList

string SCR_DeployButtonBase.m_sGridList

protected

◆ m_sList

string SCR_DeployButtonBase.m_sList

protected

◆ m_wBackgroundHighlight

Widget SCR_DeployButtonBase.m_wBackgroundHighlight

protected

◆ m_wElements

Widget SCR_DeployButtonBase.m_wElements

protected

◆ m_wGridList

GridLayoutWidget SCR_DeployButtonBase.m_wGridList

protected

◆ m_wList

Widget SCR_DeployButtonBase.m_wList

protected

◆ m_wLoading

Widget SCR_DeployButtonBase.m_wLoading

protected

◆ m_wRootButton

ButtonWidget SCR_DeployButtonBase.m_wRootButton

protected

◆ s_ExpandedList

SCR_DeployButtonBase SCR_DeployButtonBase.s_ExpandedList

staticprotected

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

Game/UI/Menu/DeployMenu/SCR_DeployRequestUIBaseComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CollapseList()

◆ ExpandList()

◆ GetGridList()

◆ GetList()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ HideTooltip()

◆ Lock()

◆ OnClick()

◆ OnFocus()

◆ OnFocusLost()

◆ OnTooltipShow()

◆ SetEnabled()

◆ SetFocused()

◆ SetParentHandler()

◆ SetSelected()

◆ SetShouldUnlock()

◆ SetTooltipAvailable()

◆ ShouldShowTooltip()

◆ ShouldUnlock()

◆ Unlock()

◆ Update()

Member Data Documentation

◆ m_bCanBeUnlocked

◆ m_bShowTooltip

◆ m_ColorSelected

◆ m_ColorWarning

◆ m_ControlsTooltip

◆ m_Loading

◆ m_ParentHandler

◆ m_sBackgroundHighlight

◆ m_sElements

◆ m_sGridList

◆ m_sList

◆ m_wBackgroundHighlight

◆ m_wElements

◆ m_wGridList

◆ m_wList

◆ m_wLoading

◆ m_wRootButton

◆ s_ExpandedList