Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_ButtonEffectBase Interface Reference

Base class for modular button effects. More...

Inheritance diagram for SCR_ButtonEffectBase:
SCR_ButtonEffectSound SCR_ButtonEffectWidgetBase SCR_ButtonEffectColor SCR_ButtonEffectImage SCR_ButtonEffectOpacity SCR_ButtonEffectPadding SCR_ButtonEffectPosition SCR_ButtonEffectSize SCR_ButtonEffectSlaveButton SCR_ButtonEffectText SCR_ButtonEffectVisibility

Public Member Functions

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 array< string > m_aTags
 
EModularButtonEventFlag m_eEvents
 
EModularButtonInputDevice m_eInputDevices
 

Protected Member Functions

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

bool m_bEnabled
 
SCR_ModularButtonComponent m_Button
 

Detailed Description

Base class for modular button effects.

Override methods in inherited classes with specific effect implementations.

Member Function Documentation

◆ _print()

void SCR_ButtonEffectBase._print ( string s)
protected

◆ GetEnabled()

bool SCR_ButtonEffectBase.GetEnabled ( )
Returns

◆ HasTag()

bool SCR_ButtonEffectBase.HasTag ( string tag)

Returns true when the effect contains a given tag.

◆ Init()

void SCR_ButtonEffectBase.Init ( SCR_ModularButtonComponent parentButton)
Parameters
[in]parentButton

◆ Internal_OnEvent()

bool SCR_ButtonEffectBase.Internal_OnEvent ( EModularButtonEventFlag eventFlag,
EInputDeviceType deviceType,
bool instant = false )
Parameters
[in]eventFlag
[in]deviceType
[in]instant
Returns
true when effect was consumed

◆ OnClicked()

◆ OnDisabled()

◆ OnFocusGained()

◆ OnFocusLost()

◆ OnHandlerAttached()

void SCR_ButtonEffectBase.OnHandlerAttached ( Widget w)
Parameters
[in]w

Implemented in SCR_ButtonEffectSlaveButton, and SCR_ButtonEffectWidgetBase.

◆ OnMouseEnter()

void SCR_ButtonEffectBase.OnMouseEnter ( bool instant)
protected

◆ OnMouseLeave()

void SCR_ButtonEffectBase.OnMouseLeave ( bool instant)
protected

◆ OnStateActivated()

◆ OnStateActivatedHovered()

◆ OnStateDefault()

◆ OnStateDisabled()

◆ OnStateDisabledActivated()

◆ OnStateHovered()

◆ OnToggledOff()

◆ OnToggledOn()

◆ PropertiesChanged()

void SCR_ButtonEffectBase.PropertiesChanged ( )

Call it if properties have changed and they must be reapplied.

◆ SetEnabled()

void SCR_ButtonEffectBase.SetEnabled ( bool enabled)
Parameters
[in]enabled

Member Data Documentation

◆ m_aTags

ref array<string> SCR_ButtonEffectBase.m_aTags

◆ m_bEnabled

bool SCR_ButtonEffectBase.m_bEnabled
protected

◆ m_Button

SCR_ModularButtonComponent SCR_ButtonEffectBase.m_Button
protected

◆ m_eEvents

EModularButtonEventFlag SCR_ButtonEffectBase.m_eEvents

◆ m_eInputDevices

EModularButtonInputDevice SCR_ButtonEffectBase.m_eInputDevices

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