Class: CUIPropertiesBox

UI binding for CUIPropertiesBox.

Source

C++ class CUIPropertiesBox : CUIFrameWindow

Custom Constructor

CUIPropertiesBox

Extends

• CUIFrameWindow

Constructors

Constructor

new CUIPropertiesBox(): CUIPropertiesBox;

Create an empty UI window.

Returns

CUIPropertiesBox

Inherited from

CUIFrameWindow.constructor

Methods

AddItem()

AddItem(id: string): void;

Add a selectable property item.

Parameters

Parameter	Type	Description
id	string	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

CUIFrameWindow.AttachChild

---

AutoUpdateSize()

AutoUpdateSize(): void;

Resize the box to fit its items.

Returns

void

---

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

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

CUIFrameWindow.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUIFrameWindow.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

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

CUIFrameWindow.GetFont

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

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

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

CUIFrameWindow.GetMouseY

---

GetSelectedItem()

GetSelectedItem(): CUIListBoxItem;

Returns

CUIListBoxItem

Currently selected property item.

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUIFrameWindow.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUIFrameWindow.GetWndPos

---

Hide()

Hide(): void;

Hide the properties box.

Returns

void

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

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

CUIFrameWindow.Init

---

InitPropertiesBox()

InitPropertiesBox(position: vector2, size: vector2): void;

Initialize properties box geometry.

Parameters

Parameter	Type	Description
position	vector2	Box position.
size	vector2	Box size.

Returns

void

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

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

Inherited from

CUIFrameWindow.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUIFrameWindow.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUIFrameWindow.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

CUIFrameWindow.IsShown

---

RemoveAll()

RemoveAll(): void;

Remove all property items.

Returns

void

---

RemoveItem()

RemoveItem(index: number): void;

Remove an item by index.

Parameters

Parameter	Type	Description
index	number	Item index.

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

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

CUIFrameWindow.SetAutoDelete

---

SetColor()

SetColor(color: number): void;

Set frame color.

Parameters

Parameter	Type	Description
color	number	ARGB color.

Returns

void

Inherited from

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

CUIFrameWindow.SetFont

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

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

CUIFrameWindow.SetPPMode

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUIFrameWindow.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUIFrameWindow.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

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

CUIFrameWindow.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

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

CUIFrameWindow.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

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

CUIFrameWindow.SetWndSize

---

Show()

Call Signature

Show(show: boolean): void;

Show or hide the properties box.

Parameters

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

Returns

void

Overrides

CUIFrameWindow.Show

Call Signature

Show(int1: number, int2: number): void;

Show the properties box near a screen point.

Parameters

Parameter	Type	Description
int1	number	X position.
int2	number	Y position.

Returns

void

Overrides

CUIFrameWindow.Show

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUIFrameWindow.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUIFrameWindow.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUIFrameWindow.__name