Workshop sub menu for displaying page of saves. More...

Inheritance diagram for SCR_ContentBrowser_SavesSubMenu:

Protected Member Functions
override void	InitWorkshopApi ()

override void	PackTagFilterData (SCR_ContentBrowser_GetAssetListParams params, bool defaultValues)

override void	RequestOnlinePage (int pageId)
	Requests a filtered page from backend to get the actual items to display.

override void	OnTileClick (SCR_ScriptedWidgetComponent baseComp)

void	OnSaveItemDeleted (WorkshopItem item)

void	OnDetailsMenuClosed ()

Protected Member Functions inherited from SCR_ContentBrowser_AddonsSubMenu
void	InitWidgets ()

void	InitWidgetEventHandlers ()

void	InitWorkshopApi ()

void	RequestPage (int pageId)

void	RequestOnlinePageUnfiltered (int pageId)
	Requests an unfiltered page from backend to get the total number of items.

void	RequestOnlinePage (int pageId)
	Requests a filtered page from backend to get the actual items to display.

void	PageRequestCallbackCleanup (SCR_WorkshopApiCallback_RequestPage callback)

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

void	DisplayOfflineItems (int pageId)

void	GridScreen_Init ()

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

void	GridScreen_DisplayItems (array< ref SCR_WorkshopItem > items)

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

void	UpdateItemsFoundMessage (int current, int total)

SCR_WorkshopItem	GetSelectedItem ()
	Returns currently selected workshop item.

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

void	UpdateNavigationButtons ()

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

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

void	SwitchFocus (SCR_EListMenuWidgetFocus focus)
	Switch focus.

void	OnInputDeviceUserChanged (EInputDeviceType oldDevice, EInputDeviceType newDevice)

void	OnConnected ()

void	OnTileClick (SCR_ScriptedWidgetComponent baseComp)

void	OnTileFocus (ScriptedWidgetComponent comp)

void	OnTileFocusLost (ScriptedWidgetComponent comp)

void	OnTileStateChange (ScriptedWidgetComponent comp)

void	OnFilterPanelToggled (bool shown)

void	OnInputAction (string name, float multiplier)

void	OnFilterButton (SCR_ButtonBaseComponent comp)

void	OnPrimaryButton (SCR_ButtonBaseComponent comp)

void	ExecuteItemPrimaryAction ()

void	OnEnableButton (SCR_ButtonBaseComponent comp)

void	SetItemEnabled ()

void	OnFavouriteButton (SCR_ButtonBaseComponent comp)

void	SetItemFavorite ()

void	OnDetailsButton (SCR_ButtonBaseComponent comp)

void	OpenItemDetails ()

void	Callback_OnRequestPageGetAllAssets (SCR_WorkshopApiCallback_RequestPage callback)

void	Callback_OnRequestPageGetAssets (SCR_WorkshopApiCallback_RequestPage callback)

void	Callback_OnRequestPageTimeout (SCR_WorkshopApiCallback_RequestPage callback)

void	Callback_OnRequestPageTimeout_OnCloseDialog ()

void	Callback_OnRequestPageTimeout_OnDialogTryAgain ()

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

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

void	OnPrevPageButton ()

void	OnNextPageButton ()

void	OnScrollPage (string name)

void	OnMouseWheelSoundCooldownEnd ()

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

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

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

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

array< ref SCR_WorkshopItem >	Filter_OfflineFilterAndSearch (array< ref SCR_WorkshopItem > itemsIn)
	Filters the array according to currently selected filters.

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)

void	PackSortingData (SCR_ContentBrowser_GetAssetListParams params)
	Pack filter sorting settings - order type, dirrection.

void	PackQuickFilterData (SCR_ContentBrowser_GetAssetListParams params, bool defaultValues)

void	PackTagFilterData (SCR_ContentBrowser_GetAssetListParams params, bool defaultValues)

Protected Member Functions inherited from SCR_SubMenuBase
void	ShowNavigationButtons (bool show)

void	FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show)

void	SetNavigationButtonVisibile (SCR_InputButtonComponent button, bool show, bool animate=false)

SCR_InputButtonComponent	CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true)

void	RequestCloseMenu ()

void	RequestTabChange (int newTabIndex)

Protected Attributes
int	m_iSavesPageCount

ref SCR_BackendCallback	m_SavePageLoadCallback = new SCR_BackendCallback()

SCR_ContentBrowserDetails_SaveOverviewSubMenu	m_OpenedSaveDetOverview

Protected Attributes inherited from SCR_ContentBrowser_AddonsSubMenu
EContentBrowserAddonsSubMenuMode	m_eMode

string	m_sOnlinePageType

string	m_sScrollWheelPageTurningSound

ref SCR_ContentBrowser_AddonsSubMenuBaseWidgets	m_Widgets = new SCR_ContentBrowser_AddonsSubMenuBaseWidgets()

SCR_MenuActionsComponent	m_MenuActionsComponent

WorkshopApi	m_WorkshopApi

ref SCR_WorkshopDownloadSequence	m_DownloadRequest

ref array< SCR_ContentBrowserTileComponent >	m_aTileComponents = {}

bool	m_bConnected

bool	m_bFailToLoad

bool	m_bClearCacheAtNextRequest

ref array< ref SCR_WorkshopItem >	m_aExternalItems = {}

SCR_ContentBrowserTileComponent	m_LastFocusedTile

ref SCR_ContentBrowser_GetAssetListParams	m_GetAssetListParams

ref SCR_ContentBrowser_GetAssetListParams	m_GetAssetListParamsDefault

bool	m_bFirstPage = true

bool	m_bPanelsModeEmpty

bool	m_bMousePageUsed

bool	m_bFirstLoad = true

int	m_iCurrentPage

int	m_iPageCount

SCR_InputButtonComponent	m_NavDetails

SCR_InputButtonComponent	m_NavPrimary

SCR_InputButtonComponent	m_NavEnable

SCR_InputButtonComponent	m_NavFavourite

SCR_InputButtonComponent	m_NavFilter

SCR_EListMenuWidgetFocus	m_eFocusedWidgetState

int	m_iItemsTotal

int	m_iOnlineFilteredItems

ref array< ref SCR_WorkshopApiCallback_RequestPage >	m_aSearchCallbacks = {}

bool	m_bCanPlayMouseWheelSound = true

Protected Attributes inherited from SCR_SubMenuBase
ResourceName	m_sNavigationButtonLayout

SCR_DynamicFooterComponent	m_DynamicFooter

ref array< SCR_InputButtonComponent >	m_aNavigationButtons = {}

ref map< SCR_InputButtonComponent, bool >	m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()

Widget	m_wMenuRoot

int	m_iIndex

bool	m_bShown

bool	m_bFocused

ref ScriptInvokerVoid	m_OnRequestCloseMenu

ref ScriptInvokerInt2	m_OnRequestTabChange

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Public Member Functions inherited from SCR_ContentBrowser_AddonsSubMenu
override void	OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)

override void	OnTabShow ()

override void	OnTabHide ()

override void	OnTabRemove ()

override void	OnMenuShow ()

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

override void	OnMenuFocusGained ()

void	PackGetAssetListParams (SCR_ContentBrowser_GetAssetListParams p, bool defaultValues=false)
	Called from OnPack of a Json API Struct.

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

Public Member Functions inherited from SCR_SubMenuBase
void	OnMenuFocusGained ()

void	OnMenuFocusLost ()

void	OnMenuShow ()

void	OnMenuHide ()

void	OnMenuUpdate (float tDelta)

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

void	OnTabShow ()

void	OnTabHide ()

void	OnTabRemove ()

void	OnTabChange ()

bool	GetShown ()

int	GetIndex ()

ScriptInvokerVoid	GetOnRequestCloseMenu ()

ScriptInvokerInt2	GetOnRequestTabChange ()

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Static Protected Attributes inherited from SCR_ContentBrowser_AddonsSubMenu
const int	GRID_N_COLUMNS = 4

const int	GRID_N_ROWS = 3

const int	LOAD_PAGE_DELAY = 500

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

const string	TEXT_PAGE_INDICATOR = "#AR-Editor_ContentBrowser_PageIndex_Text"

const string	MESSAGE_TAG_NOTHING_FOUND = "nothing_found"

const string	MESSAGE_TAG_NOTHING_DOWNLOADED = "nothing_downloaded"

const string	MESSAGE_TAG_NOTHING_DOWNLOADED_2 = "nothing_downloaded2"

const string	MESSAGE_TAG_ERROR_CONNECTION = "error_connection"

const string	MESSAGE_TAG_LOADING = "loading"

const int	MOUSE_WHEEL_SOUND_COOLDOWN = 75

Detailed Description

Workshop sub menu for displaying page of saves.

!! This is prototype implementation to display saves separatelly. With proper implementation it should be possible to load both mod and save items.

Member Function Documentation

◆ InitWorkshopApi()

override void SCR_ContentBrowser_SavesSubMenu.InitWorkshopApi ( )

protected

Implements SCR_ContentBrowser_AddonsSubMenu.

◆ OnDetailsMenuClosed()

void SCR_ContentBrowser_SavesSubMenu.OnDetailsMenuClosed ( )

protected

◆ OnSaveItemDeleted()

void SCR_ContentBrowser_SavesSubMenu.OnSaveItemDeleted ( WorkshopItem item )

protected

◆ OnTileClick()

override void SCR_ContentBrowser_SavesSubMenu.OnTileClick ( SCR_ScriptedWidgetComponent baseComp )

protected

Implements SCR_ContentBrowser_AddonsSubMenu.

◆ PackTagFilterData()

override void SCR_ContentBrowser_SavesSubMenu.PackTagFilterData	(	SCR_ContentBrowser_GetAssetListParams	params,
		bool	defaultValues
	)

protected

Implements SCR_ContentBrowser_AddonsSubMenu.

◆ RequestOnlinePage()

override void SCR_ContentBrowser_SavesSubMenu.RequestOnlinePage ( int pageId )

protected

Requests a filtered page from backend to get the actual items to display.

Implements SCR_ContentBrowser_AddonsSubMenu.

Member Data Documentation

◆ m_iSavesPageCount

int SCR_ContentBrowser_SavesSubMenu.m_iSavesPageCount

protected

◆ m_OpenedSaveDetOverview

SCR_ContentBrowserDetails_SaveOverviewSubMenu SCR_ContentBrowser_SavesSubMenu.m_OpenedSaveDetOverview

protected

◆ m_SavePageLoadCallback

ref SCR_BackendCallback SCR_ContentBrowser_SavesSubMenu.m_SavePageLoadCallback = new SCR_BackendCallback()

protected

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

Game/UI/Menu/ContentBrowser/MainMenu/SCR_ContentBrowser_SavesSubMenu.c

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ InitWorkshopApi()

◆ OnDetailsMenuClosed()

◆ OnSaveItemDeleted()

◆ OnTileClick()

◆ PackTagFilterData()

◆ RequestOnlinePage()

Member Data Documentation

◆ m_iSavesPageCount

◆ m_OpenedSaveDetOverview

◆ m_SavePageLoadCallback