ServerBrowserMenuUI Interface Reference

Inheritance diagram for ServerBrowserMenuUI:

Public Member Functions
override void	OnMenuOpen ()
	Opening menu - do server browser setup - TODO@wernerjak - cleanup open.
override void	OnMenuOpened ()
override void	OnMenuFocusGained ()
override void	OnMenuClose ()
	Closing menu - clearing server browser data.
override void	OnMenuUpdate (float tDelta)
	Updating menu - continuous menu hanling.
override void	OnMenuShow ()
void	OnActionRefresh ()
	Bind action for refreshing server list.
void	OnActionManualConnect ()
	Bind action for opening dialog with manual connect to ip.
void	OnActionFilter ()
	Bind action for switching to filter component.
void	OnActionBack ()
	Bind action for leaving menu.
void	ActivateFilter (string filterName, bool enabled, bool processFilters=true)
	Find filter by it's internal name define in ServerBrowserFilterSet.conf Set filter enabled.
void	FilterScenarioId (string scenarioId)
void	FilterHostedScenarioModId (string scenarioModId)
void	SetFilteredScenario (MissionWorkshopItem scenario)
void	JoinProcess_Init (Room roomToJoin)
	Initialize joining process to specific room.
Public Member Functions inherited from MenuRootBase
ScriptInvoker	GetOnMenuFocusGained ()
ScriptInvoker	GetOnMenuFocusLost ()
ScriptInvoker	GetOnMenuShow ()
ScriptInvoker	GetOnMenuHide ()
ScriptInvoker	GetOnMenuItem ()
ScriptInvoker	GetOnMenuUpdate ()
ScriptInvoker	GetOnMenuOpen ()
ScriptInvoker	GetOnMenuInit ()
ScriptInvoker	GetOnMenuClose ()
void	OnMenuClosed ()
void	InitChat ()
void	ShowChat ()
MenuRootComponent	GetRootComponent ()
SCR_DynamicFooterComponent	GetFooterComponent ()
override void	OnMenuFocusLost ()
override void	OnMenuHide ()
override void	OnMenuItem (string menuItemName, bool changed, bool finished)
override void	OnMenuInit ()

Static Public Member Functions
static void	OpenWithScenarioFilter (MissionWorkshopItem mission)
	Set to find server by mission workshop item.
static bool	IsServerPingAboveThreshold (Room room)
static void	TryOpenServerBrowser ()
static void	TryOpenServerBrowserWithScenarioFilter (MissionWorkshopItem mission)
Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase	CurrentChimeraMenu ()
static ChimeraMenuBase	GetOwnerMenu (Widget w)
	Returns parent menu of a widget.

Static Public Attributes
const string	TAG_DETAILS_FALLBACK_SEACHING = "Searching"
const string	TAG_DETAILS_FALLBACK_EMPTY = "Empty"
const string	TAG_MESSAGE_SEARCHING = "SEARCHING"
const string	TAG_MESSAGE_CONNECTING = "CONNECTING"
const int	SERVER_LIST_VIEW_SIZE = 32
const int	ROOM_CONTENT_LOAD_DELAY = 500
const int	ROOM_REFRESH_RATE = 10 * 1000
static const int	HIGH_PING_SERVER_THRESHOLD = 200

Protected Member Functions
void	UpdateNavigationButtons ()
void	OnActionTriggered (string action, float multiplier)
void	Refresh ()
void	OnActionFavorite ()
	Action for favoriting server.
void	OnActionDetails ()
	Action for server details.
void	OnServerEntryClickInteraction (float multiplier)
void	OnServerEntryDoubleClick (SCR_ServerBrowserEntryComponent entry)
	Join to the room on double click on server entry.
void	OnEntryMouseButton (string tag)
void	OnJoinButton ()
void	OnServerEntryClick (notnull SCR_ServerBrowserEntryComponent entry)
	Join to the room on double click on server entry.
void	WaitingForRunningBackend ()
	Start looking for servers once backend is runnig.
bool	IsBackendReady ()
void	CheckBackendState ()
void	ShowTimeoutDialog ()
void	ConnectionTimeout ()
	Fail wating for backend if takes too long.
void	OnConnectionTimeoutDialogConfirm ()
void	ClearConnectionTimeoutWaiting ()
void	OnRoomsFound (array< Room > rooms=null)
	Call this on receiving filtered rooms from search Setting up server list.
void	DisplayRooms (array< Room > rooms=null)
void	OnRoomAutoRefresh (ServerBrowserCallback callback)
	Call this once new room data are fetched.
void	SearchRooms ()
void	OnSearchAllRoomsSuccess (ServerBrowserCallback callback)
void	OnSearchAllRoomsFail (ServerBrowserCallback callback, int code, int restCode, int apiCode)
void	OnSearchAllRoomsTimeOut ()
void	OnSearchAllRooms ()
void	SearchRoomsFiltered ()
void	OnSearchRoomsSuccess (ServerBrowserCallback callback)
void	OnSearchRoomsFail (ServerBrowserCallback callback, int code, int restCode, int apiCode)
void	OnSearchRoomsTimeOut ()
void	SetupParams (ClientLobbyApi lobby)
	Restore filtering parameters in UI.
void	SetupFilteringUI (FilteredServerParams filterParams)
	Apply filter setup on each ui filtering widget - restoring filter UI states.
void	SetupCallbacks ()
	General callbacks setup.
void	OnServerEntryFocusEnter (SCR_ScriptedWidgetComponent entry)
void	OnServerEntryFocusLeave (SCR_ScriptedWidgetComponent entry)
void	OnEntryMouseClick (SCR_ScriptedWidgetComponent button)
void	ReceiveRoomContent (notnull Room room, bool receiveMods)
void	ReceiveRoomContent_Scenario (Room room)
	Separated receive scenario data for server Call this later if scenario is from mod to prevent too many request.
void	ReceiveRoomContent_Mods (Room room)
	Separeted receive mods data for server Call this later to prevent too many request.
void	SetupHandlers ()
	Getting reference for all server widget elements.
void	FilterCrossplayCheck ()
	Init behavior when filter panel script is attached If crossplay is enabled we show all servers so both filters are by default disabled If crossplay is disabled we show only servers with crossplay disabled by force.
void	SwitchFocus (SCR_EListMenuWidgetFocus focus, bool force=false)
	Switch focus.
void	ActivateFiltersFromList ()
void	FocusWidget (Widget w)
	Separated focus function for later call.
void	CallOnServerListSetPage (int page)
void	Messages_ShowMessage (string messageTag, bool showWrap=false)
	Show message feedback by selected message component showWrap = true will hide server list and display message on full layout.
void	Messages_Hide ()
	Hide both message widgets.
void	OnOpeningByLoadComponent (int menuPreset)
	Call this when server browser is open by loading component Start waiting for backend.
void	OnChangeSort (SCR_SortHeaderComponent sortHeader)
	Set focus to last filtering element.
void	OnTabViewSwitch (SCR_TabViewComponent tabView, Widget w, int id)
	Set tab filters on switching tab view.
void	OnFilterPanelToggle (bool show)
void	OnChangeFilter (SCR_FilterEntry filter)
	Call this when any of filter in filter panel is changed Get last updated filter and set it up for next search.
void	OnScrollResponse (SCR_BackendCallback callback)
	Call this when scroll returns server response to handle actions.
void	OnScrollSuccess (SCR_BackendCallback callback)
void	OnServerListSetPage (int page)
	Call this actions when server list page is changed.
void	OnSearchEditBoxConfirm (SCR_EditBoxComponent editBox, string sInput)
	Fetch new servers on confirming search string.
void	OnRoomEntrySetFavorite (SCR_ListMenuEntryComponent entry, bool favorite)
	Favoriting server.
void	OnRoomSetFavoriteResponse (SCR_RoomCallback callback)
void	DisplayFavoriteAction (bool isFavorite)
	Based on given boolean favorite nav button is displaying eather add or remove favorite.
void	OnLastRoomReconnectConfirm ()
	Confirm action to find new server.
void	OnLoadingScenario (Room room)
	Setting server details Call this when room receive scenario data.
void	OnRejoinCancel ()
	Call this on rejoin dialog cancel.
bool	CanJoinRoom (Room room)
	Check if is possible to attempt to join room Returns true if room version and platform match to client.
bool	ClientRoomVersionMatch (Room room)
SCR_ServerBrowserEntryComponent	GetEntryUnderCursor ()
SCR_ServerBrowserEntryComponent	GetSelectedEntry ()
void	ClearScenarioFilters ()
void	SetMenuHeader (string header)
void	JoinActions_Join ()
	Action for joining to selected server.
void	JoinActions_DirectJoin (string params, EDirectJoinFormats format, bool publicNetwork)
void	JoinProcess_FindRoom (string params, EDirectJoinFormats format, bool publicNetwork)
	Initialize joining process to specific room.
void	JoinProcess_OnFindRoomSuccess (ServerBrowserCallback callback)
	Call this when room is found.
void	JoinProcess_OnFindRoomFail (ServerBrowserCallback callback, int code, int restCode, int apiCode)
	Call this if room wasn't found because of error or time out.
void	JoinProcess_OnFindRoomTimeout (ServerBrowserCallback callback)
	Call this if joining to room has timeout.
void	JoinProcess_CleanFindCallback ()
void	JoinProcess_FindRoomById (string id, ServerBrowserCallback callback)
	Specific call for id search.
void	JoinProcess_OnFindRoomByIdResponse (ServerBrowserCallback callback)
	Reaction for rooms found by id response.
void	JoinProcess_CheckVersion ()
	Check if client and room versions match Progress only if versions are matching, otherwise show error and stop progress.
void	JoinProcess_CheckHighPing ()
	Display a warning dialog if the player chose to join a server with high ping.
void	OnHighPingServerWarningDialogConfirm ()
void	JoinProcess_CheckRoomPasswordProtected ()
	Check if room requires password to join.
void	OnRejoinAuthorizationFailed (string message)
void	JoinProcess_PasswordDialogOpen ()
void	OnPasswordVerified ()
	On successfull room password verification continue to cotent handling.
void	OnPasswordFailVerification (string message)
	On room password verication fail restart attemp.
void	JoinProcess_PasswordClearInvokers ()
void	JoinProcess_CheckBlockedPlayers ()
void	JoinProcess_OnCheckedBlockedPlayersInRoom (Room checkedRoom, array< BlockedRoomPlayer > blockedPlayers)
void	JoinProcess_ShowJoinDetailsDialog ()
void	CreateServerDetailsDialog ()
void	OnServerDetailModsLoaded (Room room)
	Call this to fill details mods list.
void	OnServerDetailsClosed (SCR_ConfigurableDialogUi dialog)
void	JoinProcess_LoadModContent ()
	Load data about room mods to check which data is client missing Show state if mods are already loaded or wait for receiving mods data.
void	OnLoadingDependencyList (Room room)
	Call this when mods list is received.
void	OnModListFailDialogClose (SCR_ConfigurableDialogUi dialog)
void	Platform_OnUgcPrivilegeResult (bool result)
void	JoinProcess_LoadModContentVisualize ()
void	JoinProcess_OnModCheckFailed ()
void	OnModListFail ()
	Call this when mods loading got error Show mods loading fail message.
void	OnDependenciesLoadingPrevented (array< ref SCR_WorkshopItem > dependencies)
void	JoinProcess_CheckModContent (Room room)
	Check state of room required mods on client Stop progess if room mods are restricted.
void	JoinProcess_CheckUnrelatedDownloads ()
	Display a warning dialog if there are unrelated downloads running, as these will be stopped.
void	JoinProcess_DisplayUnrelatedDownloadsWarning ()
void	JoinProcess_StopDownloadingUnrelatedMods ()
void	JoinProcess_CheckUnrelatedDownloadsCanceling ()
void	JoinProcess_CheckRequiredDownloads ()
void	JoinProcess_DownloadRequiredMods ()
void	OnDownloadRequiredModsCancel ()
void	JoinProcess_PrepareFinalJoinRequest (Room roomToJoin)
void	JoinProcess_WaitToCheckRunningDownloads ()
void	JoinProcess_CheckRunningDownloads ()
	Final step: display a warning dialog if there are still downloads running, as these will be stopped (at this point, this should not happen)
void	OnInterruptDownloadConfirm ()
void	JoinProcess_Join ()
void	JoinProcess_OnJoinSuccess (ServerBrowserCallback callback)
	Call this if joining to room was successful Connect to the server.
void	JoinProcess_OnJoinTimeout (ServerBrowserCallback callback)
	Call this if joining to room has timeout.
void	JoinProcess_OnJoinFail (ServerBrowserCallback callback, int code, int restCode, int apiCode)
void	JoinProcess_LeaveJoinQueue ()
void	JoinProcess_OnQueueJoinFail (ServerBrowserCallback callback, int code, int restCode, int apiCode)
void	JoinProcess_Clear ()
	Call this to kill joining process at any stage.
void	SetupJoinDialogs ()
	Open joining dialog in default state.
void	NegotiateMPPrivilegeAsync ()
	Attempt to allow MP privilege.
void	OnMPPrivilegeResult (UserPrivilege privilege, UserPrivilegeResult result)
void	OnCrossPlayPrivilegeResult (UserPrivilege privilege, UserPrivilegeResult result)
void	PrintDebug (string msg, string functionName=string.Empty)
	Custom debug print displayed with -scrDefine=SB_DEBUG argument.

Static Protected Member Functions
static void	ServerBrowserOnPrivilegeResult (UserPrivilege privilege, UserPrivilegeResult result)

Protected Attributes
bool	m_bHostedServers
ref ServerBrowserMenuWidgets	m_Widgets = new ServerBrowserMenuWidgets()
SCR_ServerBrowserEntryComponent	m_SelectedServerEntry
SCR_TabViewComponent	m_TabView
SCR_FilterPanelComponent	m_FilterPanel
SCR_PooledServerListComponent	m_ScrollableList
SCR_ServerScenarioDetailsPanelComponent	m_ServerScenarioDetails
SCR_EListMenuWidgetFocus	m_eFocusedWidgetState = SCR_EListMenuWidgetFocus.LIST
bool	m_bQuickJoin = true
ref array< Room >	m_aRooms = {}
ref array< Room >	m_aDirectFoundRooms = {}
ClientLobbyApi	m_Lobby
SCR_ConfigurableDialogUi	m_ModListFailDialog
ref SCR_ScriptPlatformRequestCallback	m_CallbackGetPrivilege
ref ServerBrowserCallback	m_CallbackLastSearch
ref SCR_BackendCallback	m_CallbackScroll = new SCR_BackendCallback()
ref SCR_RoomCallback	m_CallbackFavorite = new SCR_RoomCallback()
ref OnDirectJoinCallback	m_CallbackSearchTarget = new OnDirectJoinCallback()
ref ServerBrowserCallback	m_CallbackAutoRefresh = new ServerBrowserCallback()
bool	m_bFirstRoomLoad = true
bool	m_bForceUnfilteredRequest
int	m_iTotalNumberOfRooms
ref SCR_RoomModsManager	m_ModsManager = new SCR_RoomModsManager()
ref SCR_ServerBrowserDialogManager	m_Dialogs = new SCR_ServerBrowserDialogManager()
ref SCR_RoomPasswordVerification	m_PasswordVerification = new SCR_RoomPasswordVerification()
ref ServerBrowserCallback	m_CallbackJoin
ref ServerBrowserCallback	m_CallbackQueue
ref RoomJoinData	m_JoinData = new RoomJoinData()
ref FilteredServerParams	m_ParamsFilter = new FilteredServerParams()
ref FilteredServerParams	m_DirectJoinParams
ref array< ref SCR_WorkshopItem >	m_aRequiredMods = {}
ref array< ref SCR_WorkshopItemActionDownload >	m_aUnrelatedDownloads = {}
SCR_SimpleMessageComponent	m_SimpleMessageWrap
SCR_SimpleMessageComponent	m_SimpleMessageList
bool	m_bIsWaitingForBackend = true
ref ServerBrowserCallback	m_CallbackSearchPreviousRoom = new ServerBrowserCallback()
ref SCR_GetRoomsIds	m_SearchIds = new SCR_GetRoomsIds()
ref array< ref SCR_FilterEntry >	m_aFiltersToSelect = {}
ref ScriptInvokerVoid	m_OnFavoritesResponse = new ScriptInvokerVoid()
EInputDeviceType	m_eLastInputType
bool	m_bWasEntrySelected
SCR_ServerBrowserEntryComponent	m_ClickedEntry
SCR_MenuActionsComponent	m_ActionsComponent
Room	m_JoinProcessTargetRoom
Room	m_RejoinRoom
Protected Attributes inherited from MenuRootBase
MenuRootComponent	m_MenuRootComponent
ref ScriptInvoker	m_EventOnMenuFocusGained
ref ScriptInvoker	m_EventOnMenuFocusLost
ref ScriptInvoker	m_EventOnMenuShow
ref ScriptInvoker	m_EventOnMenuHide
ref ScriptInvoker	m_EventOnMenuItem
ref ScriptInvoker	m_EventOnMenuUpdate
ref ScriptInvoker	m_EventOnMenuOpen
ref ScriptInvoker	m_EventOnMenuInit
ref ScriptInvoker	m_EventOnMenuClose
SCR_ChatPanel	m_ChatPanel
SCR_DynamicFooterComponent	m_DynamicFooter
Protected Attributes inherited from ChimeraMenuBase
bool	m_bTextEditActive = false

Static Protected Attributes
static ref SCR_ScriptPlatformRequestCallback	m_CallbackGetMPPrivilege
static MissionWorkshopItem	m_MissionToFilter
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

Additional Inherited Members
Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker	m_OnTextEditContextChange = new ScriptInvoker
ref ScriptInvoker	m_OnUpdate = new ScriptInvoker

Member Function Documentation

ActivateFilter()

void ServerBrowserMenuUI.ActivateFilter	(	string	filterName,
		bool	enabled,
		bool	processFilters = true )

Find filter by it's internal name define in ServerBrowserFilterSet.conf Set filter enabled.

ActivateFiltersFromList()

void ServerBrowserMenuUI.ActivateFiltersFromList ( )

protected

CallOnServerListSetPage()

void ServerBrowserMenuUI.CallOnServerListSetPage ( int page )

protected

CanJoinRoom()

bool ServerBrowserMenuUI.CanJoinRoom ( Room room )

protected

Check if is possible to attempt to join room Returns true if room version and platform match to client.

CheckBackendState()

void ServerBrowserMenuUI.CheckBackendState ( )

protected

ClearConnectionTimeoutWaiting()

void ServerBrowserMenuUI.ClearConnectionTimeoutWaiting ( )

protected

ClearScenarioFilters()

void ServerBrowserMenuUI.ClearScenarioFilters ( )

protected

ClientRoomVersionMatch()

bool ServerBrowserMenuUI.ClientRoomVersionMatch ( Room room )

protected

ConnectionTimeout()

void ServerBrowserMenuUI.ConnectionTimeout ( )

protected

Fail wating for backend if takes too long.

CreateServerDetailsDialog()

void ServerBrowserMenuUI.CreateServerDetailsDialog ( )

protected

DisplayFavoriteAction()

void ServerBrowserMenuUI.DisplayFavoriteAction ( bool isFavorite )

protected

Based on given boolean favorite nav button is displaying eather add or remove favorite.

DisplayRooms()

void ServerBrowserMenuUI.DisplayRooms ( array< Room > rooms = null )

protected

FilterCrossplayCheck()

void ServerBrowserMenuUI.FilterCrossplayCheck ( )

protected

Init behavior when filter panel script is attached If crossplay is enabled we show all servers so both filters are by default disabled If crossplay is disabled we show only servers with crossplay disabled by force.

FilterHostedScenarioModId()

void ServerBrowserMenuUI.FilterHostedScenarioModId

(

string

scenarioModId

)

FilterScenarioId()

void ServerBrowserMenuUI.FilterScenarioId

(

string

scenarioId

)

FocusWidget()

void ServerBrowserMenuUI.FocusWidget ( Widget w )

protected

Separated focus function for later call.

GetEntryUnderCursor()

SCR_ServerBrowserEntryComponent ServerBrowserMenuUI.GetEntryUnderCursor ( )

protected

GetSelectedEntry()

SCR_ServerBrowserEntryComponent ServerBrowserMenuUI.GetSelectedEntry ( )

protected

IsBackendReady()

bool ServerBrowserMenuUI.IsBackendReady ( )

protected

IsServerPingAboveThreshold()

static bool ServerBrowserMenuUI.IsServerPingAboveThreshold ( Room room )

static

JoinActions_DirectJoin()

void ServerBrowserMenuUI.JoinActions_DirectJoin ( string params, EDirectJoinFormats format, bool publicNetwork )

protected

JoinActions_Join()

void ServerBrowserMenuUI.JoinActions_Join ( )

protected

Action for joining to selected server.

JoinProcess_CheckBlockedPlayers()

void ServerBrowserMenuUI.JoinProcess_CheckBlockedPlayers ( )

protected

JoinProcess_CheckHighPing()

void ServerBrowserMenuUI.JoinProcess_CheckHighPing ( )

protected

Display a warning dialog if the player chose to join a server with high ping.

JoinProcess_CheckModContent()

void ServerBrowserMenuUI.JoinProcess_CheckModContent ( Room room )

protected

Check state of room required mods on client Stop progess if room mods are restricted.

JoinProcess_CheckRequiredDownloads()

void ServerBrowserMenuUI.JoinProcess_CheckRequiredDownloads ( )

protected

JoinProcess_CheckRoomPasswordProtected()

void ServerBrowserMenuUI.JoinProcess_CheckRoomPasswordProtected ( )

protected

Check if room requires password to join.

JoinProcess_CheckRunningDownloads()

void ServerBrowserMenuUI.JoinProcess_CheckRunningDownloads ( )

protected

Final step: display a warning dialog if there are still downloads running, as these will be stopped (at this point, this should not happen)

JoinProcess_CheckUnrelatedDownloads()

void ServerBrowserMenuUI.JoinProcess_CheckUnrelatedDownloads ( )

protected

Display a warning dialog if there are unrelated downloads running, as these will be stopped.

JoinProcess_CheckUnrelatedDownloadsCanceling()

void ServerBrowserMenuUI.JoinProcess_CheckUnrelatedDownloadsCanceling ( )

protected

JoinProcess_CheckVersion()

void ServerBrowserMenuUI.JoinProcess_CheckVersion ( )

protected

Check if client and room versions match Progress only if versions are matching, otherwise show error and stop progress.

JoinProcess_CleanFindCallback()

void ServerBrowserMenuUI.JoinProcess_CleanFindCallback ( )

protected

JoinProcess_Clear()

void ServerBrowserMenuUI.JoinProcess_Clear ( )

protected

Call this to kill joining process at any stage.

JoinProcess_DisplayUnrelatedDownloadsWarning()

void ServerBrowserMenuUI.JoinProcess_DisplayUnrelatedDownloadsWarning ( )

protected

JoinProcess_DownloadRequiredMods()

void ServerBrowserMenuUI.JoinProcess_DownloadRequiredMods ( )

protected

JoinProcess_FindRoom()

void ServerBrowserMenuUI.JoinProcess_FindRoom ( string params, EDirectJoinFormats format, bool publicNetwork )

protected

Initialize joining process to specific room.

JoinProcess_FindRoomById()

void ServerBrowserMenuUI.JoinProcess_FindRoomById ( string id, ServerBrowserCallback callback )

protected

Specific call for id search.

JoinProcess_Init()

void ServerBrowserMenuUI.JoinProcess_Init

(

Room

roomToJoin

)

Initialize joining process to specific room.

JoinProcess_Join()

void ServerBrowserMenuUI.JoinProcess_Join ( )

protected

JoinProcess_LeaveJoinQueue()

void ServerBrowserMenuUI.JoinProcess_LeaveJoinQueue ( )

protected

JoinProcess_LoadModContent()

void ServerBrowserMenuUI.JoinProcess_LoadModContent ( )

protected

Load data about room mods to check which data is client missing Show state if mods are already loaded or wait for receiving mods data.

JoinProcess_LoadModContentVisualize()

void ServerBrowserMenuUI.JoinProcess_LoadModContentVisualize ( )

protected

JoinProcess_OnCheckedBlockedPlayersInRoom()

void ServerBrowserMenuUI.JoinProcess_OnCheckedBlockedPlayersInRoom ( Room checkedRoom, array< BlockedRoomPlayer > blockedPlayers )

protected

JoinProcess_OnFindRoomByIdResponse()

void ServerBrowserMenuUI.JoinProcess_OnFindRoomByIdResponse ( ServerBrowserCallback callback )

protected

Reaction for rooms found by id response.

JoinProcess_OnFindRoomFail()

void ServerBrowserMenuUI.JoinProcess_OnFindRoomFail ( ServerBrowserCallback callback, int code, int restCode, int apiCode )

protected

Call this if room wasn't found because of error or time out.

JoinProcess_OnFindRoomSuccess()

void ServerBrowserMenuUI.JoinProcess_OnFindRoomSuccess ( ServerBrowserCallback callback )

protected

Call this when room is found.

JoinProcess_OnFindRoomTimeout()

void ServerBrowserMenuUI.JoinProcess_OnFindRoomTimeout ( ServerBrowserCallback callback )

protected

Call this if joining to room has timeout.

JoinProcess_OnJoinFail()

void ServerBrowserMenuUI.JoinProcess_OnJoinFail ( ServerBrowserCallback callback, int code, int restCode, int apiCode )

protected

JoinProcess_OnJoinSuccess()

void ServerBrowserMenuUI.JoinProcess_OnJoinSuccess ( ServerBrowserCallback callback )

protected

Call this if joining to room was successful Connect to the server.

JoinProcess_OnJoinTimeout()

void ServerBrowserMenuUI.JoinProcess_OnJoinTimeout ( ServerBrowserCallback callback )

protected

Call this if joining to room has timeout.

JoinProcess_OnModCheckFailed()

void ServerBrowserMenuUI.JoinProcess_OnModCheckFailed ( )

protected

JoinProcess_OnQueueJoinFail()

void ServerBrowserMenuUI.JoinProcess_OnQueueJoinFail ( ServerBrowserCallback callback, int code, int restCode, int apiCode )

protected

JoinProcess_PasswordClearInvokers()

void ServerBrowserMenuUI.JoinProcess_PasswordClearInvokers ( )

protected

JoinProcess_PasswordDialogOpen()

void ServerBrowserMenuUI.JoinProcess_PasswordDialogOpen ( )

protected

JoinProcess_PrepareFinalJoinRequest()

void ServerBrowserMenuUI.JoinProcess_PrepareFinalJoinRequest ( Room roomToJoin )

protected

JoinProcess_ShowJoinDetailsDialog()

void ServerBrowserMenuUI.JoinProcess_ShowJoinDetailsDialog ( )

protected

JoinProcess_StopDownloadingUnrelatedMods()

void ServerBrowserMenuUI.JoinProcess_StopDownloadingUnrelatedMods ( )

protected

JoinProcess_WaitToCheckRunningDownloads()

void ServerBrowserMenuUI.JoinProcess_WaitToCheckRunningDownloads ( )

protected

Messages_Hide()

void ServerBrowserMenuUI.Messages_Hide ( )

protected

Hide both message widgets.

Messages_ShowMessage()

void ServerBrowserMenuUI.Messages_ShowMessage ( string messageTag, bool showWrap = false )

protected

Show message feedback by selected message component showWrap = true will hide server list and display message on full layout.

NegotiateMPPrivilegeAsync()

void ServerBrowserMenuUI.NegotiateMPPrivilegeAsync ( )

protected

Attempt to allow MP privilege.

OnActionBack()

void ServerBrowserMenuUI.OnActionBack

(

)

Bind action for leaving menu.

OnActionDetails()

void ServerBrowserMenuUI.OnActionDetails ( )

protected

Action for server details.

OnActionFavorite()

void ServerBrowserMenuUI.OnActionFavorite ( )

protected

Action for favoriting server.

OnActionFilter()

void ServerBrowserMenuUI.OnActionFilter

(

)

Bind action for switching to filter component.

OnActionManualConnect()

void ServerBrowserMenuUI.OnActionManualConnect

(

)

Bind action for opening dialog with manual connect to ip.

OnActionRefresh()

void ServerBrowserMenuUI.OnActionRefresh

(

)

Bind action for refreshing server list.

OnActionTriggered()

void ServerBrowserMenuUI.OnActionTriggered ( string action, float multiplier )

protected

TODO: Why are these being triggered twice?

Proceed only if using mouse, the navigation buttons will take care of the interactions with keyboard or gamepad

OnChangeFilter()

void ServerBrowserMenuUI.OnChangeFilter ( SCR_FilterEntry filter )

protected

Call this when any of filter in filter panel is changed Get last updated filter and set it up for next search.

OnChangeSort()

void ServerBrowserMenuUI.OnChangeSort ( SCR_SortHeaderComponent sortHeader )

protected

Set focus to last filtering element.

OnConnectionTimeoutDialogConfirm()

void ServerBrowserMenuUI.OnConnectionTimeoutDialogConfirm ( )

protected

OnCrossPlayPrivilegeResult()

void ServerBrowserMenuUI.OnCrossPlayPrivilegeResult ( UserPrivilege privilege, UserPrivilegeResult result )

protected

OnDependenciesLoadingPrevented()

void ServerBrowserMenuUI.OnDependenciesLoadingPrevented ( array< ref SCR_WorkshopItem > dependencies )

protected

OnDownloadRequiredModsCancel()

void ServerBrowserMenuUI.OnDownloadRequiredModsCancel ( )

protected

OnEntryMouseButton()

void ServerBrowserMenuUI.OnEntryMouseButton ( string tag )

protected

OnEntryMouseClick()

void ServerBrowserMenuUI.OnEntryMouseClick ( SCR_ScriptedWidgetComponent button )

protected

OnFilterPanelToggle()

void ServerBrowserMenuUI.OnFilterPanelToggle ( bool show )

protected

OnHighPingServerWarningDialogConfirm()

void ServerBrowserMenuUI.OnHighPingServerWarningDialogConfirm ( )

protected

OnInterruptDownloadConfirm()

void ServerBrowserMenuUI.OnInterruptDownloadConfirm ( )

protected

OnJoinButton()

void ServerBrowserMenuUI.OnJoinButton ( )

protected

OnLastRoomReconnectConfirm()

void ServerBrowserMenuUI.OnLastRoomReconnectConfirm ( )

protected

Confirm action to find new server.

OnLoadingDependencyList()

void ServerBrowserMenuUI.OnLoadingDependencyList ( Room room )

protected

Call this when mods list is received.

OnLoadingScenario()

void ServerBrowserMenuUI.OnLoadingScenario ( Room room )

protected

Setting server details Call this when room receive scenario data.

Update Details Dialog

OnMenuClose()

override void ServerBrowserMenuUI.OnMenuClose

(

)

Closing menu - clearing server browser data.

Implements MenuRootBase.

OnMenuFocusGained()

override void ServerBrowserMenuUI.OnMenuFocusGained

(

)

Implements MenuRootBase.

OnMenuOpen()

override void ServerBrowserMenuUI.OnMenuOpen

(

)

Opening menu - do server browser setup - TODO@wernerjak - cleanup open.

Implements MenuRootBase.

OnMenuOpened()

override void ServerBrowserMenuUI.OnMenuOpened

(

)

Implements ChimeraMenuBase.

OnMenuShow()

override void ServerBrowserMenuUI.OnMenuShow

(

)

Implements MenuRootBase.

OnMenuUpdate()

override void ServerBrowserMenuUI.OnMenuUpdate

(

float

tDelta

)

Updating menu - continuous menu hanling.

Update Entry buttons

Implements MenuRootBase.

OnModListFail()

void ServerBrowserMenuUI.OnModListFail ( )

protected

Call this when mods loading got error Show mods loading fail message.

OnModListFailDialogClose()

void ServerBrowserMenuUI.OnModListFailDialogClose ( SCR_ConfigurableDialogUi dialog )

protected

OnMPPrivilegeResult()

void ServerBrowserMenuUI.OnMPPrivilegeResult ( UserPrivilege privilege, UserPrivilegeResult result )

protected

OnOpeningByLoadComponent()

void ServerBrowserMenuUI.OnOpeningByLoadComponent ( int menuPreset )

protected

Call this when server browser is open by loading component Start waiting for backend.

OnPasswordFailVerification()

void ServerBrowserMenuUI.OnPasswordFailVerification ( string message )

protected

On room password verication fail restart attemp.

OnPasswordVerified()

void ServerBrowserMenuUI.OnPasswordVerified ( )

protected

On successfull room password verification continue to cotent handling.

OnRejoinAuthorizationFailed()

void ServerBrowserMenuUI.OnRejoinAuthorizationFailed ( string message )

protected

OnRejoinCancel()

void ServerBrowserMenuUI.OnRejoinCancel ( )

protected

Call this on rejoin dialog cancel.

OnRoomAutoRefresh()

void ServerBrowserMenuUI.OnRoomAutoRefresh ( ServerBrowserCallback callback )

protected

Call this once new room data are fetched.

OnRoomEntrySetFavorite()

void ServerBrowserMenuUI.OnRoomEntrySetFavorite ( SCR_ListMenuEntryComponent entry, bool favorite )

protected

Favoriting server.

OnRoomSetFavoriteResponse()

void ServerBrowserMenuUI.OnRoomSetFavoriteResponse ( SCR_RoomCallback callback )

protected

OnRoomsFound()

void ServerBrowserMenuUI.OnRoomsFound ( array< Room > rooms = null )

protected

Call this on receiving filtered rooms from search Setting up server list.

OnScrollResponse()

void ServerBrowserMenuUI.OnScrollResponse ( SCR_BackendCallback callback )

protected

Call this when scroll returns server response to handle actions.

OnScrollSuccess()

void ServerBrowserMenuUI.OnScrollSuccess ( SCR_BackendCallback callback )

protected

OnSearchAllRooms()

void ServerBrowserMenuUI.OnSearchAllRooms ( )

protected

OnSearchAllRoomsFail()

void ServerBrowserMenuUI.OnSearchAllRoomsFail ( ServerBrowserCallback callback, int code, int restCode, int apiCode )

protected

OnSearchAllRoomsSuccess()

void ServerBrowserMenuUI.OnSearchAllRoomsSuccess ( ServerBrowserCallback callback )

protected

OnSearchAllRoomsTimeOut()

void ServerBrowserMenuUI.OnSearchAllRoomsTimeOut ( )

protected

OnSearchEditBoxConfirm()

void ServerBrowserMenuUI.OnSearchEditBoxConfirm ( SCR_EditBoxComponent editBox, string sInput )

protected

Fetch new servers on confirming search string.

OnSearchRoomsFail()

void ServerBrowserMenuUI.OnSearchRoomsFail ( ServerBrowserCallback callback, int code, int restCode, int apiCode )

protected

OnSearchRoomsSuccess()

void ServerBrowserMenuUI.OnSearchRoomsSuccess ( ServerBrowserCallback callback )

protected

OnSearchRoomsTimeOut()

void ServerBrowserMenuUI.OnSearchRoomsTimeOut ( )

protected

OnServerDetailModsLoaded()

void ServerBrowserMenuUI.OnServerDetailModsLoaded ( Room room )

protected

Call this to fill details mods list.

OnServerDetailsClosed()

void ServerBrowserMenuUI.OnServerDetailsClosed ( SCR_ConfigurableDialogUi dialog )

protected

OnServerEntryClick()

void ServerBrowserMenuUI.OnServerEntryClick ( notnull SCR_ServerBrowserEntryComponent entry )

protected

Join to the room on double click on server entry.

This means the player moved the mouse to another entry during the small window it takes the component to check for double click... ...so another room got focused, but we want the clicked one to be the focused one

On MOUSE clicking opens the details dialog. On KEYBOARD and GAMEPAD single click is quick join, there's a separate button for details

OnServerEntryClickInteraction()

void ServerBrowserMenuUI.OnServerEntryClickInteraction ( float multiplier )

protected

multiplier value in the action is used to differentiate between single and double click

OnServerEntryDoubleClick()

void ServerBrowserMenuUI.OnServerEntryDoubleClick ( SCR_ServerBrowserEntryComponent entry )

protected

Join to the room on double click on server entry.

OnServerEntryFocusEnter()

void ServerBrowserMenuUI.OnServerEntryFocusEnter ( SCR_ScriptedWidgetComponent entry )

protected

OnServerEntryFocusLeave()

void ServerBrowserMenuUI.OnServerEntryFocusLeave ( SCR_ScriptedWidgetComponent entry )

protected

OnServerListSetPage()

void ServerBrowserMenuUI.OnServerListSetPage ( int page )

protected

Call this actions when server list page is changed.

OnTabViewSwitch()

void ServerBrowserMenuUI.OnTabViewSwitch ( SCR_TabViewComponent tabView, Widget w, int id )

protected

Set tab filters on switching tab view.

OpenWithScenarioFilter()

static void ServerBrowserMenuUI.OpenWithScenarioFilter ( MissionWorkshopItem mission )

static

Set to find server by mission workshop item.

Platform_OnUgcPrivilegeResult()

void ServerBrowserMenuUI.Platform_OnUgcPrivilegeResult ( bool result )

protected

PrintDebug()

void ServerBrowserMenuUI.PrintDebug ( string msg, string functionName = string::Empty )

protected

Custom debug print displayed with -scrDefine=SB_DEBUG argument.

ReceiveRoomContent()

void ServerBrowserMenuUI.ReceiveRoomContent ( notnull Room room, bool receiveMods )

protected

ReceiveRoomContent_Mods()

void ServerBrowserMenuUI.ReceiveRoomContent_Mods ( Room room )

protected

Separeted receive mods data for server Call this later to prevent too many request.

ReceiveRoomContent_Scenario()

void ServerBrowserMenuUI.ReceiveRoomContent_Scenario ( Room room )

protected

Separated receive scenario data for server Call this later if scenario is from mod to prevent too many request.

Refresh()

void ServerBrowserMenuUI.Refresh ( )

protected

SearchRooms()

void ServerBrowserMenuUI.SearchRooms ( )

protected

SearchRoomsFiltered()

void ServerBrowserMenuUI.SearchRoomsFiltered ( )

protected

ServerBrowserOnPrivilegeResult()

static void ServerBrowserMenuUI.ServerBrowserOnPrivilegeResult ( UserPrivilege privilege, UserPrivilegeResult result )

staticprotected

SetFilteredScenario()

void ServerBrowserMenuUI.SetFilteredScenario

(

MissionWorkshopItem

scenario

)

SetMenuHeader()

void ServerBrowserMenuUI.SetMenuHeader ( string header )

protected

SetupCallbacks()

void ServerBrowserMenuUI.SetupCallbacks ( )

protected

General callbacks setup.

SetupFilteringUI()

void ServerBrowserMenuUI.SetupFilteringUI ( FilteredServerParams filterParams )

protected

Apply filter setup on each ui filtering widget - restoring filter UI states.

SetupHandlers()

void ServerBrowserMenuUI.SetupHandlers ( )

protected

Getting reference for all server widget elements.

SetupJoinDialogs()

void ServerBrowserMenuUI.SetupJoinDialogs ( )

protected

Open joining dialog in default state.

SetupParams()

void ServerBrowserMenuUI.SetupParams ( ClientLobbyApi lobby )

protected

Restore filtering parameters in UI.

ShowTimeoutDialog()

void ServerBrowserMenuUI.ShowTimeoutDialog ( )

protected

SwitchFocus()

void ServerBrowserMenuUI.SwitchFocus ( SCR_EListMenuWidgetFocus focus, bool force = false )

protected

Switch focus.

TryOpenServerBrowser()

static void ServerBrowserMenuUI.TryOpenServerBrowser ( )

static

TryOpenServerBrowserWithScenarioFilter()

static void ServerBrowserMenuUI.TryOpenServerBrowserWithScenarioFilter ( MissionWorkshopItem mission )

static

UpdateNavigationButtons()

void ServerBrowserMenuUI.UpdateNavigationButtons ( )

protected

WaitingForRunningBackend()

void ServerBrowserMenuUI.WaitingForRunningBackend ( )

protected

Start looking for servers once backend is runnig.

Member Data Documentation

HIGH_PING_SERVER_THRESHOLD

const int ServerBrowserMenuUI.HIGH_PING_SERVER_THRESHOLD = 200

static

m_ActionsComponent

SCR_MenuActionsComponent ServerBrowserMenuUI.m_ActionsComponent

protected

m_aDirectFoundRooms

ref array<Room> ServerBrowserMenuUI.m_aDirectFoundRooms = {}

protected

m_aFiltersToSelect

ref array<ref SCR_FilterEntry> ServerBrowserMenuUI.m_aFiltersToSelect = {}

protected

m_aRequiredMods

ref array<ref SCR_WorkshopItem> ServerBrowserMenuUI.m_aRequiredMods = {}

protected

m_aRooms

ref array<Room> ServerBrowserMenuUI.m_aRooms = {}

protected

m_aUnrelatedDownloads

ref array<ref SCR_WorkshopItemActionDownload> ServerBrowserMenuUI.m_aUnrelatedDownloads = {}

protected

m_bFirstRoomLoad

bool ServerBrowserMenuUI.m_bFirstRoomLoad = true

protected

m_bForceUnfilteredRequest

bool ServerBrowserMenuUI.m_bForceUnfilteredRequest

protected

m_bHostedServers

bool ServerBrowserMenuUI.m_bHostedServers

protected

m_bIsWaitingForBackend

bool ServerBrowserMenuUI.m_bIsWaitingForBackend = true

protected

m_bQuickJoin

bool ServerBrowserMenuUI.m_bQuickJoin = true

protected

m_bWasEntrySelected

bool ServerBrowserMenuUI.m_bWasEntrySelected

protected

m_CallbackAutoRefresh

ref ServerBrowserCallback ServerBrowserMenuUI.m_CallbackAutoRefresh = new ServerBrowserCallback()

protected

m_CallbackFavorite

ref SCR_RoomCallback ServerBrowserMenuUI.m_CallbackFavorite = new SCR_RoomCallback()

protected

m_CallbackGetMPPrivilege

ref SCR_ScriptPlatformRequestCallback ServerBrowserMenuUI.m_CallbackGetMPPrivilege

staticprotected

m_CallbackGetPrivilege

ref SCR_ScriptPlatformRequestCallback ServerBrowserMenuUI.m_CallbackGetPrivilege

protected

m_CallbackJoin

ref ServerBrowserCallback ServerBrowserMenuUI.m_CallbackJoin

protected

m_CallbackLastSearch

ref ServerBrowserCallback ServerBrowserMenuUI.m_CallbackLastSearch

protected

m_CallbackQueue

ref ServerBrowserCallback ServerBrowserMenuUI.m_CallbackQueue

protected

m_CallbackScroll

ref SCR_BackendCallback ServerBrowserMenuUI.m_CallbackScroll = new SCR_BackendCallback()

protected

m_CallbackSearchPreviousRoom

ref ServerBrowserCallback ServerBrowserMenuUI.m_CallbackSearchPreviousRoom = new ServerBrowserCallback()

protected

m_CallbackSearchTarget

ref OnDirectJoinCallback ServerBrowserMenuUI.m_CallbackSearchTarget = new OnDirectJoinCallback()

protected

m_ClickedEntry

SCR_ServerBrowserEntryComponent ServerBrowserMenuUI.m_ClickedEntry

protected

m_Dialogs

ref SCR_ServerBrowserDialogManager ServerBrowserMenuUI.m_Dialogs = new SCR_ServerBrowserDialogManager()

protected

m_DirectJoinParams

ref FilteredServerParams ServerBrowserMenuUI.m_DirectJoinParams

protected

m_eFocusedWidgetState

SCR_EListMenuWidgetFocus ServerBrowserMenuUI.m_eFocusedWidgetState = SCR_EListMenuWidgetFocus.LIST

protected

m_eLastInputType

EInputDeviceType ServerBrowserMenuUI.m_eLastInputType

protected

m_FilterPanel

SCR_FilterPanelComponent ServerBrowserMenuUI.m_FilterPanel

protected

m_iTotalNumberOfRooms

int ServerBrowserMenuUI.m_iTotalNumberOfRooms

protected

m_JoinData

ref RoomJoinData ServerBrowserMenuUI.m_JoinData = new RoomJoinData()

protected

m_JoinProcessTargetRoom

Room ServerBrowserMenuUI.m_JoinProcessTargetRoom

protected

m_Lobby

ClientLobbyApi ServerBrowserMenuUI.m_Lobby

protected

m_MissionToFilter

MissionWorkshopItem ServerBrowserMenuUI.m_MissionToFilter

staticprotected

m_ModListFailDialog

SCR_ConfigurableDialogUi ServerBrowserMenuUI.m_ModListFailDialog

protected

m_ModsManager

ref SCR_RoomModsManager ServerBrowserMenuUI.m_ModsManager = new SCR_RoomModsManager()

protected

m_OnFavoritesResponse

ref ScriptInvokerVoid ServerBrowserMenuUI.m_OnFavoritesResponse = new ScriptInvokerVoid()

protected

m_ParamsFilter

ref FilteredServerParams ServerBrowserMenuUI.m_ParamsFilter = new FilteredServerParams()

protected

m_PasswordVerification

ref SCR_RoomPasswordVerification ServerBrowserMenuUI.m_PasswordVerification = new SCR_RoomPasswordVerification()

protected

m_RejoinRoom

Room ServerBrowserMenuUI.m_RejoinRoom

protected

m_ScrollableList

SCR_PooledServerListComponent ServerBrowserMenuUI.m_ScrollableList

protected

m_SearchIds

ref SCR_GetRoomsIds ServerBrowserMenuUI.m_SearchIds = new SCR_GetRoomsIds()

protected

m_SelectedServerEntry

SCR_ServerBrowserEntryComponent ServerBrowserMenuUI.m_SelectedServerEntry

protected

m_ServerScenarioDetails

SCR_ServerScenarioDetailsPanelComponent ServerBrowserMenuUI.m_ServerScenarioDetails

protected

m_SimpleMessageList

SCR_SimpleMessageComponent ServerBrowserMenuUI.m_SimpleMessageList

protected

m_SimpleMessageWrap

SCR_SimpleMessageComponent ServerBrowserMenuUI.m_SimpleMessageWrap

protected

m_TabView

SCR_TabViewComponent ServerBrowserMenuUI.m_TabView

protected

m_Widgets

ref ServerBrowserMenuWidgets ServerBrowserMenuUI.m_Widgets = new ServerBrowserMenuWidgets()

protected

ROOM_CONTENT_LOAD_DELAY

const int ServerBrowserMenuUI.ROOM_CONTENT_LOAD_DELAY = 500

static

ROOM_REFRESH_RATE

const int ServerBrowserMenuUI.ROOM_REFRESH_RATE = 10 * 1000

static

SERVER_LIST_VIEW_SIZE

const int ServerBrowserMenuUI.SERVER_LIST_VIEW_SIZE = 32

static

TAG_DETAILS_FALLBACK_EMPTY

const string ServerBrowserMenuUI.TAG_DETAILS_FALLBACK_EMPTY = "Empty"

static

TAG_DETAILS_FALLBACK_SEACHING

const string ServerBrowserMenuUI.TAG_DETAILS_FALLBACK_SEACHING = "Searching"

static

TAG_MESSAGE_CONNECTING

const string ServerBrowserMenuUI.TAG_MESSAGE_CONNECTING = "CONNECTING"

static

TAG_MESSAGE_SEARCHING

const string ServerBrowserMenuUI.TAG_MESSAGE_SEARCHING = "SEARCHING"

static

---

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

• Game/UI/Menu/ServerBrowserMenuUI.c