Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SCR_ModEntryComponent Interface Reference
Inheritance diagram for SCR_ModEntryComponent:
[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)
 
void UpdateAllWidgets ()
 
void UpdateDownloadButtonState ()
 
void OnDownloadClick (SCR_ButtonBaseComponent button)
 Do this actions on using button on

 
void SetModContent (SCR_WorkshopItem item, string version)
 
void SetModRating (string str)
 
void SetModDataSize (string str)
 
void DownloadContent ()
 
void MarkAsUpdated ()
 
SCR_WorkshopItem GetWorkshopItem ()
 
bool IsUpdated (WorkshopItem item=null)
 
bool IsDownloading (WorkshopItem item=null)
 
Dependency GetDependency ()
 
- Public Member Functions inherited from SCR_ContentEntryComponent
override void HandlerAttached (Widget w)
 
void SetLabelText (string str)
 
void SetDescriptionText (string str)
 
void SetThumbnail (ResourceName image)
 
- Public Member Functions inherited from SCR_ButtonBaseComponent
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnFocusLost (Widget w, int x, int y)
 
void SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
 
bool IsToggled ()
 
void SetToggleable (bool togglable)
 
bool GetToggleable ()
 
void ShowBorder (bool show, bool animate=true)
 
bool IsBorderShown ()
 
void SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
 Alternate way of setting button background colors through script.
 
void ColorizeBackground (bool animate=true)
 
- Public Member Functions inherited from SCR_WLibComponentBase
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnFocus (Widget w, int x, int y)
 
void SetHoverSound (string soundHover)
 
void SetClickedSound (string soundClicked)
 
string GetHoverSound ()
 
string GetClickedSound ()
 
void SetEnabled (bool enabled, bool animate=true)
 
void SetVisible (bool visible, bool animate=true)
 
bool IsEnabled ()
 
void SetMouseOverToFocus (bool mouseOverToFocus)
 
void SetDisabledOpacity (float newDisabledOpacity)
 
- 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 ()
 

Public Attributes

ref ScriptInvoker m_OnModDonwloaded = new ScriptInvoker()
 
ref Revision m_Version
 
- Public Attributes inherited from SCR_ButtonBaseComponent
bool m_bCanBeToggled
 
bool m_bUseColorization
 
ref Color m_BackgroundDefault
 
ref Color m_BackgroundHovered
 
ref Color m_BackgroundSelected
 
ref Color m_BackgroundSelectedHovered
 
ref Color m_BackgroundClicked
 
bool m_bShowBorderOnFocus
 
bool m_bShowBackgroundOnFocus
 
bool m_bNoBorderAnimation
 
bool m_bNoBackgroundAnimation
 
bool m_bShowBorderOnHover
 
Widget m_wBackground
 
Widget m_wBorder
 
ref ScriptInvoker m_OnClicked = new ScriptInvoker()
 
ref ScriptInvoker m_OnToggled = new ScriptInvoker()
 
ref ScriptInvoker< Widget > m_OnFocus = new ScriptInvoker<Widget>()
 
ref ScriptInvoker< Widget > m_OnFocusLost = new ScriptInvoker<Widget>()
 
ref ScriptInvoker m_OnShowBorder = new ScriptInvoker()
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Static Public Attributes

const string WIDGET_MOD_RATING = "hRating"
 
const string WIDGET_MOD_SIZE = "hDataSize"
 
const int STATE_DOWNLOAD = 0
 
const int STATE_DOWNLOADING = 1
 
const int STATE_CANCEL = 2
 
const int STATE_DOWNLOADED = 3
 
- Static Public Attributes inherited from SCR_ContentEntryComponent
const string WIDGET_IMAGE_THUMBNAIL = "ImgThumbnail"
 
const string WIDGET_TEXT_LABEL = "TxtLabel"
 
const string WIDGET_TEXT_DESCRIPTION = "TxtDescription"
 
const string WIDGET_BTN_DOWNLOAD = "BtnDownload"
 
- Static Public Attributes inherited from SCR_WLibComponentBase
static const float START_ANIMATION_RATE = 10001
 
static const float START_ANIMATION_PERIOD = 250
 

Protected Member Functions

void OnDownloadButtonHover ()
 
void OnDownloadButtonHoverLeave ()
 
void OnItemDownload ()
 Call this on download addon dat.
 
void Callback_OnChanged ()
 
- Protected Member Functions inherited from SCR_ContentEntryComponent
void SetTextSafe (TextWidget txt, string str)
 Just simple on line text setting.
 
- Protected Member Functions inherited from SCR_ButtonBaseComponent
void OnMenuSelect ()
 
void MenuSelectBase ()
 
void FindParentMenu ()
 Finds the parent menu of this component.
 
bool IsParentMenuFocused ()
 Returns true if parent menu is focused, or if there is no parent menu.
 
- Protected Member Functions inherited from SCR_WLibComponentBase
void OnEnabled (bool animate)
 
void OnDisabled (bool animate)
 
bool IsChildWidget (Widget parent, Widget child)
 
void SetAnimationRate ()
 
void PlaySound (string sound)
 

Protected Attributes

TextWidget m_wTxtRating
 
TextWidget m_wTxtDataSize
 
ref SCR_WorkshopItem m_Item
 
SCR_MultipleStatesButtonComponent m_BtnDownload
 
bool m_bHover = false
 
bool m_bFocus = false
 
- Protected Attributes inherited from SCR_ContentEntryComponent
ImageWidget m_wImgThumbnail
 
TextWidget m_wTxtLabel
 
TextWidget m_wTxtDescription
 
- Protected Attributes inherited from SCR_ButtonBaseComponent
bool m_bIsToggled
 
MenuBase m_ParentMenu
 
SCR_SubMenuBase m_ParentSubMenu
 
- Protected Attributes inherited from SCR_WLibComponentBase
string m_sSoundHovered
 
string m_sSoundClicked
 
float m_fAnimationTime
 
bool m_bMouseOverToFocus
 
float m_fDisabledOpacity
 
float m_fAnimationRate
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent GetButtonBase (string name, Widget parent, bool searchAllChildren=true)
 
- Static Public Member Functions inherited from SCR_WLibComponentBase
static bool SetTexture (ImageWidget widget, ResourceName texture, string image="")
 
- 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.
 

Member Function Documentation

◆ Callback_OnChanged()

void SCR_ModEntryComponent.Callback_OnChanged ( )
protected

◆ DownloadContent()

void SCR_ModEntryComponent.DownloadContent ( )

◆ GetDependency()

Dependency SCR_ModEntryComponent.GetDependency ( )

◆ GetWorkshopItem()

SCR_WorkshopItem SCR_ModEntryComponent.GetWorkshopItem ( )

◆ HandlerAttached()

override void SCR_ModEntryComponent.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_ModEntryComponent.HandlerDeattached ( Widget  w)

◆ IsDownloading()

bool SCR_ModEntryComponent.IsDownloading ( WorkshopItem  item = null)

◆ IsUpdated()

bool SCR_ModEntryComponent.IsUpdated ( WorkshopItem  item = null)

◆ MarkAsUpdated()

void SCR_ModEntryComponent.MarkAsUpdated ( )

◆ OnDownloadButtonHover()

void SCR_ModEntryComponent.OnDownloadButtonHover ( )
protected

◆ OnDownloadButtonHoverLeave()

void SCR_ModEntryComponent.OnDownloadButtonHoverLeave ( )
protected

◆ OnDownloadClick()

void SCR_ModEntryComponent.OnDownloadClick ( SCR_ButtonBaseComponent  button)

Do this actions on using button on

◆ OnFocus()

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

◆ OnFocusLost()

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

◆ OnItemDownload()

void SCR_ModEntryComponent.OnItemDownload ( )
protected

Call this on download addon dat.

◆ SetModContent()

void SCR_ModEntryComponent.SetModContent ( SCR_WorkshopItem  item,
string  version 
)

◆ SetModDataSize()

void SCR_ModEntryComponent.SetModDataSize ( string  str)

◆ SetModRating()

void SCR_ModEntryComponent.SetModRating ( string  str)

◆ UpdateAllWidgets()

void SCR_ModEntryComponent.UpdateAllWidgets ( )

◆ UpdateDownloadButtonState()

void SCR_ModEntryComponent.UpdateDownloadButtonState ( )

Member Data Documentation

◆ m_bFocus

bool SCR_ModEntryComponent.m_bFocus = false
protected

◆ m_bHover

bool SCR_ModEntryComponent.m_bHover = false
protected

◆ m_BtnDownload

SCR_MultipleStatesButtonComponent SCR_ModEntryComponent.m_BtnDownload
protected

◆ m_Item

ref SCR_WorkshopItem SCR_ModEntryComponent.m_Item
protected

◆ m_OnModDonwloaded

ref ScriptInvoker SCR_ModEntryComponent.m_OnModDonwloaded = new ScriptInvoker()

◆ m_Version

ref Revision SCR_ModEntryComponent.m_Version

◆ m_wTxtDataSize

TextWidget SCR_ModEntryComponent.m_wTxtDataSize
protected

◆ m_wTxtRating

TextWidget SCR_ModEntryComponent.m_wTxtRating
protected

◆ STATE_CANCEL

const int SCR_ModEntryComponent.STATE_CANCEL = 2
static

◆ STATE_DOWNLOAD

const int SCR_ModEntryComponent.STATE_DOWNLOAD = 0
static

◆ STATE_DOWNLOADED

const int SCR_ModEntryComponent.STATE_DOWNLOADED = 3
static

◆ STATE_DOWNLOADING

const int SCR_ModEntryComponent.STATE_DOWNLOADING = 1
static

◆ WIDGET_MOD_RATING

const string SCR_ModEntryComponent.WIDGET_MOD_RATING = "hRating"
static

◆ WIDGET_MOD_SIZE

const string SCR_ModEntryComponent.WIDGET_MOD_SIZE = "hDataSize"
static

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