Data Structures
class	SCR_ContentBrowser_GetAssetListParams

class	SCR_CompareWorkshopItemTimeSinceLastPlay

class	SCR_CompareWorkshopItemTargetSize

Enumerations
enum	EContentBrowserAddonsSubMenuMode

Functions
enum EContentBrowserAddonsSubMenuMode	Attribute ("0", UIWidgets.ComboBox, "This menu is quite universal and can work in many modes - what do you want it to be?", "", ParamEnumArray.FromEnum(EContentBrowserAddonsSubMenuMode))] EContentBrowserAddonsSubMenuMode m_eMode

void	SetWorkshopItems (array< ref SCR_WorkshopItem > items)
	Sets the item array on which this tab operates. Only possible in external item array mode. More...

void	SetFilterConfiguration_EnabledAddons ()
	Sets filters to mode which lists only 'enabled' addons. Only works for offline tab. More...

override void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)

protected void	InitWidgets ()

protected void	InitWidgetEventHandlers ()

override void	OnTabShow ()

override void	OnTabHide ()

override void	OnTabRemove ()

override void	OnMenuShow ()

override void	OnMenuUpdate (float tDelta)
	Called on each frame. More...

override void	OnMenuFocusGained ()

override void	OnTabChange ()

protected void	InitWorkshopApi ()

protected void	RequestPage (int pageId)

protected void	RequestOnlinePageUnfiltered (int pageId)

protected void	RequestOnlinePage (int pageId)

protected void	PageRequestCallbackCleanup (SCR_WorkshopApiCallback_RequestPage callback)

void	PackGetAssetListParams (SCR_ContentBrowser_GetAssetListParams p, bool defaultValues=false)

protected void	DisplayExternalItems (int pageId)
	Selects items from the externally provided array and shows them on grid, only makes sense in external array mode. More...

protected void	DisplayOfflineItems (int pageId)

protected void	GridScreen_Init ()

protected void	GridScreen_Clear ()
	Tiles are cleared up here. They are not deleted, but hidden. More...

protected void	GridScreen_DisplayItems (array< ref SCR_WorkshopItem > items)

void	SetPanelsMode (bool showEmptyPanel, bool forceFiltersList=false, string messagePresetTag=string.Empty, bool animateFiltersList=false)

array< ref SCR_WorkshopItem >	SearchItems (array< ref SCR_WorkshopItem > items, string searchStr)

protected array< ref SCR_WorkshopItem >	Filter_OfflineFilterAndSearch (array< ref SCR_WorkshopItem > itemsIn)

protected array< ref SCR_WorkshopItem >	Filter_IntersectArrays (array< ref array< ref SCR_WorkshopItem >> arrays)
	Returns intersection of all arrays (array of elements which are contained in all arrays) More...

void	UpdateItemsFoundMessage (int current, int total)

protected int	GetPageCount ()
	Returns page count, might depend on current mode. More...

protected SCR_WorkshopItem	GetSelectedItem ()
	Returns currently selected workshop item. More...

protected void	UpdatePagingWidgets ()
	Updates the widgets related to paging: buttons, text. More...

protected void	UpdateButtons ()

protected bool	GetShowReportedAddons ()
	Returns true when we have selected a filter to show reported mods. More...

bool	IsWidgetUnderCursor (Widget w)
	Returns true if cursor over a given widget. More...

protected void	OnPrevPageButton ()

protected void	OnNextPageButton ()

protected void	OnScrollPage ()

protected array< ref SCR_WorkshopItem >	SelectItemsAtPage (array< ref SCR_WorkshopItem > items, int pageId)
	Returns array of items within specified page, page ID starting from 0. More...

protected void	SwitchFocus (SCR_EListMenuWidgetFocus focus)
	Switch focus. More...

protected void	OnConnected ()

protected void	OnTileClick (SCR_ScriptedWidgetComponent baseComp)

protected void	OnTileFocus (ScriptedWidgetComponent comp)

protected void	OnFilterButton ()

protected void	OnPrimaryButton ()

protected void	OnEnableButton ()

protected void	OnFavouriteButton ()

protected void	OnDetailsButton (SCR_ButtonBaseComponent comp)

protected void	Callback_OnRequestPageGetAllAssets (SCR_WorkshopApiCallback_RequestPage callback)

protected void	Callback_OnRequestPageGetAssets (SCR_WorkshopApiCallback_RequestPage callback)

protected void	Callback_OnRequestPageTimeout (SCR_WorkshopApiCallback_RequestPage callback)

protected void	Callback_OnRequestPageTimeout_OnCloseDialog ()

protected void	Callback_OnRequestPageTimeout_OnDialogTryAgain ()

protected void	Callback_OnAddonOfflineStateChanged (SCR_WorkshopItem item, bool newState)
	Called by SCR_AddonManager when some addon is downloaded or uninstalled. More...

protected void	Callback_OnAddonReportedStateChanged (SCR_WorkshopItem item, bool newReported)
	Called by SCR_AddonManager when some addon is reported or unreported. More...

protected void	OnFilterChange (SCR_FilterEntry filter)
	Called when filter listbox selection changes. More...

protected void	OnFilterSearchConfirm (SCR_EditBoxComponent comp, string newValue)
	Called when user confirms the value in the seacrh string. More...

protected void	OnSortingHeaderChange (SCR_SortHeaderComponent sortHeader)
	Called when sorting header changes. More...

SCR_ContentBrowser_AddonsSubMenuBaseWidgets	GetWidgets ()

array< SCR_ContentBrowserTileComponent >	GetTileComponents ()

SCR_ContentBrowserTileComponent	GetTileComponentById (int id)

int	GetTileComponentsCount ()

SCR_ContentBrowser_GetAssetListParams PageParams	Compare (SCR_WorkshopItem left, SCR_WorkshopItem right)

void	SCR_ContentBrowser_GetAssetListParams (SCR_ContentBrowser_AddonsSubMenu subMenu, bool defaultValues=false)

override void	OnPack ()

Variables
	MODE_OFFLINE

	MODE_ONLINE

	MODE_EXTERNAL_ITEM_ARRAY

bool	m_bEnableSorting

bool	m_bEnableFilter

protected bool	m_bEnableOpenDetails

const protected int	GRID_N_COLUMNS = 4

const protected int	GRID_N_ROWS = 3

const protected int	LOAD_PAGE_DELAY = 500

const protected ResourceName	LAYOUT_GRID_TILE = "{67B0EFBDF7EAFF27}UI/layouts/Menus/ContentBrowser/Tile/WorkshopTile.layout"

const protected string	MESSAGE_TAG_NOTHING_FOUND = "nothing_found"

const protected string	MESSAGE_TAG_NOTHING_DOWNLOADED = "nothing_downloaded"

const protected string	MESSAGE_TAG_NOTHING_DOWNLOADED_2 = "nothing_downloaded2"

const protected string	MESSAGE_TAG_ERROR_CONNECTION = "error_connection"

const protected string	MESSAGE_TAG_LOADING = "loading"

protected ref SCR_ContentBrowser_AddonsSubMenuBaseWidgets	m_Widgets = new SCR_ContentBrowser_AddonsSubMenuBaseWidgets

protected WorkshopApi	m_WorkshopApi

protected ref SCR_WorkshopDownloadSequence	m_DownloadRequest

protected ref array< SCR_ContentBrowserTileComponent >	m_aTileComponents = {}

protected bool	m_bConnected

protected bool	m_bFailToLoad

protected bool	m_bClearCacheAtNextRequest

protected ref array< ref SCR_WorkshopItem >	m_aExternalItems = {}

protected SCR_ContentBrowserTileComponent	m_LastFocusedTile

protected ref SCR_ContentBrowser_GetAssetListParams	m_GetAssetListParams

protected ref SCR_ContentBrowser_GetAssetListParams	m_GetAssetListParamsDefault

protected bool	m_bFirstPage = true

protected bool	m_bPanelsModeEmpty

protected bool	m_bMousePageUsed

protected bool	m_bFirstLoad = true

protected int	m_iCurrentPage

protected int	m_iOfflinePageCount

protected int	m_iOnlinePageCount

protected SCR_InputButtonComponent	m_NavDetails

protected SCR_InputButtonComponent	m_NavPrimary

protected SCR_InputButtonComponent	m_NavEnable

protected SCR_InputButtonComponent	m_NavFavourite

protected SCR_InputButtonComponent	m_NavFilter

protected int	m_iItemsTotal

protected int	m_iOnlineFilteredItems

protected ref array< ref SCR_WorkshopApiCallback_RequestPage >	m_aSearchCallbacks = {}

SCR_ContentBrowser_AddonsSubMenu	m_AddonsSubMenu

protected bool	m_bUseDefaultValues

Enumeration Type Documentation

◆ EContentBrowserAddonsSubMenuMode

enum EContentBrowserAddonsSubMenuMode

Definition at line 7 of file SCR_ContentBrowser_AddonsSubMenu.c.

Function Documentation

◆ Attribute()

enum EContentBrowserAddonsSubMenuMode Attribute	(	"0"	,
		UIWidgets.	ComboBox,
		"This menu is quite universal and can work in many modes - what do you want it to be?"	,
		""	,
		ParamEnumArray.	FromEnumEContentBrowserAddonsSubMenuMode
	)

◆ Callback_OnAddonOfflineStateChanged()

protected void Callback_OnAddonOfflineStateChanged	(	SCR_WorkshopItem	item,
		bool	newState
	)

Called by SCR_AddonManager when some addon is downloaded or uninstalled.

Definition at line 1476 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnAddonReportedStateChanged()

protected void Callback_OnAddonReportedStateChanged	(	SCR_WorkshopItem	item,
		bool	newReported
	)

Called by SCR_AddonManager when some addon is reported or unreported.

Definition at line 1487 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnRequestPageGetAllAssets()

protected void Callback_OnRequestPageGetAllAssets ( SCR_WorkshopApiCallback_RequestPage callback )

Definition at line 1369 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnRequestPageGetAssets()

protected void Callback_OnRequestPageGetAssets ( SCR_WorkshopApiCallback_RequestPage callback )

Definition at line 1379 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnRequestPageTimeout()

protected void Callback_OnRequestPageTimeout ( SCR_WorkshopApiCallback_RequestPage callback )

Definition at line 1435 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnRequestPageTimeout_OnCloseDialog()

protected void Callback_OnRequestPageTimeout_OnCloseDialog ( )

Definition at line 1460 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Callback_OnRequestPageTimeout_OnDialogTryAgain()

protected void Callback_OnRequestPageTimeout_OnDialogTryAgain ( )

Definition at line 1468 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Compare()

SCR_ContentBrowser_GetAssetListParams PageParams Compare	(	SCR_WorkshopItem	left,
		SCR_WorkshopItem	right
	)

Definition at line 1581 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ DisplayExternalItems()

protected void DisplayExternalItems ( int pageId )

Selects items from the externally provided array and shows them on grid, only makes sense in external array mode.

Definition at line 571 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ DisplayOfflineItems()

protected void DisplayOfflineItems ( int pageId )

Definition at line 592 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Filter_IntersectArrays()

protected array<ref SCR_WorkshopItem> Filter_IntersectArrays ( array< ref array< ref SCR_WorkshopItem >> arrays )

Returns intersection of all arrays (array of elements which are contained in all arrays)

Definition at line 931 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ Filter_OfflineFilterAndSearch()

protected array<ref SCR_WorkshopItem> Filter_OfflineFilterAndSearch ( array< ref SCR_WorkshopItem > itemsIn )

Filters the array according to currently selected filters. !! Works only for offline configuration of filters!

Definition at line 842 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetPageCount()

protected int GetPageCount ( )

Returns page count, might depend on current mode.

Definition at line 987 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetSelectedItem()

protected SCR_WorkshopItem GetSelectedItem ( )

Returns currently selected workshop item.

Definition at line 1003 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetShowReportedAddons()

protected bool GetShowReportedAddons ( )

Returns true when we have selected a filter to show reported mods.

Definition at line 1101 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetTileComponentById()

SCR_ContentBrowserTileComponent GetTileComponentById ( int id )

Definition at line 1542 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetTileComponents()

array<SCR_ContentBrowserTileComponent> GetTileComponents ( )

Definition at line 1533 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetTileComponentsCount()

int GetTileComponentsCount ( )

Definition at line 1551 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GetWidgets()

SCR_ContentBrowser_AddonsSubMenuBaseWidgets GetWidgets ( )

Definition at line 1527 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GridScreen_Clear()

protected void GridScreen_Clear ( )

Tiles are cleared up here. They are not deleted, but hidden.

Definition at line 709 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GridScreen_DisplayItems()

protected void GridScreen_DisplayItems ( array< ref SCR_WorkshopItem > items )

Definition at line 718 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ GridScreen_Init()

protected void GridScreen_Init ( )

When pages are scrolled, tiles are not deleted, we show different data in the tiles instead to avoid unneeded widget allocations. Here we create tile widgets in advance.

Definition at line 681 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ InitWidgetEventHandlers()

protected void InitWidgetEventHandlers ( )

Definition at line 183 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ InitWidgets()

protected void InitWidgets ( )

Definition at line 165 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ InitWorkshopApi()

protected void InitWorkshopApi ( )

Definition at line 299 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ IsWidgetUnderCursor()

bool IsWidgetUnderCursor ( Widget w )

Returns true if cursor over a given widget.

Definition at line 1123 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnConnected()

protected void OnConnected ( )

Called when we have lost connection and connected again, or when the tab is opened first time and connection is already active !!! Not called for offline tab. For offline tab connection is not needed. !!!

Definition at line 1273 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnDetailsButton()

protected void OnDetailsButton ( SCR_ButtonBaseComponent comp )

Definition at line 1362 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnEnableButton()

protected void OnEnableButton ( )

Definition at line 1341 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnFavouriteButton()

protected void OnFavouriteButton ( )

Definition at line 1347 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnFilterButton()

protected void OnFilterButton ( )

Definition at line 1317 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnFilterChange()

protected void OnFilterChange ( SCR_FilterEntry filter )

Called when filter listbox selection changes.

Definition at line 1504 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnFilterSearchConfirm()

protected void OnFilterSearchConfirm	(	SCR_EditBoxComponent	comp,
		string	newValue
	)

Called when user confirms the value in the seacrh string.

Definition at line 1512 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnMenuFocusGained()

override void OnMenuFocusGained ( )

Definition at line 275 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnMenuShow()

override void OnMenuShow ( )

Definition at line 243 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnMenuUpdate()

override void OnMenuUpdate ( float tDelta )

Called on each frame.

Definition at line 252 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnNextPageButton()

protected void OnNextPageButton ( )

Definition at line 1155 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnPack()

override void Compare::OnPack ( )

Definition at line 1564 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnPrevPageButton()

protected void OnPrevPageButton ( )

Definition at line 1137 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnPrimaryButton()

protected void OnPrimaryButton ( )

Definition at line 1330 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnScrollPage()

protected void OnScrollPage ( )

Definition at line 1173 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnSortingHeaderChange()

protected void OnSortingHeaderChange ( SCR_SortHeaderComponent sortHeader )

Called when sorting header changes.

Definition at line 1520 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTabChange()

override void OnTabChange ( )

Definition at line 284 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTabCreate()

override void OnTabCreate	(	Widget	menuRoot,
		ResourceName	buttonsLayout,
		int	index
	)

Definition at line 123 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTabHide()

override void OnTabHide ( )

Definition at line 220 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTabRemove()

override void OnTabRemove ( )

Definition at line 229 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTabShow()

override void OnTabShow ( )

Definition at line 205 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTileClick()

protected void OnTileClick ( SCR_ScriptedWidgetComponent baseComp )

Definition at line 1283 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ OnTileFocus()

protected void OnTileFocus ( ScriptedWidgetComponent comp )

Definition at line 1301 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ PackGetAssetListParams()

void PackGetAssetListParams	(	SCR_ContentBrowser_GetAssetListParams	p,
		bool	defaultValues = `false`
	)

Called from OnPack of a Json API Struct. Here we pack the request data according to current filtering and sorging parameters.

Definition at line 433 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ PageRequestCallbackCleanup()

protected void PageRequestCallbackCleanup ( SCR_WorkshopApiCallback_RequestPage callback )

Definition at line 421 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ RequestOnlinePage()

protected void RequestOnlinePage ( int pageId )

Items with filters Requests a filtered page from backend, does not do anything else

Definition at line 393 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ RequestOnlinePageUnfiltered()

protected void RequestOnlinePageUnfiltered ( int pageId )

Total number of items Requests an unfiltered page from backend, does not do anything else

Definition at line 368 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ RequestPage()

protected void RequestPage ( int pageId )

Definition at line 339 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ SCR_ContentBrowser_GetAssetListParams()

void Compare::SCR_ContentBrowser_GetAssetListParams	(	SCR_ContentBrowser_AddonsSubMenu	subMenu,
		bool	defaultValues = `false`
	)

Definition at line 1557 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ SearchItems()

array<ref SCR_WorkshopItem> SearchItems	(	array< ref SCR_WorkshopItem >	items,
		string	searchStr
	)

Definition at line 768 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ SelectItemsAtPage()

protected array<ref SCR_WorkshopItem> SelectItemsAtPage	(	array< ref SCR_WorkshopItem >	items,
		int	pageId
	)

Returns array of items within specified page, page ID starting from 0.

Definition at line 1188 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ SetFilterConfiguration_EnabledAddons()

void SetFilterConfiguration_EnabledAddons ( )

Sets filters to mode which lists only 'enabled' addons. Only works for offline tab.

Definition at line 108 of file SCR_ContentBrowser_AddonsSubMenu.c.

◆ SetPanelsMode()

void SetPanelsMode	(	bool	showEmptyPanel,
		bool	forceFiltersList = `false`,
		string	messagePresetTag = `string.Empty`,
		bool	animateFiltersList = `false`
	)