SCR_ButtonEffectSound Interface Reference

Plays a sound. More...

Inheritance diagram for SCR_ButtonEffectSound:

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	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	OnMouseEnter (bool instant)
override void	OnMouseLeave (bool instant)
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)

Protected Member Functions
void	Apply (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
string	m_sSound
Protected Attributes inherited from SCR_ButtonEffectBase
bool	m_bEnabled
SCR_ModularButtonComponent	m_Button

Additional Inherited Members
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Detailed Description

Plays a sound.

Member Function Documentation

Apply()

void SCR_ButtonEffectSound.Apply ( bool  instant )

protected

OnClicked()

override void SCR_ButtonEffectSound.OnClicked

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusGained()

override void SCR_ButtonEffectSound.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectSound.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnMouseEnter()

override void SCR_ButtonEffectSound.OnMouseEnter

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnMouseLeave()

override void SCR_ButtonEffectSound.OnMouseLeave

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectSound.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectSound.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectSound.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectSound.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectSound.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectSound.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectSound.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectSound.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_sSound

string SCR_ButtonEffectSound.m_sSound

protected

---

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

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