DownloadableItem Interface Reference

Inheritance diagram for DownloadableItem:

Public Member Functions
proto native string	Id ()
proto native void	Download (BackendCallback callback, Revision revision)
	Request download of this item.
proto native void	AskDetail (BackendCallback callback)
	Request detail info.
proto native float	GetProgress ()
	Get Download/ Upload progress in range <0.0.
proto native float	GetProcessingProgress ()
	Get download/update progress based on file operations in range <0.0.
proto native bool	IsProcessing ()
	True if download is waiting for file processing.
proto native BackendImage	Thumbnail ()
	Get thumbnail image.
proto native bool	HasLatestVersion ()
	Is the local version the latest one?
proto native int	GetRevisions (out notnull array< Revision > revisions)
proto native Revision	GetActiveRevision ()
	Returns currently used revision or null if no revision is downloaded.
proto native Revision	GetDownloadingRevision ()
	Returns currently downloading revision.
proto native void	Cancel (BackendCallback callback)
	Cancel upload or download.
proto native void	DeleteLocally ()
	Delete local copy of an asset.
proto native void	DeleteDownloadProgress ()
proto native Revision	GetPendingDownload ()
proto native void	SetScriptFlag (int iFlag)
	Set script-defined persistent flags.
proto native void	ClearScriptFlag (int iFlag)
	Clear script-defined persistent flags.
proto native int	GetScriptFlag ()
	Get script-defined persistent flags.
proto native Revision	GetLatestRevision ()
proto native void	LoadDependencies (BackendCallback callback, notnull Revision revision)
	Load revision's dependency list.
proto native Revision	GetLocalRevision ()
	Get local (non-workshop) revision.
proto native string	Summary ()
	Get summary.
Public Member Functions inherited from BaseWorkshopItem
proto native string	Name ()
proto native string	Description ()

Member Function Documentation

AskDetail()

proto native void DownloadableItem.AskDetail

(

BackendCallback

callback

)

Request detail info.

Cancel()

proto native void DownloadableItem.Cancel

(

BackendCallback

callback

)

Cancel upload or download.

ClearScriptFlag()

proto native void DownloadableItem.ClearScriptFlag

(

int

iFlag

)

Clear script-defined persistent flags.

DeleteDownloadProgress()

proto native void DownloadableItem.DeleteDownloadProgress

(

)

DeleteLocally()

proto native void DownloadableItem.DeleteLocally

(

)

Delete local copy of an asset.

Download()

proto native void DownloadableItem.Download	(	BackendCallback	callback,
		Revision	revision
	)

Request download of this item.

GetActiveRevision()

proto native Revision DownloadableItem.GetActiveRevision

(

)

Returns currently used revision or null if no revision is downloaded.

GetDownloadingRevision()

proto native Revision DownloadableItem.GetDownloadingRevision

(

)

Returns currently downloading revision.

GetLatestRevision()

proto native Revision DownloadableItem.GetLatestRevision

(

)

GetLocalRevision()

proto native Revision DownloadableItem.GetLocalRevision

(

)

Get local (non-workshop) revision.

GetPendingDownload()

proto native Revision DownloadableItem.GetPendingDownload

(

)

GetProcessingProgress()

proto native float DownloadableItem.GetProcessingProgress

(

)

Get download/update progress based on file operations in range <0.0.

.. 1.0>

GetProgress()

proto native float DownloadableItem.GetProgress

(

)

Get Download/ Upload progress in range <0.0.

.. 1.0>

GetRevisions()

proto native int DownloadableItem.GetRevisions

(

out notnull array< Revision >

revisions

)

GetScriptFlag()

proto native int DownloadableItem.GetScriptFlag

(

)

Get script-defined persistent flags.

HasLatestVersion()

proto native bool DownloadableItem.HasLatestVersion

(

)

Is the local version the latest one?

Id()

proto native string DownloadableItem.Id

(

)

IsProcessing()

proto native bool DownloadableItem.IsProcessing

(

)

True if download is waiting for file processing.

LoadDependencies()

proto native void DownloadableItem.LoadDependencies	(	BackendCallback	callback,
		notnull Revision	revision
	)

Load revision's dependency list.

SetScriptFlag()

proto native void DownloadableItem.SetScriptFlag

(

int

iFlag

)

Set script-defined persistent flags.

Summary()

proto native string DownloadableItem.Summary

(

)

Get summary.

Thumbnail()

proto native BackendImage DownloadableItem.Thumbnail

(

)

Get thumbnail image.

---

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

• GameLib/online/WorkshopApi.c