Class: CUIListBoxItem

UI binding for CUIListBoxItem.

Source

C++ class CUIListBoxItem : CUIFrameLineWnd

Custom Constructor

CUIListBoxItem

Extends

• CUIFrameLineWnd

Extended by

• CUIListBoxItemMsgChain

Constructors

Constructor

new CUIListBoxItem(height: number): CUIListBoxItem;

Create a list box item with height.

Parameters

Parameter	Type	Description
height	number	Item height.

Returns

CUIListBoxItem

Overrides

CUIFrameLineWnd.constructor

Constructor

new CUIListBoxItem(target: CUIListBoxItem): CUIListBoxItem;

Copy an existing list box item.

Parameters

Parameter	Type	Description
target	CUIListBoxItem	Source item.

Returns

CUIListBoxItem

Overrides

CUIFrameLineWnd.constructor

Constructor

new CUIListBoxItem(target: CUIListBoxItem, height: number): CUIListBoxItem;

Copy an existing list box item and override its height.

Parameters

Parameter	Type	Description
target	CUIListBoxItem	Source item.
height	number	Item height.

Returns

CUIListBoxItem

Overrides

CUIFrameLineWnd.constructor

Methods

AddIconField()

AddIconField(value: number): CUIStatic;

Add an icon field to the item.

Parameters

Parameter	Type	Description
value	number	Field width.

Returns

CUIStatic

Created static field.

---

AddTextField()

AddTextField(text: string, width: number): CUITextWnd;

Add a text field to the item.

Parameters

Parameter	Type	Description
text	string	Field text.
width	number	Field width.

Returns

CUITextWnd

Created text window.

---

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

CUIFrameLineWnd.AttachChild

---

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

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

CUIFrameLineWnd.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUIFrameLineWnd.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

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

CUIFrameLineWnd.GetFont

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

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

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

CUIFrameLineWnd.GetMouseY

---

GetTextItem()

GetTextItem(): CUITextWnd;

Returns

CUITextWnd

Main text item.

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUIFrameLineWnd.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUIFrameLineWnd.GetWndPos

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

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

CUIFrameLineWnd.Init

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

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

Inherited from

CUIFrameLineWnd.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUIFrameLineWnd.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUIFrameLineWnd.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

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

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

CUIFrameLineWnd.SetAutoDelete

---

SetColor()

SetColor(color: number): void;

Set frame line color.

Parameters

Parameter	Type	Description
color	number	ARGB color.

Returns

void

Inherited from

CUIFrameLineWnd.SetColor

---

SetFont()

SetFont(font: CGameFont): void;

Set the font used by this window.

Parameters

Parameter	Type	Description
font	CGameFont	Font object.

Returns

void

Inherited from

CUIFrameLineWnd.SetFont

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

CUIFrameLineWnd.SetHeight

---

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

CUIFrameLineWnd.SetPPMode

---

SetTextColor()

SetTextColor(color: number): void;

Set item text color.

Parameters

Parameter	Type	Description
color	number	ARGB color.

Returns

void

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUIFrameLineWnd.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUIFrameLineWnd.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

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

CUIFrameLineWnd.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

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

CUIFrameLineWnd.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

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

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

CUIFrameLineWnd.Show

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUIFrameLineWnd.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUIFrameLineWnd.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUIFrameLineWnd.__name