Class: CServerList

UI binding for CServerList.

Source

C++ class CServerList : CUIWindow

Custom Constructor

CServerList

Remarks

Used by main-menu multiplayer screens. Calls assume the server browser UI is initialized.

Extends

• CUIWindow

Constructors

Constructor

new CServerList(): CServerList;

Create an empty UI window.

Returns

CServerList

Inherited from

CUIWindow.constructor

Methods

AttachChild()

AttachChild(child: CUIWindow): void;

Attach a child window.

Parameters

Parameter	Type	Description
child	CUIWindow	Child window.

Returns

void

Remarks

The Lua binding adopts child; after attachment, treat the parent as owning its lifetime.

Inherited from

CUIWindow.AttachChild

---

ConnectToSelected()

ConnectToSelected(): void;

Connect to the selected server.

Returns

void

Remarks

Requires a selected server row in the current list.

---

DetachChild()

DetachChild(child: CUIWindow): void;

Detach a child window.

Parameters

Parameter	Type	Description
child	CUIWindow	Child window.

Returns

void

Remarks

Detaching removes the parent relation. It does not reinitialize the window or attach it elsewhere.

Inherited from

CUIWindow.DetachChild

---

Enable()

Enable(is_enabled: boolean): void;

Enable or disable interaction.

Parameters

Parameter	Type	Description
is_enabled	boolean	Whether the window should be enabled.

Returns

void

Remarks

Enabled state and visibility are separate. Hidden controls can still be enabled.

Inherited from

CUIWindow.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUIWindow.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

CUIWindow.GetAbsoluteRect

---

GetFont()

GetFont(): CGameFont;

Get the font assigned to this window.

Returns

CGameFont

Font assigned to this window.

Remarks

Text controls need a font assigned before drawing custom text reliably.

Inherited from

CUIWindow.GetFont

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

CUIWindow.GetHeight

---

GetMouseX()

GetMouseX(): number;

Get cursor X coordinate stored on this window.

Returns

number

Current cursor X coordinate.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseX binding.

Inherited from

CUIWindow.GetMouseX

---

GetMouseY()

GetMouseY(): number;

Get cursor Y coordinate stored on this window.

Returns

number

Current cursor Y coordinate.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseY binding.

Inherited from

CUIWindow.GetMouseY

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUIWindow.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUIWindow.GetWndPos

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

CUIWindow.Init

Call Signature

Init(
   x1: number, 
   y1: number, 
   x2: number, 
   y2: number): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
x1	number	X position.
y1	number	Y position.
x2	number	Width.
y2	number	Height.

Returns

void

Remarks

Coordinates are relative to the parent; x2 and y2 are size, not bottom-right coordinates.

Inherited from

CUIWindow.Init

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

Whether the engine owns and deletes this window with its parent.

Inherited from

CUIWindow.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUIWindow.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUIWindow.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

CUIWindow.IsShown

---

NetRadioChanged()

NetRadioChanged(value: boolean): void;

Switch between internet and LAN server sources.

Parameters

Parameter	Type	Description
value	boolean	Whether network radio mode is enabled.

Returns

void

---

RefreshList()

RefreshList(value: boolean): void;

Refresh the server list.

Parameters

Parameter	Type	Description
value	boolean	Whether to force a refresh.

Returns

void

---

RefreshQuick()

RefreshQuick(): void;

Refresh the quick server list view.

Returns

void

---

ResetPPMode()

ResetPPMode(): void;

Disable post-process mode for this window.

Returns

void

Remarks

Pair with CUIWindow.SetPPMode when a window no longer needs post-process rendering.

Inherited from

CUIWindow.ResetPPMode

---

SetAutoDelete()

SetAutoDelete(auto_delete: boolean): void;

Set whether the parent owns this child window.

Parameters

Parameter	Type	Description
auto_delete	boolean	Whether the engine should delete the child automatically.

Returns

void

Remarks

Use this for script-created windows that are attached to a parent and should be cleaned up with the UI tree.

Inherited from

CUIWindow.SetAutoDelete

---

SetConnectionErrCb()

SetConnectionErrCb(cb: connect_error_cb): void;

Set callback for connection errors.

Parameters

Parameter	Type	Description
cb	connect_error_cb	Error callback.

Returns

void

Remarks

Keep the callback object alive for as long as the server list may report connection failures.

---

SetFilters()

SetFilters(filters: SServerFilters): void;

Apply server browser filters.

Parameters

Parameter	Type	Description
filters	SServerFilters	Filter settings.

Returns

void

---

SetFont()

SetFont(font: CGameFont): void;

Set the font used by this window.

Parameters

Parameter	Type	Description
font	CGameFont	Font object.

Returns

void

Inherited from

CUIWindow.SetFont

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

CUIWindow.SetHeight

---

SetPlayerName()

SetPlayerName(name: string): void;

Set the player name used for server browser queries.

Parameters

Parameter	Type	Description
name	string	Player name.

Returns

void

---

SetPPMode()

SetPPMode(): void;

Enable post-process mode for this window.

Returns

void

Remarks

Use for windows meant to be drawn through the post-process UI path, and reset it when the window returns to normal UI rendering.

Inherited from

CUIWindow.SetPPMode

---

SetSortFunc()

SetSortFunc(sort_column: string, ascending: boolean): void;

Set server list sorting.

Parameters

Parameter	Type	Description
sort_column	string	Column or field name to sort by.
ascending	boolean	Whether sorting is ascending.

Returns

void

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUIWindow.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUIWindow.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

CUIWindow.SetWndPos

Call Signature

SetWndPos(x1: number, y1: number): void;

Set window position.

Parameters

Parameter	Type	Description
x1	number	X position.
y1	number	Y position.

Returns

void

Inherited from

CUIWindow.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

CUIWindow.SetWndRect

Call Signature

SetWndRect(
   x1: number, 
   y1: number, 
   x2: number, 
   y2: number): void;

Set window rectangle.

Parameters

Parameter	Type	Description
x1	number	X position.
y1	number	Y position.
x2	number	Width.
y2	number	Height.

Returns

void

Remarks

Coordinates are relative to the parent; x2 and y2 are size, not bottom-right coordinates.

Inherited from

CUIWindow.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

CUIWindow.SetWndSize

Call Signature

SetWndSize(width: number, height: number): void;

Set window size.

Parameters

Parameter	Type	Description
width	number	New width.
height	number	New height.

Returns

void

Inherited from

CUIWindow.SetWndSize

---

Show()

Show(show: boolean): void;

Show or hide the window.

Parameters

Parameter	Type	Description
show	boolean	Whether the window should be visible.

Returns

void

Remarks

Visibility does not attach, detach, enable, or disable the window.

Inherited from

CUIWindow.Show

---

ShowServerInfo()

ShowServerInfo(): void;

Show details for the selected server.

Returns

void

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUIWindow.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUIWindow.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUIWindow.__name

---

ece_unique_nick_expired

readonly static ece_unique_nick_expired: 2;

Engine enum value for CServerList.ece_unique_nick_expired.

---

ece_unique_nick_not_registred

readonly static ece_unique_nick_not_registred: 1;

Engine enum value for CServerList.ece_unique_nick_not_registred.