Inheritance diagram for SCR_ButtonImageComponent:

[legend]

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)

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

Static Public Member Functions
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
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

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)

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

Member Function Documentation

◆ GetButtonImage()

static SCR_ButtonImageComponent SCR_ButtonImageComponent.GetButtonImage	(	string	name,
		Widget	parent,
		bool	searchAllChildren = `true`
	)

static

◆ GetImage()

string SCR_ButtonImageComponent.GetImage ( out string imageSet )

◆ GetImageWidget()

ImageWidget SCR_ButtonImageComponent.GetImageWidget ( )

◆ HandlerAttached()

override void SCR_ButtonImageComponent.HandlerAttached ( Widget w )

Implements SCR_ButtonBaseComponent.

Implemented in SCR_GroupFlagImageComponent, SCR_ToolMenuButtonComponent, SCR_DeployButtonBase, SCR_FactionButton, SCR_GroupButton, and SCR_LoadoutButton.

◆ OnMouseEnter()

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

Implements SCR_ButtonBaseComponent.

◆ OnMouseLeave()

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

Implements SCR_ButtonBaseComponent.

◆ SetImage() [1/2]

void SCR_ButtonImageComponent.SetImage	(	ResourceName	imageSet,
		string	imageName
	)

◆ SetImage() [2/2]

void SCR_ButtonImageComponent.SetImage	(	ResourceName	texture,
		bool	fromLocalStorage = `false`
	)

Member Data Documentation

◆ m_OnMouseEnter

ref ScriptInvoker<Widget> SCR_ButtonImageComponent.m_OnMouseEnter = new ScriptInvoker()

◆ m_OnMouseLeave

ref ScriptInvoker<Widget> SCR_ButtonImageComponent.m_OnMouseLeave = new ScriptInvoker()

◆ m_sImageName

string SCR_ButtonImageComponent.m_sImageName

◆ m_sTexture

ResourceName SCR_ButtonImageComponent.m_sTexture

◆ m_wImage

ImageWidget SCR_ButtonImageComponent.m_wImage

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

Game/UI/Components/WidgetLibrary/Button/SCR_ButtonImageComponent.c

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ GetButtonImage()

◆ GetImage()

◆ GetImageWidget()

◆ HandlerAttached()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ SetImage() [1/2]

◆ SetImage() [2/2]

Member Data Documentation

◆ m_OnMouseEnter

◆ m_OnMouseLeave

◆ m_sImageName

◆ m_sTexture

◆ m_wImage