Class: CUIListBox<T>

UI binding for CUIListBox.

Source

C++ class CUIListBox : CUIScrollView

Custom Constructor

CUIListBox

Remarks

Items added through the script binding are owned by the list. Selection getters can return no item.

Extends

• CUIScrollView

Type Parameters

Type Parameter	Default type
T extends CUIListBoxItem	CUIListBoxItem

Constructors

Constructor

new CUIListBox<T>(): CUIListBox<T>;

Create an empty UI window.

Returns

CUIListBox<T>

Inherited from

CUIScrollView.constructor

Methods

AddExistingItem()

AddExistingItem(item: T): void;

Add an existing item and transfer it to the list.

Parameters

Parameter	Type	Description
item	T	Item to add.

Returns

void

Remarks

The Lua binding adopts item; keep future lifetime management with the list.

---

AddTextItem()

AddTextItem(text: string): T;

Add a text item.

Parameters

Parameter	Type	Description
text	string	Item text.

Returns

T

Created item.

---

AddWindow()

AddWindow(window: CUIWindow, value: boolean): void;

Add a window to the scroll view.

Parameters

Parameter	Type	Description
window	CUIWindow	Window to add.
value	boolean	Whether layout should be recalculated.

Returns

void

Inherited from

CUIScrollView.AddWindow

---

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

CUIScrollView.AttachChild

---

Clear()

Clear(): void;

Remove all child windows.

Returns

void

Inherited from

CUIScrollView.Clear

---

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

CUIScrollView.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

CUIScrollView.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUIScrollView.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

CUIScrollView.GetAbsoluteRect

---

GetCurrentScrollPos()

GetCurrentScrollPos(): number;

Returns

number

Current scroll position.

Inherited from

CUIScrollView.GetCurrentScrollPos

---

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

CUIScrollView.GetFont

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

CUIScrollView.GetHeight

---

GetItem()

GetItem(index: number): CUIWindow;

Get item window by index.

Parameters

Parameter	Type	Description
index	number	Item index.

Returns

CUIWindow

Item window.

---

GetItemByIndex()

GetItemByIndex(index: number): T;

Get typed item by index.

Parameters

Parameter	Type	Description
index	number	Item index.

Returns

T

List box item.

---

GetItemHeight()

GetItemHeight(): number;

Returns

number

List item height.

---

GetMaxScrollPos()

GetMaxScrollPos(): number;

Returns

number

Maximum scroll position.

Inherited from

CUIScrollView.GetMaxScrollPos

---

GetMinScrollPos()

GetMinScrollPos(): number;

Returns

number

Minimum scroll position.

Inherited from

CUIScrollView.GetMinScrollPos

---

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

CUIScrollView.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

CUIScrollView.GetMouseY

---

GetSelectedIndex()

GetSelectedIndex(): number;

Returns

number

Selected item index.

---

GetSelectedItem()

GetSelectedItem(): Nullable<T>;

Returns

Nullable<T>

Selected item, or null when nothing is selected.

---

GetSize()

GetSize(): number;

Returns

number

Number of items in the list.

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUIScrollView.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUIScrollView.GetWndPos

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

CUIScrollView.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

CUIScrollView.Init

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

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

Inherited from

CUIScrollView.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUIScrollView.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUIScrollView.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

CUIScrollView.IsShown

---

RemoveAll()

RemoveAll(): void;

Remove all items.

Returns

void

---

RemoveItem()

RemoveItem(window: CUIWindow): void;

Remove an item window.

Parameters

Parameter	Type	Description
window	CUIWindow	Item window.

Returns

void

---

RemoveWindow()

RemoveWindow(window: CUIWindow): void;

Remove a child window from the scroll view.

Parameters

Parameter	Type	Description
window	CUIWindow	Window to remove.

Returns

void

Inherited from

CUIScrollView.RemoveWindow

---

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

CUIScrollView.ResetPPMode

---

ScrollToBegin()

ScrollToBegin(): void;

Scroll to the beginning.

Returns

void

Inherited from

CUIScrollView.ScrollToBegin

---

ScrollToEnd()

ScrollToEnd(): void;

Scroll to the end.

Returns

void

Inherited from

CUIScrollView.ScrollToEnd

---

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

CUIScrollView.SetAutoDelete

---

SetFixedScrollBar()

SetFixedScrollBar(fixed: boolean): void;

Keep scrollbar visibility fixed.

Parameters

Parameter	Type	Description
fixed	boolean	Whether scrollbar state is fixed.

Returns

void

Inherited from

CUIScrollView.SetFixedScrollBar

---

SetFont()

SetFont(font: CGameFont): void;

Set the font used by this window.

Parameters

Parameter	Type	Description
font	CGameFont	Font object.

Returns

void

Inherited from

CUIScrollView.SetFont

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

CUIScrollView.SetHeight

---

SetItemHeight()

SetItemHeight(height: number): void;

Set list item height.

Parameters

Parameter	Type	Description
height	number	Item height.

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

CUIScrollView.SetPPMode

---

SetScrollPos()

SetScrollPos(position: number): void;

Set scroll position.

Parameters

Parameter	Type	Description
position	number	Scroll position.

Returns

void

Inherited from

CUIScrollView.SetScrollPos

---

SetSelectedIndex()

SetSelectedIndex(index: number): void;

Select an item by index.

Parameters

Parameter	Type	Description
index	number	Item index.

Returns

void

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUIScrollView.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUIScrollView.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

CUIScrollView.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

CUIScrollView.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

CUIScrollView.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

CUIScrollView.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

CUIScrollView.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

CUIScrollView.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

CUIScrollView.Show

---

ShowSelectedItem()

ShowSelectedItem(value: boolean): void;

Scroll the selected item into view.

Parameters

Parameter	Type	Description
value	boolean	Whether selected item should be shown.

Returns

void

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUIScrollView.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUIScrollView.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUIScrollView.__name