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

Inheritance diagram for SCR_WorkshopDownloadSequence:

[legend]

Public Member Functions
void	SCR_WorkshopDownloadSequence (array< ref SCR_WorkshopItem > dependencies, SCR_WorkshopItem item, Revision itemTargetRevision)

void	~SCR_WorkshopDownloadSequence ()

Public Member Functions inherited from SCR_DownloadSequence
ScriptInvokerBase< ScriptInvoker_DownloadSequenceDependencies >	GetOnRestrictedDependency ()

ScriptInvokerBase< ScriptInvoker_DownloadSequenceDependencies >	GetOnDependenciesLoadingPrevented ()

ScriptInvokerBase< ScriptInvoker_DownloadSequence >	GetOnError ()

ScriptInvokerBase< ScriptInvoker_DownloadSequence >	GetOnReady ()

ScriptInvokerBase< ScriptInvoker_DownloadSequence >	GetOnCancel ()

void	Init ()

SCR_ReportedAddonsDialog	ShowRestrictedDependenciesDialog ()
	Show dialog with list of resctricted In dialog is possible to cancel reports

void	Cancel ()
	Cancels this download request.

void	OnAllReportsCanceled (SCR_ReportedAddonsDialog dialog)
	Call when all reports from dialog are cancled to clear invoker actions and display download dialog.

bool	GetRestrictedAddons ()

bool	GetBlockedAddons ()

void	~SCR_DownloadSequence ()

Static Public 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.

Static Public Member Functions inherited from SCR_DownloadSequence
static SCR_DownloadSequence	Create (array< ref SCR_WorkshopItem > dependencies, SCR_DownloadSequence previous, bool skipDetails=false)

Protected Member Functions
void	CreateLoadingOverlay ()

override 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.

override void	OnItemError (SCR_WorkshopItem item)

override 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 (SCR_BackendCallback callback=null)
	Call when main item patch size is loaded Server as AllPatchSizeLoaded in base class.

Protected Member Functions inherited from SCR_DownloadSequence
void	Setup (notnull array< ref SCR_WorkshopItem > dependencies, bool skipDetails)
	Setup new created download sequence.

bool	HasAllDetails ()
	Returns true if all details were loaded successfully.

void	LoadDependenciesDetails ()

void	OnAllDependenciesDetailsLoaded ()
	Called when finally all the details of all dependencies are loaded.

array< ref SCR_WorkshopItem >	MissingWorkshopItems ()

void	AllPatchSizeLoaded ()

void	OnDependencyDetailsLoaded (notnull SCR_WorkshopItem item)
	Call when dependency details are successfully loaded.

void	OnDependencyPatchSizeLoadResponse (SCR_BackendCallbackWorkshopItem callback)
	Call on any response to dependency patch size.

void	SetDependencySize (SCR_WorkshopItem item, float size)

void	CheckAllPatchSizeLoaded ()

void	OnItemError (SCR_WorkshopItem item)

void	OnItemTimeout (SCR_WorkshopItem item)

Protected Attributes
ref SCR_WorkshopItem	m_Item

ref Revision	m_ItemTargetRevision

SCR_LoadingOverlayDialog	m_LoadingOverlay

Protected Attributes inherited from SCR_DownloadSequence
bool	m_bSubscribeToAddons

ref array< ref SCR_WorkshopItem >	m_aDependencies = {}

bool	m_bWaitingResponse

bool	m_bCanceled

bool	m_bFailed

bool	m_bRestrictedAddons

bool	m_bBlockedAddons

bool	m_bPatchSizeLoaded

bool	m_bSkipDetails

int	m_iDependencyDetailsLoadedCount = 0

bool	m_bAllDependencyDetailsLoaded

int	m_iPatchesLoaded = 0

ref array< ref SCR_BackendCallbackWorkshopItem >	m_aPatchSizeCallbacks = {}

ref array< ref SCR_WorkshopItem >	m_aDependenciesIssues = {}

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnInit

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnDetailsLoaded

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnDependenciesLoaded

ref ScriptInvokerBase< ScriptInvoker_DownloadSequenceDependencies >	m_OnRestrictedDependencies

ref ScriptInvokerBase< ScriptInvoker_DownloadSequenceDependencies >	m_OnDependenciesLoadingPrevented

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnError

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnReady

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnCancel

ref ScriptInvokerBase< ScriptInvoker_DownloadSequence >	m_OnDestroyed

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

Constructor & Destructor Documentation

◆ SCR_WorkshopDownloadSequence()

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

◆ ~SCR_WorkshopDownloadSequence()

void SCR_WorkshopDownloadSequence.~SCR_WorkshopDownloadSequence ( )

Member Function Documentation

◆ AllPatchSizeLoaded()

override void SCR_WorkshopDownloadSequence.AllPatchSizeLoaded ( )

protected

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

Implements SCR_DownloadSequence.

◆ Create()

static SCR_WorkshopDownloadSequence SCR_WorkshopDownloadSequence.Create	(	SCR_WorkshopItem	item,
		Revision	itemTargetRevision,
		SCR_WorkshopDownloadSequence	previous
	)

static

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

◆ CreateLoadingOverlay()

void SCR_WorkshopDownloadSequence.CreateLoadingOverlay ( )

protected

◆ HandleError()

void SCR_WorkshopDownloadSequence.HandleError ( )

protected

Unified behavior for error and timeout.

◆ OnAllDependenciesDetailsLoaded()

override void SCR_WorkshopDownloadSequence.OnAllDependenciesDetailsLoaded ( )

protected

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

Implements SCR_DownloadSequence.

◆ OnItemDependenciesLoaded()

void SCR_WorkshopDownloadSequence.OnItemDependenciesLoaded ( notnull SCR_WorkshopItem item )

protected

Called from SCR_WorkshopItem.m_OnDependenciesLoaded.

◆ OnItemError()

override void SCR_WorkshopDownloadSequence.OnItemError ( SCR_WorkshopItem item )

protected

Implements SCR_DownloadSequence.

◆ OnItemGetAsset()

void SCR_WorkshopDownloadSequence.OnItemGetAsset ( SCR_WorkshopItem item )

protected

Call when main item (addon) is loaded.

◆ OnItemPatchLoaded()

void SCR_WorkshopDownloadSequence.OnItemPatchLoaded ( SCR_BackendCallback callback = null )

protected

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

◆ OnRestrictedDependenciesFound()

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

protected

◆ SetupAddonFail()

void SCR_WorkshopDownloadSequence.SetupAddonFail ( SCR_WorkshopItemActionDownload action )

protected

Open download manager and set action to fail.

◆ ShowConfirmationUI()

void SCR_WorkshopDownloadSequence.ShowConfirmationUI ( )

protected

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

◆ ShowRestrictedItemDialog()

void SCR_WorkshopDownloadSequence.ShowRestrictedItemDialog ( )

protected

Show main addon restricted dialog.

Member Data Documentation

◆ LOADING_DELAY

float SCR_WorkshopDownloadSequence.LOADING_DELAY = 500

staticprotected

◆ m_Item

ref SCR_WorkshopItem SCR_WorkshopDownloadSequence.m_Item

protected

◆ m_ItemTargetRevision

ref Revision SCR_WorkshopDownloadSequence.m_ItemTargetRevision

protected

◆ m_LoadingOverlay

SCR_LoadingOverlayDialog SCR_WorkshopDownloadSequence.m_LoadingOverlay

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_WorkshopDownloadSequence()

◆ ~SCR_WorkshopDownloadSequence()

Member Function Documentation

◆ AllPatchSizeLoaded()

◆ Create()

◆ CreateLoadingOverlay()

◆ HandleError()

◆ OnAllDependenciesDetailsLoaded()

◆ OnItemDependenciesLoaded()

◆ OnItemError()

◆ OnItemGetAsset()

◆ OnItemPatchLoaded()

◆ OnRestrictedDependenciesFound()

◆ SetupAddonFail()

◆ ShowConfirmationUI()

◆ ShowRestrictedItemDialog()

Member Data Documentation

◆ LOADING_DELAY

◆ m_Item

◆ m_ItemTargetRevision

◆ m_LoadingOverlay