Class: CUIEditBox

UI binding for CUIEditBox.

Source

C++ class CUIEditBox : CUICustomEdit

Custom Constructor

CUIEditBox

Extends

• CUICustomEdit

Constructors

Constructor

new CUIEditBox(): CUIEditBox;

Create an empty UI window.

Returns

CUIEditBox

Inherited from

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

CUICustomEdit.AttachChild

---

CaptureFocus()

CaptureFocus(value: boolean): void;

Capture or release keyboard focus.

Parameters

Parameter	Type	Description
value	boolean	Whether focus should be captured.

Returns

void

Remarks

Captured focus routes keyboard input to this edit control until it is released or moved to another capturer.

Inherited from

CUICustomEdit.CaptureFocus

---

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

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

CUICustomEdit.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUICustomEdit.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

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

CUICustomEdit.GetFont

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

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

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

CUICustomEdit.GetMouseY

---

GetText()

GetText(): string;

Returns

string

Current edit text.

Inherited from

CUICustomEdit.GetText

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUICustomEdit.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUICustomEdit.GetWndPos

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

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

CUICustomEdit.Init

---

InitTexture()

InitTexture(texture_id: string): void;

Initialize the edit box texture.

Parameters

Parameter	Type	Description
texture_id	string	Texture atlas entry name.

Returns

void

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

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

Inherited from

CUICustomEdit.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUICustomEdit.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUICustomEdit.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

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

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

CUICustomEdit.SetAutoDelete

---

SetFont()

SetFont(font: CGameFont): void;

Set the font used by this window.

Parameters

Parameter	Type	Description
font	CGameFont	Font object.

Returns

void

Inherited from

CUICustomEdit.SetFont

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

CUICustomEdit.SetHeight

---

SetNextFocusCapturer()

SetNextFocusCapturer(edit: CUICustomEdit): void;

Set the edit control that receives focus after this one.

Parameters

Parameter	Type	Description
edit	CUICustomEdit	Next edit control.

Returns

void

Inherited from

CUICustomEdit.SetNextFocusCapturer

---

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

CUICustomEdit.SetPPMode

---

SetText()

SetText(text: string): void;

Set edit text.

Parameters

Parameter	Type	Description
text	string	New text.

Returns

void

Inherited from

CUICustomEdit.SetText

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUICustomEdit.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUICustomEdit.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

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

CUICustomEdit.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

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

CUICustomEdit.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

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

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

CUICustomEdit.Show

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUICustomEdit.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUICustomEdit.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUICustomEdit.__name