Inheritance diagram for SCR_WorkshopItemActionDownload:

Protected Member Functions
ScriptInvokerBase< ScriptInvoker_ActionDownloadProgress >	GetOnDownloadProgress ()
ScriptInvokerBase< ScriptInvoker_ActionDownloadFullStorage >	GetOnFullStorageError ()
void	SCR_WorkshopItemActionDownload (SCR_WorkshopItem wrapper, bool latestVersion, Revision revision=null)
Revision	GetTargetRevision ()
Revision	GetStartRevision ()
	Returns the version which was at the moment when the download was started.
bool	GetTargetedAtLatestVersion ()
bool	GetUpdate ()
	Returns true when this is an update, false when regular download.
float	GetProgress ()
	Returns current download progress if active or paused, 1 if complete, otherwise 0.
float	GetProcessingProgress ()
float	GetSizeBytes ()
	Returns download size. Might return 0 until the actiion is activated.
override bool	OnActivate ()
override bool	OnReactivate ()
override bool	OnCancel ()
bool	GetRunningAsync ()
bool	IsRunningAsyncSolved ()
bool	IsPauseAsyncSolved ()
override bool	OnPause ()
void	OnPauseResponse (BackendCallback callback)
void	OnPauseError (BackendCallback callback)
override bool	OnResume ()
override void	OnComplete ()
bool	StartDownloadOrLoadDetails ()
override void	Internal_Update (float timeSlice)
void	Callback_OnError (BackendCallback callback)
void	FullStorageFail ()
SCR_WorkshopItemActionDownload	RetryDownload ()
	Try redownload failed addon.
void	ForceFail ()
float	GetDownloadSize ()
bool	IsProcessing ()

Protected Attributes
ref Revision	m_StartVersion
ref Revision	m_TargetRevision
bool	m_bTargetVersionLatest
ref BackendCallback	m_Callback
float	m_fSizeBytes
bool	m_bWaitingForRevisions
bool	m_bDownloadStarted
float	m_fProgress
float	m_fProcessingProgress
float	m_fDownloadedSize
bool	m_bAddonEnabledAtStart
ref BackendCallback	m_PauseDownloadCallback = new BackendCallback()
bool	m_bRunningImmediate
bool	m_bRunningAsync
ref ScriptInvokerBase< ScriptInvoker_ActionDownloadProgress >	m_OnDownloadProgress
ref ScriptInvokerBase< ScriptInvoker_ActionDownloadFullStorage >	m_OnFullStorageError

Detailed Description

Definition at line 9 of file SCR_WorkshopItemActionDownload.c.

Constructor & Destructor Documentation

◆ SCR_WorkshopItemActionDownload()

void SCR_WorkshopItemActionDownload::SCR_WorkshopItemActionDownload	(	SCR_WorkshopItem	wrapper,
		bool	latestVersion,
		Revision	revision = null )

inlineprotected

Definition at line 60 of file SCR_WorkshopItemActionDownload.c.

Member Function Documentation

◆ Callback_OnError()

void SCR_WorkshopItemActionDownload::Callback_OnError ( BackendCallback callback )

inlineprotected

Definition at line 359 of file SCR_WorkshopItemActionDownload.c.

◆ ForceFail()

void SCR_WorkshopItemActionDownload::ForceFail ( )

inlineprotected

Definition at line 405 of file SCR_WorkshopItemActionDownload.c.

◆ FullStorageFail()

void SCR_WorkshopItemActionDownload::FullStorageFail ( )

inlineprotected

Definition at line 384 of file SCR_WorkshopItemActionDownload.c.

◆ GetDownloadSize()

float SCR_WorkshopItemActionDownload::GetDownloadSize ( )

inlineprotected

Definition at line 411 of file SCR_WorkshopItemActionDownload.c.

◆ GetOnDownloadProgress()

ScriptInvokerBase< ScriptInvoker_ActionDownloadProgress > SCR_WorkshopItemActionDownload::GetOnDownloadProgress ( )

inlineprotected

Definition at line 42 of file SCR_WorkshopItemActionDownload.c.

◆ GetOnFullStorageError()

ScriptInvokerBase< ScriptInvoker_ActionDownloadFullStorage > SCR_WorkshopItemActionDownload::GetOnFullStorageError ( )

inlineprotected

Definition at line 51 of file SCR_WorkshopItemActionDownload.c.

◆ GetProcessingProgress()

float SCR_WorkshopItemActionDownload::GetProcessingProgress ( )

inlineprotected

Definition at line 114 of file SCR_WorkshopItemActionDownload.c.

◆ GetProgress()

float SCR_WorkshopItemActionDownload::GetProgress ( )

inlineprotected

Returns current download progress if active or paused, 1 if complete, otherwise 0.

Definition at line 106 of file SCR_WorkshopItemActionDownload.c.

◆ GetRunningAsync()

bool SCR_WorkshopItemActionDownload::GetRunningAsync ( )

inlineprotected

Definition at line 157 of file SCR_WorkshopItemActionDownload.c.

◆ GetSizeBytes()

float SCR_WorkshopItemActionDownload::GetSizeBytes ( )

inlineprotected

Returns download size. Might return 0 until the actiion is activated.

Definition at line 121 of file SCR_WorkshopItemActionDownload.c.

◆ GetStartRevision()

Revision SCR_WorkshopItemActionDownload::GetStartRevision ( )

inlineprotected

Returns the version which was at the moment when the download was started.

Definition at line 86 of file SCR_WorkshopItemActionDownload.c.

◆ GetTargetedAtLatestVersion()

bool SCR_WorkshopItemActionDownload::GetTargetedAtLatestVersion ( )

inlineprotected

Definition at line 92 of file SCR_WorkshopItemActionDownload.c.

◆ GetTargetRevision()

Revision SCR_WorkshopItemActionDownload::GetTargetRevision ( )

inlineprotected

Returns the target version. !! If you were targeting latest version, but the actual download has not started because it is waiting for more data from backend, then this will return an empty string until the data is fetched from backend.

Definition at line 78 of file SCR_WorkshopItemActionDownload.c.