Inheritance diagram for DownloadableItem:

Public Member Functions
void	~DownloadableItem ()

proto external void	VerifyIntegrity (BackendCallback pCallback)
	Request verification of files integrity.

proto external void	RepairIntegrity (BackendCallback pCallback)
	Request repair of local files integrity in case of corruption.

proto external bool	IsVerificationRunning ()
	Returns true if verification is currently in process.

proto external int	GetVerificationProgress ()
	Returns progress of current verification process in range of <0.0. ... 1.0>

proto external string	Id ()
	Returns Id of item.

proto external string	Summary ()
	Returns Summary text of this item.

proto external BackendImage	Thumbnail ()
	Returns thumbnail image of this item.

proto external void	AskDetail (notnull BackendCallback pCallback)
	Request details about this item from Workshop.

proto external void	LoadDependencies (BackendCallback pCallback, notnull Revision pRevision)
	Request list of all dependencies for this item on specific Revision.

proto external void	LoadScenarios (BackendCallback pCallback, notnull Revision pRevision)
	Request list of all scenarios for this item on specific Revision.

proto external void	LoadChangelog (BackendCallback pCallback, notnull Revision pRevision)
	Request changelog for this item on specific Revision.

proto external void	Download (BackendCallback pCallback, Revision pRevision)
	Request download of this item.

proto external void	PauseDownload (BackendCallback pCallback)
	Will pause download of this item.

proto external void	ResumeDownload (BackendCallback pCallback)
	Will resume download of this item.

proto external void	Cancel (BackendCallback pCallback)
	Will cancel download of this item.

proto external void	DeleteLocally ()
	Will delete locally downloaded item.

proto external void	DeleteDownloadProgress ()
	Will delete progress from downloading of this item. Download must be first canceled.

proto external void	DeleteOnline (BackendCallback pCallback)
	Request to delete this item from the Workshop.

proto external bool	HasLatestVersion ()
	Returns true if latest Revision is downloaded.

proto external Revision	GetLatestRevision ()
	Returns latest Revision of this item.

proto external Revision	GetActiveRevision ()
	Returns currently downloaded Revision of item.

proto external Revision	GetPendingDownload ()
	Returns currently pending/downloading Revision.

proto external Revision	GetDownloadingRevision ()
	Returns currently downloading Revision (will return null if it is paused)

proto external Revision	GetLocalRevision ()
	Returns pseudo Revision for local non-workshop item.

proto external int	GetRevisions (out notnull array< Revision > revisions)
	Provides array of Revision history of X latest revisions.

proto external float	GetProgress ()
	Returns progress of current download in range of <0.0. ... 1.0>. Returns 1 if it is already downloaded.

proto external float	GetProcessingProgress ()
	Return progress of current processing (delta patching) in range of <0.0. ... 1.0>. Returns 1 if it is already downloaded.

proto external bool	IsProcessing ()
	Returns true if addon is currently processing delta patches from already downloaded version.

proto external bool	IsProcessed ()
	Returns true if item is currently processing with Workshop. Is Downloading or Uploading.

proto external int	GetStateFlags ()
	Returns current state flags.

proto external int	GetScriptFlag ()
	Returns current persistent flags defined and set by scripts.

proto external void	SetScriptFlag (int iFlag)
	Set persistent flag defined by script.

proto external void	ClearScriptFlag (int iFlag)
	Clears specific persistent flag defined by script.

Public Member Functions inherited from BaseWorkshopItem
void	~BaseWorkshopItem ()

proto external string	Name ()
	Get name of the item.

proto external string	Description ()
	Get description of the item.

Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Constructor & Destructor Documentation

◆ ~DownloadableItem()

void DownloadableItem.~DownloadableItem ( )

Member Function Documentation

◆ AskDetail()

proto external void DownloadableItem.AskDetail ( notnull BackendCallback pCallback )

Request details about this item from Workshop.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ Cancel()

proto external void DownloadableItem.Cancel ( BackendCallback pCallback )

Will cancel download of this item.

Data will be cleared.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ ClearScriptFlag()

proto external void DownloadableItem.ClearScriptFlag ( int iFlag )

Clears specific persistent flag defined by script.

◆ DeleteDownloadProgress()

proto external void DownloadableItem.DeleteDownloadProgress ( )

Will delete progress from downloading of this item. Download must be first canceled.

◆ DeleteLocally()

proto external void DownloadableItem.DeleteLocally ( )

Will delete locally downloaded item.

◆ DeleteOnline()

proto external void DownloadableItem.DeleteOnline ( BackendCallback pCallback )

Request to delete this item from the Workshop.

Client must be owner of item for successful delete.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ Download()

proto external void DownloadableItem.Download	(	BackendCallback	pCallback,
		Revision	pRevision )

Request download of this item.

Parameters

pCallback	- Is script callback where you will receive result/error when request finishes
pRevision	- Is Revision which will be requested to download

◆ GetActiveRevision()

proto external Revision DownloadableItem.GetActiveRevision ( )

Returns currently downloaded Revision of item.

◆ GetDownloadingRevision()

proto external Revision DownloadableItem.GetDownloadingRevision ( )

Returns currently downloading Revision (will return null if it is paused)

◆ GetLatestRevision()

proto external Revision DownloadableItem.GetLatestRevision ( )

Returns latest Revision of this item.

◆ GetLocalRevision()

proto external Revision DownloadableItem.GetLocalRevision ( )

Returns pseudo Revision for local non-workshop item.

◆ GetPendingDownload()

proto external Revision DownloadableItem.GetPendingDownload ( )

Returns currently pending/downloading Revision.

◆ GetProcessingProgress()

proto external float DownloadableItem.GetProcessingProgress ( )

Return progress of current processing (delta patching) in range of <0.0. ... 1.0>. Returns 1 if it is already downloaded.

◆ GetProgress()

proto external float DownloadableItem.GetProgress ( )

Returns progress of current download in range of <0.0. ... 1.0>. Returns 1 if it is already downloaded.

◆ GetRevisions()

proto external int DownloadableItem.GetRevisions ( out notnull array< Revision > revisions )

Provides array of Revision history of X latest revisions.

Limit of how many revisions is provided is specified by Workshop so it may differ.

Parameters

[out] revisions - array containing X latest revisions for this item.

Returns: int - count of revisions

◆ GetScriptFlag()

proto external int DownloadableItem.GetScriptFlag ( )

Returns current persistent flags defined and set by scripts.

◆ GetStateFlags()

proto external int DownloadableItem.GetStateFlags ( )

Returns current state flags.

◆ GetVerificationProgress()

proto external int DownloadableItem.GetVerificationProgress ( )

Returns progress of current verification process in range of <0.0. ... 1.0>

◆ HasLatestVersion()

proto external bool DownloadableItem.HasLatestVersion ( )

Returns true if latest Revision is downloaded.

◆ Id()

proto external string DownloadableItem.Id ( )

Returns Id of item.

◆ IsProcessed()

proto external bool DownloadableItem.IsProcessed ( )

Returns true if item is currently processing with Workshop. Is Downloading or Uploading.

◆ IsProcessing()

proto external bool DownloadableItem.IsProcessing ( )

Returns true if addon is currently processing delta patches from already downloaded version.

◆ IsVerificationRunning()

proto external bool DownloadableItem.IsVerificationRunning ( )

Returns true if verification is currently in process.

◆ LoadChangelog()

proto external void DownloadableItem.LoadChangelog	(	BackendCallback	pCallback,
		notnull Revision	pRevision )

Request changelog for this item on specific Revision.

Parameters

pCallback	- Is script callback where you will receive result/error when request finishes
pRevision	- Is Revision from which we want to request changelog

◆ LoadDependencies()

proto external void DownloadableItem.LoadDependencies	(	BackendCallback	pCallback,
		notnull Revision	pRevision )

Request list of all dependencies for this item on specific Revision.

Parameters

pCallback	- Is script callback where you will receive result/error when request finishes
pRevision	- Is Revision from which we want to request dependency list

◆ LoadScenarios()

proto external void DownloadableItem.LoadScenarios	(	BackendCallback	pCallback,
		notnull Revision	pRevision )

Request list of all scenarios for this item on specific Revision.

Parameters

pCallback	- Is script callback where you will receive result/error when request finishes
pRevision	- Is Revision from which we want to request scenario list

◆ PauseDownload()

proto external void DownloadableItem.PauseDownload ( BackendCallback pCallback )

Will pause download of this item.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ RepairIntegrity()

proto external void DownloadableItem.RepairIntegrity ( BackendCallback pCallback )

Request repair of local files integrity in case of corruption.

Corrupted files are deleted and downloaded as new.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ ResumeDownload()

proto external void DownloadableItem.ResumeDownload ( BackendCallback pCallback )

Will resume download of this item.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ SetScriptFlag()

proto external void DownloadableItem.SetScriptFlag ( int iFlag )

Set persistent flag defined by script.

◆ Summary()

proto external string DownloadableItem.Summary ( )

Returns Summary text of this item.

◆ Thumbnail()

proto external BackendImage DownloadableItem.Thumbnail ( )

Returns thumbnail image of this item.

◆ VerifyIntegrity()

proto external void DownloadableItem.VerifyIntegrity ( BackendCallback pCallback )

Request verification of files integrity.

Sets flags of revision and each file accordingly.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

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

GameLib/generated/online/DownloadableItem.c

Public Member Functions

Constructor & Destructor Documentation

◆ ~DownloadableItem()

Member Function Documentation

◆ AskDetail()

◆ Cancel()

◆ ClearScriptFlag()

◆ DeleteDownloadProgress()

◆ DeleteLocally()

◆ DeleteOnline()

◆ Download()

◆ GetActiveRevision()

◆ GetDownloadingRevision()

◆ GetLatestRevision()

◆ GetLocalRevision()

◆ GetPendingDownload()

◆ GetProcessingProgress()

◆ GetProgress()

◆ GetRevisions()

◆ GetScriptFlag()

◆ GetStateFlags()

◆ GetVerificationProgress()

◆ HasLatestVersion()

◆ Id()

◆ IsProcessed()

◆ IsProcessing()

◆ IsVerificationRunning()

◆ LoadChangelog()

◆ LoadDependencies()

◆ LoadScenarios()

◆ PauseDownload()

◆ RepairIntegrity()

◆ ResumeDownload()

◆ SetScriptFlag()

◆ Summary()

◆ Thumbnail()

◆ VerifyIntegrity()