Serverlistingscreen

Based on game build 714014 | Last updated: 2026-03-09

Overview

The ServerListingScreen is a screen component responsible for displaying a list of available servers (both online and LAN), applying dynamic filters (intention, game mode, player count, version, etc.), sorting entries, and enabling server selection for joining, details viewing, or reporting. It integrates with TheNet for server discovery and listing management, TheFrontEnd for UI transitions and focus navigation, and persists user-selected filters using the profile system. The screen manages server metadata decoding, tab switching, periodic listing refresh, double-click joining, and modal overlays for world data, player lists, mods, and group profiles.

Usage example

local ServerListingScreen = require("screens/serverlistingscreen")
local screen = ServerListingScreen(
    TheNet:GetSessionMapping(),
    TheNet:GetServerListings(),
    function(filters)
        -- Called on cancel; filters contain current filter state
        print("Cancelled with filters:", Dump(filters))
    end,
    false -- offlineMode
)
TheFrontEnd:PushScreen(screen)

Dependencies & tags

Components used: None directly — this is a UI screen class, not a component attached to entities.

Tags: None

External modules and globals used:

TheNet — server listing, search, details download, reporting, disconnect, version check
TheFrontEnd — screen management, fading, sound, focus, mouse tracking
TheInput — input control handling, controller detection
Profile — filter persistence (GetValue, SetValue, SaveFilters)
STRINGS.UI.SERVERLISTINGSCREEN.* — localized UI strings
STRINGS.UI.HELP.* — help text strings
BRANCH — global branch identifier for version filter toggling
APP_VERSION — server version comparison
INTENTIONS, BETA_INFO, DST_CHARACTERLIST, MODCHARACTERLIST, GetGameModesSpinnerData, GetGameModeString, GetGameModeDescriptionString
TEMPLATES.* — reusable UI templates (IconButton, TabButton, NavBarButton, ServerDetailIcon, BackButton)
Resolutions (RESOLUTION_X, RESOLUTION_Y) — layout offsets
TUNING.MAX_SERVER_SIZE — maximum player count spinner limit
RunInSandboxSafe, CompareTable, subfmt, GetStaticTime, table.contains, stringidsorter — utility functions

Properties

Property	Type	Default Value	Description
`server_intention`	`{ data: string, button: widget }`	`{}`	Stores current server intention and reference to intention button
`prev_screen`	`screen?`	`nil`	Reference to the screen that opened this one
`session_mapping`	`table`	`nil`	Session-to-server-ID mapping from `TheNet`
`cb`	`function(filters: table)`	`nil`	Callback invoked on screen close/cancel
`offlinemode`	`boolean`	`false`	Indicates if offline mode is active
`tickperiod`	`number`	`0.5`	Refresh interval in seconds for periodic updates
`task`	`task?`	`nil`	Handle to the periodic refresh task
`unjoinable_servers`	`number`	`0`	Count of servers filtered out by hard filters
`root`	`widget`	`nil`	Root scaling widget (`scaleroot`)
`view_online`	`boolean`	`true`	Current tab mode (`true`: online, `false`: LAN)
`menu_bg`, `server_list_frame`, `server_list`, etc.	`widget`	`nil`	UI hierarchy widgets
`intentions_overlay`	`IntentionPicker`	`nil`	Overlay widget for intention selection
`nav_bar`	`NavBarWithScreenTitle`	`nil`	Navigation bar with title
`table`	`widget`	`nil`	Main container table widget
`sort_ascending`	`boolean?`	`nil`	Current sort direction (`true`: ascending)
`sort_column`	`string?`	`nil`	Current sort column (`"NAME"`, `"DETAILS"`, `"PLAYERS"`, `"PING"`)
`selected_index_actual`	`number`	`-1`	Index into `TheNet` server list (0-based or `nil`)
`selected_server`	`table?`	`nil`	Server listing table of the currently selected server
`list_widgets`	`{ widget }`	`{}`	List of row widgets for visible server entries
`view_offset`	`number`	`0`	Scroll offset for server list
`viewed_servers`	`{ table }`	`{}`	Filtered and sorted list of servers currently displayed
`servers`	`{ table }`	`{}`	Raw server list from `TheNet` (before filtering)
`filters`	`{ [string]: any }`	`{}`	Cache of active filter values
`sessions`	`{ [string]: any? }`	`{}`	Cache of decoded player/session data

Main functions

`GetBetaInfoId(tags)`

Description: Finds the index of a server's beta version in BETA_INFO by checking if tags contains a known server tag.
Parameters: tags — space-separated string of server tags.
Returns: i — 1-based index if found, else 0.
Error states: None.