SCR_ButtonEffectImage Interface Reference

This effect modifies texture of an image. More...

Inheritance diagram for SCR_ButtonEffectImage:

Public Member Functions
override void	OnStateDefault (bool instant)
override void	OnStateHovered (bool instant)
override void	OnStateActivated (bool instant)
override void	OnStateActivatedHovered (bool instant)
override void	OnStateDisabled (bool instant)
override void	OnStateDisabledActivated (bool instant)
override void	OnFocusGained (bool instant)
override void	OnFocusLost (bool instant)
override void	OnToggledOn (bool instant)
override void	OnToggledOff (bool instant)
Public Member Functions inherited from SCR_ButtonEffectWidgetBase
override void	OnHandlerAttached (Widget w)
Widget	GetTargetWidget ()
Public Member Functions inherited from SCR_ButtonEffectBase
bool	GetEnabled ()
void	SetEnabled (bool enabled)
void	PropertiesChanged ()
	Call it if properties have changed and they must be reapplied.
bool	HasTag (string tag)
	Returns true when the effect contains a given tag.
void	OnHandlerAttached (Widget w)
void	OnDisabled ()
bool	Internal_OnEvent (EModularButtonEventFlag eventFlag, EInputDeviceType deviceType, bool instant=false)
void	Init (SCR_ModularButtonComponent parentButton)

Public Attributes
ResourceName	m_ImageSet
ref SCR_ButtonEffectImage_ImageOrImageSet	m_Default
ref SCR_ButtonEffectImage_ImageOrImageSet	m_Hovered
ref SCR_ButtonEffectImage_ImageOrImageSet	m_Activated
ref SCR_ButtonEffectImage_ImageOrImageSet	m_ActivatedHovered
ref SCR_ButtonEffectImage_ImageOrImageSet	m_Disabled
ref SCR_ButtonEffectImage_ImageOrImageSet	m_DisabledActivated
ref SCR_ButtonEffectImage_ImageOrImageSet	m_FocusGained
ref SCR_ButtonEffectImage_ImageOrImageSet	m_FocusLost
ref SCR_ButtonEffectImage_ImageOrImageSet	m_ToggledOn
ref SCR_ButtonEffectImage_ImageOrImageSet	m_ToggledOff
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Protected Member Functions
void	Apply (SCR_ButtonEffectImage_ImageOrImageSet imgSpec)
Protected Member Functions inherited from SCR_ButtonEffectBase
void	OnStateDefault (bool instant)
void	OnStateHovered (bool instant)
void	OnStateActivated (bool instant)
void	OnStateActivatedHovered (bool instant)
void	OnStateDisabled (bool instant)
void	OnStateDisabledActivated (bool instant)
void	OnClicked (bool instant)
void	OnFocusGained (bool instant)
void	OnFocusLost (bool instant)
void	OnToggledOn (bool instant)
void	OnToggledOff (bool instant)
void	OnMouseEnter (bool instant)
void	OnMouseLeave (bool instant)
void	_print (string s)

Additional Inherited Members
Protected Attributes inherited from SCR_ButtonEffectWidgetBase
string	m_sWidgetName
Widget	m_wTarget
Protected Attributes inherited from SCR_ButtonEffectBase
bool	m_bEnabled
SCR_ModularButtonComponent	m_Button

Detailed Description

This effect modifies texture of an image.

Member Function Documentation

Apply()

void SCR_ButtonEffectImage.Apply ( SCR_ButtonEffectImage_ImageOrImageSet  imgSpec )

protected

OnFocusGained()

override void SCR_ButtonEffectImage.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectImage.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectImage.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectImage.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectImage.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectImage.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectImage.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectImage.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectImage.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectImage.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_Activated

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_Activated

m_ActivatedHovered

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_ActivatedHovered

m_Default

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_Default

m_Disabled

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_Disabled

m_DisabledActivated

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_DisabledActivated

m_FocusGained

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_FocusGained

m_FocusLost

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_FocusLost

m_Hovered

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_Hovered

m_ImageSet

ResourceName SCR_ButtonEffectImage.m_ImageSet

m_ToggledOff

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_ToggledOff

m_ToggledOn

ref SCR_ButtonEffectImage_ImageOrImageSet SCR_ButtonEffectImage.m_ToggledOn

---

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

• Game/UI/Components/ButtonComponents/ModularButton/Effects/SCR_ButtonEffectImage.c