Inheritance diagram for WorkshopApi:

[legend]

Public Member Functions
string	GetCode (int code)
	ApiCode to string.

proto native WorkshopTag	RegisterTag (string sName)
	Register new tag.

proto native int	GetTags (out notnull array< WorkshopTag > tags)
	Get all known tags.

proto native WorkshopItem	GetByName (string name)
	Get item by name.

proto native MissionWorkshopItem	GetInGameScenario (ResourceName sResource)
	Find in-game MissionWorkshopItem by its MissionHeader config.

proto native WorkshopItem	FindItem (string id)
	Find a WorkshopItem by ID in the local cache.

proto native int	GetPageScenarios (out array< MissionWorkshopItem > items, int page, int pageSize)
	Get scenarios of enabled WorkshopItems.

proto native void	OnItemsChecked (BackendCallback callback)
	Triggers OnSuccess when check for banned/up-to-date downloaded addons has finished.

proto native int	GetOfflineItems (out notnull array< WorkshopItem > items)
	Get downloaded WorskhopItems.

proto native bool	NeedScan ()
	True if local data were not loaded yet -> You can load them by ScanOfflineItems()

proto native int	GetPageItems (out array< WorkshopItem > items)
	Get page content.

proto native MissionWorkshopItem	GetCurrentMission ()
	Get downloaded WorskhopItems.

Public Member Functions inherited from DownloadableCatalogue
proto native void	ScanOfflineItems ()

proto native void	Cleanup ()
	Destroy items.

proto native int	GetBannedItems (out notnull array< string > items)

proto native int	GetDownloads (out notnull array< DownloadableItem > items)

Public Member Functions inherited from WorkshopCatalogue
proto external void	RequestPage (BackendCallback pCallback, notnull PageParams pParams, bool bClearCache)

proto external int	GetTotalItemCount ()
	Get total item count on all pages.

proto external int	GetPageCount ()
	Get page count.

proto external void	SetPageItems (int iCount)
	Set number of items per page.

proto external int	GetPage ()
	Get current page number.

proto external int	GetPageItemCount ()
	Get item count on actual page.

Member Function Documentation

◆ FindItem()

proto native WorkshopItem WorkshopApi.FindItem ( string id )

Find a WorkshopItem by ID in the local cache.

◆ GetByName()

proto native WorkshopItem WorkshopApi.GetByName ( string name )

Get item by name.

◆ GetCode()

string WorkshopApi.GetCode ( int code )

ApiCode to string.

◆ GetCurrentMission()

proto native MissionWorkshopItem WorkshopApi.GetCurrentMission ( )

Get downloaded WorskhopItems.

◆ GetInGameScenario()

proto native MissionWorkshopItem WorkshopApi.GetInGameScenario ( ResourceName sResource )

Find in-game MissionWorkshopItem by its MissionHeader config.

◆ GetOfflineItems()

proto native int WorkshopApi.GetOfflineItems ( out notnull array< WorkshopItem > items )

Get downloaded WorskhopItems.

◆ GetPageItems()

proto native int WorkshopApi.GetPageItems ( out array< WorkshopItem > items )

Get page content.

Parameters

items Array of Workshop Items

Returns: Current count of items on active page

◆ GetPageScenarios()

proto native int WorkshopApi.GetPageScenarios	(	out array< MissionWorkshopItem >	items,
		int	page,
		int	pageSize
	)

Get scenarios of enabled WorkshopItems.

◆ GetTags()

proto native int WorkshopApi.GetTags ( out notnull array< WorkshopTag > tags )

Get all known tags.

◆ NeedScan()

proto native bool WorkshopApi.NeedScan ( )

True if local data were not loaded yet -> You can load them by ScanOfflineItems()

◆ OnItemsChecked()

proto native void WorkshopApi.OnItemsChecked ( BackendCallback callback )

Triggers OnSuccess when check for banned/up-to-date downloaded addons has finished.

◆ RegisterTag()

proto native WorkshopTag WorkshopApi.RegisterTag ( string sName )

Register new tag.

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

GameLib/online/WorkshopApi.c

Public Member Functions