ServerWorkshopData Interface Reference

Data structure for integrating workshop with servers. More...

Public Member Functions
proto external ServerInfo	GetOwner ()
	Returns owner server of these workshop data.
proto external int	GetAssetCount ()
	Returns count of how many workshop assets is server using.
proto external void	RequestAssetData (notnull BackendCallback callback)
	Will request missing partial details about assets and revisions in collection.
proto external WorkshopCollection	GetCollection ()
	Returns structure of workshop collection containing all data about individual assets.

Detailed Description

Data structure for integrating workshop with servers.

It is created for servers which are running with any assets from workshop.

If server is not running with any assets (is Vanilla) then this object will not be created for such server.

Member Function Documentation

GetAssetCount()

proto external int ServerWorkshopData.GetAssetCount

(

)

Returns count of how many workshop assets is server using.

GetCollection()

proto external WorkshopCollection ServerWorkshopData.GetCollection

(

)

Returns structure of workshop collection containing all data about individual assets.

Warning

If this returns null then full details about server or its assets and revisions were not yet fetched.

GetOwner()

proto external ServerInfo ServerWorkshopData.GetOwner

(

)

Returns owner server of these workshop data.

RequestAssetData()

proto external void ServerWorkshopData.RequestAssetData

(

notnull BackendCallback

callback

)

Will request missing partial details about assets and revisions in collection.

Warning

This must be requested after full server details. It must be also requested to fully generate collection which will otherwise return null.

Exceptions

VME	- If full server details were not yet requested and loaded. If request is already being processed.

---

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

• GameLib/generated/online/server/ServerWorkshopData.c