Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_AddonLineBaseComponent Interface Reference

Class for addon line button base. More...

Inheritance diagram for SCR_AddonLineBaseComponent:
[legend]

Public Member Functions

override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnFocusLost (Widget w, int x, int y)
 
override void UpdateModularButtons ()
 
override void OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
void OnUpdateButton ()
 
void OnOpenDetailsButton ()
 
void OnEnableButton ()
 
void OnDisableButton ()
 
bool IsEnabled ()
 
void Init (SCR_WorkshopItem item)
 Setup line.
 
SCR_WorkshopItem GetWorkshopItem ()
 
SCR_EAddonLineErrorFlags GetErrorFlags ()
 
bool CanBeEnabled ()
 
ScriptInvokerScriptedWidgetComponent GetOnEnableButton ()
 
ScriptInvokerScriptedWidgetComponent GetOnDisableButton ()
 
ScriptInvokerScriptedWidgetComponent GetOnFixButton ()
 
- Public Member Functions inherited from SCR_ListMenuEntryComponent
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
override bool OnDoubleClick (Widget w, int x, int y, int button)
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnFocusLost (Widget w, int x, int y)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
void AnimateOpacity (int delay, float animationTime, float opacityEnd, float opacityStart=-1)
 Animate whole widget opacity.
 
bool IsInnerButtonInteraction ()
 
bool IsFocused ()
 
bool IsAvailable ()
 
ScriptInvokerString GetOnMouseInteractionButtonClicked ()
 
ScriptInvokerScriptedWidgetComponent GetOnFocus ()
 
ScriptInvokerScriptedWidgetComponent GetOnFocusLost ()
 
ScriptInvokerScriptedWidgetComponent GetOnMouseEnter ()
 
- Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
Widget GetRootWidget ()
 
bool IsVisible ()
 

Protected Member Functions

void UpdateAllWidgets ()
 Update vizual state of line.
 
void HandleDownloadChanges ()
 
void StartContinuousUpdate ()
 
void StopContinuousUpdate ()
 
void ContinuousUpdate ()
 
void HandleEnableButtons (bool addonEnabled, bool forceHidden=false)
 
void UpdateCompatibilityWidgets ()
 Display incopatible icon Set icon to incompatible and update base on current state.
 
void UpdateDownloadProgressWidgets ()
 
void UpdateIssueState ()
 
bool RequiresDownloadingDependencies ()
 
bool HasItemAnyIssue ()
 
void OnAnyNewDownload (SCR_WorkshopItem item, SCR_WorkshopItemActionDownload action)
 
void OnAnyDownloadError (SCR_WorkshopItemActionDownload action, int reason)
 
void OnAnyDownloadCompleted (SCR_WorkshopItemActionDownload action)
 
void OnWorkshopItemChange (SCR_WorkshopItem item)
 
void OnDeleteButton ()
 
void OnActionButton ()
 
void OnFixButton ()
 
void OnUpdateTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
void OnIncompatibleTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
void OnSideTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
void OnDependenciesTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
- Protected Member Functions inherited from SCR_ListMenuEntryComponent
void OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
 
void OnInnerButtonHover ()
 
void OnInnerButtonLeave ()
 
void EnableTextAnimations (bool enable)
 Apply behavior on all potentially longer entry text.
 
void HandleTextAnimation (SCR_HorizontalScrollAnimationComponent anim, bool enable)
 Handle animation enabled-disabling enable = false restarts positions.
 
void UpdateModularButtons ()
 
void OpacityAnimation (int time, float opacityEnd)
 

Protected Attributes

ref SCR_AddonLineBaseWidgets m_Widgets = new SCR_AddonLineBaseWidgets()
 
ref SCR_WorkshopItem m_Item
 
ref SCR_WorkshopDownloadSequence m_DownloadRequest
 
bool m_bUpdatingContinuously
 
ref ScriptInvokerScriptedWidgetComponent m_OnEnableButton
 
ref ScriptInvokerScriptedWidgetComponent m_OnDisableButton
 
ref ScriptInvokerScriptedWidgetComponent m_OnFixButton
 
SCR_ButtonEffectColor m_UpdateButtonIconColor
 
SCR_EAddonLineErrorFlags m_eAddonLineErrorFlags
 
- Protected Attributes inherited from SCR_ListMenuEntryComponent
ref array< ref SCR_HorizontalScrollAnimationComponentm_aScrollAnimations = {}
 
bool m_bInnerButtonInteraction
 
ref array< SCR_ModularButtonComponentm_aMouseButtons = {}
 
SCR_ModularButtonComponent m_MainModularButton
 
bool m_bUnavailable
 
bool m_bFocused
 
SCR_ScriptedWidgetTooltip m_CurrentTooltip
 
ref ScriptInvokerString m_OnMouseInteractionButtonClicked
 
ref ScriptInvokerScriptedWidgetComponent m_OnFocus
 
ref ScriptInvokerScriptedWidgetComponent m_OnFocusLost
 
ref ScriptInvokerScriptedWidgetComponent m_OnMouseEnter
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
 Base method for component lookup through the widget library.
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Detailed Description

Class for addon line button base.

This component just vizualize state and invoke interaction. Items are not manipulated in this component.

Member Function Documentation

◆ CanBeEnabled()

bool SCR_AddonLineBaseComponent.CanBeEnabled ( )

◆ ContinuousUpdate()

void SCR_AddonLineBaseComponent.ContinuousUpdate ( )
protected

◆ GetErrorFlags()

SCR_EAddonLineErrorFlags SCR_AddonLineBaseComponent.GetErrorFlags ( )

◆ GetOnDisableButton()

ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.GetOnDisableButton ( )

◆ GetOnEnableButton()

ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.GetOnEnableButton ( )

◆ GetOnFixButton()

ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.GetOnFixButton ( )

◆ GetWorkshopItem()

SCR_WorkshopItem SCR_AddonLineBaseComponent.GetWorkshopItem ( )

◆ HandleDownloadChanges()

void SCR_AddonLineBaseComponent.HandleDownloadChanges ( )
protected

◆ HandleEnableButtons()

void SCR_AddonLineBaseComponent.HandleEnableButtons ( bool  addonEnabled,
bool  forceHidden = false 
)
protected

◆ HandlerAttached()

override void SCR_AddonLineBaseComponent.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_AddonLineBaseComponent.HandlerDeattached ( Widget  w)

◆ HasItemAnyIssue()

bool SCR_AddonLineBaseComponent.HasItemAnyIssue ( )
protected

◆ Init()

void SCR_AddonLineBaseComponent.Init ( SCR_WorkshopItem  item)

Setup line.

Implemented in SCR_AddonLineDSConfigComponent.

◆ IsEnabled()

bool SCR_AddonLineBaseComponent.IsEnabled ( )

◆ OnActionButton()

void SCR_AddonLineBaseComponent.OnActionButton ( )
protected

◆ OnAnyDownloadCompleted()

void SCR_AddonLineBaseComponent.OnAnyDownloadCompleted ( SCR_WorkshopItemActionDownload  action)
protected

◆ OnAnyDownloadError()

void SCR_AddonLineBaseComponent.OnAnyDownloadError ( SCR_WorkshopItemActionDownload  action,
int  reason 
)
protected

◆ OnAnyNewDownload()

void SCR_AddonLineBaseComponent.OnAnyNewDownload ( SCR_WorkshopItem  item,
SCR_WorkshopItemActionDownload  action 
)
protected

◆ OnDeleteButton()

void SCR_AddonLineBaseComponent.OnDeleteButton ( )
protected

◆ OnDependenciesTooltipShow()

void SCR_AddonLineBaseComponent.OnDependenciesTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip)
protected

◆ OnDisableButton()

void SCR_AddonLineBaseComponent.OnDisableButton ( )

◆ OnEnableButton()

void SCR_AddonLineBaseComponent.OnEnableButton ( )

◆ OnFixButton()

void SCR_AddonLineBaseComponent.OnFixButton ( )
protected

◆ OnFocus()

override bool SCR_AddonLineBaseComponent.OnFocus ( Widget  w,
int  x,
int  y 
)

◆ OnFocusLost()

override bool SCR_AddonLineBaseComponent.OnFocusLost ( Widget  w,
int  x,
int  y 
)

◆ OnIncompatibleTooltipShow()

void SCR_AddonLineBaseComponent.OnIncompatibleTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip)
protected

◆ OnOpenDetailsButton()

void SCR_AddonLineBaseComponent.OnOpenDetailsButton ( )

◆ OnSideTooltipShow()

void SCR_AddonLineBaseComponent.OnSideTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip)
protected

◆ OnTooltipShow()

override void SCR_AddonLineBaseComponent.OnTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip)

◆ OnUpdateButton()

void SCR_AddonLineBaseComponent.OnUpdateButton ( )

◆ OnUpdateTooltipShow()

void SCR_AddonLineBaseComponent.OnUpdateTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip)
protected

◆ OnWorkshopItemChange()

void SCR_AddonLineBaseComponent.OnWorkshopItemChange ( SCR_WorkshopItem  item)
protected

◆ RequiresDownloadingDependencies()

bool SCR_AddonLineBaseComponent.RequiresDownloadingDependencies ( )
protected

◆ StartContinuousUpdate()

void SCR_AddonLineBaseComponent.StartContinuousUpdate ( )
protected

◆ StopContinuousUpdate()

void SCR_AddonLineBaseComponent.StopContinuousUpdate ( )
protected

◆ UpdateAllWidgets()

void SCR_AddonLineBaseComponent.UpdateAllWidgets ( )
protected

Update vizual state of line.

Implemented in SCR_WorkshopAddonLineComponent, and SCR_AddonLineDSConfigComponent.

◆ UpdateCompatibilityWidgets()

void SCR_AddonLineBaseComponent.UpdateCompatibilityWidgets ( )
protected

Display incopatible icon Set icon to incompatible and update base on current state.

◆ UpdateDownloadProgressWidgets()

void SCR_AddonLineBaseComponent.UpdateDownloadProgressWidgets ( )
protected

◆ UpdateIssueState()

void SCR_AddonLineBaseComponent.UpdateIssueState ( )
protected

◆ UpdateModularButtons()

override void SCR_AddonLineBaseComponent.UpdateModularButtons ( )

Member Data Documentation

◆ m_bUpdatingContinuously

bool SCR_AddonLineBaseComponent.m_bUpdatingContinuously
protected

◆ m_DownloadRequest

ref SCR_WorkshopDownloadSequence SCR_AddonLineBaseComponent.m_DownloadRequest
protected

◆ m_eAddonLineErrorFlags

SCR_EAddonLineErrorFlags SCR_AddonLineBaseComponent.m_eAddonLineErrorFlags
protected

◆ m_Item

ref SCR_WorkshopItem SCR_AddonLineBaseComponent.m_Item
protected

◆ m_OnDisableButton

ref ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.m_OnDisableButton
protected

◆ m_OnEnableButton

ref ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.m_OnEnableButton
protected

◆ m_OnFixButton

ref ScriptInvokerScriptedWidgetComponent SCR_AddonLineBaseComponent.m_OnFixButton
protected

◆ m_UpdateButtonIconColor

SCR_ButtonEffectColor SCR_AddonLineBaseComponent.m_UpdateButtonIconColor
protected

◆ m_Widgets

ref SCR_AddonLineBaseWidgets SCR_AddonLineBaseComponent.m_Widgets = new SCR_AddonLineBaseWidgets()
protected

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