Class: MockCUIWindow

Mock base window class.

Extends

• MockLuabindClass

Extended by

• MockCUIStatic
• MockCUIComboBox
• MockCUICustomSpin
• MockCUIDialogWnd
• MockCUIEditBox
• MockCUIListBoxItem
• MockCUIMapInfo
• MockCUIMapList
• MockCUIMMShniaga
• MockCUIScrollView
• MockCUITabControl
• MockCUITextWnd
• MockCUITrackBar
• MockCServerList

Implements

• CUIWindow

Accessors

__name

Get Signature

get __name(): string;

Returns

string

Implementation of

CUIWindow.__name

Inherited from

MockLuabindClass.__name

---

__name

Get Signature

get static __name(): string;

Returns

string

Inherited from

MockLuabindClass.__name

Constructors

Constructor

new MockCUIWindow(): MockCUIWindow;

Returns

MockCUIWindow

Inherited from

MockLuabindClass.constructor

Methods

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Implementation of

CUIWindow.GetHeight

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Implementation of

CUIWindow.GetWidth

---

OnKeyboard()

OnKeyboard(): boolean;

Returns

boolean

---

Show()

Show(isShown: boolean): void;

Show or hide the window.

Parameters

Parameter	Type
isShown	boolean

Returns

void

Remarks

Visibility does not attach, detach, enable, or disable the window.

Implementation of

CUIWindow.Show

---

create()

static create(): MockCUIWindow;

Returns

MockCUIWindow

Overrides

MockLuabindClass.create

---

mock()

static mock(): CUIWindow;

Returns

CUIWindow

Overrides

MockLuabindClass.mock

Properties

AttachChild

AttachChild: Mock<(window: CUIWindow) => void>;

Attach a child window.

Remarks

The Lua binding adopts child; after attachment, treat the parent as owning its lifetime.

Param

child

Child window.

Implementation of

CUIWindow.AttachChild

---

children

children: CUIWindow[] = [];

---

DetachChild

DetachChild: Mock<(window: CUIWindow) => void>;

Detach a child window.

Remarks

Detaching removes the parent relation. It does not reinitialize the window or attach it elsewhere.

Param

child

Child window.

Implementation of

CUIWindow.DetachChild

---

Enable

Enable: Mock<(isEnabled: boolean) => void>;

Enable or disable interaction.

Remarks

Enabled state and visibility are separate. Hidden controls can still be enabled.

Param

is_enabled

Whether the window should be enabled.

Implementation of

CUIWindow.Enable

---

focusReceiveTime

focusReceiveTime: number = 0;

---

FocusReceiveTime

FocusReceiveTime: Mock<() => number>;

Returns

Level time when this window received focus.

Implementation of

CUIWindow.FocusReceiveTime

---

GetAbsoluteRect

GetAbsoluteRect: Mock<() => Frect>;

Returns

Window rectangle in screen coordinates.

Implementation of

CUIWindow.GetAbsoluteRect

---

GetFont

GetFont: Mock<() => CGameFont>;

Get the font assigned to this window.

Remarks

Text controls need a font assigned before drawing custom text reliably.

Returns

Font assigned to this window.

Implementation of

CUIWindow.GetFont

---

GetMouseX

GetMouseX: Mock<() => number>;

Get cursor X coordinate stored on this window.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseX binding.

Returns

Current cursor X coordinate.

Implementation of

CUIWindow.GetMouseX

---

GetMouseY

GetMouseY: Mock<() => number>;

Get cursor Y coordinate stored on this window.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseY binding.

Returns

Current cursor Y coordinate.

Implementation of

CUIWindow.GetMouseY

---

GetWndPos

GetWndPos: Mock<() => vector2>;

Returns

Window position relative to its parent.

Implementation of

CUIWindow.GetWndPos

---

Init

Init: Mock<(rectOrX: number | Frect, y?: number, width?: number, height?: number) => void>;

Initialize window rectangle.

Param

frect

Window rectangle.

Implementation of

CUIWindow.Init

---

isAutoDelete

isAutoDelete: boolean = false;

---

IsAutoDelete

IsAutoDelete: Mock<() => boolean>;

Returns

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

Implementation of

CUIWindow.IsAutoDelete

---

IsCursorOverWindow

IsCursorOverWindow: Mock<() => boolean>;

Returns

Whether the UI cursor is currently over this window.

Implementation of

CUIWindow.IsCursorOverWindow

---

isEnabled

isEnabled: boolean = false;

---

IsEnabled

IsEnabled: Mock<() => boolean>;

Returns

Whether the window accepts interaction.

Implementation of

CUIWindow.IsEnabled

---

isPostProcessMode

isPostProcessMode: boolean = false;

---

isShown

isShown: boolean = false;

---

IsShown

IsShown: Mock<() => boolean>;

Returns

Whether the window is visible.

Implementation of

CUIWindow.IsShown

---

mouseX

mouseX: number = 0;

---

mouseY

mouseY: number = 0;

---

ResetPPMode

ResetPPMode: Mock<() => void>;

Disable post-process mode for this window.

Remarks

Pair with CUIWindow.SetPPMode when a window no longer needs post-process rendering.

Implementation of

CUIWindow.ResetPPMode

---

SetAutoDelete

SetAutoDelete: Mock<(isAutoDelete: boolean) => void>;

Set whether the parent owns this child window.

Remarks

Use this for script-created windows that are attached to a parent and should be cleaned up with the UI tree.

Param

auto_delete

Whether the engine should delete the child automatically.

Implementation of

CUIWindow.SetAutoDelete

---

SetFont

SetFont: Mock<(font: CGameFont) => void>;

Set the font used by this window.

Param

font

Font object.

Implementation of

CUIWindow.SetFont

---

SetHeight

SetHeight: Mock<(height: number) => void>;

Set window height.

Param

height

New height.

Implementation of

CUIWindow.SetHeight

---

SetPPMode

SetPPMode: Mock<() => void>;

Enable post-process mode for this window.

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.

Implementation of

CUIWindow.SetPPMode

---

SetWidth

SetWidth: Mock<(width: number) => void>;

Set window width.

Param

width

New width.

Implementation of

CUIWindow.SetWidth

---

SetWindowName

SetWindowName: Mock<(name: string) => void>;

Set debug/window name.

Param

name

Window name.

Implementation of

CUIWindow.SetWindowName

---

SetWndPos

SetWndPos: Mock<(positionOrX: number | vector2, y?: number) => void>;

Set window position.

Param

vector2

New position.

Implementation of

CUIWindow.SetWndPos

---

SetWndRect

SetWndRect: Mock<(rectOrX: number | Frect, y?: number, width?: number, height?: number) => void>;

Set window rectangle.

Param

rect

New rectangle.

Implementation of

CUIWindow.SetWndRect

---

SetWndSize

SetWndSize: Mock<(sizeOrWidth: number | vector2, height?: number) => void>;

Set window size.

Param

vector2

New size.

Implementation of

CUIWindow.SetWndSize

---

windowFont

windowFont: CGameFont | null = null;

---

windowName

windowName: string | null = null;

---

WindowName

WindowName: Mock<() => string>;

Returns

Window name.

Implementation of

CUIWindow.WindowName

---

windowPosition

windowPosition: vector2;

---

windowRect

windowRect: Frect | null = null;

---

windowSize

windowSize: vector2;