Loading...
Searching...
No Matches
Public Member Functions | List of all members
WorkshopCollectionItem Interface Reference
Online_workshop

This is data structure which encapsulates individual asset and its specific revision. More...

Public Member Functions

proto external string GetGUID ()
 Returns GUID of this asset related to this collection item.
 
proto external string GetName ()
 Returns name of asset related to this collection item.
 
proto external string GetVersion ()
 Returns version of revision related to this collection item.
 
proto external EApiCode GetResult ()
 Returns result for this collection item.
 
proto external WorkshopAssetBase GetAsset ()
 Returns Asset of this collection item.
 
proto external WorkshopRevisionBase GetRevision ()
 Returns Revision of this collection item.
 

Detailed Description

This is data structure which encapsulates individual asset and its specific revision.

If we failed to fetch details for this asset or revision then result will not be OK.

Member Function Documentation

◆ GetAsset()

proto external WorkshopAssetBase WorkshopCollectionItem.GetAsset ( )

Returns Asset of this collection item.

Warning
Returns null if result is not OK.

◆ GetGUID()

proto external string WorkshopCollectionItem.GetGUID ( )

Returns GUID of this asset related to this collection item.

Note
this should return GUID always even if we failed to fetch asset from workshop.

◆ GetName()

proto external string WorkshopCollectionItem.GetName ( )

Returns name of asset related to this collection item.

Note
Name can be sometimes available even if we failed to fetch details about asset and revision.
Warning
It is not always guaranteed that it will be possible to get name of asset. If this returns empty string the you should always at least fall back to show GUID of failed asset.

◆ GetResult()

proto external EApiCode WorkshopCollectionItem.GetResult ( )

Returns result for this collection item.

Warning
if it returns anything else than EACODE_ERROR_OK then item encountered error.

◆ GetRevision()

proto external WorkshopRevisionBase WorkshopCollectionItem.GetRevision ( )

Returns Revision of this collection item.

Warning
Returns null if result is not OK.

◆ GetVersion()

proto external string WorkshopCollectionItem.GetVersion ( )

Returns version of revision related to this collection item.

Warning
It is not always guaranteed that there will be some version since it might have been desired that workshop should resolve latest version but failed due to some reason. If this returns empty string then it means that version was not specified and workshop could not resolve it.
The documentation for this interface was generated from the following file: