SCR_ButtonEffectOpacity Interface Reference

Effect which animated opacity of the target widget. More...

Inheritance diagram for SCR_ButtonEffectOpacity:

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	OnClicked (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)
override void	OnMouseEnter (bool instant)
override void	OnMouseLeave (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
float	m_fDefault
float	m_fHovered
float	m_fActivated
float	m_fActivatedHovered
float	m_fDisabled
float	m_fDisabledActivated
float	m_fClicked
float	m_fFocusGained
float	m_fFocusLost
float	m_fToggledOn
float	m_fToggledOff
float	m_fMouseEnter
float	m_fMouseLeave
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Protected Member Functions
void	Apply (float value, 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 animated opacity of the target widget.

Member Function Documentation

Apply()

void SCR_ButtonEffectOpacity.Apply ( float  value, bool  instant  )

protected

OnClicked()

override void SCR_ButtonEffectOpacity.OnClicked

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnDisabled()

override void SCR_ButtonEffectOpacity.OnDisabled

(

)

Implements SCR_ButtonEffectBase.

OnFocusGained()

override void SCR_ButtonEffectOpacity.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectOpacity.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnMouseEnter()

override void SCR_ButtonEffectOpacity.OnMouseEnter

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnMouseLeave()

override void SCR_ButtonEffectOpacity.OnMouseLeave

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectOpacity.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectOpacity.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectOpacity.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectOpacity.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectOpacity.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectOpacity.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectOpacity.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectOpacity.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_fActivated

float SCR_ButtonEffectOpacity.m_fActivated

m_fActivatedHovered

float SCR_ButtonEffectOpacity.m_fActivatedHovered

m_fAnimationTime

float SCR_ButtonEffectOpacity.m_fAnimationTime

protected

m_fClicked

float SCR_ButtonEffectOpacity.m_fClicked

m_fDefault

float SCR_ButtonEffectOpacity.m_fDefault

m_fDisabled

float SCR_ButtonEffectOpacity.m_fDisabled

m_fDisabledActivated

float SCR_ButtonEffectOpacity.m_fDisabledActivated

m_fFocusGained

float SCR_ButtonEffectOpacity.m_fFocusGained

m_fFocusLost

float SCR_ButtonEffectOpacity.m_fFocusLost

m_fHovered

float SCR_ButtonEffectOpacity.m_fHovered

m_fMouseEnter

float SCR_ButtonEffectOpacity.m_fMouseEnter

m_fMouseLeave

float SCR_ButtonEffectOpacity.m_fMouseLeave

m_fToggledOff

float SCR_ButtonEffectOpacity.m_fToggledOff

m_fToggledOn

float SCR_ButtonEffectOpacity.m_fToggledOn

---

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

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