WorkshopCollection Interface Reference

This structure represent collection of multiple workshop assets alongside specific or latest revisions. More...

Public Member Functions
proto external int	GetCount ()
	Returns total count of how many assets are in the collection.
proto external int	GetErrorsCount ()
	Returns count of how many assets/revision encountered workshop side errors.
proto external void	GetItems (out notnull array< WorkshopCollectionItem > itemsOut)
	Returns list of sorted collection items.

Detailed Description

This structure represent collection of multiple workshop assets alongside specific or latest revisions.

Note

Currently this is used only for modded servers to easily group necessary assets for connection.

Member Function Documentation

GetCount()

proto external int WorkshopCollection.GetCount

(

)

Returns total count of how many assets are in the collection.

Warning

assets which encountered error are also included in this count.

GetErrorsCount()

proto external int WorkshopCollection.GetErrorsCount

(

)

Returns count of how many assets/revision encountered workshop side errors.

GetItems()

proto external void WorkshopCollection.GetItems

(

out notnull array< WorkshopCollectionItem >

itemsOut

)

Returns list of sorted collection items.

Note

Items are sorted by load order and items with errors always first.

---

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

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