Inheritance diagram for BaseWorkshopItem:

Public Member Functions
void	~BaseWorkshopItem ()

proto external bool	IsProcessed ()
	Returns true if item is currently processing with Workshop - is downloading.

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

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

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 string	Description ()
	Get description of the item.

proto external string	Id ()
	Returns Id of item.

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

proto external int	GetStateFlags ()
	Returns current state flags.

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

◆ ~BaseWorkshopItem()

void BaseWorkshopItem.~BaseWorkshopItem ( )

Member Function Documentation

◆ Description()

proto external string BaseWorkshopItem.Description ( )

Get description of the item.

◆ GetActiveRevision()

proto external Revision BaseWorkshopItem.GetActiveRevision ( )

Returns currently downloaded Revision of item.

◆ GetDownloadingRevision()

proto external Revision BaseWorkshopItem.GetDownloadingRevision ( )

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

◆ GetLatestRevision()

proto external Revision BaseWorkshopItem.GetLatestRevision ( )

Returns latest Revision of this item.

◆ GetLocalRevision()

proto external Revision BaseWorkshopItem.GetLocalRevision ( )

Returns pseudo Revision for local non-workshop item.

◆ GetPendingDownload()

proto external Revision BaseWorkshopItem.GetPendingDownload ( )

Returns currently pending/downloading Revision.

◆ GetRevisions()

proto external int BaseWorkshopItem.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

◆ GetStateFlags()

proto external int BaseWorkshopItem.GetStateFlags ( )

Returns current state flags.

◆ Id()

proto external string BaseWorkshopItem.Id ( )

Returns Id of item.

◆ IsProcessed()

proto external bool BaseWorkshopItem.IsProcessed ( )

Returns true if item is currently processing with Workshop - is downloading.

◆ Name()

proto external string BaseWorkshopItem.Name ( )

Get name of the item.

◆ Summary()

proto external string BaseWorkshopItem.Summary ( )

Returns Summary text of this item.

◆ Thumbnail()

proto external BackendImage BaseWorkshopItem.Thumbnail ( )

Returns thumbnail image of this item.

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

GameLib/generated/online/BaseWorkshopItem.c

Public Member Functions