Inheritance diagram for SCR_DownloadManagerEntry:

[legend]

Public Member Functions
ScriptInvokerBase< ScriptInvoker_DownloadManagerEntry >	GetOnUpdate ()

override void	HandlerAttached (Widget w)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)

void	InitForDownloadAction (SCR_WorkshopItem item, SCR_WorkshopItemActionDownload action)
	Initializes the line in interactive mode.

void	CanDoActions (out bool canPause, out bool canResume, out bool canCancel, out bool canRetry)
	Store which actions can be used for entry in current state.

void	OnClickPause ()

void	OnClickResume ()

void	OnClickCancel ()

void	OnClickRetry ()

SCR_WorkshopItem	GetItem ()

SCR_WorkshopItemActionDownload	GetDownloadAction ()

EDownloadManagerActionState	GetState ()

bool	GetPauseEnabled ()

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 ()

Static Public Member Functions
static EDownloadManagerActionState	DownloadActionState (SCR_WorkshopItemActionDownload action)
	Based on current download action state setup state simplified for download manager UI grouping Function is static to compare download action state before entry is created.

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.

Static Public Attributes
const int	PAUSE_ENABLE_DELAY_MS = 1000

Protected Member Functions
void	SetupWidgets ()

void	FallbackVisuals ()

void	UpdateProgressWidgets (bool force=false)
	Update all text displaying progress.

void	UpdateMessage (bool processing)

void	UpdateButtons ()

void	StateMessage (out string message, out string imageName, out Color color)
	Setup state message variables.

void	FailReason (out string message, out string icon)
	Return message with details why entry wasn't downloaded.

void	AnimateIcon (WidgetAnimationBase animation)
	Return message with details why entry wasn't downloaded.

void	DisablePauserResume (SCR_ModularButtonComponent button)

void	EnablePauserResume (SCR_ModularButtonComponent button)

void	OnActionChanged (SCR_WorkshopItemAction action)

Protected Attributes
ResourceName	m_sIconImageset

float	m_fIconAnimationSpeed

EAnimationCurve	m_eIconAnimationCurve

bool	m_bHideProgressBarOnComplete

ref SCR_DownloadManagerEntryWidgets	m_Widgets = new SCR_DownloadManagerEntryWidgets()

ref SCR_BackendImageComponent	m_BackendImage

ref SCR_WorkshopItemActionDownload	m_Action

ref SCR_WorkshopItem	m_Item

bool	m_bPauseEnabled = true

bool	m_bShowButtons

bool	m_bDelayedProcessingDisplay

EDownloadManagerActionState	m_iState = EDownloadManagerActionState.INACTIVE

WidgetAnimationImageRotation	m_SpinnerAnimation

ref ScriptInvokerBase< ScriptInvoker_DownloadManagerEntry >	m_OnUpdate

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const int	PROCESSING_MESSAGE_UPDATE_DELAY = 2000

const string	PERCENTAGE = "#AR-SupportStation_ActionFormat_Percentage"

Additional Inherited Members
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

◆ AnimateIcon()

void SCR_DownloadManagerEntry.AnimateIcon ( WidgetAnimationBase animation )

protected

Return message with details why entry wasn't downloaded.

◆ CanDoActions()

void SCR_DownloadManagerEntry.CanDoActions	(	out bool	canPause,
		out bool	canResume,
		out bool	canCancel,
		out bool	canRetry
	)

Store which actions can be used for entry in current state.

◆ DisablePauserResume()

void SCR_DownloadManagerEntry.DisablePauserResume ( SCR_ModularButtonComponent button )

protected

◆ DownloadActionState()

static EDownloadManagerActionState SCR_DownloadManagerEntry.DownloadActionState ( SCR_WorkshopItemActionDownload action )

static

Based on current download action state setup state simplified for download manager UI grouping Function is static to compare download action state before entry is created.

◆ EnablePauserResume()

void SCR_DownloadManagerEntry.EnablePauserResume ( SCR_ModularButtonComponent button )

protected

◆ FailReason()

void SCR_DownloadManagerEntry.FailReason	(	out string	message,
		out string	icon
	)

protected

Return message with details why entry wasn't downloaded.

◆ FallbackVisuals()

void SCR_DownloadManagerEntry.FallbackVisuals ( )

protected

◆ GetDownloadAction()

SCR_WorkshopItemActionDownload SCR_DownloadManagerEntry.GetDownloadAction ( )

◆ GetItem()

SCR_WorkshopItem SCR_DownloadManagerEntry.GetItem ( )

◆ GetOnUpdate()

ScriptInvokerBase< ScriptInvoker_DownloadManagerEntry > SCR_DownloadManagerEntry.GetOnUpdate ( )

◆ GetPauseEnabled()

bool SCR_DownloadManagerEntry.GetPauseEnabled ( )

◆ GetState()

EDownloadManagerActionState SCR_DownloadManagerEntry.GetState ( )

◆ HandlerAttached()

override void SCR_DownloadManagerEntry.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ InitForDownloadAction()

void SCR_DownloadManagerEntry.InitForDownloadAction	(	SCR_WorkshopItem	item,
		SCR_WorkshopItemActionDownload	action
	)

Initializes the line in interactive mode.

It will be able to interact with the download action.

◆ OnActionChanged()

void SCR_DownloadManagerEntry.OnActionChanged ( SCR_WorkshopItemAction action )

protected

◆ OnClickCancel()

void SCR_DownloadManagerEntry.OnClickCancel ( )

◆ OnClickPause()

void SCR_DownloadManagerEntry.OnClickPause ( )

◆ OnClickResume()

void SCR_DownloadManagerEntry.OnClickResume ( )

◆ OnClickRetry()

void SCR_DownloadManagerEntry.OnClickRetry ( )

◆ OnMouseEnter()

override bool SCR_DownloadManagerEntry.OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

◆ OnMouseLeave()

override bool SCR_DownloadManagerEntry.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y
	)

◆ SetupWidgets()

void SCR_DownloadManagerEntry.SetupWidgets ( )

protected

◆ StateMessage()

void SCR_DownloadManagerEntry.StateMessage	(	out string	message,
		out string	imageName,
		out Color	color
	)

protected

Setup state message variables.

◆ UpdateButtons()

void SCR_DownloadManagerEntry.UpdateButtons ( )

protected

◆ UpdateMessage()

void SCR_DownloadManagerEntry.UpdateMessage ( bool processing )

protected

◆ UpdateProgressWidgets()

void SCR_DownloadManagerEntry.UpdateProgressWidgets ( bool force = false )

protected

Update all text displaying progress.

Member Data Documentation

◆ m_Action

ref SCR_WorkshopItemActionDownload SCR_DownloadManagerEntry.m_Action

protected

◆ m_BackendImage

ref SCR_BackendImageComponent SCR_DownloadManagerEntry.m_BackendImage

protected

◆ m_bDelayedProcessingDisplay

bool SCR_DownloadManagerEntry.m_bDelayedProcessingDisplay

protected

◆ m_bHideProgressBarOnComplete

bool SCR_DownloadManagerEntry.m_bHideProgressBarOnComplete

protected

◆ m_bPauseEnabled

bool SCR_DownloadManagerEntry.m_bPauseEnabled = true

protected

◆ m_bShowButtons

bool SCR_DownloadManagerEntry.m_bShowButtons

protected

◆ m_eIconAnimationCurve

EAnimationCurve SCR_DownloadManagerEntry.m_eIconAnimationCurve

protected

◆ m_fIconAnimationSpeed

float SCR_DownloadManagerEntry.m_fIconAnimationSpeed

protected

◆ m_iState

EDownloadManagerActionState SCR_DownloadManagerEntry.m_iState = EDownloadManagerActionState.INACTIVE

protected

◆ m_Item

ref SCR_WorkshopItem SCR_DownloadManagerEntry.m_Item

protected

◆ m_OnUpdate

ref ScriptInvokerBase<ScriptInvoker_DownloadManagerEntry> SCR_DownloadManagerEntry.m_OnUpdate

protected

◆ m_sIconImageset

ResourceName SCR_DownloadManagerEntry.m_sIconImageset

protected

◆ m_SpinnerAnimation

WidgetAnimationImageRotation SCR_DownloadManagerEntry.m_SpinnerAnimation

protected

◆ m_Widgets

ref SCR_DownloadManagerEntryWidgets SCR_DownloadManagerEntry.m_Widgets = new SCR_DownloadManagerEntryWidgets()

protected

◆ PAUSE_ENABLE_DELAY_MS

const int SCR_DownloadManagerEntry.PAUSE_ENABLE_DELAY_MS = 1000

static

◆ PERCENTAGE

const string SCR_DownloadManagerEntry.PERCENTAGE = "#AR-SupportStation_ActionFormat_Percentage"

staticprotected

◆ PROCESSING_MESSAGE_UPDATE_DELAY

const int SCR_DownloadManagerEntry.PROCESSING_MESSAGE_UPDATE_DELAY = 2000

staticprotected

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

Game/UI/Menu/DownloadManager/SCR_DownloadManagerEntry.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AnimateIcon()

◆ CanDoActions()

◆ DisablePauserResume()

◆ DownloadActionState()

◆ EnablePauserResume()

◆ FailReason()

◆ FallbackVisuals()

◆ GetDownloadAction()

◆ GetItem()

◆ GetOnUpdate()

◆ GetPauseEnabled()

◆ GetState()

◆ HandlerAttached()

◆ InitForDownloadAction()

◆ OnActionChanged()

◆ OnClickCancel()

◆ OnClickPause()

◆ OnClickResume()

◆ OnClickRetry()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ SetupWidgets()

◆ StateMessage()

◆ UpdateButtons()

◆ UpdateMessage()

◆ UpdateProgressWidgets()

Member Data Documentation

◆ m_Action

◆ m_BackendImage

◆ m_bDelayedProcessingDisplay

◆ m_bHideProgressBarOnComplete

◆ m_bPauseEnabled

◆ m_bShowButtons

◆ m_eIconAnimationCurve

◆ m_fIconAnimationSpeed

◆ m_iState

◆ m_Item

◆ m_OnUpdate

◆ m_sIconImageset

◆ m_SpinnerAnimation

◆ m_Widgets

◆ PAUSE_ENABLE_DELAY_MS

◆ PERCENTAGE

◆ PROCESSING_MESSAGE_UPDATE_DELAY