WorkshopAsset Interface Reference

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

Inheritance diagram for WorkshopAsset:

Public Member Functions
proto external string	GetDescription ()
	Returns full description of this asset.
proto external void	GetAvailableRevisions (out notnull array< WorkshopRevisionBase > revisionsOut)
	Provides array of all revisions which are still available on the workshop and can be listed with details or even downloaded.
proto external void	GetScreenshots (out notnull array< BImage > screenshotsOut)
	Provides array of all screenshots available on this asset.
Public Member Functions inherited from WorkshopAssetBase
proto external void	SetEnabledState (bool enabled)
	Specifies if this asset should be enabled.
proto external EWorkshopAssetState	GetEnabledState ()
	Returns desired state the asset will set as default state when possible.
proto external EWorkshopAssetState	GetState ()
	Returns current state of locally available (downloaded) revision of this asset.
proto external bool	IsCorrupted ()
	Returns true if asset has corrupted data and should not be loaded.
proto external bool	HasData ()
	Returns true if asset has some data locally on the drive.
proto external WorkshopJob	GetPendingJob ()
	Returns currently pending job of this asset.
proto external string	GetGUID ()
	Returns GUID of this asset.
proto external string	GetName ()
	Returns name of this asset.
proto external string	GetSummary ()
	Returns short summary text of this asset.
proto external EWorkshopAssetVisibility	GetVisibility ()
	Returns visibility of this asset.
proto external void	GetTags (out notnull array< WorkshopAssetTag > tagsOut)
	Returns array containing all tag objects on this asset.
proto external int	GetTagsCount ()
	Returns total count of how many tags are on this asset.
proto external WorkshopUserProfile	GetAuthor ()
	Returns object containing data about author of this asset.
proto external WorkshopRevisionBase	GetLatestRevision ()
	Return latest revision available on the workshop.
proto external WorkshopRevisionBase	GetCurrentRevision ()
	Return revision which is already downloaded and locally available.
proto external BImage	GetPreviewImage ()
	Returns preview image of the asset.
proto external BImage	GetIconImage ()
	Returns icon image of the asset.
proto external bool	DeleteData ()
	This will delete all locally available data of asset on the drive.
proto external void	RequestSubscribe (notnull BackendCallback callback, bool subscribed)
	Will request change of subscribe state to this asset.
proto external int	GetSubscriberCount ()
	Returns count of how many users have currently subscribed this asset.
proto external int	GetUniqueDownloadCount ()
	Returns count of how many unique users have ever downloaded this asset.
proto external void	RequestRate (notnull BackendCallback callback, float rating)
	Will request submit of rating to this asset.
proto external float	GetRating ()
	Returns current rating of this asset calculated from all ratings submitted by other users as value 0.0f to 0.1f.
proto external float	GetMyRating ()
	Returns current personal rating of this asset as value 0.0f to 0.1f.
proto external int	GetRatingCount ()
	Returns total count of how many users submitted rating.
proto external void	RequestBlock (notnull BackendCallback callback, bool block)
	Will request change of blocked state to this asset.
proto external void	RequestReport (notnull BackendCallback callback, EWorkshopReportTypes type, string description, bool block)
	Will request submit of report against this asset and can be also optionally blocked.
proto external void	RequestDetails (notnull BackendCallback callback)
	Will request missing details about this asset.
proto external WorkshopAsset	GetWorkshopAsset ()
	Returns full WorkshopAsset 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

GetAvailableRevisions()

proto external void WorkshopAsset.GetAvailableRevisions

(

out notnull array< WorkshopRevisionBase >

revisionsOut

)

Provides array of all revisions which are still available on the workshop and can be listed with details or even downloaded.

Note

List is sorted from latest to most old revision. First element should always be equal to the LatestRevision except if it is not know and is null.

GetDescription()

proto external string WorkshopAsset.GetDescription

(

)

Returns full description of this asset.

GetScreenshots()

proto external void WorkshopAsset.GetScreenshots

(

out notnull array< BImage >

screenshotsOut

)

Provides array of all screenshots available on this asset.

Note

Screenshot can be possibly null in case of some issue or other reason and should be properly handled by either skipping or using some error image.

---

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

• GameLib/generated/online/workshop/WorkshopAsset.c