SCR_WorkshopDownloadSequence Class Reference

Inheritance diagram for SCR_WorkshopDownloadSequence:

Protected Member Functions
void	CreateLoadingOverlay ()
void	AllPatchSizeLoaded ()
	After all dependencies patch loaded start loading patch size for main item.
void	HandleError ()
	Unified behavior for error and timeout.
void	SetupAddonFail (SCR_WorkshopItemActionDownload action)
	Open download manager and set action to fail.
void	ShowRestrictedItemDialog ()
	Show main addon restricted dialog.
void	ShowConfirmationUI ()
	Show download confirm dialog base on main item size and dependencies.
void	OnItemError (SCR_WorkshopItem item)
void	OnAllDependenciesDetailsLoaded ()
	Called when finally all the details of all dependencies are loaded.
void	OnRestrictedDependenciesFound (SCR_DownloadSequence sequence, array< ref SCR_WorkshopItem > dependencies)
void	OnItemDependenciesLoaded (notnull SCR_WorkshopItem item)
	Called from SCR_WorkshopItem.m_OnDependenciesLoaded.
void	OnItemGetAsset (SCR_WorkshopItem item)
	Call when main item (addon) is loaded.
void	OnItemPatchLoaded ()
void	OnItemPatchError ()
void	SCR_WorkshopDownloadSequence (array< ref SCR_WorkshopItem > dependencies, SCR_WorkshopItem item, Revision itemTargetRevision)
void	~SCR_WorkshopDownloadSequence ()

Static Protected Member Functions
static SCR_WorkshopDownloadSequence	Create (SCR_WorkshopItem item, Revision itemTargetRevision, SCR_WorkshopDownloadSequence previous)
	Tries to create a new request if previous doesn't exist or finished. Otherwise returns the previous request.

Protected Attributes
ref SCR_WorkshopItem	m_Item
ref Revision	m_ItemTargetRevision
SCR_LoadingOverlayDialog	m_LoadingOverlay

Static Protected Attributes
static float	LOADING_DELAY = 500

Detailed Description

Extended download sequence for workshop downloading Instead of just dependencies main m_Item is used for downloading single item

• Item dependencies are then stored in dependencies list

Is displaying workshop donwload related UI and automatically starts download

Definition at line 12 of file SCR_WorkshopDownloadSequence.c.

Constructor & Destructor Documentation

SCR_WorkshopDownloadSequence()

void SCR_WorkshopDownloadSequence::SCR_WorkshopDownloadSequence ( array< ref SCR_WorkshopItem > dependencies, SCR_WorkshopItem item, Revision itemTargetRevision )

inlineprotected

Definition at line 265 of file SCR_WorkshopDownloadSequence.c.

~SCR_WorkshopDownloadSequence()

void SCR_WorkshopDownloadSequence::~SCR_WorkshopDownloadSequence ( )

inlineprotected

Definition at line 287 of file SCR_WorkshopDownloadSequence.c.

Member Function Documentation

AllPatchSizeLoaded()

void SCR_WorkshopDownloadSequence::AllPatchSizeLoaded ( )

inlineprotected

After all dependencies patch loaded start loading patch size for main item.

Definition at line 55 of file SCR_WorkshopDownloadSequence.c.

Create()

SCR_WorkshopDownloadSequence SCR_WorkshopDownloadSequence::Create ( SCR_WorkshopItem item, Revision itemTargetRevision, SCR_WorkshopDownloadSequence previous )

inlinestaticprotected

Tries to create a new request if previous doesn't exist or finished. Otherwise returns the previous request.

Definition at line 27 of file SCR_WorkshopDownloadSequence.c.

CreateLoadingOverlay()

void SCR_WorkshopDownloadSequence::CreateLoadingOverlay ( )

inlineprotected

Definition at line 38 of file SCR_WorkshopDownloadSequence.c.

HandleError()

void SCR_WorkshopDownloadSequence::HandleError ( )

inlineprotected

Unified behavior for error and timeout.

Definition at line 68 of file SCR_WorkshopDownloadSequence.c.

OnAllDependenciesDetailsLoaded()

void SCR_WorkshopDownloadSequence::OnAllDependenciesDetailsLoaded ( )

inlineprotected

Called when finally all the details of all dependencies are loaded.

Definition at line 170 of file SCR_WorkshopDownloadSequence.c.

OnItemDependenciesLoaded()

void SCR_WorkshopDownloadSequence::OnItemDependenciesLoaded ( notnull SCR_WorkshopItem item )

inlineprotected

Called from SCR_WorkshopItem.m_OnDependenciesLoaded.

Definition at line 190 of file SCR_WorkshopDownloadSequence.c.

OnItemError()

void SCR_WorkshopDownloadSequence::OnItemError ( SCR_WorkshopItem item )

inlineprotected

Definition at line 161 of file SCR_WorkshopDownloadSequence.c.

OnItemGetAsset()

void SCR_WorkshopDownloadSequence::OnItemGetAsset ( SCR_WorkshopItem item )

inlineprotected

Call when main item (addon) is loaded.

Definition at line 218 of file SCR_WorkshopDownloadSequence.c.

OnItemPatchError()

void SCR_WorkshopDownloadSequence::OnItemPatchError ( )

inlineprotected

Call when main item patch size fails to load Server as AllPatchSizeLoaded in base class

Definition at line 255 of file SCR_WorkshopDownloadSequence.c.

OnItemPatchLoaded()

void SCR_WorkshopDownloadSequence::OnItemPatchLoaded ( )

inlineprotected

Call when main item patch size is loaded Server as AllPatchSizeLoaded in base class

Definition at line 233 of file SCR_WorkshopDownloadSequence.c.

OnRestrictedDependenciesFound()

void SCR_WorkshopDownloadSequence::OnRestrictedDependenciesFound ( SCR_DownloadSequence sequence, array< ref SCR_WorkshopItem > dependencies )

inlineprotected

Definition at line 182 of file SCR_WorkshopDownloadSequence.c.

SetupAddonFail()

void SCR_WorkshopDownloadSequence::SetupAddonFail ( SCR_WorkshopItemActionDownload action )

inlineprotected

Open download manager and set action to fail.

Definition at line 95 of file SCR_WorkshopDownloadSequence.c.

ShowConfirmationUI()

void SCR_WorkshopDownloadSequence::ShowConfirmationUI ( )

inlineprotected

Show download confirm dialog base on main item size and dependencies.

Definition at line 116 of file SCR_WorkshopDownloadSequence.c.

ShowRestrictedItemDialog()

void SCR_WorkshopDownloadSequence::ShowRestrictedItemDialog ( )

inlineprotected

Show main addon restricted dialog.

Definition at line 103 of file SCR_WorkshopDownloadSequence.c.

Member Data Documentation

LOADING_DELAY

float SCR_WorkshopDownloadSequence::LOADING_DELAY = 500

staticprotected

Definition at line 14 of file SCR_WorkshopDownloadSequence.c.

m_Item

ref SCR_WorkshopItem SCR_WorkshopDownloadSequence::m_Item

protected

Definition at line 16 of file SCR_WorkshopDownloadSequence.c.

m_ItemTargetRevision

ref Revision SCR_WorkshopDownloadSequence::m_ItemTargetRevision

protected

Definition at line 17 of file SCR_WorkshopDownloadSequence.c.

m_LoadingOverlay

SCR_LoadingOverlayDialog SCR_WorkshopDownloadSequence::m_LoadingOverlay

protected

Definition at line 19 of file SCR_WorkshopDownloadSequence.c.

---

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

• scripts/Game/UI/Menu/ContentBrowser/Common/SCR_WorkshopDownloadSequence.c