Class: CUIComboBox

UI binding for CUIComboBox.

Source

C++ class CUIComboBox : CUIWindow

Custom Constructor

CUIComboBox

Remarks

Item ids and list indices are different. Use ids for stable values and indices for visual order.

Extends

• CUIWindow

Constructors

Constructor

new CUIComboBox(): CUIComboBox;

Create an empty UI window.

Returns

CUIComboBox

Inherited from

CUIWindow.constructor

Methods

AddItem()

AddItem(label: string, id: number): void;

Add an item.

Parameters

Parameter	Type	Description
label	string	Item text.
id	number	Item id.

Returns

void

---

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

---

ClearList()

ClearList(): void;

Remove all items from the combo box.

Returns

void

---

CurrentID()

CurrentID(): number;

Returns

number

Current item id.

---

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

---

disable_id()

disable_id(id: number): void;

Disable an item by id.

Parameters

Parameter	Type	Description
id	number	Item id.

Returns

void

Remarks

id is the item id passed to CUIComboBox.AddItem, not the visual index.

---

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

---

enable_id()

enable_id(id: number): void;

Enable an item by id.

Parameters

Parameter	Type	Description
id	number	Item id.

Returns

void

Remarks

id is the item id passed to CUIComboBox.AddItem, not the visual index.

---

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

---

GetCurrentIdx()

GetCurrentIdx(): number;

Returns

number

Current selected item index.

---

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

---

GetText()

GetText(): string;

Returns

string

Current visible text.

---

GetTextOf()

GetTextOf(id: number): string;

Get text for an item id.

Parameters

Parameter	Type	Description
id	number	Item id.

Returns

string

Item text.

Remarks

id is the item id passed to CUIComboBox.AddItem, not the visual index.

---

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

---

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

---

SetCurrentID()

SetCurrentID(id: number): void;

Select an item by id.

Parameters

Parameter	Type	Description
id	number	Item id.

Returns

void

Remarks

id is the item id passed to CUIComboBox.AddItem, not the visual index.

---

SetCurrentIdx()

SetCurrentIdx(index: number): void;

Select an item by index.

Parameters

Parameter	Type	Description
index	number	Item index.

Returns

void

Remarks

Index follows current visual order and can change when the list contents change.

---

SetCurrentOptValue()

SetCurrentOptValue(): void;

Apply the current option value from engine options.

Returns

void

---

SetCurrentValue()

SetCurrentValue(): void;

Apply the current combo value.

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

---

SetListLength()

SetListLength(length: number): void;

Set visible list length.

Parameters

Parameter	Type	Description
length	number	Maximum visible item count.

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

---

SetText()

SetText(text: string): void;

Set the visible text.

Parameters

Parameter	Type	Description
text	string	Text to show.

Returns

void

---

SetVertScroll()

SetVertScroll(enabled: boolean): void;

Enable or disable the vertical scrollbar.

Parameters

Parameter	Type	Description
enabled	boolean	Whether vertical scrolling is enabled.

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

---

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