SCR_ButtonEffectColor Interface Reference

Effect which colorizes a widget with given name. More...

Inheritance diagram for SCR_ButtonEffectColor:

Public Member Functions
override void	OnStateDefault (bool instant)
override void	OnStateHovered (bool instant)
override void	OnStateActivated (bool instant)
override void	OnStateDisabled (bool instant)
override void	OnStateDisabledActivated (bool instant)
override void	OnStateActivatedHovered (bool instant)
override void	OnClicked (bool instant)
override void	OnFocusGained (bool instant)
override void	OnFocusLost (bool instant)
override void	OnToggledOn (bool instant)
override void	OnToggledOff (bool instant)
override void	OnDisabled ()
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
ref Color	m_cDefault
ref Color	m_cHovered
ref Color	m_cActivated
ref Color	m_cActivatedHovered
ref Color	m_cDisabled
ref Color	m_cDisabledActivated
ref Color	m_cClicked
ref Color	m_cFocusGained
ref Color	m_cFocusLost
ref Color	m_cToggledOn
ref Color	m_cToggledOff
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Protected Member Functions
void	Apply (Color color, bool instant)
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)

Protected Attributes
float	m_fAnimationTime
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

Effect which colorizes a widget with given name.

Member Function Documentation

Apply()

void SCR_ButtonEffectColor.Apply ( Color  color, bool  instant  )

protected

OnClicked()

override void SCR_ButtonEffectColor.OnClicked

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnDisabled()

override void SCR_ButtonEffectColor.OnDisabled

(

)

Implements SCR_ButtonEffectBase.

OnFocusGained()

override void SCR_ButtonEffectColor.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectColor.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectColor.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectColor.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectColor.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectColor.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectColor.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectColor.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectColor.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectColor.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_cActivated

ref Color SCR_ButtonEffectColor.m_cActivated

m_cActivatedHovered

ref Color SCR_ButtonEffectColor.m_cActivatedHovered

m_cClicked

ref Color SCR_ButtonEffectColor.m_cClicked

m_cDefault

ref Color SCR_ButtonEffectColor.m_cDefault

m_cDisabled

ref Color SCR_ButtonEffectColor.m_cDisabled

m_cDisabledActivated

ref Color SCR_ButtonEffectColor.m_cDisabledActivated

m_cFocusGained

ref Color SCR_ButtonEffectColor.m_cFocusGained

m_cFocusLost

ref Color SCR_ButtonEffectColor.m_cFocusLost

m_cHovered

ref Color SCR_ButtonEffectColor.m_cHovered

m_cToggledOff

ref Color SCR_ButtonEffectColor.m_cToggledOff

m_cToggledOn

ref Color SCR_ButtonEffectColor.m_cToggledOn

m_fAnimationTime

float SCR_ButtonEffectColor.m_fAnimationTime

protected

---

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

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