Final structure of the workshop asset which contains all data and functionality. More...

Inheritance diagram for WorkshopRevision:

Public Member Functions
proto external string	GetChangelog ()
	Returns full changelog of this revision.

proto external void	RequestDeltaSize (notnull BackendCallback callback, notnull WorkshopRevisionBase other)
	Will request download of manifest for this and other revision into memory which is necessary for calculation of patch size between them.

proto external int	GetPatchSizeKB (notnull WorkshopRevisionBase other)
	Will calculate delta patch size from this to other revision - how much data will be needed to get from this to other revision.

proto external WorkshopLicense	GetLicense ()
	Returns pointer to the license object of this revision.

Public Member Functions inherited from WorkshopRevisionBase
proto external bool	IsLatest ()
	Returns true if this is latest revision of its asset.

proto external bool	IsCurrent ()
	Return true if this is current revision of its asset.

proto external string	GetVersion ()
	Returns version numbers as a string.

proto external int	GetSizeKB ()
	Returns total size of this revision in KibiBytes.

proto external WorkshopJob	RequestDownload (notnull BackendCallback callback)
	Will request download of this revision.

proto external void	RequestDetails (notnull BackendCallback callback)
	Will request missing details about this revision.

proto external WorkshopRevision	GetWorkshopRevision ()
	Returns full WorkshopRevision structure of this if it was previously requested with successful result.

Detailed Description

Final structure of the workshop asset which contains all data and functionality.

Member Function Documentation

proto external string WorkshopRevision.GetChangelog ( )

Returns full changelog of this revision.

proto external WorkshopLicense WorkshopRevision.GetLicense ( )

Returns pointer to the license object of this revision.

Note: if this returns null then revision does not have any specific license and the most restrictive rules apply for this revision.

proto external int WorkshopRevision.GetPatchSizeKB ( notnull WorkshopRevisionBase other )

Will calculate delta patch size from this to other revision - how much data will be needed to get from this to other revision.

Warning: This does not represent exact amount of how much data will be downloaded because data could be possibly reused if they exist in different places. But it can still indicate how much data at most would user need to download. Exact size to download has to be deeply calculated and will be provided by active job.

proto external void WorkshopRevision.RequestDeltaSize	(	notnull BackendCallback	callback,
		notnull WorkshopRevisionBase	other )

Will request download of manifest for this and other revision into memory which is necessary for calculation of patch size between them.

Note: If both manifests are already cached in memory then this method will call OnSuccess immediately and no request is performed.

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