Class: CUICheckButton

UI binding for CUICheckButton.

Source

C++ class CUICheckButton : CUI3tButton

Custom Constructor

CUICheckButton

Extends

• CUI3tButton

Constructors

Constructor

new CUICheckButton(): CUICheckButton;

Create an empty UI window.

Returns

CUICheckButton

Inherited from

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

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

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

CUI3tButton.Enable

---

FocusReceiveTime()

FocusReceiveTime(): number;

Returns

number

Level time when this window received focus.

Inherited from

CUI3tButton.FocusReceiveTime

---

GetAbsoluteRect()

GetAbsoluteRect(): Frect;

Returns

Frect

Window rectangle in screen coordinates.

Inherited from

CUI3tButton.GetAbsoluteRect

---

GetCheck()

GetCheck(): boolean;

Returns

boolean

Whether the button is checked.

---

GetColor()

GetColor(): number;

Returns

number

Texture color.

Inherited from

CUI3tButton.GetColor

---

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

CUI3tButton.GetFont

---

GetHeading()

GetHeading(): number;

Returns

number

Heading angle.

Inherited from

CUI3tButton.GetHeading

---

GetHeight()

GetHeight(): number;

Returns

number

Window height.

Inherited from

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

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

CUI3tButton.GetMouseY

---

GetOriginalRect()

GetOriginalRect(): Frect;

Returns

Frect

Original texture rectangle.

Inherited from

CUI3tButton.GetOriginalRect

---

GetStretchTexture()

GetStretchTexture(): boolean;

Returns

boolean

Whether texture stretching is enabled.

Inherited from

CUI3tButton.GetStretchTexture

---

GetText()

GetText(): string;

Returns

string

Current text.

Inherited from

CUI3tButton.GetText

---

GetTextAlign()

GetTextAlign(): number;

Returns

number

Text alignment id.

Inherited from

CUI3tButton.GetTextAlign

---

GetTextureColor()

GetTextureColor(): number;

Returns

number

Texture color.

Inherited from

CUI3tButton.GetTextureColor

---

GetTextureRect()

GetTextureRect(): Frect;

Returns

Frect

Texture rectangle.

Inherited from

CUI3tButton.GetTextureRect

---

GetTextX()

GetTextX(): number;

Returns

number

Text X offset.

Inherited from

CUI3tButton.GetTextX

---

GetTextY()

GetTextY(): number;

Returns

number

Text Y offset.

Inherited from

CUI3tButton.GetTextY

---

GetWidth()

GetWidth(): number;

Returns

number

Window width.

Inherited from

CUI3tButton.GetWidth

---

GetWndPos()

GetWndPos(): vector2;

Returns

vector2

Window position relative to its parent.

Inherited from

CUI3tButton.GetWndPos

---

Init()

Call Signature

Init(frect: Frect): void;

Initialize window rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Window rectangle.

Returns

void

Inherited from

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

CUI3tButton.Init

---

InitTexture()

InitTexture(texture: string): void;

Assign texture by atlas id.

Parameters

Parameter	Type	Description
texture	string	Texture id.

Returns

void

Inherited from

CUI3tButton.InitTexture

---

InitTextureEx()

InitTextureEx(first: string, second: string): void;

Assign texture and shader by name.

Parameters

Parameter	Type	Description
first	string	Texture id.
second	string	Shader id.

Returns

void

Inherited from

CUI3tButton.InitTextureEx

---

IsAutoDelete()

IsAutoDelete(): boolean;

Returns

boolean

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

Inherited from

CUI3tButton.IsAutoDelete

---

IsCursorOverWindow()

IsCursorOverWindow(): boolean;

Returns

boolean

Whether the UI cursor is currently over this window.

Inherited from

CUI3tButton.IsCursorOverWindow

---

IsEnabled()

IsEnabled(): boolean;

Returns

boolean

Whether the window accepts interaction.

Inherited from

CUI3tButton.IsEnabled

---

IsShown()

IsShown(): boolean;

Returns

boolean

Whether the window is visible.

Inherited from

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

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

CUI3tButton.SetAutoDelete

---

SetCheck()

SetCheck(value: boolean): void;

Set checked state.

Parameters

Parameter	Type	Description
value	boolean	New checked state.

Returns

void

---

SetColor()

SetColor(color: number): void;

Set texture color.

Parameters

Parameter	Type	Description
color	number	ARGB color.

Returns

void

Inherited from

CUI3tButton.SetColor

---

SetDependControl()

SetDependControl(window: CUIWindow): void;

Bind another control to this checkbox state.

Parameters

Parameter	Type	Description
window	CUIWindow	Dependent control.

Returns

void

Remarks

The dependent control follows this checkbox state in the UI.

---

SetElipsis()

SetElipsis(a: number, b: number): void;

Configure text ellipsis.

Parameters

Parameter	Type	Description
a	number	Ellipsis mode.
b	number	Indent.

Returns

void

Inherited from

CUI3tButton.SetElipsis

---

SetFont()

SetFont(font: CGameFont): void;

Set the font used by this window.

Parameters

Parameter	Type	Description
font	CGameFont	Font object.

Returns

void

Inherited from

CUI3tButton.SetFont

---

SetHeading()

SetHeading(number: number): void;

Set heading angle.

Parameters

Parameter	Type	Description
number	number	Heading angle.

Returns

void

Inherited from

CUI3tButton.SetHeading

---

SetHeight()

SetHeight(height: number): void;

Set window height.

Parameters

Parameter	Type	Description
height	number	New height.

Returns

void

Inherited from

CUI3tButton.SetHeight

---

SetOriginalRect()

SetOriginalRect(frect: Frect): void;

Set original texture rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Original rectangle.

Returns

void

Inherited from

CUI3tButton.SetOriginalRect

---

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

CUI3tButton.SetPPMode

---

SetStretchTexture()

SetStretchTexture(stretch: boolean): void;

Enable or disable texture stretching.

Parameters

Parameter	Type	Description
stretch	boolean	Whether texture should stretch to the window rect.

Returns

void

Inherited from

CUI3tButton.SetStretchTexture

---

SetText()

SetText(text: string): void;

Set raw text.

Parameters

Parameter	Type	Description
text	string	Text value.

Returns

void

Inherited from

CUI3tButton.SetText

---

SetTextAlign()

SetTextAlign(align: number): void;

Set text alignment.

Parameters

Parameter	Type	Description
align	number	Alignment id.

Returns

void

Inherited from

CUI3tButton.SetTextAlign

---

SetTextColor()

SetTextColor(
   a: number, 
   r: number, 
   g: number, 
   b: number): void;

Set text color from color channels.

Parameters

Parameter	Type	Description
a	number	Alpha channel.
r	number	Red channel.
g	number	Green channel.
b	number	Blue channel.

Returns

void

Inherited from

CUI3tButton.SetTextColor

---

SetTextST()

SetTextST(string: string): void;

Set translated string-table text.

Parameters

Parameter	Type	Description
string	string	String table id.

Returns

void

Inherited from

CUI3tButton.SetTextST

---

SetTextureColor()

SetTextureColor(color: number): void;

Set texture color.

Parameters

Parameter	Type	Description
color	number	ARGB color.

Returns

void

Inherited from

CUI3tButton.SetTextureColor

---

SetTextureOffset()

SetTextureOffset(x: number, y: number): void;

Set texture drawing offset.

Parameters

Parameter	Type	Description
x	number	X offset.
y	number	Y offset.

Returns

void

Inherited from

CUI3tButton.SetTextureOffset

---

SetTextureRect()

SetTextureRect(frect: Frect): void;

Set source texture rectangle.

Parameters

Parameter	Type	Description
frect	Frect	Texture rectangle.

Returns

void

Inherited from

CUI3tButton.SetTextureRect

---

SetTextX()

SetTextX(x: number): void;

Set text X offset.

Parameters

Parameter	Type	Description
x	number	X offset.

Returns

void

Inherited from

CUI3tButton.SetTextX

---

SetTextY()

SetTextY(x: number): void;

Set text Y offset.

Parameters

Parameter	Type	Description
x	number	Y offset.

Returns

void

Inherited from

CUI3tButton.SetTextY

---

SetWidth()

SetWidth(width: number): void;

Set window width.

Parameters

Parameter	Type	Description
width	number	New width.

Returns

void

Inherited from

CUI3tButton.SetWidth

---

SetWindowName()

SetWindowName(name: string): void;

Set debug/window name.

Parameters

Parameter	Type	Description
name	string	Window name.

Returns

void

Inherited from

CUI3tButton.SetWindowName

---

SetWndPos()

Call Signature

SetWndPos(vector2: vector2): void;

Set window position.

Parameters

Parameter	Type	Description
vector2	vector2	New position.

Returns

void

Inherited from

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

CUI3tButton.SetWndPos

---

SetWndRect()

Call Signature

SetWndRect(rect: Frect): void;

Set window rectangle.

Parameters

Parameter	Type	Description
rect	Frect	New rectangle.

Returns

void

Inherited from

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

CUI3tButton.SetWndRect

---

SetWndSize()

Call Signature

SetWndSize(vector2: vector2): void;

Set window size.

Parameters

Parameter	Type	Description
vector2	vector2	New size.

Returns

void

Inherited from

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

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

CUI3tButton.Show

---

TextControl()

TextControl(): CUILines;

Returns

CUILines

Text line controller.

Inherited from

CUI3tButton.TextControl

---

WindowName()

WindowName(): string;

Returns

string

Window name.

Inherited from

CUI3tButton.WindowName

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CUI3tButton.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CUI3tButton.__name